Execution Cancellation

In the real world, a lot of HTTP requests are dropped or canceled. This can happen due to a flakey internet connection, navigation to a new view or page within a web or native app or the user simply closing the app. In this case, the server can stop processing the request and save resources.

That is why Hive Gateway comes with the support for canceling the GraphQL execution upon request cancellation.

So any extra calls to the services can be stopped and the resources can be saved.

Enable Execution Cancellation

import { defineConfig } from '@graphql-hive/gateway'
 
export const gatewayConfig = defineConfig({
  executionCancellation: true
})

That is all you need to do to enable execution cancellation in your Hive Gateway. Theoretically, you can enable this and immediately benefit from it without making any other adjustments within your GraphQL schema implementation.

If you want to understand how it works and how you can adjust your resolvers to properly cancel pending promises (e.g. database reads or HTTP requests), you can continue with the next section.