Merge pull request #1346 from opencomponents/add-action-route-support

Add support for Actions

.gitignore

@@ -23,7 +23,6 @@ npm-debug.log
 node_modules
 .yarn
 # yarn.lock
-package-lock.json
 
 src/components/oc.json
 src/components/base-component-handlebars/_package

package.json

@@ -104,7 +104,7 @@
     "multer": "1.4.3",
     "nice-cache": "0.0.5",
     "oc-client": "4.0.1",
-    "oc-client-browser": "1.6.6",
+    "oc-client-browser": "1.6.8",
     "oc-empty-response-handler": "1.0.2",
     "oc-get-unix-utc-timestamp": "1.0.6",
     "oc-s3-storage-adapter": "2.1.1",
@@ -128,4 +128,4 @@
     "universalify": "^2.0.0",
     "yargs": "17.7.2"
   }
-}
+}

src/registry/routes/components.ts

@@ -10,6 +10,7 @@ import { Config } from '../../types';
 import { Request, RequestHandler, Response } from 'express';
 
 type Component = {
+  action?: string;
   name: string;
   version: string;
   parameters: Record<string, string>;
@@ -69,6 +70,7 @@ export default function components(
         getComponent(
           {
             conf: res.conf,
+            action: component.action,
             name: component.name,
             headers: req.headers,
             ip: req.ip!,

src/registry/routes/helpers/get-component.ts

@@ -24,6 +24,7 @@ import { IncomingHttpHeaders } from 'http';
 import { fromPromise } from 'universalify';
 
 export interface RendererOptions {
+  action?: string;
   conf: Config;
   headers: IncomingHttpHeaders;
   ip: string;
@@ -191,7 +192,7 @@ export default function getComponent(conf: Config, repository: Repository) {
           component.oc.parameters
         );
 
-        if (!validationResult.isValid) {
+        if (!options.action && !validationResult.isValid) {
           return callback({
             status: 400,
             response: {
@@ -323,13 +324,15 @@ export default function getComponent(conf: Config, repository: Repository) {
           }
 
           const response: {
+            baseUrl: string;
             type: string;
             version: string;
             requestVersion: string;
             name: string;
             renderMode: string;
             href?: string;
           } = {
+            baseUrl: conf.baseUrl,
             type: conf.local ? 'oc-component-local' : 'oc-component',
             version: component.version,
             requestVersion: requestedComponent.version,
@@ -461,6 +464,7 @@ export default function getComponent(conf: Config, repository: Repository) {
             const setEmptyResponse =
               emptyResponseHandler.contextDecorator(returnComponent);
             const contextObj = {
+              action: options.action,
               acceptLanguage: acceptLanguageParser.parse(acceptLanguage!),
               baseUrl: conf.baseUrl,
               env: { ...conf.env, ...env },

test/fixtures/mocked-components/index.js

@@ -13,6 +13,7 @@ module.exports = {
   'timeout-component': require('./timeout'),
   'undefined-component': require('./undefined'),
   'simple-component': require('./simple'),
+  'required-parameter-component': require('./parameters'),
   'response-headers-component': require('./response-headers'),
   'another-response-headers-component': require('./another-response-headers')
 };

test/fixtures/mocked-components/parameters.js

@@ -0,0 +1,35 @@
+'use strict';
+
+module.exports = {
+  package: {
+    name: 'required-parameter-component',
+    version: '1.0.0',
+    oc: {
+      container: false,
+      renderInfo: false,
+      files: {
+        template: {
+          type: 'jade',
+          hashKey: '8c1fbd954f2b0d8cd5cf11c885fed4805225749f',
+          src: 'template.js'
+        },
+        dataProvider: {
+          type: 'node.js',
+          hashKey: '123457',
+          src: 'server.js'
+        }
+      },
+      parameters: {
+        userId: {
+          description: 'The id identifying the user',
+          mandatory: true,
+          type: 'string'
+        }
+      }
+    }
+  },
+  data: '"use strict";module.exports.data = function(ctx, cb){cb(null, {done:true});};',
+  view:
+    'var oc=oc||{};oc.components=oc.components||{},oc.components["8c1fbd954f2b0d8cd5cf11c885fed4805225749f"]' +
+    '=function(){var o=[];return o.push("<div>hello</div>"),o.join("")};'
+};

test/unit/registry-routes-components.js

@@ -2,6 +2,7 @@
 
 const expect = require('chai').expect;
 const sinon = require('sinon');
+const settings = require('../../dist/resources/settings').default;
 
 describe('registry : routes : components', () => {
   const ComponentsRoute =
@@ -41,17 +42,25 @@ describe('registry : routes : components', () => {
     };
   };
 
-  const makeRequest = function (body, cb) {
+  const makeRequest = function (body, headersOrCallback, cb) {
+    let callback = cb;
+    let headers = headersOrCallback;
+
+    if (typeof headersOrCallback === 'function') {
+      callback = headersOrCallback;
+      headers = {};
+    }
+
     componentsRoute(
-      { headers: {}, body: body },
+      { headers, body },
       {
         conf: { baseUrl: 'http://components.com/' },
         status: function (jsonCode) {
           code = jsonCode;
           return {
             json: function (jsonResponse) {
               response = jsonResponse;
-              cb();
+              callback();
             }
           };
         }
@@ -319,4 +328,116 @@ describe('registry : routes : components', () => {
       });
     });
   });
+
+  describe('when getting a component that has custom parameters', () => {
+    before(done => {
+      initialise(mockedComponents['required-parameter-component']);
+      componentsRoute = ComponentsRoute({}, mockedRepository);
+
+      makeRequest(
+        {
+          components: [
+            {
+              name: 'required-parameter-component',
+              version: '1.X.X',
+              parameters: { userId: 'USERID' }
+            }
+          ]
+        },
+        done
+      );
+    });
+
+    const expectedResponse = [
+      {
+        status: 200,
+        response: {
+          name: 'required-parameter-component',
+          type: 'oc-component',
+          requestVersion: '1.X.X',
+          version: '1.0.0'
+        }
+      }
+    ];
+
+    it('should return a 200 response', () => {
+      expect(response[0].response).to.include(expectedResponse[0].response);
+    });
+  });
+
+  describe('when getting a component that has missing required parameters', () => {
+    before(done => {
+      initialise(mockedComponents['required-parameter-component']);
+      componentsRoute = ComponentsRoute({}, mockedRepository);
+
+      makeRequest(
+        {
+          components: [
+            {
+              name: 'required-parameter-component',
+              version: '1.X.X'
+            }
+          ]
+        },
+        done
+      );
+    });
+
+    const expectedResponse = [
+      {
+        status: 400,
+        response: {
+          name: 'required-parameter-component',
+          code: 'NOT_VALID_REQUEST',
+          error: 'Expected mandatory parameters are missing: userId',
+          requestVersion: '1.X.X'
+        }
+      }
+    ];
+
+    it('should return 400 status code', () => {
+      expect(response).to.be.eql(expectedResponse);
+    });
+  });
+
+  describe('when making valid info request for a component action', () => {
+    before(done => {
+      initialise(mockedComponents['required-parameter-component']);
+      componentsRoute = ComponentsRoute({}, mockedRepository);
+
+      makeRequest(
+        {
+          components: [
+            {
+              action: 'someAction',
+              name: 'required-parameter-component',
+              version: '1.X.X'
+            }
+          ]
+        },
+        {
+          accept: settings.registry.acceptUnrenderedHeader
+        },
+        done
+      );
+    });
+
+    const expectedResponse = [
+      {
+        status: 200,
+        response: {
+          href: 'http://components.com/required-parameter-component/1.X.X',
+          name: 'required-parameter-component',
+          type: 'oc-component',
+          requestVersion: '1.X.X',
+          version: '1.0.0',
+          renderMode: 'unrendered'
+        }
+      }
+    ];
+
+    it('should return a 200 response', () => {
+      expect(response[0].response).to.include(expectedResponse[0].response);
+    });
+  });
 });