Path parameters fail to deploy due to incorrect Swagger document.

jthomas · jthomas · commit 31b8d8aab41b · 2019-02-15T17:48:10.000Z
diff --git a/compile/apigw/index.js b/compile/apigw/index.js
@@ -249,6 +249,7 @@ class OpenWhiskCompileHttpEvents {
 
   compileSwaggerPath(httpEvent, host) {
     const operationId = this.operationId(httpEvent)
+    const pathParameters = this.parsePathParameters(httpEvent.relpath)
     const responses = { "200": { description: "A successful invocation response" } }
     const webaction_url = this.webActionUrl(httpEvent, host)
 
@@ -258,7 +259,6 @@ class OpenWhiskCompileHttpEvents {
     }
     
     const swaggerPath = { operationId, responses, "x-openwhisk": x_ow }
-    const pathParameters = this.parsePathParameters(httpEvent.relpath)
 
     if (pathParameters.length) {
       swaggerPath.parameters = pathParameters.map(this.createPathParameter)
@@ -293,7 +293,8 @@ class OpenWhiskCompileHttpEvents {
   }
 
   compileSwaggerCaseSwitch(httpEvent, host) {
-    const webaction_url = this.webActionUrl(httpEvent, host)
+    const pathParameters = this.parsePathParameters(httpEvent.relpath)
+    const webaction_url = this.webActionUrl(httpEvent, host, !!pathParameters.length)
     const operationId = this.operationId(httpEvent)
 
     const header = {
@@ -311,8 +312,10 @@ class OpenWhiskCompileHttpEvents {
     return swaggerCaseSwitch
   }
 
-  webActionUrl(httpEvent, host) {
-    return `https://${host}/api/v1/web/${httpEvent.namespace}/${httpEvent.pkge}/${httpEvent.action}.${httpEvent.responsetype}`
+  webActionUrl(httpEvent, host, has_path_params) {
+    const url = `https://${host}/api/v1/web/${httpEvent.namespace}/${httpEvent.pkge}/${httpEvent.action}.${httpEvent.responsetype}${has_path_params ? '$(request.path)': ''}`
+
+    return url
   }
 
   operationId(httpEvent) {
diff --git a/compile/apigw/tests/index.js b/compile/apigw/tests/index.js
@@ -260,7 +260,7 @@ describe('OpenWhiskCompileHttpEvents', () => {
 
       const httpEvent = {
         relpath: '/api/foo/{id}', operation: 'GET', secure_key: 'auth-token',
-        action: 'action-name', namespace: 'user@host.com_space', pkge: 'default', responsetype: 'json'
+        action: 'action-name', namespace: 'user@host.com_space', pkge: 'default', responsetype: 'http'
       }
 
       const host = 'openwhisk.somewhere.com'
@@ -280,7 +280,7 @@ describe('OpenWhiskCompileHttpEvents', () => {
           action: "action-name",
           namespace: "user@host.com_space",
           package: "default",
-          url: "https://openwhisk.somewhere.com/api/v1/web/user@host.com_space/default/action-name.json"
+          url: "https://openwhisk.somewhere.com/api/v1/web/user@host.com_space/default/action-name.http"
         }
       }
 
@@ -323,6 +323,40 @@ describe('OpenWhiskCompileHttpEvents', () => {
 
       return expect(result).to.deep.equal(expectedResult)
     });
+
+    it('should define swagger case statement from http events with path parameters', () => {
+      openwhiskCompileHttpEvents.serverless.service.service = 'my-service' 
+      openwhiskCompileHttpEvents.serverless.service.provider = {namespace: "sample_ns"};
+
+      const httpEvent = {
+        relpath: '/api/foo/{id}', operation: 'GET', secure_key: 'auth-token',
+        action: 'action-name', namespace: 'user@host.com_space', pkge: 'default', responsetype: 'http'
+      }
+
+      const host = 'openwhisk.somewhere.com'
+      const result = openwhiskCompileHttpEvents.compileSwaggerCaseSwitch(httpEvent, host);
+
+      const expectedResult = {
+        execute: [{
+            "set-variable": {
+              actions: [{
+                  set: "message.headers.X-Require-Whisk-Auth",
+                  value: "auth-token"
+              }]
+            }
+          },
+          {
+            invoke: {
+              "target-url": "https://openwhisk.somewhere.com/api/v1/web/user@host.com_space/default/action-name.http$(request.path)",
+              "verb": "keep"
+            }
+          }
+        ],
+        operations: [ "get-/api/foo/{id}" ]
+      }
+
+      return expect(result).to.deep.equal(expectedResult)
+    });
   });
 
   describe('#generateSwagger()', () => {
diff --git a/deploy/lib/deployApiGw.js b/deploy/lib/deployApiGw.js
@@ -40,7 +40,8 @@ module.exports = {
               const id = operation.operationId
               const stmts = swagger["x-ibm-configuration"].assembly.execute[0]['operation-switch'].case
               const stmt = stmts.find(stmt => stmt.operations[0] === id)
-              stmt.execute[stmt.execute.length -1].invoke['target-url'] = swaggerAction.url
+              const invoke = stmt.execute[stmt.execute.length -1].invoke
+              invoke['target-url'] = invoke['target-url'].replace(/web\/_/, `web/${action.namespace}`)
             }
           }
         }
diff --git a/deploy/tests/deployApiGw.js b/deploy/tests/deployApiGw.js
@@ -71,6 +71,27 @@ describe('deployHttpEvents', () => {
       let result = await openwhiskDeploy.replaceDefaultNamespace(source)
       expect(result).to.be.deep.equal(converted)
     })
+
+    it('should return same swagger doc including path params', async () => {
+      const without_default_ns = fs.readFileSync('./deploy/tests/resources/swagger_ns_paths.json', 'utf-8')
+      const with_default_ns = fs.readFileSync('./deploy/tests/resources/swagger_paths.json', 'utf-8')
+      const source = JSON.parse(with_default_ns)
+      const converted = JSON.parse(without_default_ns)
+
+      const actions = [{"name":"hello","namespace":"user@host.com_dev"}]
+
+      sandbox.stub(openwhiskDeploy.provider, 'client', () => {
+        const list = params => {
+          return Promise.resolve(actions);
+        };
+
+        return Promise.resolve({ actions: { list } });
+      });
+
+      let result = await openwhiskDeploy.replaceDefaultNamespace(source)
+      expect(result).to.be.deep.equal(converted)
+
+  })
   })
 
   /**
diff --git a/deploy/tests/resources/swagger_ns_paths.json b/deploy/tests/resources/swagger_ns_paths.json
@@ -0,0 +1,66 @@
+{
+    "swagger": "2.0",
+    "basePath": "/testing",
+    "info": {
+        "title": "testing",
+        "version": "1.0"
+    },
+    "paths": {
+        "/testing": {
+            "get": {
+                "operationId": "getTesting",
+                "responses": {
+                    "200": {
+                        "description": "A successful invocation response"
+                    }
+                },
+                "x-openwhisk": {
+                    "action": "hello",
+                    "namespace": "user@host.com_dev",
+                    "package": "default",
+                    "url": "https://openwhisk/api/v1/web/user@host.com_dev/default/hello.http"
+                }
+            }
+        }
+    },
+    "x-ibm-configuration": {
+        "assembly": {
+            "execute": [
+                {
+                    "operation-switch": {
+                        "case": [
+                            {
+                                "execute": [
+                                    {
+                                        "set-variable": {
+                                            "actions": [
+                                                {
+                                                    "set": "message.headers.X-Require-Whisk-Auth",
+                                                    "value": "3b08f67e-c7fa-4998-9096-ffa355932a3d"
+                                                }
+                                            ]
+                                        }
+                                    },
+                                    {
+                                        "invoke": {
+                                            "target-url": "https://openwhisk/api/v1/web/user@host.com_dev/default/hello.http$(request.path)",
+                                            "verb": "keep"
+                                        }
+                                    }
+                                ],
+                                "operations": [
+                                    "getTesting"
+                                ]
+                            }
+                        ],
+                        "otherwise": [],
+                        "title": "whisk-invoke"
+                    }
+                }
+            ]
+        },
+        "cors": {
+            "enabled": true
+        }
+    }
+}
diff --git a/deploy/tests/resources/swagger_paths.json b/deploy/tests/resources/swagger_paths.json
@@ -0,0 +1,66 @@
+{
+    "swagger": "2.0",
+    "basePath": "/testing",
+    "info": {
+        "title": "testing",
+        "version": "1.0"
+    },
+    "paths": {
+        "/testing": {
+            "get": {
+                "operationId": "getTesting",
+                "responses": {
+                    "200": {
+                        "description": "A successful invocation response"
+                    }
+                },
+                "x-openwhisk": {
+                    "action": "hello",
+                    "namespace": "_",
+                    "package": "default",
+                    "url": "https://openwhisk/api/v1/web/_/default/hello.http"
+                }
+            }
+        }
+    },
+    "x-ibm-configuration": {
+        "assembly": {
+            "execute": [
+                {
+                    "operation-switch": {
+                        "case": [
+                            {
+                                "execute": [
+                                    {
+                                        "set-variable": {
+                                            "actions": [
+                                                {
+                                                    "set": "message.headers.X-Require-Whisk-Auth",
+                                                    "value": "3b08f67e-c7fa-4998-9096-ffa355932a3d"
+                                                }
+                                            ]
+                                        }
+                                    },
+                                    {
+                                        "invoke": {
+                                            "target-url": "https://openwhisk/api/v1/web/_/default/hello.http$(request.path)",
+                                            "verb": "keep"
+                                        }
+                                    }
+                                ],
+                                "operations": [
+                                    "getTesting"
+                                ]
+                            }
+                        ],
+                        "otherwise": [],
+                        "title": "whisk-invoke"
+                    }
+                }
+            ]
+        },
+        "cors": {
+            "enabled": true
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,8 @@ module.exports = {`
`40`	`40`	`const id = operation.operationId`
`41`	`41`	`const stmts = swagger["x-ibm-configuration"].assembly.execute[0]['operation-switch'].case`
`42`	`42`	`const stmt = stmts.find(stmt => stmt.operations[0] === id)`
`43`		`- stmt.execute[stmt.execute.length -1].invoke['target-url'] = swaggerAction.url`
	`43`	`+ const invoke = stmt.execute[stmt.execute.length -1].invoke`
	`44`	+ invoke['target-url'] = invoke['target-url'].replace(/web\/_/, `web/${action.namespace}`)
`44`	`45`	`}`
`45`	`46`	`}`
`46`	`47`	`}`