serverless-openapi-documenter 0.0.111 → 0.0.113

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.111",
+  "version": "0.0.113",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -50,7 +50,6 @@
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
     "json-schema-for-openapi": "^0.5.0",
-    "lodash.isequal": "^4.5.0",
     "openapi-to-postmanv2": "^5.0.0",
     "uuid": "^11.1.0"
   },

package/src/definitionGenerator.js

@@ -1,5 +1,6 @@
 "use strict";
 
+const isEqual = require("node:util").isDeepStrictEqual;
 const path = require("path");
 
 const {
@@ -8,7 +9,6 @@ const {
   stringifyYaml,
   createConfig,
 } = require("@redocly/openapi-core");
-const isEqual = require("lodash.isequal");
 const { v4: uuid } = require("uuid");
 
 const SchemaHandler = require("./schemaHandler");
@@ -39,7 +39,11 @@ class DefinitionGenerator {
       },
     };
 
-    this.schemaHandler = new SchemaHandler(serverless, this.openAPI);
+    this.schemaHandler = new SchemaHandler(
+      serverless,
+      this.openAPI,
+      this.logger
+    );
 
     this.operationIdMap = {};
     this.functionMap = {};
@@ -620,7 +624,7 @@ class DefinitionGenerator {
           continue;
         }
 
-        const obj = JSON.parse(JSON.stringify(this.DEFAULT_CORS_HEADERS[key]));
+        const obj = structuredClone(this.DEFAULT_CORS_HEADERS[key]);
 
         if (key === "Access-Control-Allow-Origin") {
           if (

package/src/openAPIGenerator.js

@@ -241,7 +241,7 @@ class OpenAPIGenerator {
     };
 
     PostmanGenerator.convert(
-      { type: "json", data: JSON.parse(JSON.stringify(openAPI)) },
+      { type: "json", data: structuredClone(openAPI) },
       {},
       postmanGeneration
     );

package/src/schemaHandler.js

@@ -1,14 +1,16 @@
 "use strict";
 
+const isEqual = require("node:util").isDeepStrictEqual;
 const path = require("path");
 
 const $RefParser = require("@apidevtools/json-schema-ref-parser");
 const SchemaConvertor = require("json-schema-for-openapi");
-const isEqual = require("lodash.isequal");
 const { v4: uuid } = require("uuid");
 
 class SchemaHandler {
-  constructor(serverless, openAPI) {
+  constructor(serverless, openAPI, logger) {
+    this.logger = logger;
+
     this.apiGatewayModels =
       serverless.service?.provider?.apiGateway?.request?.schemas || {};
     this.documentation = serverless.service.custom.documentation;
@@ -19,6 +21,12 @@ class SchemaHandler {
     this.__standardiseModels();
 
     try {
+      this.logger.verbose(
+        `Trying to resolve Ref-Parser config from: ${path.resolve(
+          "options",
+          "ref-parser.js"
+        )}`
+      );
       this.refParserOptions = require(path.resolve("options", "ref-parser.js"));
     } catch (err) {
       this.refParserOptions = {};
@@ -63,24 +71,15 @@ class SchemaHandler {
       const modelName = model.name;
       const modelSchema = model.schema;
 
-      const dereferencedSchema = await this.__dereferenceSchema(
-        modelSchema
+      const convertedSchemas = await this.__dereferenceAndConvert(
+        modelSchema,
+        modelName,
+        model
       ).catch((err) => {
-        if (err.errors) {
-          for (const error of err?.errors) {
-            this.__HTTPError(error, model);
-          }
-        } else {
-          this.__HTTPError(err, model);
-        }
-        return modelSchema;
+        if (err instanceof Error) throw err;
+        else return err;
       });
 
-      const convertedSchemas = SchemaConvertor.convert(
-        dereferencedSchema,
-        modelName
-      );
-
       if (
         typeof convertedSchemas.schemas === "object" &&
         !Array.isArray(convertedSchemas.schemas) &&
@@ -119,13 +118,12 @@ class SchemaHandler {
       return this.modelReferences[name];
     }
 
-    const dereferencedSchema = await this.__dereferenceSchema(schema).catch(
-      (err) => {
-        throw err;
-      }
-    );
-
-    const convertedSchemas = SchemaConvertor.convert(dereferencedSchema, name);
+    const convertedSchemas = await this.__dereferenceAndConvert(schema, name, {
+      name,
+      schema,
+    }).catch((err) => {
+      throw err;
+    });
 
     for (const [schemaName, schemaValue] of Object.entries(
       convertedSchemas.schemas
@@ -147,6 +145,32 @@ class SchemaHandler {
     return `#/components/schemas/${finalName}`;
   }
 
+  async __dereferenceAndConvert(schema, name, model) {
+    this.logger.verbose(`dereferencing model: ${name}`);
+    const dereferencedSchema = await this.__dereferenceSchema(schema).catch(
+      (err) => {
+        this.__checkForHTTPErrorsAndThrow(err, model);
+
+        this.__checkForMissingPathAndThrow(err);
+
+        return schema;
+      }
+    );
+
+    this.logger.verbose(
+      `dereferenced model: ${JSON.stringify(dereferencedSchema)}`
+    );
+
+    this.logger.verbose(`converting model: ${name}`);
+    const convertedSchemas = SchemaConvertor.convert(dereferencedSchema, name);
+
+    this.logger.verbose(
+      `converted schemas: ${JSON.stringify(convertedSchemas)}`
+    );
+
+    return convertedSchemas;
+  }
+
   async __dereferenceSchema(schema) {
     const bundledSchema = await $RefParser
       .bundle(schema, this.refParserOptions)
@@ -228,9 +252,23 @@ class SchemaHandler {
     }
   }
 
+  __checkForMissingPathAndThrow(error) {
+    if (error.message === "Expected a file path, URL, or object. Got undefined")
+      throw error;
+  }
+
+  __checkForHTTPErrorsAndThrow(error, model) {
+    if (error.errors) {
+      for (const err of error?.errors) {
+        this.__HTTPError(err, model);
+      }
+    } else {
+      this.__HTTPError(error, model);
+    }
+  }
+
   __HTTPError(error, model) {
     if (error.message.includes("HTTP ERROR")) {
-      //   throw err;
       throw new Error(
         `There was an error dereferencing ${
           model.name

package/test/unit/definitionGenerator.spec.js

@@ -23,7 +23,7 @@ describe("DefinitionGenerator", () => {
   );
 
   beforeEach(function () {
-    mockServerless = JSON.parse(JSON.stringify(serverlessMock));
+    mockServerless = structuredClone(serverlessMock);
     Object.assign(mockServerless.service.custom.documentation, modelsDocument);
   });
 
@@ -39,9 +39,7 @@ describe("DefinitionGenerator", () => {
     });
 
     it("should default to version 3.0.0 of openAPI when openAPI version is not passed in", function () {
-      const serverlessWithoutOpenAPIVersion = JSON.parse(
-        JSON.stringify(mockServerless)
-      );
+      const serverlessWithoutOpenAPIVersion = structuredClone(mockServerless);
       delete serverlessWithoutOpenAPIVersion.processedInput;
       let expected = new DefinitionGenerator(
         serverlessWithoutOpenAPIVersion,
@@ -108,9 +106,7 @@ describe("DefinitionGenerator", () => {
     });
 
     it("should respect the version of openAPI when passed in", function () {
-      const serverlessWithOpenAPIVersion = JSON.parse(
-        JSON.stringify(mockServerless)
-      );
+      const serverlessWithOpenAPIVersion = structuredClone(mockServerless);
       serverlessWithOpenAPIVersion.processedInput.options.openApiVersion =
         "3.0.2";
       let expected = new DefinitionGenerator(

package/test/unit/openAPIGenerator.spec.js

@@ -57,6 +57,7 @@ describe("OpenAPIGenerator", () => {
         notice: (str) => {},
         error: (str) => {},
         success: (str) => {},
+        verbose: (str) => {},
       },
     };
   });
@@ -106,9 +107,7 @@ describe("OpenAPIGenerator", () => {
       const getAllFuncsStub = sinon
         .stub(sls.service, "getAllFunctions")
         .returns(["createUser"]);
-      const basicInvalidFunction = JSON.parse(
-        JSON.stringify(basicValidFunction)
-      );
+      const basicInvalidFunction = structuredClone(basicValidFunction);
 
       delete basicInvalidFunction.createUser.events[0].http.documentation
         .methodResponses[0].responseModels;
@@ -144,9 +143,7 @@ describe("OpenAPIGenerator", () => {
       const getAllFuncsStub = sinon
         .stub(sls.service, "getAllFunctions")
         .returns(["createUser"]);
-      const basicInvalidFunction = JSON.parse(
-        JSON.stringify(basicValidFunction)
-      );
+      const basicInvalidFunction = structuredClone(basicValidFunction);
 
       const getFuncStub = sinon
         .stub(sls.service, "getFunction")
@@ -181,9 +178,7 @@ describe("OpenAPIGenerator", () => {
         .stub(sls.service, "getAllFunctions")
         .returns(["createUser"]);
 
-      const basicInvalidFunction = JSON.parse(
-        JSON.stringify(basicValidFunction)
-      );
+      const basicInvalidFunction = structuredClone(basicValidFunction);
 
       delete basicInvalidFunction.createUser.events[0].http.documentation
         .pathParams;

package/test/unit/owasp.spec.js

@@ -56,7 +56,7 @@ describe(`owasp`, function () {
     });
 
     it(`adds any properties contained in a new release`, async function () {
-      const newOWASPJSONAdded = JSON.parse(JSON.stringify(newOWASPJSON));
+      const newOWASPJSONAdded = structuredClone(newOWASPJSON);
       newOWASPJSONAdded.headers.push({ name: "x-added", value: "true" });
 
       nock("https://owasp.org")