fix(reference): add support for external cycles detection in OpenAPI …

…2.0 dereference strategy (#3871) Refs #3863
swagger-api · Feb 28, 2024 · 5a2141d · 5a2141d
1 parent 0735471
commit 5a2141d
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 4 deletions.
diff --git a/packages/apidom-reference/src/dereference/strategies/openapi-2/visitor.ts b/packages/apidom-reference/src/dereference/strategies/openapi-2/visitor.ts
@@ -57,13 +57,22 @@ const OpenApi2DereferenceVisitor = stampit({
     reference: null,
     options: null,
     ancestors: null,
+    refractCache: null,
   },
-  init({ indirections = [], reference, namespace, options, ancestors = new AncestorLineage() }) {
+  init({
+    indirections = [],
+    reference,
+    namespace,
+    options,
+    ancestors = new AncestorLineage(),
+    refractCache = new Map(),
+  }) {
     this.indirections = indirections;
     this.namespace = namespace;
     this.reference = reference;
     this.options = options;
     this.ancestors = new AncestorLineage(...ancestors);
+    this.refractCache = refractCache;
   },
   methods: {
     toBaseURI(uri: string): string {
@@ -149,15 +158,20 @@ const OpenApi2DereferenceVisitor = stampit({
       // applying semantics to a fragment
       if (isPrimitiveElement(referencedElement)) {
         const referencedElementType = toValue(referencingElement.meta.get('referenced-element'));
+        const cacheKey = `${referencedElementType}-${toValue(identityManager.identify(referencedElement))}`;
 
-        if (isReferenceLikeElement(referencedElement)) {
+        if (this.refractCache.has(cacheKey)) {
+          referencedElement = this.refractCache.get(cacheKey);
+        } else if (isReferenceLikeElement(referencedElement)) {
           // handling indirect references
           referencedElement = ReferenceElement.refract(referencedElement);
           referencedElement.setMetaProperty('referenced-element', referencedElementType);
+          this.refractCache.set(cacheKey, referencedElement);
         } else {
           // handling direct references
           const ElementClass = this.namespace.getElementClass(referencedElementType);
           referencedElement = ElementClass.refract(referencedElement);
+          this.refractCache.set(cacheKey, referencedElement);
         }
       }
 
@@ -183,6 +197,7 @@ const OpenApi2DereferenceVisitor = stampit({
         indirections: [...this.indirections],
         options: this.options,
         ancestors: ancestorsLineage,
+        refractCache: this.refractCache,
       });
       referencedElement = await visitAsync(referencedElement, visitor, {
         keyMap,
@@ -272,7 +287,14 @@ const OpenApi2DereferenceVisitor = stampit({
 
       // applying semantics to a referenced element
       if (isPrimitiveElement(referencedElement)) {
-        referencedElement = PathItemElement.refract(referencedElement);
+        const cacheKey = `pathItem-${toValue(identityManager.identify(referencedElement))}`;
+
+        if (this.refractCache.has(cacheKey)) {
+          referencedElement = this.refractCache.get(cacheKey);
+        } else {
+          referencedElement = PathItemElement.refract(referencedElement);
+          this.refractCache.set(cacheKey, referencedElement);
+        }
       }
 
       // detect direct or indirect reference
@@ -297,6 +319,7 @@ const OpenApi2DereferenceVisitor = stampit({
         indirections: [...this.indirections],
         options: this.options,
         ancestors: ancestorsLineage,
+        refractCache: this.refractCache,
       });
       referencedElement = await visitAsync(referencedElement, visitor, {
         keyMap,
@@ -394,15 +417,20 @@ const OpenApi2DereferenceVisitor = stampit({
       // applying semantics to a fragment
       if (isPrimitiveElement(referencedElement)) {
         const referencedElementType = toValue(referencingElement.meta.get('referenced-element'));
+        const cacheKey = `pathItem-${toValue(identityManager.identify(referencedElement))}`;
 
-        if (isJSONReferenceLikeElement(referencedElement)) {
+        if (this.refractCache.has(cacheKey)) {
+          referencedElement = this.refractCache.get(cacheKey);
+        } else if (isJSONReferenceLikeElement(referencedElement)) {
           // handling indirect references
           referencedElement = ReferenceElement.refract(referencedElement);
           referencedElement.setMetaProperty('referenced-element', referencedElementType);
+          this.refractCache.set(cacheKey, referencedElement);
         } else {
           // handling direct references
           const ElementClass = this.namespace.getElementClass(referencedElementType);
           referencedElement = ElementClass.refract(referencedElement);
+          this.refractCache.set(cacheKey, referencedElement);
         }
       }
 
@@ -428,6 +456,7 @@ const OpenApi2DereferenceVisitor = stampit({
         indirections: [...this.indirections],
         options: this.options,
         ancestors: ancestorsLineage,
+        refractCache: this.refractCache,
       });
       referencedElement = await visitAsync(referencedElement, visitor, {
         keyMap,

diff --git a/...st/dereference/strategies/openapi-2/json-reference-object/fixtures/external-cycle/ex.json b/...st/dereference/strategies/openapi-2/json-reference-object/fixtures/external-cycle/ex.json
@@ -0,0 +1,13 @@
+{
+  "definitions": {
+    "externalSchema": {
+      "type": "object",
+      "description": "external schema",
+      "properties": {
+        "parent": {
+          "$ref": "#/definitions/externalSchema"
+        }
+      }
+    }
+  }
+}
diff --git a/.../dereference/strategies/openapi-2/json-reference-object/fixtures/external-cycle/root.json b/.../dereference/strategies/openapi-2/json-reference-object/fixtures/external-cycle/root.json
@@ -0,0 +1,8 @@
+{
+  "swagger": "2.0",
+  "definitions": {
+    "schema": {
+      "$ref": "./ex.json#/definitions/externalSchema"
+    }
+  }
+}
diff --git a/...ges/apidom-reference/test/dereference/strategies/openapi-2/json-reference-object/index.ts b/...ges/apidom-reference/test/dereference/strategies/openapi-2/json-reference-object/index.ts
@@ -84,6 +84,24 @@ describe('dereference', function () {
           });
         });
 
+        context('given JSONReference Objects pointing to external cycles', function () {
+          const fixturePath = path.join(rootFixturePath, 'external-cycle');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const dereferenced = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const parent = evaluate('/0/definitions/schema/properties', dereferenced);
+            const cyclicParent = evaluate(
+              '/0/definitions/schema/properties/parent/properties',
+              dereferenced,
+            );
+
+            assert.strictEqual(parent, cyclicParent);
+          });
+        });
+
         context('given JSONReference Objects pointing to external indirections', function () {
           const fixturePath = path.join(rootFixturePath, 'external-indirections');