feat(internal-plugin-usersub): add usersub plugin to allow the publis…

jest.config.js

@@ -26,6 +26,7 @@ const packages = [
   '@webex/internal-plugin-support',
   '@webex/internal-plugin-team',
   '@webex/internal-plugin-user',
+  '@webex/internal-plugin-usersub',
   '@webex/internal-plugin-voicea',
   '@webex/internal-plugin-wdm',
   '@webex/jsdoctrinetest',

package.json

@@ -27,7 +27,7 @@
   },
   "scripts": {
     "@all": "yarn @workspaces run",
-    "@legacy": "yarn @workspaces --from \"{@webex/common,@webex/common-evented,@webex/common-timers,@webex/helper-html,@webex/helper-image,@webex/http-core,@webex/internal-plugin-avatar,@webex/internal-plugin-board,@webex/internal-plugin-calendar,@webex/internal-plugin-conversation,@webex/internal-plugin-device,@webex/internal-plugin-dss,@webex/internal-plugin-ediscovery,@webex/internal-plugin-encryption,@webex/internal-plugin-feature,@webex/internal-plugin-flag,@webex/internal-plugin-llm,@webex/internal-plugin-locus,@webex/internal-plugin-lyra,@webex/internal-plugin-mercury,@webex/internal-plugin-metrics,@webex/internal-plugin-presence,@webex/internal-plugin-scheduler,@webex/internal-plugin-search,@webex/internal-plugin-support,@webex/internal-plugin-team,@webex/internal-plugin-user,@webex/internal-plugin-voicea,@webex/internal-plugin-wdm,@webex/jsdoctrinetest,@webex/media-helpers,@webex/plugin-attachment-actions,@webex/plugin-authorization,@webex/plugin-authorization-browser,@webex/plugin-authorization-browser-first-party,@webex/plugin-authorization-node,@webex/plugin-device-manager,@webex/plugin-logger,@webex/plugin-meetings,@webex/plugin-memberships,@webex/plugin-messages,@webex/plugin-people,@webex/plugin-presence,@webex/plugin-rooms,@webex/plugin-team-memberships,@webex/plugin-teams,@webex/plugin-webhooks,@webex/recipe-private-web-client,@webex/storage-adapter-local-forage,@webex/storage-adapter-local-storage,@webex/storage-adapter-session-storage,@webex/storage-adapter-spec,@webex/test-helper-appid,@webex/test-helper-automation,@webex/test-helper-chai,@webex/test-helper-file,@webex/test-helper-make-local-url,@webex/test-helper-mocha,@webex/test-helper-mock-web-socket,@webex/test-helper-mock-webex,@webex/test-helper-refresh-callback,@webex/test-helper-retry,@webex/test-helper-server,@webex/test-helper-test-users,@webex/test-users,@webex/webex-core,@webex/webex-server,@webex/webrtc,@webex/xunit-with-logs,webex}\" run",
+    "@legacy": "yarn @workspaces --from \"{@webex/common,@webex/common-evented,@webex/common-timers,@webex/helper-html,@webex/helper-image,@webex/http-core,@webex/internal-plugin-avatar,@webex/internal-plugin-board,@webex/internal-plugin-calendar,@webex/internal-plugin-conversation,@webex/internal-plugin-device,@webex/internal-plugin-dss,@webex/internal-plugin-ediscovery,@webex/internal-plugin-encryption,@webex/internal-plugin-feature,@webex/internal-plugin-flag,@webex/internal-plugin-llm,@webex/internal-plugin-locus,@webex/internal-plugin-lyra,@webex/internal-plugin-mercury,@webex/internal-plugin-metrics,@webex/internal-plugin-presence,@webex/internal-plugin-scheduler,@webex/internal-plugin-search,@webex/internal-plugin-support,@webex/internal-plugin-team,@webex/internal-plugin-user,@webex/internal-plugin-usersub,@webex/internal-plugin-voicea,@webex/internal-plugin-wdm,@webex/jsdoctrinetest,@webex/media-helpers,@webex/plugin-attachment-actions,@webex/plugin-authorization,@webex/plugin-authorization-browser,@webex/plugin-authorization-browser-first-party,@webex/plugin-authorization-node,@webex/plugin-device-manager,@webex/plugin-logger,@webex/plugin-meetings,@webex/plugin-memberships,@webex/plugin-messages,@webex/plugin-people,@webex/plugin-presence,@webex/plugin-rooms,@webex/plugin-team-memberships,@webex/plugin-teams,@webex/plugin-webhooks,@webex/recipe-private-web-client,@webex/storage-adapter-local-forage,@webex/storage-adapter-local-storage,@webex/storage-adapter-session-storage,@webex/storage-adapter-spec,@webex/test-helper-appid,@webex/test-helper-automation,@webex/test-helper-chai,@webex/test-helper-file,@webex/test-helper-make-local-url,@webex/test-helper-mocha,@webex/test-helper-mock-web-socket,@webex/test-helper-mock-webex,@webex/test-helper-refresh-callback,@webex/test-helper-retry,@webex/test-helper-server,@webex/test-helper-test-users,@webex/test-users,@webex/webex-core,@webex/webex-server,@webex/webrtc,@webex/xunit-with-logs,webex}\" run",
     "@legacy-tools": "yarn @workspaces --topological-dev --from \"{@webex/babel-config-legacy,@webex/env-config-legacy,@webex/eslint-config-legacy,@webex/jest-config-legacy,@webex/legacy-tools}\" run",
     "@tools": "yarn @workspaces --topological-dev --from \"{@webex/cli-tools,@webex/package-tools}\" run",
     "@workspaces": "yarn workspaces foreach --parallel --verbose",

packages/@webex/internal-plugin-usersub/.eslintrc.js

@@ -0,0 +1,6 @@
+const config = {
+  root: true,
+  extends: ['@webex/eslint-config-legacy'],
+};
+
+module.exports = config;

packages/@webex/internal-plugin-usersub/README.md

@@ -0,0 +1,42 @@
+# @webex/internal-plugin-usersub
+
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+
+> Plugin for the UserSub services
+
+This is an internal Cisco Webex plugin. As such, it does not strictly adhere to semantic versioning. Use at your own risk. If you're not working on one of our first party clients, please look at our [developer api](https://developer.webex.com/) and stick to our public plugins.
+
+- [Install](#install)
+- [Usage](#usage)
+- [Contribute](#contribute)
+- [Maintainers](#maintainers)
+- [License](#license)
+
+## Install
+
+```bash
+npm install --save @webex/internal-plugin-usersub
+```
+
+## Usage
+
+```js
+import '@webex/internal-plugin-usersub';
+
+import WebexCore from '@webex/webex-core';
+
+const webex = new WebexCore();
+webex.internal.usersub.WHATEVER;
+```
+
+## Maintainers
+
+This package is maintained by [Cisco Webex for Developers](https://developer.webex.com/).
+
+## Contribute
+
+Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/webex-js-sdk/blob/master/CONTRIBUTING.md) for more details.
+
+## License
+
+© 2016-2020 Cisco and/or its affiliates. All Rights Reserved.

packages/@webex/internal-plugin-usersub/babel.config.js

@@ -0,0 +1,3 @@
+const babelConfigLegacy = require('@webex/babel-config-legacy');
+
+module.exports = babelConfigLegacy;

packages/@webex/internal-plugin-usersub/jest.config.js

@@ -0,0 +1,3 @@
+const config = require('@webex/jest-config-legacy');
+
+module.exports = config;

packages/@webex/internal-plugin-usersub/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@webex/internal-plugin-usersub",
+  "description": "Internal plugin for managing user subscriptions in Webex SDK",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "devMain": "src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webex/webex-js-sdk.git",
+    "directory": "packages/@webex/internal-plugin-usersub"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "browserify": {
+    "transform": [
+      "babelify",
+      "envify"
+    ]
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.10",
+    "@webex/babel-config-legacy": "workspace:*",
+    "@webex/eslint-config-legacy": "workspace:*",
+    "@webex/jest-config-legacy": "workspace:*",
+    "@webex/legacy-tools": "workspace:*",
+    "@webex/test-helper-chai": "workspace:*",
+    "@webex/test-helper-mocha": "workspace:*",
+    "@webex/test-helper-mock-webex": "workspace:*",
+    "@webex/test-helper-test-users": "workspace:*",
+    "eslint": "^8.24.0",
+    "prettier": "^2.7.1",
+    "sinon": "^9.2.4"
+  },
+  "dependencies": {
+    "@webex/common": "workspace:*",
+    "@webex/common-timers": "workspace:*",
+    "@webex/internal-plugin-device": "workspace:*",
+    "@webex/webex-core": "workspace:*",
+    "lodash": "^4.17.21",
+    "uuid": "^3.3.2"
+  },
+  "scripts": {
+    "build": "yarn build:src",
+    "build:src": "webex-legacy-tools build -dest \"./dist\" -src \"./src\" -js -ts -maps",
+    "deploy:npm": "yarn npm publish",
+    "test": "yarn test:style && yarn test:unit && yarn test:integration && yarn test:browser",
+    "test:browser:broken": "webex-legacy-tools test --integration --runner karma",
+    "test:style": "eslint ./src/**/*.*",
+    "test:unit": "webex-legacy-tools test --unit --runner jest"
+  }
+}

packages/@webex/internal-plugin-usersub/process

@@ -0,0 +1 @@
+module.exports = {browser: true};

packages/@webex/internal-plugin-usersub/src/config.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+export default {
+  userSub: {},
+};

packages/@webex/internal-plugin-usersub/src/constants.ts

@@ -0,0 +1,2 @@
+export const EXPIRATION_OFFSET = 60 * 1000; // 1 minute in ms
+export const USERSUB_SERVICE_NAME = 'usersub';

packages/@webex/internal-plugin-usersub/src/index.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {registerInternalPlugin} from '@webex/webex-core';
+
+import Usersub from './usersub';
+import config from './config';
+
+registerInternalPlugin('usersub', Usersub, {config});
+
+export {default} from './usersub';

packages/@webex/internal-plugin-usersub/src/usersub.ts

@@ -0,0 +1,151 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import '@webex/internal-plugin-device';
+
+import {WebexPlugin} from '@webex/webex-core';
+import {safeSetTimeout} from '@webex/common-timers';
+import {EXPIRATION_OFFSET, USERSUB_SERVICE_NAME} from './constants';
+
+/**
+ * @class
+ * @extends WebexPlugin
+ */
+const Usersub = WebexPlugin.extend({
+  namespace: 'Usersub',
+
+  session: {
+    crossClientState: {
+      type: 'object',
+      /**
+       * Returns a new Map instance as the default value for crossClientState.
+       * @returns {Map}
+       */
+      default() {
+        return new Map();
+      },
+    },
+
+    refreshTimer: {
+      default: undefined,
+      type: 'any',
+    },
+  },
+
+  /**
+   * Sets the value for answer-calls-on-wxcc for the calling application.
+   * @param {boolean} enable - The state will be enabled/disabled.
+   * @param {string} appName - The app setting the state.
+   * @param {number} ttl - Time To Live for the event in seconds.
+   * @returns {Promise}
+   */
+  updateAnswerCallsCrossClient(enable: boolean, appName: string, ttl: number) {
+    if (typeof enable !== 'boolean') {
+      return Promise.reject(new Error('Enable parameter must be a boolean'));
+    }
+
+    if (!appName) {
+      return Promise.reject(new Error('An appName is required'));
+    }
+
+    if (ttl <= 0) {
+      return Promise.reject(new Error('A positive ttl is required'));
+    }
+
+    const jsonData = {
+      users: [this.webex.internal.device.userId],
+      compositions: [
+        {
+          type: 'cross-client-state',
+          ttl,
+          composition: {
+            devices: [
+              {
+                deviceId: this._extractIdFromUrl(this.webex.internal.device.url),
+                appName,
+                state: {
+                  'answer-calls-on-wxcc': enable,
+                },
+              },
+            ],
+          },
+        },
+      ],
+    };
+
+    return this.webex
+      .request({
+        method: 'POST',
+        service: USERSUB_SERVICE_NAME,
+        resource: 'publish',
+        body: jsonData,
+      })
+      .then((response) => {
+        this.crossClientState.set(appName, enable);
+        this._startRefreshTimer(appName, ttl);
+
+        return response.body;
+      })
+      .catch((error) => {
+        this.logger.error(
+          `userSub: updateAnswerCallsCrossClient failed with error: ${error.message}`
+        );
+
+        return Promise.reject(error);
+      });
+  },
+
+  /**
+   * Starts the refresh timer for the cross-client state.
+   * @private
+   * @param {string} appName - The app setting the state.
+   * @param {number} ttl - Time To Live for the event in seconds.
+   * @returns {void}
+   */
+  _startRefreshTimer(appName: string, ttl: number): void {
+    this._stopRefreshTimer();
+    const answerCallsState = this.crossClientState.get(appName);
+    if (answerCallsState) {
+      const refreshTime = ttl * 1000 - EXPIRATION_OFFSET;
+      if (refreshTime <= 0) {
+        this.logger.warn('Refresh time is non-positive, skipping timer setup.');
+
+        return;
+      }
+      this.refreshTimer = safeSetTimeout(
+        () => this.updateAnswerCallsCrossClient(answerCallsState, appName, ttl),
+        refreshTime
+      );
+    }
+  },
+
+  /**
+   * Stops the refresh timer for the cross-client state.
+   * @private
+   * @returns {void}
+   */
+  _stopRefreshTimer(): void {
+    if (this.refreshTimer) {
+      clearTimeout(this.refreshTimer);
+    }
+  },
+
+  /**
+   * Extracts the device ID from a given URL.
+   * @param {string} url - The URL to extract the device ID from.
+   * @returns {string | null} The extracted device ID or null if not found.
+   */
+  _extractIdFromUrl(url: string): string {
+    if (url) {
+      const regex = /\/devices\/([^/?]+)/;
+      const match = url.match(regex);
+
+      return match ? match[1] : '';
+    }
+
+    return '';
+  },
+});
+
+export default Usersub;