GraphOS Query Planner Custom Check

Example code that listens to a GraphOS custom check webhook to validate changes in query plans

⚠️ This code uses the internal package of the JS Query Planner. Apollo is actively moving to a new Native Query Planner and this may have to be updated in the future to support new Federation features

⚠️ The code in this repository is experimental and has been provided for reference purposes only. Community feedback is welcome but this project may not be supported in the same way that repositories in the official Apollo GraphQL GitHub organization are. If you need help you can file an issue on this repository, contact Apollo to talk to an expert, or create a ticket directly in Apollo Studio.

What's Inside

The code that lives in api/webhook.ts is example Typescript code for a Vercel Function that can be called by GraphOS Studio when a custom check is triggered. This is an example in Vercel, but you could apply this code or logic to any runtime, serverless or not, you just need a public endpoint for GraphOS to call.

Inside the function we validate that it is a proper check notification with HMAC and then fetch the current and proposed supergraphs to check the differences in query plans.

As an example you could change the level of warnings vs errors in the _config-options.ts file

Run Locally

• Clone the repo
• Install the latest LTS version of Node (see nvm)
• Install dependencies

  npm install

• Start the app using the Vercel CLI locally:

  npm run vercel

Endpoints

• /api/hello Simple test endpoint that returns a hello world message
• /api/webhook Example Webhook that understands GraphOS Custom Checks