Added handling if remoteRefResolver threw err

prashantRaghu · prashantRaghu · commit 142defaee855 · 2023-08-17T16:21:10.000+05:30
diff --git a/lib/bundle.js b/lib/bundle.js
@@ -339,7 +339,7 @@ async function getReferences (currentNode, isOutOfRoot, pathSolver, parentFilena
             /**
              * Converts contents received from remoteRefResolver into stringified JSON
              * @param {string | object} content - contents from remoteRefResolver
-             * @returns Stringified JSON contents
+             * @returns {string} Stringified JSON contents
              */
             function convertToJSONString (content) {
               if (typeof content === 'object') {
@@ -351,17 +351,24 @@ async function getReferences (currentNode, isOutOfRoot, pathSolver, parentFilena
               return JSON.stringify(parsedFile.oasObject);
             }
 
-            let contentFromRemote = await remoteRefResolver(property.$ref),
-              nodeTemp = {
-                fileName: tempRef,
-                path: tempRef,
-                content: convertToJSONString(contentFromRemote)
-              };
+            try {
+              let contentFromRemote = await remoteRefResolver(property.$ref),
+                nodeTemp = {
+                  fileName: tempRef,
+                  path: tempRef,
+                  content: convertToJSONString(contentFromRemote)
+                };
 
-            remoteRefContentMap.set(tempRef, contentFromRemote);
+              remoteRefContentMap.set(tempRef, contentFromRemote);
 
-            allData.push(nodeTemp);
-            resolveInner();
+              allData.push(nodeTemp);
+            }
+            catch (err) {
+              // swallow the err
+            }
+            finally {
+              resolveInner();
+            }
           })
         );
 
@@ -447,84 +454,91 @@ async function getReferences (currentNode, isOutOfRoot, pathSolver, parentFilena
       }
 
       const hasRemoteReferenceTypeKey = Object.keys(property)
-        .find(
-          (key) => {
-            const isExternal = isExtURLRef(property, key),
-
-              // Only process URL refs if remoteRefResolver is provided and a valid function
-              isReferenciable = isExternal && _.isFunction(remoteRefResolver);
+          .find(
+            (key) => {
+              const isExternal = isExtURLRef(property, key),
 
-            return isReferenciable;
-          }
-        );
+                // Only process URL refs if remoteRefResolver is provided and a valid function
+                isReferenciable = isExternal && _.isFunction(remoteRefResolver);
 
-      if (hasRemoteReferenceTypeKey) {
-        const tempRef = calculatePath(parentFilename, property.$ref),
-          nodeTrace = handleLocalCollisions(
-            getTraceFromParentKeyInComponents(this, tempRef, mainKeys, version, commonPathFromData),
-            rootMainKeys
-          ),
-          componentKey = nodeTrace[nodeTrace.length - 1],
-          referenceInDocument = getJsonPointerRelationToRoot(
-            tempRef,
-            nodeTrace,
-            version
+              return isReferenciable;
+            }
           ),
-          traceToParent = [...this.parents.map((item) => {
-            return item.key;
-          }).filter((item) => {
-            return item !== undefined;
-          }), this.key];
+        handleRemoteURLReference = () => {
+          const tempRef = calculatePath(parentFilename, property.$ref);
 
-        let newValue = Object.assign({}, this.node),
-          [, local] = tempRef.split(localPointer),
-          nodeFromData,
-          refHasContent = false,
-          parseResult,
-          newRefInDoc,
-          inline,
-          contentFromRemote = remoteRefContentMap.get(tempRef),
-          nodeTemp = {
-            fileName: tempRef,
-            path: tempRef,
-            content: contentFromRemote
-          };
+          if (remoteRefContentMap.get(tempRef) === undefined) {
+            return;
+          }
 
-        nodeFromData = nodeTemp;
+          let nodeTrace = handleLocalCollisions(
+              getTraceFromParentKeyInComponents(this, tempRef, mainKeys, version, commonPathFromData),
+              rootMainKeys
+            ),
+            componentKey = nodeTrace[nodeTrace.length - 1],
+            referenceInDocument = getJsonPointerRelationToRoot(
+              tempRef,
+              nodeTrace,
+              version
+            ),
+            traceToParent = [...this.parents.map((item) => {
+              return item.key;
+            }).filter((item) => {
+              return item !== undefined;
+            }), this.key],
+            newValue = Object.assign({}, this.node),
+            [, local] = tempRef.split(localPointer),
+            nodeFromData,
+            refHasContent = false,
+            parseResult,
+            newRefInDoc,
+            inline,
+            contentFromRemote = remoteRefContentMap.get(tempRef),
+            nodeTemp = {
+              fileName: tempRef,
+              path: tempRef,
+              content: contentFromRemote
+            };
+
+          nodeFromData = nodeTemp;
+
+          if (nodeFromData && nodeFromData.content) {
+            parseResult = parseFile(JSON.stringify(nodeFromData.content));
+            if (parseResult.result) {
+              newValue.$ref = referenceInDocument;
+              refHasContent = true;
+              nodeFromData.parsed = parseResult;
+            }
+          }
+          this.update({ $ref: tempRef });
 
-        if (nodeFromData && nodeFromData.content) {
-          parseResult = parseFile(JSON.stringify(nodeFromData.content));
-          if (parseResult.result) {
-            newValue.$ref = referenceInDocument;
-            refHasContent = true;
-            nodeFromData.parsed = parseResult;
+          if (nodeTrace.length === 0) {
+            inline = true;
           }
-        }
-        this.update({ $ref: tempRef });
 
-        if (nodeTrace.length === 0) {
-          inline = true;
-        }
+          if (_.isNil(globalReferences[tempRef])) {
+            nodeReferenceDirectory[tempRef] = {
+              local,
+              keyInComponents: nodeTrace,
+              node: newValue,
+              reference: inline ? newRefInDoc : referenceInDocument,
+              traceToParent,
+              parentNodeKey: parentFilename,
+              mainKeyInTrace: nodeTrace[nodeTrace.length - 1],
+              refHasContent,
+              inline
+            };
+          }
 
-        if (_.isNil(globalReferences[tempRef])) {
-          nodeReferenceDirectory[tempRef] = {
-            local,
-            keyInComponents: nodeTrace,
-            node: newValue,
-            reference: inline ? newRefInDoc : referenceInDocument,
-            traceToParent,
-            parentNodeKey: parentFilename,
-            mainKeyInTrace: nodeTrace[nodeTrace.length - 1],
-            refHasContent,
-            inline
-          };
-        }
+          mainKeys[componentKey] = tempRef;
 
-        mainKeys[componentKey] = tempRef;
+          if (!added(property.$ref, referencesInNode)) {
+            referencesInNode.push({ path: pathSolver(property), keyInComponents: nodeTrace, newValue: this.node });
+          }
+        };
 
-        if (!added(property.$ref, referencesInNode)) {
-          referencesInNode.push({ path: pathSolver(property), keyInComponents: nodeTrace, newValue: this.node });
-        }
+      if (hasRemoteReferenceTypeKey) {
+        handleRemoteURLReference();
       }
     }
   });
diff --git a/test/data/toBundleExamples/remote_url_refs/expected_3.json b/test/data/toBundleExamples/remote_url_refs/expected_3.json
@@ -0,0 +1,76 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Sample API",
+    "description": "Buy or rent spacecrafts"
+  },
+  "paths": {
+    "/spacecrafts/{spacecraftId}": {
+      "parameters": [
+        {
+          "name": "spacecraftId",
+          "description": "The unique identifier of the spacecraft",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "$ref": "https://localhost:8080/SpacecraftId.json#/SpacecraftId"
+          }
+        }
+      ],
+      "get": {
+        "summary": "Read a spacecraft",
+        "responses": {
+          "200": {
+            "description": "The spacecraft corresponding to the provided `spacecraftId`",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Spacecraft"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SpacecraftId": {
+        "description": "The unique identifier of a spacecraft",
+        "type": "string"
+      },
+      "Spacecraft": {
+        "type": "object",
+        "required": [
+          "variant",
+          "fuelFlowRate",
+          "type"
+        ],
+        "properties": {
+          "id": {
+            "description": "THE ID",
+            "type": "string"
+          },
+          "variant": {
+            "description": "The identifier of a spacecraft",
+            "type": "string"
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "ApiKey": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-Api-Key"
+      }
+    }
+  },
+  "security": [
+    {
+      "ApiKey": []
+    }
+  ]
+}
diff --git a/test/data/toBundleExamples/remote_url_refs/root_3.json b/test/data/toBundleExamples/remote_url_refs/root_3.json
@@ -0,0 +1,76 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Sample API",
+    "description": "Buy or rent spacecrafts"
+  },
+  "paths": {
+    "/spacecrafts/{spacecraftId}": {
+      "parameters": [
+        {
+          "name": "spacecraftId",
+          "description": "The unique identifier of the spacecraft",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "$ref": "https://localhost:8080/SpacecraftId.json#/SpacecraftId"
+          }
+        }
+      ],
+      "get": {
+        "summary": "Read a spacecraft",
+        "responses": {
+          "200": {
+            "description": "The spacecraft corresponding to the provided `spacecraftId`",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Spacecraft"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SpacecraftId": {
+        "description": "The unique identifier of a spacecraft",
+        "type": "string"
+      },
+    "Spacecraft": {
+        "type": "object",
+        "required": [
+            "variant",
+            "fuelFlowRate",
+            "type"
+        ],
+        "properties": {
+            "id": {
+                "description": "THE ID",
+                "type": "string"
+            },
+            "variant": {
+                "description": "The identifier of a spacecraft",
+                "type": "string"
+            }
+        }
+      }
+    },
+    "securitySchemes": {
+      "ApiKey": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-Api-Key"
+      }
+    }
+  },
+  "security": [
+    {
+      "ApiKey": []
+    }
+  ]
+}
diff --git a/test/unit/bundle.test.js b/test/unit/bundle.test.js
@@ -2834,6 +2834,41 @@ describe('bundle files method - 3.0', function () {
     expect(res.output.specification.version).to.equal('3.0');
     expect(JSON.stringify(JSON.parse(res.output.data[0].bundledContent), null, 2)).to.be.equal(expected);
   });
+
+  it('Should return bundled file as json without resolving the reference if resolver threw err - remote_url_refs',
+    async function () {
+      let contentRootFile = fs.readFileSync(remoteURLRefExamples + '/root_3.json', 'utf8'),
+        remoteRefResolver = async () => {
+          // eslint-disable-next-line no-throw-literal
+          throw { message: 'Something went wrong' };
+        },
+        expected = fs.readFileSync(remoteURLRefExamples + '/expected_3.json', 'utf8'),
+        input = {
+          type: 'multiFile',
+          specificationVersion: '3.0',
+          rootFiles: [
+            {
+              path: 'root.json'
+            }
+          ],
+          data: [
+            {
+              path: 'root.json',
+              content: contentRootFile
+            }
+          ],
+          options: {},
+          bundleFormat: 'JSON',
+          remoteRefResolver
+        };
+
+      const res = await Converter.bundle(input);
+
+      expect(res).to.not.be.empty;
+      expect(res.result).to.be.true;
+      expect(res.output.specification.version).to.equal('3.0');
+      expect(JSON.stringify(JSON.parse(res.output.data[0].bundledContent), null, 2)).to.be.equal(expected);
+    });
 });
 
 describe('getReferences method when node does not have any reference', function() {
