fix: edge case where references was incorrect handled for JSON Schema (…

…#1754)
asyncapi · Jan 29, 2024 · 34b6dc2 · 34b6dc2
1 parent 75db7c8
commit 34b6dc2
Show file tree

Hide file tree

Showing 4 changed files with 120 additions and 20 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -35,7 +35,7 @@
     "./LICENSE"
   ],
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^9.0.9",
+    "@apidevtools/json-schema-ref-parser": "^11.1.0",
     "@apidevtools/swagger-parser": "^10.0.3",
     "@asyncapi/parser": "3.0.0-next-major-spec.8",
     "@smoya/multi-parser": "^4.0.0",

diff --git a/src/processors/JsonSchemaInputProcessor.ts b/src/processors/JsonSchemaInputProcessor.ts
@@ -1,5 +1,5 @@
 import { AbstractInputProcessor } from './AbstractInputProcessor';
-import $RefParser from '@apidevtools/json-schema-ref-parser';
+import { dereference } from '@apidevtools/json-schema-ref-parser';
 import path from 'path';
 import {
   CommonModel,
@@ -15,6 +15,7 @@ import {
 import { Logger } from '../utils';
 import { Interpreter } from '../interpreter/Interpreter';
 import { convertToMetaModel } from '../helpers';
+import { ParserOptions } from '@apidevtools/json-schema-ref-parser/dist/lib/options';
 
 /**
  * Class for processing JSON Schema
@@ -84,7 +85,7 @@ export class JsonSchemaInputProcessor extends AbstractInputProcessor {
       {},
       'root',
       true
-    ) as any;
+    );
     input = await this.dereferenceInputs(input);
     const parsedSchema = Draft7Schema.toSchema(input);
     const newCommonModel = JsonSchemaInputProcessor.convertSchemaToCommonModel(
@@ -114,7 +115,7 @@ export class JsonSchemaInputProcessor extends AbstractInputProcessor {
       {},
       'root',
       true
-    ) as any;
+    );
     input = await this.dereferenceInputs(input);
     const parsedSchema = Draft4Schema.toSchema(input);
     const newCommonModel = JsonSchemaInputProcessor.convertSchemaToCommonModel(
@@ -144,7 +145,7 @@ export class JsonSchemaInputProcessor extends AbstractInputProcessor {
       {},
       'root',
       true
-    ) as any;
+    );
     input = await this.dereferenceInputs(input);
     const parsedSchema = Draft6Schema.toSchema(input);
     const newCommonModel = JsonSchemaInputProcessor.convertSchemaToCommonModel(
@@ -197,20 +198,27 @@ export class JsonSchemaInputProcessor extends AbstractInputProcessor {
   public async dereferenceInputs(input: any): Promise<any> {
     input = this.handleRootReference(input);
     Logger.debug('Dereferencing all $ref instances');
-    const refParser = new $RefParser();
     // eslint-disable-next-line no-undef
     const localPath = `${process.cwd()}${path.sep}`;
-    const deRefOption: $RefParser.Options = {
+    const deRefOption: ParserOptions = {
       continueOnError: true,
-      dereference: { circular: true }
+      dereference: {
+        circular: true,
+        excludedPathMatcher: (path: string) => {
+          return (
+            path.includes('/examples/') &&
+            !path.includes('/properties/examples/')
+          );
+        }
+      }
     };
     Logger.debug(
       `Trying to dereference all $ref instances from input, using option ${JSON.stringify(
         deRefOption
       )}.`
     );
     try {
-      await refParser.dereference(localPath, input, deRefOption);
+      await dereference(localPath, input, deRefOption);
     } catch (e: any) {
       const errorMessage = `Could not dereference $ref in input, is all the references correct? ${e.message}`;
       Logger.error(errorMessage, e);
@@ -252,7 +260,7 @@ export class JsonSchemaInputProcessor extends AbstractInputProcessor {
       return schema;
     }
 
-    schema = Object.assign({}, schema);
+    schema = { ...schema };
     if (isRoot) {
       namesStack[String(name)] = 0;
       (schema as any)[this.MODELGEN_INFFERED_NAME] = name;

diff --git a/test/processors/JsonSchemaInputProcessor.spec.ts b/test/processors/JsonSchemaInputProcessor.spec.ts
@@ -5,7 +5,7 @@ import { AnyModel, CommonModel } from '../../src/models';
 jest.mock('../../src/utils/LoggingInterface');
 jest.spyOn(JsonSchemaInputProcessor, 'convertSchemaToCommonModel');
 let mockedReturnModels = [new CommonModel()];
-const mockedMetaModel = new AnyModel('test', undefined);
+const mockedMetaModel = new AnyModel('test', undefined, {});
 jest.mock('../../src/helpers/CommonModelToMetaModel', () => {
   return {
     convertToMetaModel: jest.fn().mockImplementation(() => {
@@ -261,6 +261,38 @@ describe('JsonSchemaInputProcessor', () => {
         'Cannot handle input, because it has a root `$ref`, please manually resolve the first reference.'
       );
     });
+    test('should not resolve example containing $ref keyword', async () => {
+      const processor = new JsonSchemaInputProcessor();
+      const schema = {
+        examples: [{ $ref: '#/none/existing/reference' }],
+        properties: {
+          $ref: {
+            type: 'string'
+          }
+        }
+      };
+      const dereferencedSchema = await processor.dereferenceInputs(schema);
+      expect(dereferencedSchema.examples[0]).toEqual({
+        $ref: '#/none/existing/reference'
+      });
+    });
+    test('should resolve example containing $ref keyword if part of properties', async () => {
+      const processor = new JsonSchemaInputProcessor();
+      const schema = {
+        definitions: {
+          reference: {
+            type: 'string'
+          }
+        },
+        properties: {
+          $ref: { $ref: '#/definitions/reference' }
+        }
+      };
+      const dereferencedSchema = await processor.dereferenceInputs(schema);
+      expect(dereferencedSchema.properties.$ref).toEqual({
+        type: 'string'
+      });
+    });
   });
 
   describe('convertSchemaToCommonModel()', () => {