Merge pull request #3290 from shockey/v/3.0.17

v3.0.17

.babelrc

@@ -5,6 +5,7 @@
     "stage-0"
   ],
   "plugins": [
+    "transform-runtime",
     [
       "module-alias",
       [

README.md

@@ -6,6 +6,8 @@
 
 **This is the new version of swagger-ui, 3.x. Want to learn more? Check out our [FAQ](http://swagger.io/new-ui-faq/).**
 
+**👉🏼 Want to score an easy open-source contribution?** Check out our [Good first contribution](https://github.com/swagger-api/swagger-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+contribution%22) label.
+
 As a brand new version, written from the ground up, there are some known issues and unimplemented features. Check out the [Known Issues](#known-issues) section for more details.
 
 This repo publishes to two different NPM packages:
@@ -20,7 +22,7 @@ The OpenAPI Specification has undergone 4 revisions since initial creation in 20
 
 Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes | Status
 ------------------ | ------------ | -------------------------- | ----- | ------
-3.0.16              | 2017-06-17   | 2.0                        | [tag v3.0.16](https://github.com/swagger-api/swagger-ui/tree/v3.0.16) |
+3.0.17              | 2017-06-23   | 2.0                        | [tag v3.0.17](https://github.com/swagger-api/swagger-ui/tree/v3.0.17) |
 2.2.10             | 2017-01-04   | 1.1, 1.2, 2.0              | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10) |
 2.1.5              | 2016-07-20   | 1.1, 1.2, 2.0              | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5) |
 2.0.24             | 2014-09-12   | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |

dist/swagger-ui-bundle.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;AAu/FA;AA6+FA;;;;;;;;;;;;;;;;;;;;;;;;;;AA2TA;;;;;;AAoIA;AAi7FA;AAmtCA;AAi0IA;AAioJA;AA2iGA;AAs+FA;AA4kFA;AA6jFA;AAm9CA;AA6jDA;AAgrCA;AA+/EA;;;;;AAu3BA;AA0qJA;;;;;;;;;;;;;;AAwoFA;AA+lIA;AA2hJA;AAo2HA;AA8lGA;AAwiEA;AAo4DA;AAk7DA;AAyHA;;;;;;AA6iGA;AA07FA;;;;;AAi8CA;AAgsFA;AAs2CA;AAilCA;AA+7CA;AA85DA;AA4zCA;AAs5FA;;;;;;;;;AAqlCA;AA2zIA;AAu7FA;AAmrFA;AA20EA","sourceRoot":""}
+{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;AAitFA;;;;;;AAoIA;AAy2FA;AA8iCA;AA6lJA;AA8vIA;AA8iFA;AAi4GA;AA8jFA;AAu0FA;AA89CA;AAy9CA;AA+qCA;AAs0EA;;;;;AAw/CA;AA8zJA;;;;;;;;;;;;;;AAyoFA;AA+lIA;AA4oJA;AAqvHA;AAsvGA;AA2iEA;AAy5DA;AA65DA;AAAA;;;;;;AAk8GA;AA2nHA;;;;;AAkoDA;AAgsFA;AA6kDA;AAq3CA;AA4wFA;AAk3CA;AA8iFA;;;;;;;;;AA2qEA;AA2zIA;AAu7FA;AAmrFA;AAwiHA","sourceRoot":""}

dist/swagger-ui-standalone-preset.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;;;;;AA0SA;AAgyGA;AAuxFA;;;;;;AAocA;AAkvFA;AAu+CA;AAo+CA;AAgrCA;AAuyEA","sourceRoot":""}
+{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;AA+uFA;;;;;AAyOA;AAo7GA;AAw0FA;;;;;;AAmZA;AAivFA;AAu+CA;AAo+CA;AAirCA;AAuyEA","sourceRoot":""}

dist/swagger-ui.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AAizCA;AAoyHA;AAmyHA;AAukGA;AA+9BA;AA8jCA;AAyiCA;AAs5BA","sourceRoot":""}
+{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;AAylFA;;;;;;AAg5CA;AA2pHA;AA6qIA;AAi+FA;AAyvDA;AAmzCA;AA+xCA","sourceRoot":""}

make-webpack-config.js

@@ -147,7 +147,7 @@ module.exports = function(options) {
       extensions: ["", ".web.js", ".js", ".jsx", ".json", ".less"],
       packageAlias: 'browser',
       alias: {
-        base: "getbase/src/less/base"
+        base: "getbase/src/less/base",
       }
     },
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-ui",
-  "version": "3.0.16",
+  "version": "3.0.17",
   "main": "dist/swagger-ui.js",
   "repository": "git@github.com:swagger-api/swagger-ui.git",
   "contributors": [
@@ -35,7 +35,6 @@
     "just-test-in-node": "mocha --recursive --compilers js:babel-core/register test/core test/components test/bugs test/swagger-ui-dist-package"
   },
   "dependencies": {
-    "babel-polyfill": "^6.23.0",
     "base64-js": "^1.2.0",
     "brace": "0.7.0",
     "deep-extend": "0.4.1",
@@ -70,12 +69,12 @@
     "sanitize-html": "^1.14.1",
     "serialize-error": "2.0.0",
     "shallowequal": "0.2.2",
-    "swagger-client": "~3.0.15",
+    "swagger-client": "3.0.16",
     "url-parse": "^1.1.8",
     "whatwg-fetch": "0.11.1",
     "worker-loader": "^0.7.1",
     "xml": "1.0.1",
-    "yaml-js": "^0.1.3"
+    "yaml-js": "0.2.0"
   },
   "devDependencies": {
     "autoprefixer": "6.6.1",
@@ -83,6 +82,7 @@
     "babel-eslint": "^7.1.1",
     "babel-loader": "^6.3.2",
     "babel-plugin-module-alias": "^1.6.0",
+    "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-es2015": "^6.22.0",
     "babel-preset-es2015-ie": "^6.6.2",
     "babel-preset-react": "^6.23.0",
@@ -132,7 +132,7 @@
   "browserslist": [
     "> 1%",
     "last 2 versions",
-    "IE 10"
+    "IE 11"
   ],
   "optionalDependencies": {
     "webpack-dev-server": "1.14.0"

src/core/components/providers/markdown.jsx

@@ -11,6 +11,12 @@ const sanitizeOptions = {
 
 function Markdown({ source }) {
   const sanitized = sanitize(source, sanitizeOptions)
+
+  // sometimes the sanitizer returns "undefined" as a string
+  if(!source || !sanitized || sanitized === "undefined") {
+    return null
+  }
+
   return <Remarkable
     options={{html: true, typographer: true, linkify: true, linkTarget: "_blank"}}
     source={sanitized}

src/core/index.js

@@ -117,6 +117,7 @@ module.exports = function SwaggerUI(opts) {
     return downloadSpec()
   }
 
+  return system
 }
 
 // Add presets

src/core/plugins/spec/reducers.js

@@ -41,7 +41,7 @@ export default {
   [UPDATE_PARAM]: ( state, {payload} ) => {
     let { path, paramName, value, isXml } = payload
     return state.updateIn( [ "resolved", "paths", ...path, "parameters" ], fromJS([]), parameters => {
-      let index = parameters.findIndex( p => p.get( "name" ) === paramName )
+      const index = parameters.findIndex(p => p.get( "name" ) === paramName )
       if (!(value instanceof win.File)) {
         value = fromJSOrdered( value )
       }

src/core/utils.js

@@ -1,9 +1,9 @@
 import Im from "immutable"
-import shallowEqual from "shallowequal"
 
 import camelCase from "lodash/camelCase"
 import upperFirst from "lodash/upperFirst"
 import _memoize from "lodash/memoize"
+import find from "lodash/find"
 import some from "lodash/some"
 import eq from "lodash/eq"
 import { memoizedSampleFromSchema, memoizedCreateXMLExample } from "core/plugins/samples/fn"
@@ -418,11 +418,6 @@ export function pascalCaseFilename(filename) {
   return pascalCase(filename.replace(/\.[^./]*$/, ""))
 }
 
-// Only compare a set of props
-export function shallowEqualKeys(a,b, keys) {
-  return !!keys.find(key => !shallowEqual(a[key], b[key]))
-}
-
 // Check if ...
 // - new props
 // - If immutable, use .is()
@@ -593,3 +588,10 @@ export const filterConfigs = (configs, allowed) => {
 
     return filteredConfigs
 }
+
+// Is this really required as a helper? Perhaps. TODO: expose the system of presets.apis in docs, so we know what is supported
+export const shallowEqualKeys = (a,b, keys) => {
+  return !!find(keys, (key) => {
+    return eq(a[key], b[key])
+  })
+}

src/polyfills.js

@@ -0,0 +1,2 @@
+// Promise global, Used ( at least ) by 'whatwg-fetch'. And required by IE 11
+require("core-js/fn/promise")

swagger-ui-dist-package/absolute-path.js

@@ -3,7 +3,7 @@
  * @return {string} When run in NodeJS env, returns the absolute path to the current directory
  *                  When run outside of NodeJS, will return an error message
  */
-const getAbsoluteFSPath = () => {
+const getAbsoluteFSPath = function () {
   // detect whether we are running in a browser or nodejs
   if (typeof module !== "undefined" && module.exports) {
     return require("path").resolve(__dirname)

test/bugs/3279-empty-markdown-source.js

@@ -0,0 +1,37 @@
+/* eslint-env mocha */
+import React from "react"
+import expect from "expect"
+import { render } from "enzyme"
+import Markdown from "components/providers/markdown"
+
+describe("UI-3279: Empty Markdown inputs causing bare `undefined` in output", function(){
+  it("should return no text for `null` as source input", function(){
+    let props = {
+      source: null
+    }
+
+    let el = render(<Markdown {...props}/>)
+
+    expect(el.text()).toEqual("")
+  })
+
+  it("should return no text for `undefined` as source input", function(){
+    let props = {
+      source: undefined
+    }
+
+    let el = render(<Markdown {...props}/>)
+
+    expect(el.text()).toEqual("")
+  })
+
+  it("should return no text for empty string as source input", function(){
+    let props = {
+      source: ""
+    }
+
+    let el = render(<Markdown {...props}/>)
+
+    expect(el.text()).toEqual("")
+  })
+})

webpack-dist-bundle.config.js

@@ -13,7 +13,7 @@ module.exports = require('./make-webpack-config.js')({
 
   entry: {
     'swagger-ui-bundle': [
-      'babel-polyfill',
+      './src/polyfills',
       './src/core/index.js'
     ]
   },

webpack-dist-standalone.config.js

@@ -13,6 +13,7 @@ module.exports = require('./make-webpack-config.js')({
 
   entry: {
     'swagger-ui-standalone-preset': [
+      './src/polyfills',
       './src/standalone/index.js'
     ]
   },

webpack-dist.config.js

@@ -1,9 +1,8 @@
-var path = require('path')
-var fs = require('fs')
-var node_modules = fs.readdirSync('node_modules').filter(function(x) { return x !== '.bin' })
+const path = require("path")
+const fs = require("fs")
+const nodeModules = fs.readdirSync("node_modules").filter(function(x) { return x !== ".bin" })
 
-
-module.exports = require('./make-webpack-config.js')({
+module.exports = require("./make-webpack-config.js")({
   _special: {
     separateStylesheets: true,
     minimize: true,
@@ -15,9 +14,9 @@ module.exports = require('./make-webpack-config.js')({
 
   entry: {
     "swagger-ui": [
-      'babel-polyfill',
-      './src/style/main.scss',
-      './src/core/index.js'
+      "./src/style/main.scss",
+      "./src/polyfills",
+      "./src/core/index.js"
     ]
   },
 
@@ -25,11 +24,11 @@ module.exports = require('./make-webpack-config.js')({
     // webpack injects some stuff into the resulting file,
     // these libs need to be pulled in to keep that working.
     var exceptionsForWebpack = ["ieee754", "base64-js"]
-    if(node_modules.indexOf(request) !== -1 || exceptionsForWebpack.indexOf(request) !== -1) {
-      cb(null, 'commonjs ' + request)
-      return;
+    if(nodeModules.indexOf(request) !== -1 || exceptionsForWebpack.indexOf(request) !== -1) {
+      cb(null, "commonjs " + request)
+      return
     }
-    cb();
+    cb()
   },
 
   output:  {

webpack-hot-dev-server.config.js

@@ -10,12 +10,12 @@ module.exports = require("./make-webpack-config")({
 	devtool: "eval",
   entry: {
     'swagger-ui-bundle': [
-      'webpack/hot/dev-server',
-      'babel-polyfill',
-      './src/core/index.js',
+      './src/polyfills',
+      './src/core/index.js'
     ],
     'swagger-ui-standalone-preset': [
       'webpack/hot/dev-server',
+      './src/polyfills',
       './src/standalone/index.js',
     ]
   },