feat(openwhisk): add request.pathInfo (#257)

fixes #255
adobe · Apr 16, 2019 · 8485626 · 8485626
1 parent 25af1c3
commit 8485626
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 0 deletions.
diff --git a/docs/request.schema.json b/docs/request.schema.json
diff --git a/docs/request.schema.md b/docs/request.schema.md
diff --git a/src/context.d.ts b/src/context.d.ts
@@ -98,6 +98,14 @@ export interface Request {
    * The path of the client request URL
    */
   path?: string;
+  /**
+   * The part of the client path that is relative to the rootPath
+   */
+  pathInfo?: string;
+  /**
+   * The request root path of the current strain.
+   */
+  rootPath?: string;
   /**
    * The selector (sub-type indicator)
    */

diff --git a/src/schemas/request.schema.json b/src/schemas/request.schema.json
@@ -32,6 +32,20 @@
         "/docs/api/general/index.nav.html"
       ]
     },
+    "pathInfo": {
+      "type": "string",
+      "description": "The part of the client path that is relative to the rootPath",
+      "examples": [
+        "/general/index.nav.html"
+      ]
+    },
+    "rootPath": {
+      "type": "string",
+      "description": "The request root path of the current strain.",
+      "examples": [
+        "/docs/api"
+      ]
+    },
     "selector": {
       "type": "string",
       "description": "The selector (sub-type indicator)",

diff --git a/src/utils/openwhisk.js b/src/utils/openwhisk.js
@@ -51,6 +51,10 @@ function extractClientRequest(action) {
     return {};
   }
   const reqPath = buildPath(request);
+  let pathInfo = reqPath.replace(/\/*$/, '');
+  if (`${pathInfo}/`.startsWith(`${request.params.rootPath}/`)) {
+    pathInfo = pathInfo.substring(request.params.rootPath.length);
+  }
   const query = request.params.params ? `?${request.params.params}` : '';
   return {
     // the edge encodes the client request parameters into the `params` param ;-)
@@ -61,6 +65,8 @@ function extractClientRequest(action) {
     extension: request.params.extension || '',
     selector: request.params.selector || '',
     url: `${reqPath}${query}`,
+    rootPath: request.params.rootPath,
+    pathInfo,
   };
 }
 

diff --git a/test/testOpenwhisk.js b/test/testOpenwhisk.js
@@ -168,6 +168,8 @@ describe('Testing OpenWhisk adapter', () => {
       },
       url: '/api/general/index.html?a=42&b=green',
       path: '/api/general/index.html',
+      rootPath: '/api/general',
+      pathInfo: '/index.html',
       selector: '',
     });
   });
@@ -202,6 +204,8 @@ describe('Testing OpenWhisk adapter', () => {
       params: {},
       url: '/api/general/index.html',
       path: '/api/general/index.html',
+      rootPath: '/api/general',
+      pathInfo: '/index.html',
       selector: '',
     });
   });
@@ -259,6 +263,8 @@ describe('Testing OpenWhisk adapter', () => {
         extension: 'html',
         selector: 'print.preview',
         url: '/docs/test.print.preview.html?a=42&b=green',
+        rootPath: '/docs',
+        pathInfo: '/test.print.preview.html',
       },
     });
   });