feat: exclude operation name via a field in RequestConfig

[robertobadalamenti]

No description provided.

[jasonkuhrt]

Could you explain the following:

• Example of document sent, ignored vs not ignored
• Why this matters

Links to other information sources are fine.

[robertobadalamenti]

I have created a new commit with an updated readme that I hope answers your questions. Feel free to ask me anything, I will be happy to answer.

[jasonkuhrt]

Thanks @robertobadalamenti, left a comment on the docs before diving into the rest.

[jasonkuhrt]

Thanks for the effort! Two things:

1. Can you show an example of how the GraphQL document sent over the wire changes, if at all. (if nothing, ignore this point)
2. Please write a test

After that we can merge. Thanks!

[robertobadalamenti]

I made a new commit with the tests for the ignoreOperationName flag. While below are the logs with the two different configurations for ignoreOperationName. I hope it answers your requests, in case you don't hesitate to ask me anything else.

current case i.e. not ignoring the operationName

	const client = new GraphQLClient(context.base_url, {
		method: "POST",
		errorPolicy: "ignore",
		requestMiddleware: requestMiddleware,
	});
	
	//or equivalently
	
	const client = new GraphQLClient(context.base_url, {
		method: "POST",
		errorPolicy: "ignore",
		ignoreOperationName: false,  // <--
		requestMiddleware: requestMiddleware,
	});

related log

 request {
  method: 'POST',
  headers: _HeadersList {
    cookies: null,
    [Symbol(headers map)]: Map(7) {
      'graphql-request-hash' => [Object],
      'accept' => [Object],
      'content-type' => [Object]
    },
    [Symbol(headers map sorted)]: null
  },
  body: '{"query":"query GetPage($id: ID!) { getPage(id: $id) { lastModified } }","variables":{"id":"/"},"operationName":"GetPage"}',
  errorPolicy: 'ignore',
  url: 'https://your_shema_url.it',
  operationName: 'GetPage',
  variables: { id: '/' }
}`

instead by setting the new "ignoreOperationName" flag to true

	const client = new GraphQLClient(context.base_url, {
		method: "POST",
		errorPolicy: "ignore",
		ignoreOperationName: true,   //<--
		requestMiddleware: requestMiddleware,
	});

related log

request {
  method: 'POST',
  headers: _HeadersList {
    cookies: null,
    [Symbol(headers map)]: Map(7) {
      'graphql-request-hash' => [Object],
      'accept' => [Object],
      'content-type' => [Object]
    },
    [Symbol(headers map sorted)]: null
  },
  body: '{"query":"query GetPage($id: ID!) { getPage(id: $id) { lastModified } }","variables":{"id":"/"}}',
  errorPolicy: 'ignore',
  url: 'https://your_shema_url.it',
  operationName: undefined,
  variables: { id: '/' }
}

thank you for your support.

[jasonkuhrt]

Looking good. I think ignore... is the wrong term here, as that suggests not paying attention to something received. In fact, this is about not sending something to the server. Let's call this includeOperationName or something (will require flipping the boolean value in that case, since the boolean sense is reversed).

Also, please rebase.

[robertobadalamenti]

The idea was to use a negative term so that it is backwards compatible, i.e. if it is not defined, the behaviour remains as it is now. What do you think about exclude...?
If I reverse the logic by using include..., if the flag is not defined, do we still include it?

[jasonkuhrt]

@robertobadalamenti exclude... works yep!

[robertobadalamenti]

I did the commit for 'exclude...' and rebase

[jasonkuhrt]

ty!

Just some checks to fix then I can merge!

[robertobadalamenti]

I have solved the checks

[jasonkuhrt]

@robertobadalamenti There's some kind of formatting check issue, but, I won't bother you with that. Will merge and fix myself later. Thanks for your dedication on this PR!