@shopgate/pwa-core 7.30.0-alpha.6 → 7.30.0-alpha.8

package/classes/AppCommand/index.js

@@ -1,33 +1,137 @@
-import _regeneratorRuntime from"@babel/runtime/regenerator";function asyncGeneratorStep(gen,resolve,reject,_next,_throw,key,arg){try{var info=gen[key](arg);var value=info.value;}catch(error){reject(error);return;}if(info.done){resolve(value);}else{Promise.resolve(value).then(_next,_throw);}}function _asyncToGenerator(fn){return function(){var self=this,args=arguments;return new Promise(function(resolve,reject){var gen=fn.apply(self,args);function _next(value){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"next",value);}function _throw(err){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"throw",err);}_next(undefined);});};}function _extends(){_extends=Object.assign||function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source){if(Object.prototype.hasOwnProperty.call(source,key)){target[key]=source[key];}}}return target;};return _extends.apply(this,arguments);}function _typeof(obj){if(typeof Symbol==="function"&&typeof Symbol.iterator==="symbol"){_typeof=function _typeof(obj){return typeof obj;};}else{_typeof=function _typeof(obj){return obj&&typeof Symbol==="function"&&obj.constructor===Symbol&&obj!==Symbol.prototype?"symbol":typeof obj;};}return _typeof(obj);}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);return Constructor;}import{logger,hasSGJavaScriptBridge}from"../../helpers";import{isValidVersion,getLibVersion,isVersionAtLeast}from"../../helpers/version";import logGroup from"../../helpers/logGroup";import*as appCommands from"../../constants/AppCommands";import Bridge from"../Bridge";/**
+import { logger, hasSGJavaScriptBridge } from "../../helpers";
+import { isValidVersion, getLibVersion, isVersionAtLeast } from "../../helpers/version";
+import logGroup from "../../helpers/logGroup";
+import * as appCommands from "../../constants/AppCommands";
+import Bridge from "../Bridge";
+
+/**
  * The app command class.
- */var AppCommand=/*#__PURE__*/function(){/**
+ */
+class AppCommand {
+  /**
    * @param {boolean} log Whether the command will be logged.
    * @param {boolean} checkLibVersion Whether the lib version will be checked before dispatch.
-   */function AppCommand(){var log=arguments.length>0&&arguments[0]!==undefined?arguments[0]:true;var checkLibVersion=arguments.length>1&&arguments[1]!==undefined?arguments[1]:hasSGJavaScriptBridge();_classCallCheck(this,AppCommand);this.log=log;this.checkLibVersion=checkLibVersion;this.name='';this.params=null;this.libVersion='9.0';this.commandsWithoutLog=[appCommands.COMMAND_SEND_PIPELINE_REQUEST,appCommands.COMMAND_SEND_HTTP_REQUEST,appCommands.COMMAND_GET_WEBSTORAGE_ENTRY];}/**
+   */
+  constructor(log = true, checkLibVersion = hasSGJavaScriptBridge()) {
+    this.log = log;
+    this.checkLibVersion = checkLibVersion;
+    this.name = '';
+    this.params = null;
+    this.libVersion = '9.0';
+    this.commandsWithoutLog = [appCommands.COMMAND_SEND_PIPELINE_REQUEST, appCommands.COMMAND_SEND_HTTP_REQUEST, appCommands.COMMAND_GET_WEBSTORAGE_ENTRY];
+  }
+
+  /**
    * Sets the command name.
    * @param {string} name The command name.
    * @return {AppCommand}
-   */return _createClass(AppCommand,[{key:"setCommandName",value:function setCommandName(name){if(typeof name==='string'){this.name=name;}else{logger.error('Invalid command name',name);}return this;}/**
+   */
+  setCommandName(name) {
+    if (typeof name === 'string') {
+      this.name = name;
+    } else {
+      logger.error('Invalid command name', name);
+    }
+    return this;
+  }
+
+  /**
    * Sets the command params.
    * @param {Object} [params=null] The command params.
    * @return {AppCommand}
-   */},{key:"setCommandParams",value:function setCommandParams(params){if(params&&_typeof(params)==='object'&&params.constructor===Object){this.params=params;}else{logger.error('Invalid command params',params);}return this;}/**
+   */
+  setCommandParams(params) {
+    if (params && typeof params === 'object' && params.constructor === Object) {
+      this.params = params;
+    } else {
+      logger.error('Invalid command params', params);
+    }
+    return this;
+  }
+
+  /**
    * Sets the minimum required shopgate lib version for the command.
    * @param {string} libVersion The library version.
    * @return {AppCommand}
-   */},{key:"setLibVersion",value:function setLibVersion(libVersion){if(isValidVersion(libVersion)){this.libVersion=libVersion;}else{logger.error('Invalid lib version',libVersion);}return this;}/**
+   */
+  setLibVersion(libVersion) {
+    if (isValidVersion(libVersion)) {
+      this.libVersion = libVersion;
+    } else {
+      logger.error('Invalid lib version', libVersion);
+    }
+    return this;
+  }
+
+  /**
    * Logs the command to the console.
    * @private
    * @return {AppCommand}
-   */},{key:"logCommand",value:function logCommand(){if(this.log&&!this.commandsWithoutLog.includes(this.name)){var title="AppCommand %c".concat(this.name);logGroup(title,this.params||{},'#8e44ad');}return this;}/**
+   */
+  logCommand() {
+    if (this.log && !this.commandsWithoutLog.includes(this.name)) {
+      const title = `AppCommand %c${this.name}`;
+      logGroup(title, this.params || {}, '#8e44ad');
+    }
+    return this;
+  }
+
+  /**
    * Creates the command object which will be dispatched through the JavaScript bridge.
    * @return {Object|null}
-   */},{key:"buildCommand",value:function buildCommand(){var command=this.name?_extends({c:this.name},this.params&&{p:this.params}):null;return command;}/**
+   */
+  buildCommand() {
+    const command = this.name ? {
+      c: this.name,
+      ...(this.params && {
+        p: this.params
+      })
+    } : null;
+    return command;
+  }
+
+  /**
    * Dispatches the command to the app.
    * The returned promise will not be rejected for now in error cases to avoid the necessity
    * of refactoring within existing code. But it resolves with FALSE in those cases.
    * @param {Object} [params] The command params.
    * @return {Promise<boolean>}
-   */},{key:"dispatch",value:function(){var _dispatch=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(params){var command,appLibVersion,appHasSupport,bridge;return _regeneratorRuntime.wrap(function _callee$(_context){while(1)switch(_context.prev=_context.next){case 0:if(params){this.setCommandParams(params);}command=this.buildCommand();// Only proceed if the command is valid.
-if(!(command===null)){_context.next=5;break;}logger.error("Dispatch aborted for invalid command. name: \"".concat(this.name,"\" | params:"),this.params);return _context.abrupt("return",false);case 5:appLibVersion=this.libVersion;appHasSupport=true;// Perform a libVersion check if the flag is active.
-if(!this.checkLibVersion){_context.next=12;break;}_context.next=10;return getLibVersion();case 10:appLibVersion=_context.sent;appHasSupport=isVersionAtLeast(this.libVersion,appLibVersion);case 12:if(appHasSupport){_context.next=15;break;}logger.warn("The command \"".concat(this.name,"\" is not supported by LibVersion (required ").concat(this.libVersion," | current ").concat(appLibVersion,")"));return _context.abrupt("return",false);case 15:bridge=new Bridge();_context.prev=16;bridge.dispatchCommand(command,appLibVersion);this.logCommand();_context.next=25;break;case 21:_context.prev=21;_context.t0=_context["catch"](16);logger.error(_context.t0);return _context.abrupt("return",false);case 25:return _context.abrupt("return",true);case 26:case"end":return _context.stop();}},_callee,this,[[16,21]]);}));function dispatch(_x){return _dispatch.apply(this,arguments);}return dispatch;}()}]);}();export default AppCommand;
+   */
+  async dispatch(params) {
+    if (params) {
+      this.setCommandParams(params);
+    }
+    const command = this.buildCommand();
+
+    // Only proceed if the command is valid.
+    if (command === null) {
+      logger.error(`Dispatch aborted for invalid command. name: "${this.name}" | params:`, this.params);
+      return false;
+    }
+    let appLibVersion = this.libVersion;
+    let appHasSupport = true;
+
+    // Perform a libVersion check if the flag is active.
+    if (this.checkLibVersion) {
+      // Gather the libVersion of the app and check if it supports the command.
+      appLibVersion = await getLibVersion();
+      appHasSupport = isVersionAtLeast(this.libVersion, appLibVersion);
+    }
+
+    // Only proceed if the command is supported by the app.
+    if (!appHasSupport) {
+      logger.warn(`The command "${this.name}" is not supported by LibVersion (required ${this.libVersion} | current ${appLibVersion})`);
+      return false;
+    }
+    const bridge = new Bridge();
+    try {
+      bridge.dispatchCommand(command, appLibVersion);
+      this.logCommand();
+    } catch (exception) {
+      logger.error(exception);
+      return false;
+    }
+    return true;
+  }
+}
+export default AppCommand;

package/classes/AppCommand/spec.js

@@ -1,8 +1,262 @@
-import _regeneratorRuntime from"@babel/runtime/regenerator";function asyncGeneratorStep(gen,resolve,reject,_next,_throw,key,arg){try{var info=gen[key](arg);var value=info.value;}catch(error){reject(error);return;}if(info.done){resolve(value);}else{Promise.resolve(value).then(_next,_throw);}}function _asyncToGenerator(fn){return function(){var self=this,args=arguments;return new Promise(function(resolve,reject){var gen=fn.apply(self,args);function _next(value){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"next",value);}function _throw(err){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"throw",err);}_next(undefined);});};}import{hasSGJavaScriptBridge}from"../../helpers";import{defaultClientInformation}from"../../helpers/version";import AppCommand from"./index";jest.unmock("./index.js");// Mocks for the logger.
-var mockedLoggerError=jest.fn();var mockedLoggerWarn=jest.fn();jest.mock("../../helpers",function(){return{logger:{error:function error(){mockedLoggerError.apply(void 0,arguments);},warn:function warn(){mockedLoggerWarn.apply(void 0,arguments);},log:function log(){}},hasSGJavaScriptBridge:jest.fn().mockReturnValue(false),useBrowserConnector:function useBrowserConnector(){return false;}};});var mockedLogGroup=jest.fn();// eslint-disable-next-line extra-rules/potential-point-free
-jest.mock("../../helpers/logGroup",function(){return function logGroup(){mockedLogGroup.apply(void 0,arguments);};});// Mock of the DevServer bridge.
-var mockedBridgeDispatch=jest.fn();jest.mock("../DevServerBridge",function(){return function(){return{dispatchCommandsForVersion:mockedBridgeDispatch};};});// Mock of the client information web storage.
-var mockedClientInformation=null;jest.mock("../../commands/getWebStorageEntry",function(){return jest.fn().mockImplementation(function(){return{then:function then(cb){cb({value:mockedClientInformation});}};});});var defaultLibVersion=defaultClientInformation.libVersion;/**
+import { hasSGJavaScriptBridge } from "../../helpers";
+import { defaultClientInformation } from "../../helpers/version";
+import AppCommand from "./index";
+jest.unmock("./index.js");
+
+// Mocks for the logger.
+const mockedLoggerError = jest.fn();
+const mockedLoggerWarn = jest.fn();
+jest.mock("../../helpers", () => ({
+  logger: {
+    error: (...args) => {
+      mockedLoggerError(...args);
+    },
+    warn: (...args) => {
+      mockedLoggerWarn(...args);
+    },
+    log: () => {}
+  },
+  hasSGJavaScriptBridge: jest.fn().mockReturnValue(false),
+  useBrowserConnector: () => false
+}));
+const mockedLogGroup = jest.fn();
+// eslint-disable-next-line extra-rules/potential-point-free
+jest.mock("../../helpers/logGroup", () => function logGroup(...args) {
+  mockedLogGroup(...args);
+});
+let mockedBridgeDispatch = jest.fn();
+
+/* eslint-disable require-jsdoc, class-methods-use-this */
+jest.mock("../DevServerBridge", () => {
+  class DevServerBridge {
+    dispatchCommandsForVersion(...args) {
+      return mockedBridgeDispatch(...args);
+    }
+  }
+  return {
+    __esModule: true,
+    default: DevServerBridge
+  };
+});
+/* eslint-enable require-jsdoc, class-methods-use-this */
+
+// Mock of the client information web storage.
+let mockedClientInformation = null;
+jest.mock("../../commands/getWebStorageEntry", () => jest.fn().mockImplementation(() => ({
+  then(cb) {
+    cb({
+      value: mockedClientInformation
+    });
+  }
+})));
+const defaultLibVersion = defaultClientInformation.libVersion;
+
+/**
  * Updates the mocked client information.
  * @param {string} libVersion The libVersion.
- */var setClientInformation=function setClientInformation(){var libVersion=arguments.length>0&&arguments[0]!==undefined?arguments[0]:defaultLibVersion;mockedClientInformation={libVersion:libVersion};};describe('AppCommand',function(){var instance;beforeEach(function(){setClientInformation();mockedLoggerError.mockClear();mockedLoggerWarn.mockClear();mockedLogGroup.mockClear();mockedBridgeDispatch.mockClear();instance=new AppCommand(true,true);});describe('.constructor()',function(){it('should construct as expected without parameters',function(){instance=new AppCommand();expect(instance.log).toBe(true);expect(instance.checkLibVersion).toBe(false);});it('should construct as expected when the SGJavaScriptBridge was detected',function(){hasSGJavaScriptBridge.mockReturnValueOnce(true);instance=new AppCommand();expect(instance.log).toBe(true);expect(instance.checkLibVersion).toBe(true);});it('should construct as expected when log parameter is false',function(){instance=new AppCommand(false,true);expect(instance.log).toBe(false);expect(instance.checkLibVersion).toBe(true);});});describe('.setCommandName()',function(){it('should set a valid value',function(){var value='sendPipelineRequest';var command=instance.setCommandName(value);expect(command).toEqual(instance);expect(command.name).toEqual(value);});it('should not set an invalid value',function(){var initial=instance.name;var command=instance.setCommandName(17.3);expect(command).toEqual(instance);expect(command.name).toEqual(initial);expect(mockedLoggerError).toHaveBeenCalledTimes(1);});});describe('.setCommandParams()',function(){it('should set a valid value',function(){var value={paramOne:'foo',paramTwo:1337};var command=instance.setCommandParams(value);expect(command).toEqual(instance);expect(command.params).toEqual(value);});it('should not set an invalid value',function(){var initial=instance.params;var command=instance.setCommandParams('sendPipelineRequest');expect(command).toEqual(instance);expect(command.params).toEqual(initial);expect(mockedLoggerError).toHaveBeenCalledTimes(1);});});describe('.setLibVersion()',function(){it('should set a valid value',function(){var value='17.2';var command=instance.setLibVersion(value);expect(command).toEqual(instance);expect(command.libVersion).toEqual(value);});it('should not set an invalid value',function(){var initial=instance.libVersion;var command=instance.setLibVersion('sendPipelineRequest');expect(command).toEqual(instance);expect(command.libVersion).toEqual(initial);expect(mockedLoggerError).toHaveBeenCalledTimes(1);});});describe('.logCommand',function(){it('should log a command',function(){instance.setCommandName('openPage');var command=instance.logCommand();expect(command).toEqual(instance);expect(mockedLogGroup).toHaveBeenCalledTimes(1);});it('should not log a command when logging is turned off',function(){instance=new AppCommand(false);instance.setCommandName('openPage');var command=instance.logCommand();expect(command).toEqual(instance);expect(mockedLogGroup).toHaveBeenCalledTimes(0);});it('should not log a command when it is blacklisted',function(){instance.setCommandName('sendPipelineRequest');var command=instance.logCommand();expect(command).toEqual(instance);expect(mockedLogGroup).toHaveBeenCalledTimes(0);});});describe('.buildCommand()',function(){it('should build a command when name and params are set',function(){var name='sendPipelineRequest';var params={paramOne:'foo',paramTwo:1337};var expected={c:name,p:params};instance.setCommandName(name);instance.setCommandParams(params);var result=instance.buildCommand();expect(result).toEqual(expected);});it('should build a command when only the name is set',function(){var name='sendPipelineRequest';var expected={c:name};instance.setCommandName(name);var result=instance.buildCommand();expect(result).toEqual(expected);});it('should not build a command when no name is set',function(){var params={paramOne:'foo',paramTwo:1337};instance.setCommandParams(params);var result=instance.buildCommand();expect(result).toEqual(null);});});describe('.dispatch()',function(){it('should dispatch as expected',/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(){var name,result;return _regeneratorRuntime.wrap(function _callee$(_context){while(1)switch(_context.prev=_context.next){case 0:name='sendPipelineRequest';instance.setCommandName(name);_context.next=4;return instance.dispatch();case 4:result=_context.sent;expect(result).toBe(true);expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);expect(mockedBridgeDispatch.mock.calls[0][0][0].c).toBe(name);expect(mockedBridgeDispatch.mock.calls[0][1]).toBe(defaultLibVersion);expect(mockedLoggerError).toHaveBeenCalledTimes(0);expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);case 11:case"end":return _context.stop();}},_callee);})));it('should set the params if passed to dispatch',/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2(){var params,result;return _regeneratorRuntime.wrap(function _callee2$(_context2){while(1)switch(_context2.prev=_context2.next){case 0:params={paramOne:'foo',paramTwo:1337};instance.setCommandName('sendPipelineRequest');_context2.next=4;return instance.dispatch(params);case 4:result=_context2.sent;expect(result).toBe(true);expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);expect(mockedBridgeDispatch.mock.calls[0][0][0].p).toEqual(params);expect(mockedLoggerError).toHaveBeenCalledTimes(0);expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);case 10:case"end":return _context2.stop();}},_callee2);})));it('should not dispatch when no command was set up',/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee3(){var result;return _regeneratorRuntime.wrap(function _callee3$(_context3){while(1)switch(_context3.prev=_context3.next){case 0:_context3.next=2;return instance.dispatch();case 2:result=_context3.sent;expect(result).toBe(false);expect(mockedBridgeDispatch).toHaveBeenCalledTimes(0);expect(mockedLoggerError).toHaveBeenCalledTimes(1);expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);case 7:case"end":return _context3.stop();}},_callee3);})));it('should not dispatch when the command is not supported by the app',/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee4(){var libVersion,result;return _regeneratorRuntime.wrap(function _callee4$(_context4){while(1)switch(_context4.prev=_context4.next){case 0:libVersion=(Number.parseFloat(defaultLibVersion)+1).toFixed(1);instance.setCommandName('sendPipelineRequest');instance.setLibVersion(libVersion);_context4.next=5;return instance.dispatch();case 5:result=_context4.sent;expect(result).toBe(false);expect(mockedBridgeDispatch).toHaveBeenCalledTimes(0);expect(mockedLoggerError).toHaveBeenCalledTimes(0);expect(mockedLoggerWarn).toHaveBeenCalledTimes(1);case 10:case"end":return _context4.stop();}},_callee4);})));it('should dispatch when the command is not supported by the app but the check is off',/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee5(){var libVersion,result;return _regeneratorRuntime.wrap(function _callee5$(_context5){while(1)switch(_context5.prev=_context5.next){case 0:libVersion=(Number.parseFloat(defaultLibVersion)+1).toFixed(1);instance=new AppCommand(true,false);instance.setCommandName('sendPipelineRequest');instance.setLibVersion(libVersion);_context5.next=6;return instance.dispatch();case 6:result=_context5.sent;expect(result).toBe(true);expect(mockedBridgeDispatch.mock.calls[0][1]).toBe(libVersion);expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);expect(mockedLoggerError).toHaveBeenCalledTimes(0);expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);case 12:case"end":return _context5.stop();}},_callee5);})));it('should handle errors during bridge dispatch',/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee6(){var name,result;return _regeneratorRuntime.wrap(function _callee6$(_context6){while(1)switch(_context6.prev=_context6.next){case 0:mockedBridgeDispatch=jest.fn().mockImplementation(function(){throw new Error();});name='sendPipelineRequest';instance.setCommandName(name);_context6.next=5;return instance.dispatch();case 5:result=_context6.sent;expect(result).toBe(false);expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);expect(mockedLoggerError).toHaveBeenCalledTimes(1);expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);case 10:case"end":return _context6.stop();}},_callee6);})));});});
+ */
+const setClientInformation = (libVersion = defaultLibVersion) => {
+  mockedClientInformation = {
+    libVersion
+  };
+};
+describe('AppCommand', () => {
+  let instance;
+  beforeEach(() => {
+    setClientInformation();
+    mockedLoggerError.mockClear();
+    mockedLoggerWarn.mockClear();
+    mockedLogGroup.mockClear();
+    mockedBridgeDispatch.mockClear();
+    instance = new AppCommand(true, true);
+  });
+  describe('.constructor()', () => {
+    it('should construct as expected without parameters', () => {
+      instance = new AppCommand();
+      expect(instance.log).toBe(true);
+      expect(instance.checkLibVersion).toBe(false);
+    });
+    it('should construct as expected when the SGJavaScriptBridge was detected', () => {
+      hasSGJavaScriptBridge.mockReturnValueOnce(true);
+      instance = new AppCommand();
+      expect(instance.log).toBe(true);
+      expect(instance.checkLibVersion).toBe(true);
+    });
+    it('should construct as expected when log parameter is false', () => {
+      instance = new AppCommand(false, true);
+      expect(instance.log).toBe(false);
+      expect(instance.checkLibVersion).toBe(true);
+    });
+  });
+  describe('.setCommandName()', () => {
+    it('should set a valid value', () => {
+      const value = 'sendPipelineRequest';
+      const command = instance.setCommandName(value);
+      expect(command).toEqual(instance);
+      expect(command.name).toEqual(value);
+    });
+    it('should not set an invalid value', () => {
+      const initial = instance.name;
+      const command = instance.setCommandName(17.3);
+      expect(command).toEqual(instance);
+      expect(command.name).toEqual(initial);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(1);
+    });
+  });
+  describe('.setCommandParams()', () => {
+    it('should set a valid value', () => {
+      const value = {
+        paramOne: 'foo',
+        paramTwo: 1337
+      };
+      const command = instance.setCommandParams(value);
+      expect(command).toEqual(instance);
+      expect(command.params).toEqual(value);
+    });
+    it('should not set an invalid value', () => {
+      const initial = instance.params;
+      const command = instance.setCommandParams('sendPipelineRequest');
+      expect(command).toEqual(instance);
+      expect(command.params).toEqual(initial);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(1);
+    });
+  });
+  describe('.setLibVersion()', () => {
+    it('should set a valid value', () => {
+      const value = '17.2';
+      const command = instance.setLibVersion(value);
+      expect(command).toEqual(instance);
+      expect(command.libVersion).toEqual(value);
+    });
+    it('should not set an invalid value', () => {
+      const initial = instance.libVersion;
+      const command = instance.setLibVersion('sendPipelineRequest');
+      expect(command).toEqual(instance);
+      expect(command.libVersion).toEqual(initial);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(1);
+    });
+  });
+  describe('.logCommand', () => {
+    it('should log a command', () => {
+      instance.setCommandName('openPage');
+      const command = instance.logCommand();
+      expect(command).toEqual(instance);
+      expect(mockedLogGroup).toHaveBeenCalledTimes(1);
+    });
+    it('should not log a command when logging is turned off', () => {
+      instance = new AppCommand(false);
+      instance.setCommandName('openPage');
+      const command = instance.logCommand();
+      expect(command).toEqual(instance);
+      expect(mockedLogGroup).toHaveBeenCalledTimes(0);
+    });
+    it('should not log a command when it is blacklisted', () => {
+      instance.setCommandName('sendPipelineRequest');
+      const command = instance.logCommand();
+      expect(command).toEqual(instance);
+      expect(mockedLogGroup).toHaveBeenCalledTimes(0);
+    });
+  });
+  describe('.buildCommand()', () => {
+    it('should build a command when name and params are set', () => {
+      const name = 'sendPipelineRequest';
+      const params = {
+        paramOne: 'foo',
+        paramTwo: 1337
+      };
+      const expected = {
+        c: name,
+        p: params
+      };
+      instance.setCommandName(name);
+      instance.setCommandParams(params);
+      const result = instance.buildCommand();
+      expect(result).toEqual(expected);
+    });
+    it('should build a command when only the name is set', () => {
+      const name = 'sendPipelineRequest';
+      const expected = {
+        c: name
+      };
+      instance.setCommandName(name);
+      const result = instance.buildCommand();
+      expect(result).toEqual(expected);
+    });
+    it('should not build a command when no name is set', () => {
+      const params = {
+        paramOne: 'foo',
+        paramTwo: 1337
+      };
+      instance.setCommandParams(params);
+      const result = instance.buildCommand();
+      expect(result).toEqual(null);
+    });
+  });
+  describe('.dispatch()', () => {
+    it('should dispatch as expected', async () => {
+      const name = 'sendPipelineRequest';
+      instance.setCommandName(name);
+      const result = await instance.dispatch();
+      expect(result).toBe(true);
+      expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);
+      expect(mockedBridgeDispatch.mock.calls[0][0][0].c).toBe(name);
+      expect(mockedBridgeDispatch.mock.calls[0][1]).toBe(defaultLibVersion);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(0);
+      expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);
+    });
+    it('should set the params if passed to dispatch', async () => {
+      const params = {
+        paramOne: 'foo',
+        paramTwo: 1337
+      };
+      instance.setCommandName('sendPipelineRequest');
+      const result = await instance.dispatch(params);
+      expect(result).toBe(true);
+      expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);
+      expect(mockedBridgeDispatch.mock.calls[0][0][0].p).toEqual(params);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(0);
+      expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);
+    });
+    it('should not dispatch when no command was set up', async () => {
+      const result = await instance.dispatch();
+      expect(result).toBe(false);
+      expect(mockedBridgeDispatch).toHaveBeenCalledTimes(0);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(1);
+      expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);
+    });
+    it('should not dispatch when the command is not supported by the app', async () => {
+      const libVersion = (Number.parseFloat(defaultLibVersion) + 1).toFixed(1);
+      instance.setCommandName('sendPipelineRequest');
+      instance.setLibVersion(libVersion);
+      const result = await instance.dispatch();
+      expect(result).toBe(false);
+      expect(mockedBridgeDispatch).toHaveBeenCalledTimes(0);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(0);
+      expect(mockedLoggerWarn).toHaveBeenCalledTimes(1);
+    });
+    it('should dispatch when the command is not supported by the app but the check is off', async () => {
+      const libVersion = (Number.parseFloat(defaultLibVersion) + 1).toFixed(1);
+      instance = new AppCommand(true, false);
+      instance.setCommandName('sendPipelineRequest');
+      instance.setLibVersion(libVersion);
+      const result = await instance.dispatch();
+      expect(result).toBe(true);
+      expect(mockedBridgeDispatch.mock.calls[0][1]).toBe(libVersion);
+      expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(0);
+      expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);
+    });
+    it('should handle errors during bridge dispatch', async () => {
+      mockedBridgeDispatch = jest.fn().mockImplementation(() => {
+        throw new Error();
+      });
+      const name = 'sendPipelineRequest';
+      instance.setCommandName(name);
+      const result = await instance.dispatch();
+      expect(result).toBe(false);
+      expect(mockedBridgeDispatch).toHaveBeenCalledTimes(1);
+      expect(mockedLoggerError).toHaveBeenCalledTimes(1);
+      expect(mockedLoggerWarn).toHaveBeenCalledTimes(0);
+    });
+  });
+});

package/classes/AppCommandRequest/index.js

@@ -1,47 +1,105 @@
-import _regeneratorRuntime from"@babel/runtime/regenerator";function _typeof(obj){if(typeof Symbol==="function"&&typeof Symbol.iterator==="symbol"){_typeof=function _typeof(obj){return typeof obj;};}else{_typeof=function _typeof(obj){return obj&&typeof Symbol==="function"&&obj.constructor===Symbol&&obj!==Symbol.prototype?"symbol":typeof obj;};}return _typeof(obj);}function _extends(){_extends=Object.assign||function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source){if(Object.prototype.hasOwnProperty.call(source,key)){target[key]=source[key];}}}return target;};return _extends.apply(this,arguments);}function asyncGeneratorStep(gen,resolve,reject,_next,_throw,key,arg){try{var info=gen[key](arg);var value=info.value;}catch(error){reject(error);return;}if(info.done){resolve(value);}else{Promise.resolve(value).then(_next,_throw);}}function _asyncToGenerator(fn){return function(){var self=this,args=arguments;return new Promise(function(resolve,reject){var gen=fn.apply(self,args);function _next(value){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"next",value);}function _throw(err){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"throw",err);}_next(undefined);});};}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);return Constructor;}function _callSuper(_this,derived,args){function isNativeReflectConstruct(){if(typeof Reflect==="undefined"||!Reflect.construct)return false;if(Reflect.construct.sham)return false;if(typeof Proxy==="function")return true;try{return!Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){}));}catch(e){return false;}}derived=_getPrototypeOf(derived);return _possibleConstructorReturn(_this,isNativeReflectConstruct()?Reflect.construct(derived,args||[],_getPrototypeOf(_this).constructor):derived.apply(_this,args));}function _possibleConstructorReturn(self,call){if(call&&(_typeof(call)==="object"||typeof call==="function")){return call;}return _assertThisInitialized(self);}function _assertThisInitialized(self){if(self===void 0){throw new ReferenceError("this hasn't been initialised - super() hasn't been called");}return self;}function _getPrototypeOf(o){_getPrototypeOf=Object.setPrototypeOf?Object.getPrototypeOf:function _getPrototypeOf(o){return o.__proto__||Object.getPrototypeOf(o);};return _getPrototypeOf(o);}function _inherits(subClass,superClass){if(typeof superClass!=="function"&&superClass!==null){throw new TypeError("Super expression must either be null or a function");}subClass.prototype=Object.create(superClass&&superClass.prototype,{constructor:{value:subClass,writable:true,configurable:true}});if(superClass)_setPrototypeOf(subClass,superClass);}function _setPrototypeOf(o,p){_setPrototypeOf=Object.setPrototypeOf||function _setPrototypeOf(o,p){o.__proto__=p;return o;};return _setPrototypeOf(o,p);}/* eslint-disable class-methods-use-this */import Request from"../Request";import AppCommand from"../AppCommand";import event from"../Event";import requestBuffer from"../RequestBuffer";import{logger}from"../../helpers";import logGroup from"../../helpers/logGroup";var DEFAULT_LIB_VERSION='25.0';/**
+/* eslint-disable class-methods-use-this */
+import Request from "../Request";
+import AppCommand from "../AppCommand";
+import event from "../Event";
+import requestBuffer from "../RequestBuffer";
+import { logger } from "../../helpers";
+import logGroup from "../../helpers/logGroup";
+const DEFAULT_LIB_VERSION = '25.0';
+
+/**
  * The AppCommandRequest class is the base class to implement request like app commands that have a
  * corresponding app event that delivers response data.
  * It contains the logic which in necessary to establish the process of sending an
  * app command and receiving an associated event.
- */var AppCommandRequest=/*#__PURE__*/function(_Request){/**
+ */
+class AppCommandRequest extends Request {
+  /**
    * The constructor.
    * @param {string} commandName The name of the command which is dispatched to the app.
    * @param {string} eventName The event name which is called by the app to deliver the data.
-   */function AppCommandRequest(commandName,eventName){var _this2;_classCallCheck(this,AppCommandRequest);_this2=_callSuper(this,AppCommandRequest);_this2.commandName=commandName;_this2.eventName=eventName||"".concat(commandName,"Response");_this2.commandParams=null;_this2.libVersion=DEFAULT_LIB_VERSION;_this2.logColor='#9a9800';event.registerEvent(_this2.eventName);_this2.createSerial(_this2.commandName);_this2.createEventCallbackName(_this2.eventName);return _this2;}/**
+   */
+  constructor(commandName, eventName) {
+    super();
+    this.commandName = commandName;
+    this.eventName = eventName || `${commandName}Response`;
+    this.commandParams = null;
+    this.libVersion = DEFAULT_LIB_VERSION;
+    this.logColor = '#9a9800';
+    event.registerEvent(this.eventName);
+    this.createSerial(this.commandName);
+    this.createEventCallbackName(this.eventName);
+  }
+
+  /**
    * Sets the parameters for the app command.
    * @param {Object} [commandParams=null] The parameters.
    * @return {AppCommandRequest}
-   */_inherits(AppCommandRequest,_Request);return _createClass(AppCommandRequest,[{key:"setCommandParams",value:function setCommandParams(){var commandParams=arguments.length>0&&arguments[0]!==undefined?arguments[0]:null;this.commandParams=commandParams;return this;}/**
+   */
+  setCommandParams(commandParams = null) {
+    this.commandParams = commandParams;
+    return this;
+  }
+
+  /**
    * Sets the minimum lib version for the app command.
    * @param {string} [libVersion="25.0"] The lib version.
    * @return {AppCommandRequest}
-   */},{key:"setLibVersion",value:function setLibVersion(){var libVersion=arguments.length>0&&arguments[0]!==undefined?arguments[0]:DEFAULT_LIB_VERSION;this.libVersion=libVersion;return this;}/**
+   */
+  setLibVersion(libVersion = DEFAULT_LIB_VERSION) {
+    this.libVersion = libVersion;
+    return this;
+  }
+
+  /**
    * Cleans up the instance after a successful or failed request.
    * @private
    * @param {Function} requestCallback The event callback that processes the response.
    * @return {AppCommandRequest}
-   */},{key:"cleanUpRequest",value:function cleanUpRequest(requestCallback){// Remove the event listener entry.
-event.removeCallback(this.getEventCallbackName(),requestCallback);// Remove the request from the buffer.
-requestBuffer.remove(this.serial);return this;}/**
+   */
+  cleanUpRequest(requestCallback) {
+    // Remove the event listener entry.
+    event.removeCallback(this.getEventCallbackName(), requestCallback);
+    // Remove the request from the buffer.
+    requestBuffer.remove(this.serial);
+    return this;
+  }
+
+  /**
    * Validates the command params before dispatch.
    *
    * This method is supposed to be overwritten by an inheriting class. It's invoked with the
    * currently configured command params object.
    * @param {Object} commandParams The params of the command to be dispatched
    * @return {boolean}
-   */},{key:"validateCommandParams",value:function validateCommandParams(){return true;}/**
+   */
+  validateCommandParams() {
+    return true;
+  }
+
+  /**
    * Creates a title for the app command request log.
    *
    * This method is supposed to be overwritten by an inheriting class to enable customization of
    * log output.
    * @returns {string}
-   */},{key:"getRequestLogTitle",value:function getRequestLogTitle(){return"AppCommandRequest %c".concat(this.commandName);}/**
+   */
+  getRequestLogTitle() {
+    return `AppCommandRequest %c${this.commandName}`;
+  }
+
+  /**
    * Creates a title for the app command response log.
    *
    * This method is supposed to be overwritten by an inheriting class to enable customization of
    * log output.
    * @returns {string}
-   */},{key:"getResponseLogTitle",value:function getResponseLogTitle(){return"AppCommandResponse %c".concat(this.commandName);}/**
+   */
+  getResponseLogTitle() {
+    return `AppCommandResponse %c${this.commandName}`;
+  }
+
+  /**
    * Creates payload for the app command response log.
    *
    * This default handler expects the command serial as first and the request response as
@@ -50,7 +108,12 @@ requestBuffer.remove(this.serial);return this;}/**
    * @param {string} serial The serial that was used to identify the response callback.
    * @param {Object} response The response object for the request
    * @returns {Object}
-   */},{key:"getResponseLogPayload",value:function getResponseLogPayload(serial,response){return response;}/**
+   */
+  getResponseLogPayload(serial, response) {
+    return response;
+  }
+
+  /**
    * App command response handler. Can be used to implement custom logic for handling the incoming
    * data.
    *
@@ -63,16 +126,62 @@ requestBuffer.remove(this.serial);return this;}/**
    * of the AppCommandRequest instance.
    * @param {string} serial The serial that was used to identify the response callback.
    * @param {Object} response The response object for the request
-   */},{key:"onResponse",value:function onResponse(resolve,reject,serial,response){resolve(response);}/**
+   */
+  onResponse(resolve, reject, serial, response) {
+    resolve(response);
+  }
+
+  /**
    * Dispatches the app request command.
    * @private
    * @param {Function} resolve The resolve() callback of the dispatch promise.
    * @param {Function} reject The reject() callback of the dispatch promise.
-   */},{key:"onDispatch",value:function(){var _onDispatch=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(resolve,reject){var _this3=this;var message,requestCallback,command,success;return _regeneratorRuntime.wrap(function _callee$(_context){while(1)switch(_context.prev=_context.next){case 0:if(!(this.validateCommandParams(this.commandParams)===false)){_context.next=5;break;}// In case of an error log a message and reject the request promise.
-message="".concat(this.commandName," - invalid command parameters passed");logger.error(message,this.commandParams);reject(new Error(message));return _context.abrupt("return");case 5:/**
+   */
+  async onDispatch(resolve, reject) {
+    // Validate the command parameters.
+    if (this.validateCommandParams(this.commandParams) === false) {
+      // In case of an error log a message and reject the request promise.
+      const message = `${this.commandName} - invalid command parameters passed`;
+      logger.error(message, this.commandParams);
+      reject(new Error(message));
+      return;
+    }
+
+    /**
      * The event callback for the command response.
-     */requestCallback=function requestCallback(){for(var _len=arguments.length,params=new Array(_len),_key=0;_key<_len;_key++){params[_key]=arguments[_key];}logGroup(_this3.getResponseLogTitle(),_this3.getResponseLogPayload.apply(_this3,params)||{},_this3.logColor);_this3.cleanUpRequest(requestCallback);_this3.onResponse.apply(_this3,[resolve,reject].concat(params));};// Add the request to the buffer.
-requestBuffer.add(this,this.serial);// Add the event callback for the response.
-event.addCallback(this.getEventCallbackName(),requestCallback);// Prepare the command.
-command=new AppCommand().setCommandName(this.commandName).setLibVersion(this.libVersion).setCommandParams(_extends({serial:this.serial},this.commandParams&&_extends({},this.commandParams)));// Try to dispatch the command.
-_context.next=11;return command.dispatch();case 11:success=_context.sent;if(!(success===false)){_context.next=16;break;}this.cleanUpRequest(requestCallback);reject(new Error("".concat(this.commandName," command dispatch failed")));return _context.abrupt("return");case 16:logGroup(this.getRequestLogTitle(),this.commandParams||{},this.logColor);case 17:case"end":return _context.stop();}},_callee,this);}));function onDispatch(_x,_x2){return _onDispatch.apply(this,arguments);}return onDispatch;}()}]);}(Request);/* eslint-enable class-methods-use-this */export default AppCommandRequest;
+     */
+    const requestCallback = (...params) => {
+      logGroup(this.getResponseLogTitle(), this.getResponseLogPayload(...params) || {}, this.logColor);
+      this.cleanUpRequest(requestCallback);
+      this.onResponse(resolve, reject, ...params);
+    };
+
+    // Add the request to the buffer.
+    requestBuffer.add(this, this.serial);
+    // Add the event callback for the response.
+    event.addCallback(this.getEventCallbackName(), requestCallback);
+
+    // Prepare the command.
+    const command = new AppCommand().setCommandName(this.commandName).setLibVersion(this.libVersion).setCommandParams({
+      serial: this.serial,
+      ...(this.commandParams && {
+        ...this.commandParams
+      })
+    });
+
+    // Try to dispatch the command.
+    const success = await command.dispatch();
+
+    // If the dispatch of the command failed revert everything and reject the promise.
+    if (success === false) {
+      this.cleanUpRequest(requestCallback);
+      reject(new Error(`${this.commandName} command dispatch failed`));
+      return;
+    }
+    logGroup(this.getRequestLogTitle(), this.commandParams || {}, this.logColor);
+  }
+}
+
+/* eslint-enable class-methods-use-this */
+
+export default AppCommandRequest;