Ajv8 upgrade (#353)

* upgrade codebase to ajv8

* fix ajv warnings

* update docs

* fix format within debugMode

* update docs spec

* fix regression

Author: Eomm

README.md

@@ -7,7 +7,14 @@
 [![NPM downloads](https://img.shields.io/npm/dm/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)
 
 
-__fast-json-stringify__ is significantly faster than `JSON.stringify()` for small payloads. Its performance advantage shrinks as your payload grows. It pairs well with [__flatstr__](https://www.npmjs.com/package/flatstr), which triggers a V8 optimization that improves performance when eventually converting the string to a `Buffer`.
+__fast-json-stringify__ is significantly faster than `JSON.stringify()` for small payloads.  
+Its performance advantage shrinks as your payload grows.  
+It pairs well with [__flatstr__](https://www.npmjs.com/package/flatstr), which triggers a V8 optimization that improves performance when eventually converting the string to a `Buffer`.
+
+
+### How it works
+
+fast-json-stringify requires a [JSON Schema Draft 7](https://json-schema.org/specification-links.html#draft-7) input to generate a fast `stringify` function.
 
 ##### Benchmarks
 
@@ -99,7 +106,7 @@ const stringify = fastJson(mySchema, {
 ```
 
 - `schema`: external schemas references by $ref property. [More details](#ref)
-- `ajv`: ajv instance's settings for those properties that require `ajv`. [More details](#anyof)
+- `ajv`: [ajv v8 instance's settings](https://ajv.js.org/options.html) for those properties that require `ajv`. [More details](#anyof)
 - `rounding`: setup how the `integer` types will be rounded when not integers. [More details](#integer)
 
 
@@ -108,7 +115,7 @@ const stringify = fastJson(mySchema, {
 <a name="fastJsonStringify"></a>
 ### fastJsonStringify(schema)
 
-Build a `stringify()` function based on [jsonschema](https://json-schema.org/).
+Build a `stringify()` function based on [jsonschema draft 7 spec](https://json-schema.org/specification-links.html#draft-7).
 
 Supported types:
 

build-schema-validator.js

@@ -1,16 +1,26 @@
 'use strict'
 
-const Ajv = require('ajv').default
-const schema = require('ajv/dist/refs/json-schema-draft-07.json')
-const standalone = require('ajv/dist/standalone').default
+const Ajv = require('ajv')
+const standaloneCode = require('ajv/dist/standalone').default
+const ajvFormats = require('ajv-formats')
+const fs = require('fs')
+const path = require('path')
 
-const { basename, join } = require('path')
-const { writeFileSync } = require('fs')
+const ajv = new Ajv({
+  addUsedSchema: false,
+  allowUnionTypes: true,
+  code: {
+    source: true,
+    lines: true,
+    optimize: 3
+  }
+})
+ajvFormats(ajv)
 
-// *************************
+const schema = require('ajv/lib/refs/json-schema-draft-07.json')
+const validate = ajv.compile(schema)
+const validationCode = standaloneCode(ajv, validate)
 
-const ajv = new Ajv({ code: { source: true } })
-const validator = ajv.compile(schema)
-const moduleCode = `/* CODE GENERATED BY '${basename(__filename)}' DO NOT EDIT! */\n${standalone(ajv, validator)}`
+const moduleCode = `/* CODE GENERATED BY '${path.basename(__filename)}' DO NOT EDIT! */\n${validationCode}`
 
-writeFileSync(join(__dirname, 'schema-validator.js'), moduleCode)
+fs.writeFileSync(path.join(__dirname, 'schema-validator.js'), moduleCode)

index.js

@@ -2,7 +2,7 @@
 
 /* eslint no-prototype-builtins: 0 */
 
-const Ajv = require('ajv').default
+const Ajv = require('ajv')
 const ajvFormats = require('ajv-formats')
 const merge = require('deepmerge')
 const clone = require('rfdc')({ proto: true })
@@ -27,7 +27,7 @@ function isValidSchema (schema, name) {
       name = ''
     }
     const first = validate.errors[0]
-    const err = new Error(`${name}schema is invalid: data${first.dataPath} ${first.message}`)
+    const err = new Error(`${name}schema is invalid: data${first.instancePath} ${first.message}`)
     err.errors = isValidSchema.errors
     throw err
   }

package.json

@@ -43,8 +43,8 @@
     "webpack": "^5.40.0"
   },
   "dependencies": {
-    "ajv": "^7.2.3",
-    "ajv-formats": "^1.6.1",
+    "ajv": "^8.6.2",
+    "ajv-formats": "^2.1.1",
     "deepmerge": "^4.2.2",
     "rfdc": "^1.2.0",
     "string-similarity": "^4.0.1"

schema-validator.js

@@ -108,7 +108,7 @@ test('object with allOf and no schema on the allOf', (t) => {
     build(schema)
     t.fail()
   } catch (e) {
-    t.equal(e.message, 'schema is invalid: data/allOf should NOT have fewer than 1 items')
+    t.equal(e.message, 'schema is invalid: data/allOf must NOT have fewer than 1 items')
   }
 })
 

test/allof.test.js

@@ -63,3 +63,29 @@ test('to string auto-consistent with ajv', t => {
   const tobe = JSON.stringify({ str: 'Foo' })
   t.same(compiled({ str: 'Foo', void: 'me' }), tobe)
 })
+
+test('to string auto-consistent with ajv-formats', t => {
+  t.plan(3)
+  const debugMode = fjs({
+    title: 'object with multiple types field and format keyword',
+    type: 'object',
+    properties: {
+      str: {
+        anyOf: [{
+          type: 'string',
+          format: 'email'
+        }, {
+          type: 'boolean'
+        }]
+      }
+    }
+  }, { debugMode: 1 })
+  t.type(debugMode, Array)
+
+  const str = debugMode.toString()
+
+  const compiled = fjs.restore(str)
+  const tobe = JSON.stringify({ str: '[email protected]' })
+  t.same(compiled({ str: '[email protected]' }), tobe)
+  t.same(compiled({ str: 'foo' }), JSON.stringify({ str: null }), 'invalid format is ignored')
+})

test/debug-mode.test.js

@@ -8,11 +8,13 @@ const schema = {
   properties: {
   },
   if: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar'] }
     }
   },
   then: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar'] },
       foo: { type: 'string' },
@@ -30,6 +32,7 @@ const schema = {
     }
   },
   else: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['greeting'] },
       hi: { type: 'string' },
@@ -52,17 +55,20 @@ const nestedIfSchema = {
   type: 'object',
   properties: { },
   if: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar', 'greeting'] }
     }
   },
   then: {
     if: {
+      type: 'object',
       properties: {
         kind: { type: 'string', enum: ['foobar'] }
       }
     },
     then: {
+      type: 'object',
       properties: {
         kind: { type: 'string', enum: ['foobar'] },
         foo: { type: 'string' },
@@ -80,6 +86,7 @@ const nestedIfSchema = {
       }
     },
     else: {
+      type: 'object',
       properties: {
         kind: { type: 'string', enum: ['greeting'] },
         hi: { type: 'string' },
@@ -88,6 +95,7 @@ const nestedIfSchema = {
     }
   },
   else: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['alphabet'] },
       a: { type: 'string' },
@@ -100,11 +108,13 @@ const nestedElseSchema = {
   type: 'object',
   properties: { },
   if: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar'] }
     }
   },
   then: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar'] },
       foo: { type: 'string' },
@@ -123,18 +133,21 @@ const nestedElseSchema = {
   },
   else: {
     if: {
+      type: 'object',
       properties: {
         kind: { type: 'string', enum: ['greeting'] }
       }
     },
     then: {
+      type: 'object',
       properties: {
         kind: { type: 'string', enum: ['greeting'] },
         hi: { type: 'string' },
         hello: { type: 'number' }
       }
     },
     else: {
+      type: 'object',
       properties: {
         kind: { type: 'string', enum: ['alphabet'] },
         a: { type: 'string' },
@@ -154,11 +167,13 @@ const noElseSchema = {
   properties: {
   },
   if: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar'] }
     }
   },
   then: {
+    type: 'object',
     properties: {
       kind: { type: 'string', enum: ['foobar'] },
       foo: { type: 'string' },

test/if-then-else.test.js

@@ -97,16 +97,21 @@ const testSet = {
     items: {}
   }, null, null],
   nullableObject: [{ type: 'object', nullable: true }, null, null],
-  complexObject: [complexObject, complexData, complexExpectedResult]
+  complexObject: [complexObject, complexData, complexExpectedResult, { ajv: { allowUnionTypes: true } }]
 }
 
 Object.keys(testSet).forEach(key => {
   test(`handle nullable:true in ${key} correctly`, (t) => {
     t.plan(1)
 
-    const stringifier = build(testSet[key][0])
-    const data = testSet[key][1]
-    const expected = testSet[key][2]
+    const [
+      schema,
+      data,
+      expected,
+      extraOptions
+    ] = testSet[key]
+
+    const stringifier = build(schema, extraOptions)
     const result = stringifier(data)
     t.same(JSON.parse(result), expected)
   })

test/nullable.test.js

@@ -155,3 +155,42 @@ test('must not mutate items $ref', t => {
   t.equal(value, '[{"name":"foo"}]')
   t.same(schema, clonedSchema)
 })
+
+test('must not mutate items referred by $ref', t => {
+  t.plan(2)
+
+  const firstSchema = {
+    $id: 'example1',
+    type: 'object',
+    properties: {
+      name: {
+        type: 'string'
+      }
+    }
+  }
+
+  const reusedSchema = {
+    $id: 'example2',
+    type: 'object',
+    properties: {
+      name: {
+        oneOf: [
+          {
+            $ref: 'example1'
+          }
+        ]
+      }
+    }
+  }
+
+  const clonedSchema = clone(firstSchema)
+  const stringify = build(reusedSchema, {
+    schema: {
+      [firstSchema.$id]: firstSchema
+    }
+  })
+
+  const value = stringify({ name: { name: 'foo' } })
+  t.equal(value, '{"name":{"name":"foo"}}')
+  t.same(firstSchema, clonedSchema)
+})