Merge branch 'develop' into fix496/validateWithServers

Author: LuisTejedaS

.npmignore

@@ -43,4 +43,16 @@ test/data/.temp
 
 # Prevent unit test coverage reports from being added
 .coverage
-.nyc_output
+.nyc_output
+
+# - Prevent config and test files from being added
+.git*
+.github/
+scripts/
+test/
+examples/
+.eslintrc
+.eslintignore
+.nycrc
+.editorconfig
+.jsdoc-config.json

CHANGELOG.md

@@ -1,5 +1,10 @@
 # OpenAPI-Postman Changelog
 
+#### v4.0.0 (July 12, 2022)
+* Added support for new multi-file API detectRootFiles() for OpenAPI 3 and Swagger 2 formats to support detection of root files among multiple files.
+* Added support for new multi-file API detectRelatedFiles() for OpenAPI 3 and Swagger 2 formats to support detection of related files for a provided root file amongst multiple files.
+* Added support for new multi-file API bundle() for OpenAPI 3 and Swagger 2 formats to support bundling of root files from provided multiple files.
+
 #### v3.2.0 (May 02, 2022)
 * Fixed some of critical and high level severity vulnerabilities.
 * Fixed issue [#10752](https://github.com/postmanlabs/postman-app-support/issues/10752) where deepObject style parameters were not generated correctly.

lib/bundle.js

@@ -22,7 +22,7 @@ let path = require('path'),
   { DFS } = require('./dfs'),
   deref = require('./deref.js'),
   { isSwagger, getBundleRulesDataByVersion } = require('./common/versionUtils'),
-  CIRCULAR_REF_EXT_PROP = 'x-circularRef';
+  CIRCULAR_OR_REF_EXT_PROP = 'x-orRef';
 
 
 /**
@@ -481,6 +481,34 @@ function findReferenceByMainKeyInTraceFromContext(documentContext, mainKeyInTrac
   return relatedRef;
 }
 
+/**
+ * Verifies if a node has same content as one of the parents so it is a circular ref
+ * @param {function} traverseContext - The context of the traverse function
+ * @param {object} contentFromTrace -  The resolved content of the node to deref
+ * @returns {boolean} whether is circular reference or not.
+ */
+function isCircularReference(traverseContext, contentFromTrace) {
+  return traverseContext.parents.find((parent) => { return parent.node === contentFromTrace; }) !== undefined;
+}
+
+/**
+ * Modifies content of a node if it is circular reference.
+ *
+ * @param {function} traverseContext - The context of the traverse function
+ * @param {object} documentContext The document context from root
+ * @returns {undefined}  nothing
+ */
+function handleCircularReference(traverseContext, documentContext) {
+  let relatedRef = '';
+  if (traverseContext.circular) {
+    relatedRef = findReferenceByMainKeyInTraceFromContext(documentContext, traverseContext.circular.key);
+    traverseContext.update({ $ref: relatedRef });
+  }
+  if (traverseContext.keys && traverseContext.keys.includes(CIRCULAR_OR_REF_EXT_PROP)) {
+    traverseContext.update({ $ref: traverseContext.node[CIRCULAR_OR_REF_EXT_PROP] });
+  }
+}
+
 /**
  * Generates the components object from the documentContext data
  * @param {object} documentContext The document context from root
@@ -492,8 +520,9 @@ function findReferenceByMainKeyInTraceFromContext(documentContext, mainKeyInTrac
  */
 function generateComponentsObject (documentContext, rootContent, refTypeResolver, components, version) {
   let notInLine = Object.entries(documentContext.globalReferences).filter(([, value]) => {
-    return value.keyInComponents.length !== 0;
-  });
+      return value.keyInComponents.length !== 0;
+    }),
+    circularRefsSet = new Set();
   const { COMPONENTS_KEYS } = getBundleRulesDataByVersion(version);
   notInLine.forEach(([key, value]) => {
     let [, partial] = key.split(localPointer);
@@ -541,6 +570,17 @@ function generateComponentsObject (documentContext, rootContent, refTypeResolver
             if (!contentFromTrace) {
               refData.nodeContent = { $ref: `${localPointer + local}` };
             }
+            else if (isCircularReference(this, contentFromTrace)) {
+              if (refData.inline) {
+                refData.nodeContent = { [CIRCULAR_OR_REF_EXT_PROP]: tempRef };
+                circularRefsSet.add(tempRef);
+              }
+              else {
+                refData.node = { [CIRCULAR_OR_REF_EXT_PROP]: refData.reference };
+                refData.nodeContent = contentFromTrace;
+                circularRefsSet.add(refData.reference);
+              }
+            }
             else {
               refData.nodeContent = contentFromTrace;
             }
@@ -551,39 +591,30 @@ function generateComponentsObject (documentContext, rootContent, refTypeResolver
             refData.node = hasSiblings ?
               _.merge(referenceSiblings, refData.nodeContent) :
               refData.nodeContent;
-            documentContext.globalReferences[property.$ref].reference =
+            documentContext.globalReferences[tempRef].reference =
               resolveJsonPointerInlineNodes(this.parents, this.key);
           }
-          this.update(refData.node);
-          if (!refData.inline) {
-            if (documentContext.globalReferences[tempRef].refHasContent) {
-              setValueInComponents(
-                refData.keyInComponents,
-                components,
-                refData.nodeContent,
-                COMPONENTS_KEYS
-              );
-            }
+          else if (refData.refHasContent) {
+            setValueInComponents(
+              refData.keyInComponents,
+              components,
+              refData.nodeContent,
+              COMPONENTS_KEYS
+            );
           }
+          this.update(refData.node);
         }
       }
     });
   });
   return {
     resRoot: traverseUtility(rootContent).map(function () {
-      let relatedRef = '';
-      if (this.circular) {
-        relatedRef = findReferenceByMainKeyInTraceFromContext(documentContext, this.circular.key);
-        this.update({ $ref: relatedRef, [CIRCULAR_REF_EXT_PROP]: true });
-      }
+      handleCircularReference(this, documentContext);
     }),
     newComponents: traverseUtility(components).map(function () {
-      let relatedRef = '';
-      if (this.circular) {
-        relatedRef = findReferenceByMainKeyInTraceFromContext(documentContext, this.circular.key);
-        this.update({ $ref: relatedRef, [CIRCULAR_REF_EXT_PROP]: true });
-      }
-    })
+      handleCircularReference(this, documentContext);
+    }),
+    circularRefs: [...circularRefsSet]
   };
 }
 
@@ -618,7 +649,7 @@ function generateComponentsWrapper(parsedOasObject, version, nodesContent = {})
 }
 
 /**
- * Generates a map of generated refernce to the original reference
+ * Generates a map of generated reference to the original reference
  *
  * @param {object} globalReferences - Global references present at each root file context
  * @returns {object} reference map
@@ -712,7 +743,8 @@ module.exports = {
       fileContent: finalElements.resRoot,
       components: finalElements.newComponents,
       fileName: specRoot.fileName,
-      referenceMap: getReferenceMap(rootContextData.globalReferences)
+      referenceMap: getReferenceMap(rootContextData.globalReferences),
+      circularRefs: finalElements.circularRefs
     };
   },
   getReferences,

lib/common/schemaUtilsCommon.js

@@ -63,7 +63,7 @@ function removeWordFromLastPosition(schemaPath, word) {
  * "<integer>"
  *
  * @param {string} value - Value to check for
- * @param {string} type - The type in the schemna
+ * @param {string} type - The type in the schema
  * @returns {Boolean} the value is the representation of its type
  */
 function compareType(value, type) {
@@ -75,7 +75,7 @@ function compareType(value, type) {
  * "<integer>"
  * Works in array types
  * @param {string} value - Value to check for
- * @param {*} types - The types in the schemna
+ * @param {*} types - The types in the schema
  * @returns {Boolean} the value is the representation of its type
  */
 function isTypeValueArrayCheck(value, types) {
@@ -89,7 +89,7 @@ function isTypeValueArrayCheck(value, types) {
  * "<integer>"
  * Works in array types
  * @param {string} value - Value to check for
- * @param {*} types - The types in the schemna
+ * @param {*} types - The types in the schema
  * @returns {Boolean} the value is the representation of its type
  */
 function checkValueOnlyTypes(value, types) {
@@ -118,7 +118,7 @@ function getDefaultFromTypeAndFormat(type, format) {
  * @returns {Boolean} the value is the representation of its type
  */
 function checkValueTypesAndFormat(value, types, format) {
-  let typesNotInMapp = [],
+  let typesNotInMap = [],
     typesArray = Array.isArray(types) ? types : [types],
     found = typesArray.find((type) => {
       let defaultValue;
@@ -132,7 +132,7 @@ function checkValueTypesAndFormat(value, types, format) {
         }
       }
       else {
-        typesNotInMapp.push(type);
+        typesNotInMap.push(type);
       }
       return defaultValue === value;
     });
@@ -141,7 +141,7 @@ function checkValueTypesAndFormat(value, types, format) {
     return true;
   }
 
-  found = typesNotInMapp.find((type) => {
+  found = typesNotInMap.find((type) => {
     let defaultValue;
     defaultValue = '<' + type + (format ? ('-' + format) : '') + '>';
     return defaultValue === value;
@@ -185,7 +185,7 @@ function isTypeValue(value, schema) {
 }
 
 /**
- * Checks if value is correcta according to schema
+ * Checks if value is correct according to schema
  * If the value should be numeric, it tries to convert and then validate
  * also validates if the value is a correct representation in the form of
  * <long> or <integer> etc for integers format 32 or format 64
@@ -332,7 +332,7 @@ module.exports = {
   isTypeValue,
 
   /**
-   * Checks if value is correcta according to schema
+   * Checks if value is correct according to schema
    * If the value should be numeric, it tries to convert and then validate
    * also validates if the value is a correct representation in the form of
    * <long> or <integer> etc for integers format 32 or format 64

lib/schemaUtils.js

@@ -1827,6 +1827,10 @@ module.exports = {
       bodyData = this.convertToPmBodyData(contentObj[FORM_DATA], requestType, FORM_DATA,
         PARAMETER_SOURCE.REQUEST, options.indentCharacter, components, options, schemaCache);
       encoding = contentObj[FORM_DATA].encoding ? contentObj[FORM_DATA].encoding : {};
+
+      if (contentObj[FORM_DATA].hasOwnProperty('schema') && contentObj[FORM_DATA].schema.hasOwnProperty('$ref')) {
+        contentObj[FORM_DATA].schema = this.getRefObject(contentObj[FORM_DATA].schema.$ref, components, options);
+      }
       // create the form parameters and add it to the request body object
       _.forOwn(bodyData, (value, key) => {
 
@@ -2454,9 +2458,6 @@ module.exports = {
       pmBody = this.convertToPmBody(reqBody, REQUEST_TYPE.ROOT, components, options, schemaCache);
       item.request.body = pmBody.body;
 
-      // Following is added to make sure body pruning for request methods like GET, HEAD etc is disabled'.
-      item.protocolProfileBehavior = { disableBodyPruning: true };
-
       if (!options.keepImplicitHeaders || (!_.find(reqParams.header, (h) => {
         return _.toLower(_.get(h, 'name')) === 'content-type';
       }))) {
@@ -2568,6 +2569,13 @@ module.exports = {
     if (!_.isEmpty(acceptHeader) && !item.request.headers.has('accept')) {
       item.request.addHeader(acceptHeader);
     }
+
+    /**
+     * Following is added to make sure body pruning for request methods like GET, HEAD etc is disabled'.
+     * https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md
+     */
+    item.protocolProfileBehavior = { disableBodyPruning: true };
+
     return item;
   },
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-to-postmanv2",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "Convert a given OpenAPI specification to Postman Collection v2.0",
   "homepage": "https://github.com/postmanlabs/openapi-to-postman",
   "bugs": "https://github.com/postmanlabs/openapi-to-postman/issues",

package.json

@@ -28,7 +28,7 @@
                 "schema": {
                   "type": "array",
                   "items": {
-                    "$ref": "#/components/schemas/_schemas_schemas.yaml-components_schemas_ErrorDetail"
+                    "$ref": "#/components/schemas/_schemas_schemas.yaml-_components_schemas_ErrorDetail"
                   }
                 }
               }
@@ -40,7 +40,7 @@
   },
   "components": {
     "schemas": {
-      "_schemas_schemas.yaml-components_schemas_ErrorDetail": {
+      "_schemas_schemas.yaml-_components_schemas_ErrorDetail": {
         "type": "object",
         "description": "The error detail.",
         "properties": {
@@ -63,8 +63,7 @@
             "readOnly": true,
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/_schemas_schemas.yaml-components_schemas_ErrorDetail",
-              "x-circularRef": true
+              "$ref": "#/components/schemas/_schemas_schemas.yaml-_components_schemas_ErrorDetail"
             },
             "description": "The error details."
           }

test/data/toBundleExamples/circular_reference/expected.json

@@ -25,4 +25,4 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: "./schemas/schemas.yaml#components/schemas/ErrorDetail"
+                  $ref: "./schemas/schemas.yaml#/components/schemas/ErrorDetail"