fast-json-stringify 2.7.10 → 2.7.11

package/.github/workflows/benchmark.yml

@@ -0,0 +1,111 @@
+name: Benchmark
+
+on:
+  pull_request_target:
+    types: [labeled]
+
+jobs:
+  benchmark:
+    if: ${{ github.event.label.name == 'benchmark' }}
+    runs-on: ubuntu-latest
+    outputs:
+      PR-BENCH-12: ${{ steps.benchmark-pr.outputs.BENCH_RESULT12 }}
+      PR-BENCH-14: ${{ steps.benchmark-pr.outputs.BENCH_RESULT14 }}
+      PR-BENCH-16: ${{ steps.benchmark-pr.outputs.BENCH_RESULT16 }}
+      MAIN-BENCH-12: ${{ steps.benchmark-main.outputs.BENCH_RESULT12 }}
+      MAIN-BENCH-14: ${{ steps.benchmark-main.outputs.BENCH_RESULT14 }}
+      MAIN-BENCH-16: ${{ steps.benchmark-main.outputs.BENCH_RESULT16 }}
+    strategy:
+      matrix:
+        node-version: [12, 14, 16]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{github.event.pull_request.head.ref}}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install
+        run: |
+          npm install --ignore-scripts
+
+      - name: Run benchmark
+        id: benchmark-pr
+        run: |
+          npm run --silent benchmark > ./bench-result
+          content=$(cat ./bench-result)
+          content="${content//'%'/'%25'}"
+          content="${content//$'\n'/'%0A'}"
+          content="${content//$'\r'/'%0D'}"
+          echo "::set-output name=BENCH_RESULT${{matrix.node-version}}::$content"
+
+      # main benchmark
+      - uses: actions/checkout@v2
+        with:
+          ref: 'master'
+
+      - name: Install
+        run: |
+          npm install --ignore-scripts
+
+      - name: Run benchmark
+        id: benchmark-master
+        run: |
+          npm run --silent benchmark > ./bench-result
+          content=$(cat ./bench-result)
+          content="${content//'%'/'%25'}"
+          content="${content//$'\n'/'%0A'}"
+          content="${content//$'\r'/'%0D'}"
+          echo "::set-output name=BENCH_RESULT${{matrix.node-version}}::$content"
+
+  output-benchmark:
+    needs: [benchmark]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment PR
+        uses: thollander/actions-comment-pull-request@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          message: |
+            **Node**: 12
+            **PR**:
+            ```
+            ${{ needs.benchmark.outputs.PR-BENCH-12 }}
+            ```
+            **MAIN**:
+            ```
+            ${{ needs.benchmark.outputs.MAIN-BENCH-12 }}
+            ```
+            
+            ---
+            
+            **Node**: 14
+            **PR**:
+            ```
+            ${{ needs.benchmark.outputs.PR-BENCH-14 }}
+            ```
+            **MAIN**:
+            ```
+            ${{ needs.benchmark.outputs.MAIN-BENCH-14 }}
+            ```
+            
+            ---
+            
+            **Node**: 16
+            **PR**:
+            ```
+            ${{ needs.benchmark.outputs.PR-BENCH-16 }}
+            ```
+            **MAIN**:
+            ```
+            ${{ needs.benchmark.outputs.MAIN-BENCH-16 }}
+            ```
+            
+      - uses: actions-ecosystem/action-remove-labels@v1
+        with:
+          labels: |
+            benchmark
+          github_token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/ci.yml

@@ -38,6 +38,6 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: fastify/github-action-merge-dependabot@v2.4.0
+      - uses: fastify/github-action-merge-dependabot@v2.5.0
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

package/index.js

@@ -47,7 +47,10 @@ function mergeLocation (source, dest) {
   }
 }
 
+const referenceSerializersMap = new Map()
+
 function build (schema, options) {
+  referenceSerializersMap.clear()
   options = options || {}
   isValidSchema(schema)
   if (options.schema) {
@@ -144,6 +147,8 @@ function build (schema, options) {
     return dependenciesName
   }
 
+  referenceSerializersMap.clear()
+
   return (Function.apply(null, dependenciesName).apply(null, dependencies))
 }
 
@@ -969,8 +974,18 @@ function buildArray (location, code, name, key = null) {
       schema = location.schema
       schema[fjsCloned] = true
     }
+
     location = refFinder(schema.items.$ref, location)
     schema.items = location.schema
+
+    if (referenceSerializersMap.has(schema.items)) {
+      code += `
+      return ${referenceSerializersMap.get(schema.items)}(obj)
+      }
+      `
+      return code
+    }
+    referenceSerializersMap.set(schema.items, name)
   }
 
   let result = { code: '', laterCode: '' }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-json-stringify",
-  "version": "2.7.10",
+  "version": "2.7.11",
   "description": "Stringify your JSON at max speed",
   "main": "index.js",
   "types": "index.d.ts",

package/test/recursion.test.js

@@ -0,0 +1,137 @@
+'use strict'
+
+const test = require('tap').test
+const build = require('..')
+
+test('can stringify recursive directory tree (issue #181)', (t) => {
+  t.plan(1)
+
+  const schema = {
+    definitions: {
+      directory: {
+        type: 'object',
+        properties: {
+          name: { type: 'string' },
+          subDirectories: {
+            type: 'array',
+            items: { $ref: '#/definitions/directory' },
+            default: []
+          }
+        }
+      }
+    },
+    type: 'array',
+    items: { $ref: '#/definitions/directory' }
+  }
+  const stringify = build(schema)
+
+  t.equal(stringify([
+    { name: 'directory 1', subDirectories: [] },
+    {
+      name: 'directory 2',
+      subDirectories: [
+        { name: 'directory 2.1', subDirectories: [] },
+        { name: 'directory 2.2', subDirectories: [] }
+      ]
+    }
+  ]), '[{"name":"directory 1","subDirectories":[]},{"name":"directory 2","subDirectories":[{"name":"directory 2.1","subDirectories":[]},{"name":"directory 2.2","subDirectories":[]}]}]')
+})
+
+test('can stringify when recursion in external schema', t => {
+  t.plan(1)
+
+  const referenceSchema = {
+    $id: 'person',
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      children: {
+        type: 'array',
+        items: { $ref: '#' }
+      }
+    }
+  }
+
+  const schema = {
+    $id: 'mainSchema',
+    type: 'object',
+    properties: {
+      people: {
+        $ref: 'person'
+      }
+    }
+  }
+  const stringify = build(schema, {
+    schema: {
+      [referenceSchema.$id]: referenceSchema
+    }
+  })
+
+  const value = stringify({ people: { name: 'Elizabeth', children: [{ name: 'Charles' }] } })
+  t.equal(value, '{"people":{"name":"Elizabeth","children":[{"name":"Charles"}]}}')
+})
+
+test('use proper serialize function', t => {
+  t.plan(1)
+
+  const personSchema = {
+    $id: 'person',
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      children: {
+        type: 'array',
+        items: { $ref: '#' }
+      }
+    }
+  }
+
+  const directorySchema = {
+    $id: 'directory',
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      subDirectories: {
+        type: 'array',
+        items: { $ref: '#' },
+        default: []
+      }
+    }
+  }
+
+  const schema = {
+    $id: 'mainSchema',
+    type: 'object',
+    properties: {
+      people: { $ref: 'person' },
+      directory: { $ref: 'directory' }
+    }
+  }
+  const stringify = build(schema, {
+    schema: {
+      [personSchema.$id]: personSchema,
+      [directorySchema.$id]: directorySchema
+    }
+  })
+
+  const value = stringify({
+    people: {
+      name: 'Elizabeth',
+      children: [{
+        name: 'Charles',
+        children: [{ name: 'William', children: [{ name: 'George' }, { name: 'Charlotte' }] }, { name: 'Harry' }]
+      }]
+    },
+    directory: {
+      name: 'directory 1',
+      subDirectories: [
+        { name: 'directory 1.1', subDirectories: [] },
+        {
+          name: 'directory 1.2',
+          subDirectories: [{ name: 'directory 1.2.1' }, { name: 'directory 1.2.2' }]
+        }
+      ]
+    }
+  })
+  t.equal(value, '{"people":{"name":"Elizabeth","children":[{"name":"Charles","children":[{"name":"William","children":[{"name":"George"},{"name":"Charlotte"}]},{"name":"Harry"}]}]},"directory":{"name":"directory 1","subDirectories":[{"name":"directory 1.1","subDirectories":[]},{"name":"directory 1.2","subDirectories":[{"name":"directory 1.2.1","subDirectories":[]},{"name":"directory 1.2.2","subDirectories":[]}]}]}}')
+})