Merge pull request #1571 from shockey/bug/1560-ref-formatting-validation

$ref formatting validation with whole-document paths

Author: shockey

src/plugins/validation/get-timestamp.js

@@ -1,7 +1,7 @@
 export default function getTimestamp() {
   if(typeof performance !== "undefined" && performance.now) {
     return performance.now()
-  } else if(typeof self.performance !== "undefined" && self.performance.now) {
+  } else if(typeof self !== "undefined" && typeof self.performance !== "undefined" && self.performance.now) {
     return self.performance.now()
   } else {
     return Date.now()

src/plugins/validation/semantic-validators/hook.js

@@ -5,28 +5,15 @@ import { transformPathToArray } from "../path-translator"
 
 import assign from "lodash/assign"
 import getTimestamp from "../get-timestamp"
-let request = require.context("./validators/", true, /\.js$/)
+import rawValidators from "./validators"
 let semanticValidators = []
 
 let LOG_SEMVAL_PERF = process.env.NODE_ENV !== "production"
 
-request.keys().forEach( function( key ){
-  if( key === "./hook.js" ) {
-    return
-  }
-
-  if( !key.match(/js$/) ) {
-    return
-  }
-
-  if( key.slice(2).indexOf("/") > -1) {
-    // skip files in subdirs
-    return
-  }
-
+Object.keys(rawValidators).forEach( function( key ) {
   semanticValidators.push({
     name: toTitleCase(key).replace(".js", "").replace("./", ""),
-    validate: request(key).validate
+    validate: rawValidators[key]
   })
 })
 

src/plugins/validation/semantic-validators/validators/index.js

@@ -0,0 +1,27 @@
+import { validate as dummy } from "./dummy"
+import { validate as form_data } from "./form-data"
+import { validate as items_required_for_array_objects } from "./items-required-for-array-objects"
+import { validate as operation_ids } from "./operation-ids"
+import { validate as operations } from "./operations"
+import { validate as parameters } from "./parameters"
+import { validate as paths } from "./paths"
+import { validate as refs } from "./refs"
+import { validate as schema } from "./schema"
+import { validate as security_definitions } from "./security-definitions"
+import { validate as security } from "./security"
+import { validate as walker } from "./walker"
+
+export default {
+  dummy,
+  form_data,
+  items_required_for_array_objects,
+  operation_ids,
+  operations,
+  parameters,
+  paths,
+  refs,
+  schema,
+  security_definitions,
+  security,
+  walker
+}

src/plugins/validation/semantic-validators/validators/refs.js

@@ -6,21 +6,26 @@ import filter from "lodash/filter"
 import startsWith from "lodash/startsWith"
 import each from "lodash/each"
 
-export function validate({ jsSpec , specStr }) {
+function collectRefs(val, key, arr = []) {
+  if(key === "$ref") {
+    return arr.push(val)
+  }
+
+  if(typeof val !== "object") {
+    return
+  }
+
+  Object.keys(val).map(k => collectRefs(val[k], k, arr))
+
+  return arr
+}
+
+export function validate({ jsSpec }) {
   let errors = []
   let warnings = []
 
   // Assertation 1
-  // This is a "creative" way to approach the problem of collecting used $refs,
-  // but other solutions required walking the jsSpec recursively to detect $refs,
-  // which can be quite slow.
-  let refRegex = /\$ref.*["'](.*)["']/g
-  let match = refRegex.exec(specStr)
-  let refs = []
-  while(match !== null) {
-      refs.push(match[1])
-      match = refRegex.exec(specStr)
-  }
+  const refs = collectRefs(jsSpec, "")
 
   // de-dupe the array, and filter out non-definition refs
   let definitionsRefs = filter(uniq(refs), v => startsWith(v, "#/definitions"))

src/plugins/validation/semantic-validators/validators/walker.js

@@ -83,10 +83,10 @@ export function validate({ jsSpec }) {
         // eslint-disable-next-line no-unused-vars
         const [refUrl, refPath] = value.split("#")
 
-        if(!refPath || refPath[0] !== "/") {
+        if(refPath && refPath[0] !== "/") {
           errors.push({
             path,
-            message: "$refs must begin with `#/`"
+            message: "$ref paths must begin with `#/`"
           })
         }