feat!: add signal support

[arnaudbzn]

Add a new signal request option to request, rawRequest and batchRequests GraphQL Client methods.

New GraphQL Client request, rawRequest and batchRequests method overloads with a single options object argument.

The signal defined as a function argument overrides the signal defined in the GraphQLClient constructor.

This feature will add more flexibility and it will allow GraphQL Code Gen React Query plugin to support signal and request cancellation with graphql-request.

Related issue: #182

Also included in this PR: yarn test:coverage.

[alejo4373]

I was just looking for a way to cancel requests with this lib and the changes in this PR will enable me to do just that. Thanks, @arnaudbzn!

[arnaudbzn]

@jasonkuhrt Node.js supports AbortController since v14.x.
To support previous Node.js versions (v12 in the current checks) we have to use a polyfill like node-abort-controller.
Or we can just remove Node.js v12 check here:

      matrix:
        node: [12, 14, 16]

According to the README, we should not have to fully support v12.

[arnaudbzn]

@jasonkuhrt Node.js supports AbortController since v14.x. To support previous Node.js versions (v12 in the current checks) we have to use a polyfill like node-abort-controller. Or we can just remove Node.js v12 check here:

      matrix:
        node: [12, 14, 16]

According to the README, we should not have to fully support v12.

@jasonkuhrt , I've removed the Node v12 from the test matrix, everything should be green 🚦

[jasonkuhrt]

@arnaudbzn Are there simple instructions for how Node 12 users can polyfill themselves? If so let's add that to our REDAME?

[arnaudbzn]

@arnaudbzn Are there simple instructions for how Node 12 users can polyfill themselves? If so let's add that to our REDAME?

Actually AbortController has been added in Node.js v14.17.0
So I'll have to use an AbortController polyfill to support both v14 and v12.

[arnaudbzn]

@jasonkuhrt An AbortController polyfill is now used in the new signal tests to support both Node.js v12 and v14.
All checks ✅

[bviebahn]

Looking forward to using this. Can this be released?

[arnaudbzn]

Looking forward to using this. Can this be released?

@jasonkuhrt Thank you for the merge 🙂
When do you plan the next release? 🚀

[jasonkuhrt]

I'll cut a preview release today. Unfortunately the automation for that is still failing.

[arnaudbzn]

I'll cut a preview release today. Unfortunately the automation for that is still failing.

@jasonkuhrt Thank you Jason, any update about the release?

[jasonkuhrt]

Preview went out 10 days ago, I can cut a stable today I guess.

[arnaudbzn]

Preview went out 10 days ago, I can cut a stable today I guess.

@jasonkuhrt Have you planned a release this week? Thks.

[jasonkuhrt]

@arnaudbzn we cut one last week, there's a problem with the release tool so no activity on the git repo about that. But it is on npm now.

[arnaudbzn]

@arnaudbzn we cut one last week, there's a problem with the release tool so no activity on the git repo about that. But it is on npm now.

That's great! thank you Jason.

[abed-daloopa]

Hey,

Is it documented anywhere how to actually use this?

  const companiesQuery = useQuery({
    queryKey: ["companies", "search", deferredSearchInput],
    queryFn: ({ signal }) =>
	  // How to use signal with request?
      graphqlClient.request(companiesQueryDocument, {
        query: deferredSearchInput,
      }),
    enabled: Boolean(deferredSearchInput),
  });

---

Update: it should be used like this

  const companiesQuery = useQuery({
    queryKey: ["companies", "search", deferredSearchInput],
    queryFn: ({ signal }) =>
      graphqlClient.request({
        document: companiesQueryDocument,
        variables: { query: deferredSearchInput },
        signal,
      }),
    enabled: Boolean(deferredSearchInput),
  });