fix: type safety for operation summary handling (via swagger-api#5191)

* fix: gracefully handle non-string operation summaries * use lodash for more summary type safety
deepjia · Feb 25, 2019 · fdfa689 · fdfa689
1 parent 8af6d79
commit fdfa689
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/src/core/components/operation-summary.jsx b/src/core/components/operation-summary.jsx
@@ -2,6 +2,7 @@ import React, { PureComponent } from "react"
 import PropTypes from "prop-types"
 import { Iterable, List } from "immutable"
 import ImPropTypes from "react-immutable-proptypes"
+import toString from "lodash/toString"
 
 
 export default class OperationSummary extends PureComponent {
@@ -63,7 +64,7 @@ export default class OperationSummary extends PureComponent {
 
         {!showSummary ? null :
           <div className="opblock-summary-description">
-            {(resolvedSummary || summary).toString()}
+            {toString(resolvedSummary || summary)}
           </div>
         }
 

diff --git a/test/e2e-cypress/static/documents/bugs/5188.yaml b/test/e2e-cypress/static/documents/bugs/5188.yaml
@@ -8,10 +8,17 @@ paths:
   /pet:
     get:
       tags:
-        - pet
+        - default
       summary: 
-        $ref: 
-      operationId: addPet
+        whatever: 123 
+      operationId: objectSummary
+      responses:
+        '405':
+          description: Invalid input
+    post:
+      tags:
+        - default
+      operationId: noSummary
       responses:
         '405':
           description: Invalid input
diff --git a/test/e2e-cypress/tests/bugs/5188.js b/test/e2e-cypress/tests/bugs/5188.js
@@ -2,9 +2,17 @@ describe("#5188: non-string operation summary value", () => {
   it("should gracefully handle an object value for an operation summary", () => {
     cy
       .visit("?url=/documents/bugs/5188.yaml")
-      .get("#operations-pet-addPet")
+      .get("#operations-default-objectSummary")
       .click()
       .get(".opblock-summary-description")
       .contains("[object Object]")
-    })
+  })
+  it("should gracefully handle a missing value for an operation summary", () => {
+    cy
+      .visit("?url=/documents/bugs/5188.yaml")
+      .get("#operations-default-noSummary")
+      .click()
+      // check for response rendering; makes sure the Operation itself rendered
+      .contains("Invalid input")
+  })
 })