Add ability to turn directive validation on/off and add missing benchmarks

Author: jonnydgreen

README.md

@@ -117,7 +117,7 @@ app.listen(3000)
 
 ### Normal GraphQL Server Mode | Without Validation
 
-Last run: `2021-09-18`
+Last run: `2021-09-27`
 
 ```text
 Running 10s test @ http://localhost:3000/graphql
@@ -126,61 +126,97 @@ Running 10s test @ http://localhost:3000/graphql
 ┌─────────┬──────┬──────┬───────┬───────┬─────────┬─────────┬───────┐
 │ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg     │ Stdev   │ Max   │
 ├─────────┼──────┼──────┼───────┼───────┼─────────┼─────────┼───────┤
-│ Latency │ 6 ms │ 6 ms │ 13 ms │ 19 ms │ 6.83 ms │ 2.62 ms │ 64 ms │
+│ Latency │ 4 ms │ 5 ms │ 8 ms  │ 14 ms │ 5.33 ms │ 2.28 ms │ 63 ms │
 └─────────┴──────┴──────┴───────┴───────┴─────────┴─────────┴───────┘
-┌───────────┬────────┬────────┬─────────┬─────────┬──────────┬─────────┬────────┐
-│ Stat      │ 1%     │ 2.5%   │ 50%     │ 97.5%   │ Avg      │ Stdev   │ Min    │
-├───────────┼────────┼────────┼─────────┼─────────┼──────────┼─────────┼────────┤
-│ Req/Sec   │ 8015   │ 8015   │ 14431   │ 14911   │ 13649.28 │ 1899.44 │ 8013   │
-├───────────┼────────┼────────┼─────────┼─────────┼──────────┼─────────┼────────┤
-│ Bytes/Sec │ 3.5 MB │ 3.5 MB │ 6.31 MB │ 6.52 MB │ 5.96 MB  │ 830 kB  │ 3.5 MB │
-└───────────┴────────┴────────┴─────────┴─────────┴──────────┴─────────┴────────┘
+┌───────────┬────────┬────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
+│ Stat      │ 1%     │ 2.5%   │ 50%     │ 97.5%   │ Avg     │ Stdev   │ Min     │
+├───────────┼────────┼────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+│ Req/Sec   │ 9831   │ 9831   │ 18111   │ 19023   │ 17069.1 │ 2470.46 │ 9827    │
+├───────────┼────────┼────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+│ Bytes/Sec │ 4.3 MB │ 4.3 MB │ 7.91 MB │ 8.31 MB │ 7.46 MB │ 1.08 MB │ 4.29 MB │
+└───────────┴────────┴────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
 
 Req/Bytes counts sampled once per second.
 
-150k requests in 11.04s, 65.6 MB read
+188k requests in 11.03s, 82 MB read
 ```
 
 ### Normal GraphQL Server Mode | With Validation
 
-Last run: `2021-09-18`
+Last run: `2021-09-27`
 
 ```text
 Running 10s test @ http://localhost:3000/graphql
 100 connections
 
-┌─────────┬──────┬──────┬───────┬───────┬────────┬─────────┬───────┐
-│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg    │ Stdev   │ Max   │
-├─────────┼──────┼──────┼───────┼───────┼────────┼─────────┼───────┤
-│ Latency │ 6 ms │ 6 ms │ 13 ms │ 19 ms │ 6.8 ms │ 2.86 ms │ 84 ms │
-└─────────┴──────┴──────┴───────┴───────┴────────┴─────────┴───────┘
+┌─────────┬──────┬──────┬───────┬───────┬─────────┬─────────┬───────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg     │ Stdev   │ Max   │
+├─────────┼──────┼──────┼───────┼───────┼─────────┼─────────┼───────┤
+│ Latency │ 4 ms │ 5 ms │ 8 ms  │ 15 ms │ 5.48 ms │ 2.07 ms │ 55 ms │
+└─────────┴──────┴──────┴───────┴───────┴─────────┴─────────┴───────┘
 ┌───────────┬─────────┬─────────┬─────────┬─────────┬──────────┬─────────┬─────────┐
 │ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg      │ Stdev   │ Min     │
 ├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
-│ Req/Sec   │ 7531    │ 7531    │ 14783   │ 15071   │ 13784.19 │ 2108.74 │ 7531    │
+│ Req/Sec   │ 9399    │ 9399    │ 17215   │ 18943   │ 16704.73 │ 2427.11 │ 9398    │
 ├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
-│ Bytes/Sec │ 3.29 MB │ 3.29 MB │ 6.46 MB │ 6.59 MB │ 6.02 MB  │ 921 kB  │ 3.29 MB │
+│ Bytes/Sec │ 4.11 MB │ 4.11 MB │ 7.52 MB │ 8.27 MB │ 7.3 MB   │ 1.06 MB │ 4.11 MB │
 └───────────┴─────────┴─────────┴─────────┴─────────┴──────────┴─────────┴─────────┘
 
 Req/Bytes counts sampled once per second.
 
-152k requests in 11.04s, 66.3 MB read
+184k requests in 11.03s, 80.3 MB read
 ```
 
 ### Gateway GraphQL Server Mode | Without Validation
 
-Last run: `2021-09-18`
+Last run: `2021-09-27`
 
 ```text
+Running 10s test @ http://localhost:3000/graphql
+100 connections
+
+┌─────────┬───────┬───────┬───────┬────────┬──────────┬──────────┬────────┐
+│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%    │ Avg      │ Stdev    │ Max    │
+├─────────┼───────┼───────┼───────┼────────┼──────────┼──────────┼────────┤
+│ Latency │ 32 ms │ 38 ms │ 71 ms │ 100 ms │ 40.55 ms │ 13.79 ms │ 237 ms │
+└─────────┴───────┴───────┴───────┴────────┴──────────┴──────────┴────────┘
+┌───────────┬────────┬────────┬────────┬────────┬─────────┬────────┬────────┐
+│ Stat      │ 1%     │ 2.5%   │ 50%    │ 97.5%  │ Avg     │ Stdev  │ Min    │
+├───────────┼────────┼────────┼────────┼────────┼─────────┼────────┼────────┤
+│ Req/Sec   │ 1079   │ 1079   │ 2577   │ 2853   │ 2434.28 │ 493.75 │ 1079   │
+├───────────┼────────┼────────┼────────┼────────┼─────────┼────────┼────────┤
+│ Bytes/Sec │ 378 kB │ 378 kB │ 902 kB │ 998 kB │ 852 kB  │ 173 kB │ 378 kB │
+└───────────┴────────┴────────┴────────┴────────┴─────────┴────────┴────────┘
 
+Req/Bytes counts sampled once per second.
+
+27k requests in 11.03s, 9.37 MB read
 ```
 
 ### Gateway GraphQL Server Mode | With Validation
 
-Last run: `2021-09-18`
+Last run: `2021-09-27`
 
 ```text
+Running 10s test @ http://localhost:3000/graphql
+100 connections
+
+┌─────────┬───────┬───────┬───────┬────────┬──────────┬──────────┬────────┐
+│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%    │ Avg      │ Stdev    │ Max    │
+├─────────┼───────┼───────┼───────┼────────┼──────────┼──────────┼────────┤
+│ Latency │ 32 ms │ 35 ms │ 70 ms │ 103 ms │ 37.97 ms │ 13.33 ms │ 216 ms │
+└─────────┴───────┴───────┴───────┴────────┴──────────┴──────────┴────────┘
+┌───────────┬────────┬────────┬────────┬─────────┬────────┬────────┬────────┐
+│ Stat      │ 1%     │ 2.5%   │ 50%    │ 97.5%   │ Avg    │ Stdev  │ Min    │
+├───────────┼────────┼────────┼────────┼─────────┼────────┼────────┼────────┤
+│ Req/Sec   │ 1153   │ 1153   │ 2711   │ 2969    │ 2597.4 │ 521.83 │ 1153   │
+├───────────┼────────┼────────┼────────┼─────────┼────────┼────────┼────────┤
+│ Bytes/Sec │ 404 kB │ 404 kB │ 949 kB │ 1.04 MB │ 909 kB │ 183 kB │ 404 kB │
+└───────────┴────────┴────────┴────────┴─────────┴────────┴────────┴────────┘
+
+Req/Bytes counts sampled once per second.
 
+26k requests in 10.03s, 9.09 MB read
 ```
 
 ## Examples

bench.sh

@@ -17,15 +17,17 @@ npx concurrently --raw -k \
 echo '====================================='
 echo '= Gateway Mode | Without Validation ='
 echo '====================================='
-npx concurrently --raw -k \                                                                              [12:23:58]
+npx concurrently --raw -k \
   "node ./bench/gateway-user-service.js" \
   "node ./bench/gateway-post-service.js" \
-  "npx wait-on tcp:3001 tcp:3002 && node ./bench/gateway-without-validation.js"
+  "npx wait-on tcp:3001 tcp:3002 && node ./bench/gateway-without-validation.js" \
+  "npx wait-on tcp:3000 && node ./bench/gateway-bench.js"
 
 echo '=================================='
 echo '= Gateway Mode | With Validation ='
 echo '=================================='
-npx concurrently --raw -k \                                                                              [12:23:58]
+npx concurrently --raw -k \
   "node ./bench/gateway-user-service.js" \
   "node ./bench/gateway-post-service.js" \
-  "npx wait-on tcp:3001 tcp:3002 && node ./bench/gateway-with-validation.js"
+  "npx wait-on tcp:3001 tcp:3002 && node ./bench/gateway-with-validation.js" \
+  "npx wait-on tcp:3000 && node ./bench/gateway-bench.js"

docs/api/options.md

@@ -10,8 +10,9 @@
 
 Extends: [`AJVOptions`](https://ajv.js.org/options.html)
 
-* **mode** `"JSONSchema" | "JTD"` (optional, default: `JSONSchema`) - the validation mode of the plugin. This is used to specify the type of schema that needs to be compiled.
+* **mode** `"JSONSchema" | "JTD"` (optional, default: `"JSONSchema"`) - the validation mode of the plugin. This is used to specify the type of schema that needs to be compiled.
 * **schema** `MercuriusValidationSchema` (optional) - the validation schema definition that the plugin with run. One can define JSON Schema or JTD definitions for GraphQL types, fields and arguments or functions for GraphQL arguments.
+* **directiveValidation** `boolean` (optional, default: `true`) - turn directive validation on or off. It is on by default.
 
 It extends the [AJV options](https://ajv.js.org/options.html). These can be used to register additional `formats` for example and provide further customization to the AJV validation behavior.
 

index.d.ts

@@ -71,13 +71,17 @@ export type MercuriusValidationMode = 'JSONSchema' | 'JTD'
  */
 export interface MercuriusValidationOptions<TParent = any, TArgs = any, TContext = MercuriusContext> extends Options {
   /**
-   * The mode of operation to use when interpreting Mercurius validation schemas.
+   * The mode of operation to use when interpreting Mercurius validation schemas (default: `"JSONSchema"`).
    */
   mode?: MercuriusValidationMode;
   /**
    * The validation schema definition for the Mercurius GraphQL server.
    */
   schema?: MercuriusValidationSchema<TParent, TArgs, TContext>;
+  /**
+   * Turn directive validation on or off (default: `true`).
+   */
+  directiveValidation?: boolean;
 }
 
 export default MercuriusValidation

lib/utils.js

@@ -7,6 +7,14 @@ const { MER_VALIDATION_ERR_INVALID_OPTS } = require('./errors')
  * Perform basic validation on the validation options.
  */
 function validateOpts (opts) {
+  if (typeof opts.mode !== 'undefined' && typeof opts.mode !== 'string') {
+    throw new MER_VALIDATION_ERR_INVALID_OPTS('opts.mode must be a string.')
+  }
+
+  if (typeof opts.directiveValidation !== 'undefined' && typeof opts.directiveValidation !== 'boolean') {
+    throw new MER_VALIDATION_ERR_INVALID_OPTS('opts.directiveValidation must be a boolean.')
+  }
+
   if (typeof opts.schema !== 'undefined') {
     if (typeof opts.schema !== 'object' || opts.schema === null) {
       throw new MER_VALIDATION_ERR_INVALID_OPTS('opts.schema must be an object.')

lib/validation.js

@@ -4,10 +4,15 @@ const { FunctionValidator, JSONSchemaValidator, JTDValidator, DirectiveValidator
 const { kValidationSchema, kDirectiveValidator, kSchemaValidator, kFunctionValidator } = require('./symbols')
 
 class Validation {
-  constructor (app, { schema, mode, ...opts }) {
+  constructor (app, { schema, mode = 'JSONSchema', directiveValidation = true, ...opts }) {
     this[kValidationSchema] = schema || {}
 
-    this[kDirectiveValidator] = new DirectiveValidator(opts)
+    // By default, we turn on directive validation
+    if (directiveValidation) {
+      this[kDirectiveValidator] = new DirectiveValidator(opts)
+    } else {
+      this[kDirectiveValidator] = null
+    }
 
     if (mode === 'JTD') {
       this[kSchemaValidator] = new JTDValidator(opts)
@@ -23,7 +28,9 @@ class Validation {
   //  - Validation on field responses
   registerValidationSchema (graphQLSchema) {
     // We register policies in the reverse order of intended operation
-    this[kDirectiveValidator].registerValidationSchema(graphQLSchema)
+    if (this[kDirectiveValidator] !== null) {
+      this[kDirectiveValidator].registerValidationSchema(graphQLSchema)
+    }
     this[kFunctionValidator].registerValidationSchema(graphQLSchema, this[kValidationSchema])
     this[kSchemaValidator].registerValidationSchema(graphQLSchema, this[kValidationSchema])
   }

test/directive-validation.js

@@ -73,7 +73,7 @@ const resolvers = {
 }
 
 t.test('With directives', t => {
-  t.plan(26)
+  t.plan(27)
 
   t.test('should protect the schema and not affect operations when everything is okay', async (t) => {
     t.plan(1)
@@ -2677,4 +2677,54 @@ t.test('With directives', t => {
       ]
     })
   })
+
+  t.test('should be able to turn off directive validation', async (t) => {
+    t.plan(1)
+
+    const app = Fastify()
+    t.teardown(app.close.bind(app))
+
+    app.register(mercurius, {
+      schema,
+      resolvers
+    })
+    app.register(mercuriusValidation, { directiveValidation: false })
+
+    const query = `query {
+      messages(filters: { text: ""}) {
+        id
+        text
+      }
+    }`
+
+    const response = await app.inject({
+      method: 'POST',
+      headers: { 'content-type': 'application/json' },
+      url: '/graphql',
+      body: JSON.stringify({ query })
+    })
+
+    t.same(JSON.parse(response.body), {
+      data: {
+        messages: [
+          {
+            id: '0',
+            text: 'Some system message.'
+          },
+          {
+            id: '1',
+            text: 'Hello there'
+          },
+          {
+            id: '2',
+            text: 'Give me a place to stand, a lever long enough and a fulcrum. And I can move the Earth.'
+          },
+          {
+            id: '3',
+            text: ''
+          }
+        ]
+      }
+    })
+  })
 })

test/registration.js

@@ -27,7 +27,7 @@ const resolvers = {
 }
 
 t.test('registrations', t => {
-  t.plan(5)
+  t.plan(7)
 
   t.test('registration - should error if mercurius is not loaded', async (t) => {
     t.plan(1)
@@ -61,6 +61,40 @@ t.test('registrations', t => {
     )
   })
 
+  t.test('registration - should error if mode is defined but not a string', async (t) => {
+    t.plan(1)
+
+    const app = Fastify()
+    t.teardown(app.close.bind(app))
+
+    app.register(mercurius, {
+      schema,
+      resolvers
+    })
+
+    t.rejects(
+      app.register(mercuriusValidation, { mode: 123456 }),
+      new MER_VALIDATION_ERR_INVALID_OPTS('opts.mode must be a string.')
+    )
+  })
+
+  t.test('registration - should error if directiveValidation is defined but not a boolean', async (t) => {
+    t.plan(1)
+
+    const app = Fastify()
+    t.teardown(app.close.bind(app))
+
+    app.register(mercurius, {
+      schema,
+      resolvers
+    })
+
+    t.rejects(
+      app.register(mercuriusValidation, { directiveValidation: 'string' }),
+      new MER_VALIDATION_ERR_INVALID_OPTS('opts.directiveValidation must be a boolean.')
+    )
+  })
+
   t.test('registration - should error if schema type is not an object', async (t) => {
     t.plan(1)
 

test/types/index.test-d.ts

@@ -23,6 +23,10 @@ app.register(mercuriusValidation, {
 app.register(mercuriusValidation, { mode: 'JTD' })
 app.register(mercuriusValidation, { mode: 'JSONSchema' })
 
+// Turn directive validation on/off
+app.register(mercuriusValidation, { directiveValidation: true })
+app.register(mercuriusValidation, { directiveValidation: false })
+
 // Register JSON Schema definitions
 app.register(mercuriusValidation, {
   mode: 'JSONSchema',