Bi-directional event handling

package.json

@@ -4,9 +4,9 @@
   "description": "Reference App to demonstrate Firebolt APIs and Lifecycle",
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "9.1.2",
-    "@firebolt-js/discovery-sdk": "1.7.0",
-    "@firebolt-js/manage-sdk": "1.7.0",
-    "@firebolt-js/sdk": "1.7.0",
+    "@firebolt-js/discovery-sdk": "1.8.0-next-major.4",
+    "@firebolt-js/manage-sdk": "1.8.0-next-major.4",
+    "@firebolt-js/sdk": "1.8.0-next-major.4",
     "@lightningjs/core": "2.11.0",
     "@lightningjs/sdk": "5.5.6",
     "@lightningjs/ui-components": "2.25.1",

src/App.js

@@ -39,6 +39,7 @@ import { withAnnouncer } from '@lightningjs/ui-components';
 const Base = withAnnouncer(lng.Application);
 import Toast, { eventEmitter } from './Toast';
 import IntentReader from 'IntentReader';
+const packagejson = require('../package.json');
 
 export default class App extends Base {
   static _template() {
@@ -90,6 +91,10 @@ export default class App extends Base {
       this.accessibilityCheck(voiceAnnouncement);
     });
     this.toastStates = [];
+    const sdkVersionFromPackageJson = packagejson.dependencies['@firebolt-js/sdk'];
+    const pattern = /^([2-9]|\d{2,})\.\d+\.\d+$|^1\.(8|9|\d{2,})\.\d+/;
+    process.env.IS_BIDIRECTIONAL_SDK = pattern.test(sdkVersionFromPackageJson);
+    console.log('process.env.IS_BIDIRECTIONAL_SDK----:', process.env.IS_BIDIRECTIONAL_SDK);
     this.overlayed = false;
     this.overlayDismissTimer = null;
     const appUrl = window.location;
@@ -126,6 +131,7 @@ export default class App extends Base {
     process.env.PUBSUB_SUBSCRIBE_TOPIC_SUFFIX = new URLSearchParams(appUrl.search).get('pubSubSubscribeSuffix');
     process.env.PUBSUB_PUBLISH_TOPIC_SUFFIX = new URLSearchParams(appUrl.search).get('pubSubPublishSuffix');
     process.env.REGION = new URLSearchParams(appUrl.search).get('region');
+    process.env.SDK_VERSION = new URLSearchParams(appUrl.search).get('sdkVersion');
 
     if (platform) {
       process.env.PLATFORM = platform;

src/FireboltExampleInvoker.js

@@ -109,8 +109,12 @@ export default class FireboltExampleInvoker {
         return await methodFn(...params);
       } else if (method.match(/^on[A-Z][a-zA-Z]+$/) && moduleClass.listen) {
         let id;
+        let event = method[2].toLowerCase() + method.substr(3);
         console.log('params:', params);
-        const event = method[2].toLowerCase() + method.substr(3);
+        if (process.env.IS_BIDIRECTIONAL_SDK === true || (typeof process.env.IS_BIDIRECTIONAL_SDK === 'string' && process.env.IS_BIDIRECTIONAL_SDK.toLowerCase() === 'true')) {
+          event = method;
+        }
+
         if (params.length == 1 && params[0] === true) {
           id = await moduleClass.listen(event, (e) => {
             logger.error(e, 'invoke');

src/FireboltTransportInvoker.js

@@ -16,9 +16,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import Transport from '@firebolt-js/sdk/dist/lib/Transport';
+import Transport from 'Transport';
 const logger = require('./utils/Logger')('FireboltTransportInvoker.js');
 let getInvoker;
+
 try {
   getInvoker = require('../plugins/FireboltExtensionInvoker').getInvoker;
 } catch (err) {
@@ -51,7 +52,10 @@ export default class FireboltTransportInvoker {
       const invoker = getInvoker(sdk);
       if (sdk && invoker) {
         return await invoker.send(module, method, jsonParams);
+      } else if (process.env.IS_BIDIRECTIONAL_SDK === true || (typeof process.env.IS_BIDIRECTIONAL_SDK === 'string' && process.env.IS_BIDIRECTIONAL_SDK.toLowerCase() === 'true')) {
+        return await Transport.request(`${module}.${method}`, jsonParams);
       } else {
+        // Default to transport
         return await Transport.send(module, method, jsonParams);
       }
     } else {

src/LifeCycleHistory.js

@@ -48,11 +48,35 @@ export default class LifecycleHistory {
   async init(appInstance = null) {
     lifecycleValidation = process.env.LIFECYCLE_VALIDATION;
     const lifecycleModule = await assignModuleCapitalization('Lifecycle');
-    await Lifecycle.listen('inactive', this._recordHistory.bind(this, lifecycleModule + '.onInactive'));
-    await Lifecycle.listen('foreground', this._recordHistory.bind(this, lifecycleModule + '.onForeground'));
-    Lifecycle.listen('background', this._recordHistory.bind(this, lifecycleModule + '.onBackground'));
-    Lifecycle.listen('suspended', this._recordHistory.bind(this, lifecycleModule + '.onSuspended'));
-    Lifecycle.listen('unloading', async (event) => {
+    const isBidirectionalSdk = String(process.env.IS_BIDIRECTIONAL_SDK).toLowerCase() === 'true';
+    const eventNames = isBidirectionalSdk
+      ? {
+          inactive: 'onInactive',
+          foreground: 'onForeground',
+          background: 'onBackground',
+          suspended: 'onSuspended',
+          unloading: 'onUnloading',
+          navigateTo: 'onNavigateTo',
+        }
+      : {
+          inactive: 'inactive',
+          foreground: 'foreground',
+          background: 'background',
+          suspended: 'suspended',
+          unloading: 'unloading',
+          navigateTo: 'navigateTo',
+        };
+    const inactiveEvent = eventNames.inactive;
+    const foregroundEvent = eventNames.foreground;
+    const backgroundEvent = eventNames.background;
+    const suspendedEvent = eventNames.suspended;
+    const unloadingEvent = eventNames.unloading;
+    const navigateToEvent = eventNames.navigateTo;
+    await Lifecycle.listen(inactiveEvent, this._recordHistory.bind(this, lifecycleModule + '.onInactive'));
+    await Lifecycle.listen(foregroundEvent, this._recordHistory.bind(this, lifecycleModule + '.onForeground'));
+    Lifecycle.listen(backgroundEvent, this._recordHistory.bind(this, lifecycleModule + '.onBackground'));
+    Lifecycle.listen(suspendedEvent, this._recordHistory.bind(this, lifecycleModule + '.onSuspended'));
+    Lifecycle.listen(unloadingEvent, async (event) => {
       let schemaResult, validationResult;
       await getschemaValidationDone(lifecycleModule + '.onUnloading', event, 'core').then((res) => {
         schemaResult = res;
@@ -100,7 +124,7 @@ export default class LifecycleHistory {
       }
     }
     // register for Discovery.onNavigateTo event
-    Discovery.listen('navigateTo', async (event) => {
+    Discovery.listen(navigateToEvent, async (event) => {
       logger.info('Printing onNavigate To event received: ' + JSON.stringify(event));
 
       try {

src/MediaView.js

@@ -68,15 +68,27 @@ export default class MediaView extends lng.Component {
 
   _init() {
     const p = this.tag('Player');
-    Lifecycle.listen('inactive', (event) => {
+    const isBidirectionalSdk = String(process.env.IS_BIDIRECTIONAL_SDK).toLowerCase() === 'true';
+    const eventNames = isBidirectionalSdk
+      ? {
+          inactive: 'onInactive',
+          foreground: 'onForeground',
+        }
+      : {
+          inactive: 'inactive',
+          foreground: 'foreground',
+        };
+    const inactiveEvent = eventNames.inactive;
+    const foregroundEvent = eventNames.foreground;
+    Lifecycle.listen(inactiveEvent, (event) => {
       if (event.state && this.tag('Row.ToggleInactive').checked) {
         if (p.isPlaying()) {
           logger.info('Unpausing video', '_init');
           p.playPause();
         }
       }
     });
-    Lifecycle.listen('foreground', (event) => {
+    Lifecycle.listen(foregroundEvent, (event) => {
       if (event.state && this.tag('Row.ToggleInactive').checked) {
         const p = this.tag('Player');
         if (!p.isPlaying()) {

src/constant.js

@@ -194,4 +194,6 @@ export const CONSTANTS = {
   SLA_VALIDATION_INTENT: 'sla-validation',
   OPENRPC_URL: 'https://rdkcentral.github.io/firebolt/requirements/latest/specifications/firebolt-open-rpc.json',
   DEFAULT_SLA: 300,
+  CLEARED_LISTENERS: 'Cleared Listeners',
+  NO_ACTIVE_LISTENERS: 'No active listeners',
 };

src/pubsub/handlers/ClearEventListeners.js

@@ -28,7 +28,7 @@ export default class ClearEventListeners extends BaseHandler {
 
   async handle(message) {
     const eventInvokerInfo = new EventInvocation();
-    const validationReport = eventInvokerInfo.clearAllListeners();
+    const validationReport = await eventInvokerInfo.clearAllListeners();
     return JSON.stringify({ report: validationReport });
   }
 }

src/pubsub/handlers/RegisterEventHandler.js

@@ -40,6 +40,7 @@ export default class RegisterEventHandler extends BaseHandler {
     if (message.context) {
       process.env.COMMUNICATION_MODE = message.context.communicationMode;
     }
+    process.env.IS_NOT_SUPPORTED_API = message.isNotSupportedApi;
     const eventInvokerInfo = new EventInvocation();
     let sdkType;
     if (!message.params.event.includes('_')) {

src/pubsub/handlers/clearEventHandler.js

@@ -38,7 +38,7 @@ export default class clearEventHandler extends BaseHandler {
       process.env.SDK_TYPE = sdkType;
     }
     try {
-      const validationReport = eventInvokerInfo.clearEventListeners(message.params.event);
+      const validationReport = await eventInvokerInfo.clearEventListeners(message.params.event);
       return JSON.stringify({ report: validationReport });
     } catch (e) {
       const result = {

test/jest.config.js

@@ -36,6 +36,7 @@ module.exports = {
     '^CensorData$': '<rootDir>/../src/source/censorData.json',
     '^RunTestHandler$': '<rootDir>/../src/pubsub/handlers/RunTestHandler.js',
   },
+  resolver: '<rootDir>/jest.transport-resolver.js',
   transform: {
     '^.+\\.[tj]s$': 'babel-jest',
     '^.+\\.mjs$': 'babel-jest',

test/jest.setup.js

@@ -183,6 +183,8 @@ jest.mock('../src/constant', () => {
     SLA_VALIDATION_INTENT: 'sla-validation',
     OPENRPC_URL: 'https://rdkcentral.github.io/firebolt/requirements/latest/specifications/firebolt-open-rpc.json',
     DEFAULT_SLA: 300,
+    CLEARED_LISTENERS: 'Cleared Listeners',
+    NO_ACTIVE_LISTENERS: 'No active listeners',
   };
 
   return { CONSTANTS };

test/jest.transport-resolver.js

@@ -0,0 +1,25 @@
+const fs = require('fs');
+const path = require('path');
+
+module.exports = (request, options) => {
+  const defaultResolve = options.defaultResolver;
+  // Check if the module to resolve is 'Transport'
+  if (request === 'Transport') {
+    try {
+      // Get the list of files in the specified directory
+      const files = fs.readdirSync('node_modules/@firebolt-js/sdk/dist/lib/');
+      // If the 'Gateway' file exists, then the sdk version is 2.0.0 or later, so resolve to 'Gateway' path
+      if (files.includes('Gateway')) {
+        console.log('Using Gateway from @firebolt-js/sdk');
+        return path.resolve(__dirname, '../node_modules/@firebolt-js/sdk/dist/lib/Gateway/index.mjs');
+      } else {
+        console.log('Using Transport from @firebolt-js/sdk');
+        return path.resolve(__dirname, '../node_modules/@firebolt-js/sdk/dist/lib/Transport/index.mjs');
+      }
+    } catch (err) {
+      console.error(`Error resolving files: ${err.message}`);
+      return defaultResolve(request, options);
+    }
+  }
+  return defaultResolve(request, options);
+};