Handle invalid schema object examples in OAS 2 (#221)

Handle invalid schema object examples in OAS 2

Author: pksunkara

packages/fury-adapter-swagger/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Fury Swagger Parser Changelog
 
+## 0.25.1 (2019-04-26)
+
+### Bug Fixes
+
+- Fixes a potential parser crash while handling an example value for a 'Schema
+  Object' which contains an invalid reference.
+
 ## 0.25.0 (2019-03-26)
 
 ### Enhancements

packages/fury-adapter-swagger/lib/json-schema.js

@@ -6,18 +6,20 @@ if (!Object.values) {
   values.shim();
 }
 
+class ReferenceError extends Error {}
+
 // Test whether a key is a special Swagger extension.
 const isExtension = (value, key) => _.startsWith(key, 'x-');
 
 const parseReference = (reference) => {
   const parts = reference.split('/');
 
   if (parts[0] !== '#') {
-    throw new Error('Schema reference must start with document root (#)');
+    throw new ReferenceError('Schema reference must start with document root (#)');
   }
 
   if (parts[1] !== 'definitions' || parts.length !== 3) {
-    throw new Error('Schema reference must be reference to #/definitions');
+    throw new ReferenceError('Schema reference must be reference to #/definitions');
   }
 
   const id = parts[2];
@@ -43,11 +45,11 @@ const lookupReference = (reference, root, depth) => {
   const parts = reference.split('/').reverse();
 
   if (parts.pop() !== '#') {
-    throw new Error('Schema reference must start with document root (#)');
+    throw new ReferenceError('Schema reference must start with document root (#)');
   }
 
   if (parts.pop() !== 'definitions') {
-    throw new Error('Schema reference must be reference to #/definitions');
+    throw new ReferenceError('Schema reference must be reference to #/definitions');
   }
 
   const id = parts[parts.length - 1];
@@ -67,7 +69,7 @@ const lookupReference = (reference, root, depth) => {
   }
 
   if (value === undefined) {
-    throw new Error(`Reference to ${reference} does not exist`);
+    throw new ReferenceError(`Reference to ${reference} does not exist`);
   }
 
   return {
@@ -93,6 +95,20 @@ const pathHasCircularReference = (paths, path, reference) => {
 };
 
 const dereference = (example, root, paths, path) => {
+  // We shouldn't even be dereferencing examples, but given how swagger-parser
+  // works it had been doing this from the start (which was caught later).
+  //
+  // See https://github.com/apiaryio/api-elements.js/issues/220
+  //
+  // At thsi point, changing that behaviour would be a significant breaking
+  // change and it will affect some of our larger users. Not to mention that
+  // swagger-parser will still dereference the examples in cases where our code
+  // path doesn't, it won't be easy to solve.
+  //
+  // The below code attemps to dereference an example, but if we can't we
+  // will just return the example (possibly a "reference object") to be
+  // the example value.
+
   if (example === null || example === undefined) {
     return example;
   }
@@ -105,7 +121,18 @@ const dereference = (example, root, paths, path) => {
       return null;
     }
 
-    const ref = lookupReference(example.$ref, root);
+    let ref;
+
+    try {
+      ref = lookupReference(example.$ref, root);
+    } catch (error) {
+      if (error instanceof ReferenceError) {
+        // Cannot find the reference, use example
+        return example;
+      }
+
+      throw error;
+    }
 
     const newPaths = (paths || []).concat([currentPath]);
     return dereference(ref.referenced, root, newPaths, refPath);

packages/fury-adapter-swagger/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fury-adapter-swagger",
-  "version": "0.25.0",
+  "version": "0.25.1",
   "description": "Swagger 2.0 parser for Fury.js",
   "author": "Apiary.io <[email protected]>",
   "license": "MIT",

packages/fury-adapter-swagger/test/fixtures/schema-references-example-invalid.json

@@ -0,0 +1,79 @@
+{
+  "element": "parseResult",
+  "content": [
+    {
+      "element": "category",
+      "meta": {
+        "classes": {
+          "element": "array",
+          "content": [
+            {
+              "element": "string",
+              "content": "api"
+            }
+          ]
+        },
+        "title": {
+          "element": "string",
+          "content": "My API"
+        }
+      },
+      "attributes": {
+        "version": {
+          "element": "string",
+          "content": "1.0.0"
+        }
+      },
+      "content": [
+        {
+          "element": "category",
+          "meta": {
+            "classes": {
+              "element": "array",
+              "content": [
+                {
+                  "element": "string",
+                  "content": "dataStructures"
+                }
+              ]
+            }
+          },
+          "content": [
+            {
+              "element": "dataStructure",
+              "content": {
+                "element": "array",
+                "meta": {
+                  "id": {
+                    "element": "string",
+                    "content": "definitions/Test"
+                  }
+                },
+                "content": [
+                  {
+                    "element": "object",
+                    "content": [
+                      {
+                        "element": "member",
+                        "content": {
+                          "key": {
+                            "element": "string",
+                            "content": "$ref"
+                          },
+                          "value": {
+                            "element": "string",
+                            "content": "#/info"
+                          }
+                        }
+                      }
+                    ]
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

packages/fury-adapter-swagger/test/fixtures/schema-references-example-invalid.yaml

@@ -0,0 +1,10 @@
+swagger: '2.0'
+info:
+  title: My API
+  version: 1.0.0
+paths: {}
+definitions:
+  Test:
+    type: array
+    example:
+      - $ref: '#/info'

packages/fury-cli/package.json

@@ -26,7 +26,7 @@
     "fury-adapter-apib-parser": "^0.14.0",
     "fury-adapter-apib-serializer": "^0.10.0",
     "fury-adapter-oas3-parser": "^0.7.4",
-    "fury-adapter-swagger": "^0.25.0",
+    "fury-adapter-swagger": "^0.25.1",
     "js-yaml": "^3.12.0",
     "minim": "^0.23.1"
   },