@envelop/graphql-jit

This plugins replaces the original execute of GraphQL with graphql-jit.

Getting Started

yarn add @envelop/graphql-jit

Usage Example

1import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
2import { envelop, useEngine } from '@envelop/core'
3import { useGraphQlJit } from '@envelop/graphql-jit'
4
5const getEnveloped = envelop({
6  plugins: [
7    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
8    // ... other plugins ...
9    useGraphQlJit(
10      {
11        // your compiler options here. See https://github.com/zalando-incubator/graphql-jit#compiledquery--compilequeryschema-document-operationname-compileroptions
12      },
13      {
14        onError: (e: Error) => {} // custom error handler
15      }
16    )
17  ]
18})

Conditional Execution

If you wish to conditionally use the JIT executor based on the incoming request, you can use enableIf config flag and return a boolean based on the ExecutionArgs:

1import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
2import { envelop, useEngine } from '@envelop/core'
3import { useGraphQlJit } from '@envelop/graphql-jit'
4
5const getEnveloped = envelop({
6  plugins: [
7    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
8    // ... other plugins ...
9    useGraphQlJit(
10      {
11        // your compiler options here. See https://github.com/zalando-incubator/graphql-jit#compiledquery--compilequeryschema-document-operationname-compileroptions
12      },
13      {
14        enableIf: executionArgs => executionArgs.contextValue.shouldUseJit
15      }
16    )
17  ]
18})

## Configuring JIT cache

You can configure the JIT cache with the following options:

1import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
2import { envelop, useEngine } from '@envelop/core'
3import { useGraphQlJit } from '@envelop/graphql-jit'
4
5const getEnveloped = envelop({
6  plugins: [
7    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
8    // ... other plugins ...
9    useGraphQlJit(
10      {
11        // your compiler options here
12      },
13      {
14        cache: lru() // Pass in a custom cache instance, by default a new LRU cache is created which uses the default `max` and `ttl` settings
15      }
16    )
17  ]
18})

Notes

You can find more details here: https://github.com/zalando-incubator/graphql-jit