Merge pull request #1517 from swagger-api/feature/validation-refactor-pr

Refactor validation plugin into a pluggable system itself.

Author: shockey

.eslintrc

@@ -22,7 +22,7 @@
   "rules": {
     "semi": [2, "never"],
     "strict": 0,
-    "quotes": 2,
+    "quotes": [2, "double", { "allowTemplateLiterals": true }],
     "no-unused-vars": 2,
     "no-multi-spaces": 1,
     "camelcase": 1,

package.json

@@ -34,6 +34,7 @@
     "test-in-node": "npm run lint-errors && npm run just-test-in-node",
     "just-test": "karma start --config karma.conf.js",
     "just-test-in-node": "mocha --recursive --compilers js:babel-core/register test",
+    "just-test-in-node-watch": "npm run just-test-in-node -- -w",
     "serve-static": "http-server -i -a 0.0.0.0 -p 3001",
     "prestart": "npm install",
     "start": "npm-run-all --parallel serve-static open-static",
@@ -42,7 +43,6 @@
   "dependencies": {
     "ajv": "^5.2.2",
     "boron": "^0.2.3",
-    "bowser": "1.6.1",
     "classnames": "^2.1.3",
     "core-js": "^2.4.1",
     "deepmerge": "^1.3.2",
@@ -60,6 +60,7 @@
     "redux": "^3.x.x",
     "swagger-client": "^3.4.2",
     "swagger-ui": "^3.7.0",
+    "traverse": "^0.6.6",
     "whatwg-fetch": "^2.0.3"
   },
   "devDependencies": {

src/index.js

@@ -5,13 +5,14 @@ import "swagger-ui/dist/swagger-ui.css"
 
 import EditorPlugin from "./plugins/editor"
 import LocalStoragePlugin from "./plugins/local-storage"
-import ValidationPlugin from "./plugins/validation"
-import ValidationApiPlugin from "./plugins/validation/apis"
+import ValidatePlugin from "./plugins/validate"
+import ValidateJsonSchemaPlugin from "./plugins/validate-json-schema"
 import EditorAutosuggestPlugin from "./plugins/editor-autosuggest"
 import EditorAutosuggestSnippetsPlugin from "./plugins/editor-autosuggest-snippets"
 import EditorAutosuggestKeywordsPlugin from "./plugins/editor-autosuggest-keywords"
 import EditorAutosuggestOAS3KeywordsPlugin from "./plugins/editor-autosuggest-oas3-keywords"
 import EditorAutosuggestRefsPlugin from "./plugins/editor-autosuggest-refs"
+import PerformancePlugin from "./plugins/performance"
 import JumpToPathPlugin from "./plugins/jump-to-path"
 
 // eslint-disable-next-line no-undef
@@ -21,14 +22,15 @@ window.versions = window.versions || {}
 window.versions.swaggerEditor = `${PACKAGE_VERSION}/${GIT_COMMIT || "unknown"}${GIT_DIRTY ? "-dirty" : ""}`
 const plugins = {
   EditorPlugin,
-  ValidationPlugin,
-  ValidationApiPlugin,
+  ValidatePlugin,
+  ValidateJsonSchemaPlugin,
   LocalStoragePlugin,
   EditorAutosuggestPlugin,
   EditorAutosuggestSnippetsPlugin,
   EditorAutosuggestKeywordsPlugin,
   EditorAutosuggestRefsPlugin,
   EditorAutosuggestOAS3KeywordsPlugin,
+  PerformancePlugin,
   JumpToPathPlugin,
 }
 

src/plugins/performance/index.js

@@ -0,0 +1,69 @@
+const getTimestamp = ((that) => {
+  if(that.performance && that.performance.now) {
+    return that.performance.now.bind(that.performance)
+  }
+  return Date.now.bind(Date)
+})(self || window)
+
+export default function PerformancePlugin() {
+  if(!(window || {}).LOG_PERF) {
+    return {
+      fn: {
+        getTimestamp,
+        Timer: TimerStub,
+        timeCall: (name,fn) => fn(),
+      }
+    }
+  }
+
+  return {
+    fn: {
+      getTimestamp,
+      Timer,
+      timeCall,
+    }
+  }
+}
+
+function timeCall(name,fn) {
+  fn = fn || name
+  name = typeof name === "function" ? "that" : name
+  const a = getTimestamp()
+  const r = fn()
+  const b = getTimestamp()
+  console.log(name,"took", b - a, "ms") // eslint-disable-line no-console
+  return r
+}
+
+function TimerStub() {
+  this.start = this.mark = this.print = Function.prototype
+}
+
+function Timer(name, _getTimestamp=getTimestamp) {
+  this._name = name
+  this.getTimestamp = _getTimestamp
+  this._markers = []
+  this.start()
+}
+
+Timer.prototype.start = function() {
+  this._start = this.getTimestamp()
+}
+
+Timer.prototype.mark = function(name) {
+  this._markers = this._markers || []
+  this._markers.push({
+    time: this.getTimestamp(),
+    name
+  })
+}
+
+Timer.prototype.print = function(name) {
+  this.mark(name)
+  this._markers.forEach(m => {
+    // eslint-disable-next-line no-console
+    console.log(this._name, m.name, m.time - this._start, "ms")
+  })
+  this._markers = []
+  this.start()
+}

src/plugins/validation/apis/index.js renamed to src/plugins/validate-json-schema/apis/index.js

@@ -26,9 +26,6 @@ export function makeValidationWorker() {
       errActions.clear({
         source: "schema"
       })
-      errActions.clear({
-        source: "semantic"
-      })
 
       // Filter out anything funky
       validationErrors = validationErrors

src/plugins/validation/get-timestamp.js renamed to src/plugins/validate-json-schema/get-timestamp.js

@@ -0,0 +1,5 @@
+import Apis from "./apis"
+
+export default function ValidateJsonSchemaPlugin() {
+  return Apis
+}