fix(bundle): handle external URLs better (#30)

Author: P0lip

lib/bundle/index.js

@@ -4,7 +4,7 @@ const $Ref = require("../ref");
 const Pointer = require("../pointer");
 const url = require("../util/url");
 const { safePathToPointer, safePointerToPath } = require("../util/url");
-const { get, set } = require("./util/object");
+const { get, set, unset } = require("./util/object");
 
 module.exports = bundle;
 
@@ -291,14 +291,26 @@ function remap (schema, inventory, $refs, options, customRoots) {
   let file, hash, pathFromRoot;
   for (let entry of inventory) {
     // console.log('Re-mapping $ref pointer "%s" at %s', entry.$ref.$ref, entry.pathFromRoot);
-    // if entry is not dinlineable and has a custom root linked, we need to remap the properties of the object
+    // if entry is not inlineable and has a custom root linked, we need to remap the properties of the object
     if (customRoots[entry.file] && customRoots[entry.file][entry.hash] !== null) {
-      if (entry.hash === "#" || !("#" in customRoots[entry.file])) {
+      if (entry.hash === "#" || !customRoots[entry.file]["#"]) {
+        entry.$ref.$ref = customRoots[entry.file][entry.hash];
+
         // the whole file is referenced for the first time
         // we need to inject its entire content here
         // or only certain fragment of the whole file has a custom root and we need to inject that portion
+        // assuming we haven't already set it earlier
+        if (get(schema, customRoots[entry.file][entry.hash])) continue;
         set(schema, customRoots[entry.file][entry.hash], $Ref.dereference(entry.$ref, entry.value));
-        entry.$ref.$ref = customRoots[entry.file][entry.hash];
+
+        // let's try to remove a shared definition in the $reffed schema that won't be used
+        let parentEntry = inventory.find(({ file, hash }) => file === entry.file && hash === "#");
+        // parentEntry will be undefined if we never reference the entire document
+        if (!parentEntry) continue;
+        pathFromRoot = parentEntry.pathFromRoot;
+        if (entry.hash !== "#" && pathFromRoot) {
+          unset(schema, Pointer.join(pathFromRoot, Pointer.parse(entry.hash.replace(hash, "#"))));
+        }
       }
       // entry is not supposed to be moved anywhere, it's not placed under root
       else {
@@ -339,7 +351,7 @@ function remap (schema, inventory, $refs, options, customRoots) {
       hash = entry.hash;
 
       // This is the first $ref to point to this value, so dereference the value.
-      // Any other $refs that point to the sam  e value will point to this $ref instead
+      // Any other $refs that point to the same value will point to this $ref instead
       if (entry.file in customRoots && customRoots[entry.file]["#"]) {
         entry.$ref.$ref = entry.mappedPathFromRoot;
         pathFromRoot = entry.mappedPathFromRoot;

lib/bundle/util/object.js

@@ -56,3 +56,25 @@ module.exports.set = function (obj, pointer, value) {
   }
 };
 
+/**
+ * @param {object} obj
+ * @param {string} pointer
+ */
+module.exports.unset = function (obj, pointer) {
+  let tokens = Pointer.parse(pointer);
+
+  if (tokens.length === 0) {
+    throw new TypeError("Path cannot point at root");
+  }
+
+  let curObj = obj;
+  for (let i = 0; i < tokens.length - 1; i++) {
+    let segment = tokens[i];
+    curObj = curObj[segment];
+  }
+
+  if (curObj && (tokens[tokens.length - 1] in curObj)) {
+    delete curObj[tokens[tokens.length - 1]];
+  }
+};
+

test/specs/custom-bundling-roots-new-stoplight/custom-bundling-roots-new-stoplight.spec.js

@@ -136,4 +136,130 @@ describe("Stoplight-specific defaults", () => {
       }
     });
   });
+
+  it("should handle external URLs", async () => {
+    setupHttpMocks({
+      "https://api.stoplight.io/v1/schema/user.json": {
+        definitions: {
+          status: {
+            type: "string",
+          }
+        },
+        type: "object",
+        properties: {
+          orders: {
+            type: "object",
+            properties: {
+              new: { $ref: "#/definitions/status" },
+              cancelled: { $ref: "#/definitions/status" },
+              error: { $ref: "#/definitions/status" }
+            },
+          }
+        },
+      },
+    });
+
+    let parser = new $RefParser();
+    let defaults = createStoplightDefaults({
+      cwd: __dirname,
+      endpointUrl: "http://jakub.stoplight-local.com:8080/api/v1/projects/jakub/my-project/nodes",
+    });
+
+    const document = {
+      swagger: "2.0",
+      paths: {
+        "/": {
+          get: {
+            responses: {
+              200: {
+                $ref: "#/responses/Address"
+              }
+            }
+          },
+          post: {
+            responses: {
+              200: {
+                $ref: "#/responses/Address"
+              }
+            },
+            parameters: [
+              {
+                in: "body",
+                schema: {
+                  $ref: "https://api.stoplight.io/v1/schema/user.json"
+                }
+              }
+            ]
+          }
+        }
+      },
+      responses: {
+        Address: {
+          title: "Address",
+        }
+      }
+    };
+
+    const schema = await parser.bundle(document, {
+      bundle: defaults.oas2,
+    });
+
+    expect(schema).to.equal(parser.schema);
+    expect(schema).to.deep.equal({
+      swagger: "2.0",
+      definitions: {
+        User_Status: {
+          type: "string"
+        }
+      },
+      paths: {
+        "/": {
+          get: {
+            responses: {
+              200: {
+                $ref: "#/responses/Address"
+              }
+            }
+          },
+          post: {
+            parameters: [
+              {
+                in: "body",
+                schema: {
+                  type: "object",
+                  definitions: {},
+                  properties: {
+                    orders: {
+                      type: "object",
+                      properties: {
+                        cancelled: {
+                          $ref: "#/definitions/User_Status"
+                        },
+                        error: {
+                          $ref: "#/definitions/User_Status"
+                        },
+                        new: {
+                          $ref: "#/definitions/User_Status"
+                        }
+                      },
+                    }
+                  }
+                }
+              }
+            ],
+            responses: {
+              200: {
+                $ref: "#/responses/Address"
+              }
+            }
+          }
+        }
+      },
+      responses: {
+        Address: {
+          title: "Address"
+        }
+      }
+    });
+  });
 });