Merge pull request #25 from criteria-labs/fix-maximum-call-stack-size-exceeded

Fix maximum call stack size exceeded

Author: jcmosc

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@criteria/openapi",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "TypeScript implementation of the OpenAPI specification.",
   "keywords": [
     "openapi",
@@ -35,8 +35,9 @@
     "clean": "rimraf tsconfig.build.tsbuildinfo ./dist"
   },
   "dependencies": {
-    "@criteria/json-schema": "^0.9.0",
-    "@criteria/json-pointer": "^0.1.1"
+    "@criteria/json-schema": "^0.9.1",
+    "@criteria/json-pointer": "^0.1.1",
+    "toad-uri-js": "^5.0.1"
   },
   "devDependencies": {
     "@types/jest": "^29.2.4",

packages/criteria-openapi/package.json

@@ -81,7 +81,16 @@ export class OpenAPIIndex extends DocumentIndex {
       this.references.set(reference, info)
     })
 
-    return chainForEach(foundReferences.values(), (info: ReferenceInfo<Metadata>) => {
+    // Help prevent Maximum call stack size exceeded errors
+    const unindexedReferences = [...foundReferences.values()].filter((info) => {
+      if (this.isURIIndexed(info.resolvedURI)) {
+        return false
+      }
+      const { absoluteURI, fragment } = splitFragment(info.resolvedURI)
+      return !this.isURIIndexed(absoluteURI)
+    })
+
+    return chainForEach(unindexedReferences.values(), (info: ReferenceInfo<Metadata>) => {
       if (this.isURIIndexed(info.resolvedURI)) {
         return
       }

packages/criteria-openapi/src/openapi-index/OpenAPIIndex.ts

@@ -0,0 +1,28 @@
+/* eslint-env jest */
+import { resolve } from 'path'
+import { dereferenceOpenAPI } from '../../../src/v3.0'
+import retrieveFromFilesystem from '../../util/retrieveFromFilesystem'
+import openAPI from './openapi.json'
+
+describe('GitHub OpenAPI', () => {
+  describe('dereferenceOpenAPI()', () => {
+    describe('synchronous', () => {
+      test('does not result in Maximum call stack size exceeded', () => {
+        const output = dereferenceOpenAPI(openAPI as any, {
+          baseURI: resolve(__dirname, 'openapi.json'),
+          retrieve: retrieveFromFilesystem
+        }) as any
+        expect(output).toMatchObject({ openapi: '3.0.3' })
+      })
+    })
+    describe('asynchronous', () => {
+      test('does not result in Maximum call stack size exceeded', async () => {
+        const output = (await dereferenceOpenAPI(openAPI as any, {
+          baseURI: resolve(__dirname, 'openapi.json'),
+          retrieve: async (uri) => await retrieveFromFilesystem(uri)
+        })) as any
+        expect(output).toMatchObject({ openapi: '3.0.3' })
+      })
+    })
+  })
+})