fix(specmap): avoid traversal limit for non-complex huge definitions (#…

…3399) Refs swagger-api/swagger-ui#9645 Refs #3385
swagger-api · Mar 1, 2024 · 042af17 · 042af17
1 parent 9358552
commit 042af17
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 17 deletions.
diff --git a/src/specmap/index.js b/src/specmap/index.js
@@ -6,7 +6,7 @@ import properties from './lib/properties.js';
 import ContextTree from './lib/context-tree.js';
 
 const PLUGIN_DISPATCH_LIMIT = 100;
-const TRAVERSE_LIMIT = 1000;
+const TRAVERSE_LIMIT = 3000;
 const noop = () => {};
 
 class SpecMap {
@@ -40,7 +40,6 @@ class SpecMap {
           getInstance: () => this,
         }),
         allowMetaPatches: false,
-        currentTraverseCount: 0,
       },
       opts
     );
@@ -72,7 +71,6 @@ class SpecMap {
 
   wrapPlugin(plugin, name) {
     const { pathDiscriminator } = this;
-    const that = this;
     let ctx = null;
     let fn;
 
@@ -107,16 +105,15 @@ class SpecMap {
         const refCache = {};
 
         // eslint-disable-next-line no-restricted-syntax
-        for (const patch of patches.filter(lib.isAdditiveMutation)) {
-          if (that.currentTraverseCount < TRAVERSE_LIMIT) {
+        for (const [i, patch] of patches.filter(lib.isAdditiveMutation).entries()) {
+          if (i < TRAVERSE_LIMIT) {
             yield* traverse(patch.value, patch.path, patch);
           } else {
             return;
           }
         }
 
         function* traverse(obj, path, patch) {
-          that.currentTraverseCount += 1;
           if (!lib.isObject(obj)) {
             if (pluginObj.key === path[path.length - 1]) {
               yield pluginObj.plugin(obj, pluginObj.key, path, specmap);
@@ -142,11 +139,7 @@ class SpecMap {
                   if (specmap.allowMetaPatches && objRef) {
                     refCache[objRef] = true;
                   }
-                  if (that.currentTraverseCount < TRAVERSE_LIMIT) {
-                    yield* traverse(val, updatedPath, patch);
-                  } else {
-                    return;
-                  }
+                  yield* traverse(val, updatedPath, patch);
                 }
               }
 
@@ -325,8 +318,6 @@ class SpecMap {
     const that = this;
     const plugin = this.nextPlugin();
 
-    that.currentTraverseCount = 0;
-
     if (!plugin) {
       const nextPromise = this.nextPromisedPatch();
       if (nextPromise) {

diff --git a/test/specmap/complex.js b/test/specmap/complex.js
@@ -36,7 +36,7 @@ describe('complex', () => {
         const startTime = new Date();
         console.log('Run', spec.name); // eslint-disable-line no-console
 
-        return mapSpec({ spec: spec.spec, plugins: [refs, allOf] })
+        return mapSpec({ spec: spec.spec, plugins: [refs, allOf], allowMetaPatches: true })
           .then((res) => {
             if (res.errors.length) throw res.errors[0];
             expect(res.errors.length).toEqual(0);
@@ -64,15 +64,17 @@ describe('complex', () => {
     expect(
       result.spec.components.schemas[
         'com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments-create'
-      ].properties.scenario.allOf[0].$ref
+      ].properties.scenario.$ref
     ).toEqual(
       '#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create'
     );
 
     expect(
       result.spec.components.schemas[
         'com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups'
-      ].properties.study.properties.scenarios.items.$$ref
-    ).toEqual('#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios');
+      ].properties.study.properties.materials.items.$$ref
+    ).toEqual(
+      '#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials'
+    );
   });
 });