@webex/webex-core 3.8.0 → 3.8.1-next.1

package/src/lib/services-v2/types.ts

@@ -0,0 +1,13 @@
+export type ServiceUrl = {
+  baseUrl: string;
+  host: string;
+  priority: number;
+  failed?: boolean;
+};
+
+export interface IServiceDetail {
+  id: string;
+  serviceName: string;
+  serviceUrls: Array<ServiceUrl>;
+  failHost(url: string): boolean;
+}

package/test/fixtures/host-catalog-v2.ts

@@ -0,0 +1,249 @@
+export const serviceHostmapV2 = {
+  activeServices: {
+    conversation: 'urn:TEAM:us-east-2_a:conversation',
+    idbroker: 'urn:TEAM:us-east-2_a:idbroker',
+    locus: 'urn:TEAM:us-east-2_a:locus',
+    mercury: 'urn:TEAM:us-east-2_a:mercury',
+  },
+  services: [
+    {
+      id: 'urn:TEAM:us-east-2_a:conversation',
+      serviceName: 'conversation',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-achm-message.svc.webex.com/conversation/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://conv-a.wbx2.com/conversation/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:me-central-1_d:conversation',
+      serviceName: 'conversation',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-adxb-message.svc.webex.com/conversation/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://conv-d.wbx2.com/conversation/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:us-east-2_a:idbroker',
+      serviceName: 'idbroker',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-adxb-message.svc.webex.com/idbroker/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://idbroker.webex.com/idb/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:me-central-1_d:idbroker',
+      serviceName: 'idbroker',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-adxb-message.svc.webex.com/idbroker/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://conv-d.wbx2.com/idbroker/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:us-east-2_a:locus',
+      serviceName: 'locus',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-adxb-message.svc.webex.com/locus/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://locus-a.wbx2.com/locus/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:me-central-1_d:locus',
+      serviceName: 'locus',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-adxb-message.svc.webex.com/locus/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://conv-d.wbx2.com/locus/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:us-east-2_a:mercury',
+      serviceName: 'mercury',
+      serviceUrls: [
+        {
+          baseUrl: 'https://mercury-a.wbx2.com/mercury/api/v1',
+          priority: 1,
+        },
+      ],
+    },
+    {
+      id: 'urn:TEAM:me-central-1_d:mercury',
+      serviceName: 'mercury',
+      serviceUrls: [
+        {
+          baseUrl: 'https://prod-adxb-message.svc.webex.com/mercury/api/v1',
+          priority: 1,
+        },
+        {
+          baseUrl: 'https://conv-d.wbx2.com/mercury/api/v1',
+          priority: 2,
+        },
+      ],
+    },
+  ],
+  orgId: '3e0e410f-f83f-4ee4-ac32-12692e99355c',
+  timestamp: '1745533341',
+  format: 'U2Cv2',
+};
+
+export const formattedServiceHostmapEntryConv = {
+  id: 'urn:TEAM:us-east-2_a:conversation',
+  serviceName: 'conversation',
+  serviceUrls: [
+    {
+      baseUrl: 'https://prod-achm-message.svc.webex.com/conversation/api/v1',
+      host: 'prod-achm-message.svc.webex.com',
+      priority: 1,
+    },
+    {
+      baseUrl: 'https://conv-a.wbx2.com/conversation/api/v1',
+      host: 'conv-a.wbx2.com',
+      priority: 2,
+    },
+  ],
+};
+
+export const formattedServiceHostmapV2 = [
+  formattedServiceHostmapEntryConv,
+  {
+    id: 'urn:TEAM:me-central-1_d:conversation',
+    serviceName: 'conversation',
+    serviceUrls: [
+      {
+        baseUrl: 'https://prod-adxb-message.svc.webex.com/conversation/api/v1',
+        host: 'prod-adxb-message.svc.webex.com',
+        priority: 1,
+      },
+      {
+        baseUrl: 'https://conv-d.wbx2.com/conversation/api/v1',
+        host: 'conv-d.wbx2.com',
+        priority: 2,
+      },
+    ],
+  },
+  {
+    id: 'urn:TEAM:us-east-2_a:idbroker',
+    serviceName: 'idbroker',
+    serviceUrls: [
+      {
+        baseUrl: 'https://prod-adxb-message.svc.webex.com/idbroker/api/v1',
+        host: 'prod-adxb-message.svc.webex.com',
+        priority: 1,
+      },
+      {
+        baseUrl: 'https://idbroker.webex.com/idb/api/v1',
+        host: 'idbroker.webex.com',
+        priority: 2,
+      },
+    ],
+  },
+  {
+    id: 'urn:TEAM:me-central-1_d:idbroker',
+    serviceName: 'idbroker',
+    serviceUrls: [
+      {
+        baseUrl: 'https://prod-adxb-message.svc.webex.com/idbroker/api/v1',
+        host: 'prod-adxb-message.svc.webex.com',
+        priority: 1,
+      },
+      {
+        baseUrl: 'https://conv-d.wbx2.com/idbroker/api/v1',
+        host: 'conv-d.wbx2.com',
+        priority: 2,
+      },
+    ],
+  },
+  {
+    id: 'urn:TEAM:us-east-2_a:locus',
+    serviceName: 'locus',
+    serviceUrls: [
+      {
+        baseUrl: 'https://prod-adxb-message.svc.webex.com/locus/api/v1',
+        host: 'prod-adxb-message.svc.webex.com',
+        priority: 1,
+      },
+      {
+        baseUrl: 'https://locus-a.wbx2.com/locus/api/v1',
+        host: 'locus-a.wbx2.com',
+        priority: 2,
+      },
+    ],
+  },
+  {
+    id: 'urn:TEAM:me-central-1_d:locus',
+    serviceName: 'locus',
+    serviceUrls: [
+      {
+        baseUrl: 'https://prod-adxb-message.svc.webex.com/locus/api/v1',
+        host: 'prod-adxb-message.svc.webex.com',
+        priority: 1,
+      },
+      {
+        baseUrl: 'https://conv-d.wbx2.com/locus/api/v1',
+        host: 'conv-d.wbx2.com',
+        priority: 2,
+      },
+    ],
+  },
+  {
+    id: 'urn:TEAM:us-east-2_a:mercury',
+    serviceName: 'mercury',
+    serviceUrls: [
+      {
+        baseUrl: 'https://mercury-a.wbx2.com/mercury/api/v1',
+        host: 'mercury-a.wbx2.com',
+        priority: 1,
+      },
+    ],
+  },
+  {
+    id: 'urn:TEAM:me-central-1_d:mercury',
+    serviceName: 'mercury',
+    serviceUrls: [
+      {
+        baseUrl: 'https://prod-adxb-message.svc.webex.com/mercury/api/v1',
+        host: 'prod-adxb-message.svc.webex.com',
+        priority: 1,
+      },
+      {
+        baseUrl: 'https://conv-d.wbx2.com/mercury/api/v1',
+        host: 'conv-d.wbx2.com',
+        priority: 2,
+      },
+    ],
+  },
+];

package/test/integration/spec/services/services.js

@@ -37,15 +37,17 @@ describe('webex-core', () => {
             orgId: process.env.EU_PRIMARY_ORG_ID,
           },
         }),
-      ]).then(([[user], [userEU]]) =>
-        new Promise((resolve) => {
-          setTimeout(() => {
-            webexUser = user;
-            webexUserEU = userEU;
-            resolve();
-          }, 1000)
-        })
-    ));
+      ]).then(
+        ([[user], [userEU]]) =>
+          new Promise((resolve) => {
+            setTimeout(() => {
+              webexUser = user;
+              webexUserEU = userEU;
+              resolve();
+            }, 1000);
+          })
+      )
+    );
 
     beforeEach('create webex instance', () => {
       webex = new WebexCore({credentials: {supertoken: webexUser.token}});
@@ -893,7 +895,7 @@ describe('webex-core', () => {
             assert.equal(Object.keys(unauthServices.list(false, 'postauth')).length, 0);
           }));
 
-      it('validates new user with activationOptions suppressEmail true', () =>
+      it.skip('validates new user with activationOptions suppressEmail true', () =>
         unauthServices
           .validateUser({
             email: `Collabctg+webex-js-sdk-${uuid.v4()}@gmail.com`,

package/test/unit/spec/interceptors/redirect.js

@@ -96,6 +96,78 @@ describe('webex-core', () => {
 
           assert.equal(interceptor.onResponse({$redirectCount: 5}, response), response);
         });
+
+        it('redirects GET requests to new url on appapi redirect error', () => {
+          const response = {
+            statusCode: 404,
+            headers: {},
+            body: {
+              code: 404100,
+              data: {
+                siteFullUrl: 'newlocus.example.com'
+              },
+            },
+          };
+
+          interceptor.onResponse({$redirectCount: 0, uri: 'https://test.webex.com/meet/v1/join'}, response);
+          sinon.assert.calledWith(webex.request, {
+            $redirectCount: 1,
+            uri: 'https://newlocus.example.com/meet/v1/join',
+          });
+        });
+        it('returns when appapi redirect is not encountered', () => {
+          const response = {
+            statusCode: 404,
+            headers: {},
+            body: {
+              code: 404101,
+              data: {
+                siteFullUrl: 'http://newlocus.example.com?alternate=true'
+              },
+            },
+          };
+
+          assert.equal(interceptor.onResponse({$redirectCount: 5}, response), response);
+        });
+        it('does not redirect on reaching max redirects', () => {
+          const response = {
+            statusCode: 404,
+            headers: {},
+            body: {
+              code: 404100,
+              data: {
+                siteFullUrl: 'http://newlocus.example.com?alternate=true'
+              },
+            },
+            options: {
+              qs: true,
+            },
+          };
+
+          assert.isRejected(interceptor.onResponse({$redirectCount: 5}, response));
+        });
+
+        it('redirects POST requests to new url on appapi redirect error', () => {
+          const response = {
+            statusCode: 404,
+            headers: {},
+            body: {
+              code: 404100,
+              data: {
+                siteFullUrl: 'http://newlocus.example.com?alternate=true'
+              },
+            },
+            options: {
+              qs: true,
+            },
+          };
+
+          interceptor.onResponse({$redirectCount: 4}, response);
+          sinon.assert.calledWith(webex.request, {
+            $redirectCount: 5,
+            uri: 'http://newlocus.example.com',
+          });
+        });
       });
     });
   });

package/test/unit/spec/services-v2/service-catalog.ts

@@ -0,0 +1,288 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {assert} from '@webex/test-helper-chai';
+import MockWebex from '@webex/test-helper-mock-webex';
+import {ServicesV2} from '@webex/webex-core';
+import {formattedServiceHostmapV2} from '../../../fixtures/host-catalog-v2';
+
+describe('webex-core', () => {
+  describe('ServiceCatalogV2', () => {
+    let webex;
+    let services;
+    let catalog;
+
+    beforeEach(() => {
+      webex = new MockWebex();
+      services = new ServicesV2(undefined, {parent: webex});
+      catalog = services._getCatalog();
+    });
+
+    describe('#namespace', () => {
+      it('is accurate to plugin name', () => {
+        assert.equal(catalog.namespace, 'ServiceCatalog');
+      });
+    });
+
+    describe('#serviceGroups', () => {
+      it('has all the required keys', () => {
+        assert.hasAllKeys(catalog.serviceGroups, [
+          'discovery',
+          'override',
+          'preauth',
+          'signin',
+          'postauth',
+        ]);
+      });
+
+      it('contains values that are arrays', () => {
+        Object.keys(catalog.serviceGroups).forEach((key) => {
+          assert.typeOf(catalog.serviceGroups[key], 'array');
+        });
+      });
+    });
+
+    describe('#status', () => {
+      it('has all the required keys', () => {
+        assert.hasAllKeys(catalog.status, [
+          'discovery',
+          'override',
+          'preauth',
+          'postauth',
+          'signin',
+        ]);
+      });
+
+      it('has valid key value types', () => {
+        assert.typeOf(catalog.status.preauth.ready, 'boolean');
+        assert.typeOf(catalog.status.preauth.collecting, 'boolean');
+        assert.typeOf(catalog.status.postauth.ready, 'boolean');
+        assert.typeOf(catalog.status.postauth.collecting, 'boolean');
+        assert.typeOf(catalog.status.signin.ready, 'boolean');
+        assert.typeOf(catalog.status.signin.collecting, 'boolean');
+      });
+    });
+
+    describe('#allowedDomains', () => {
+      it('is an array', () => {
+        assert.isArray(catalog.allowedDomains);
+      });
+    });
+
+    describe('#clean()', () => {
+      beforeEach(() => {
+        catalog.serviceGroups.preauth = [1, 2, 3];
+        catalog.serviceGroups.signin = [1, 2, 3];
+        catalog.serviceGroups.postauth = [1, 2, 3];
+        catalog.status.preauth = {ready: true};
+        catalog.status.signin = {ready: true};
+        catalog.status.postauth = {ready: true};
+      });
+
+      it('should reset service group ready status', () => {
+        catalog.clean();
+
+        assert.isFalse(catalog.status.preauth.ready);
+        assert.isFalse(catalog.status.signin.ready);
+        assert.isFalse(catalog.status.postauth.ready);
+      });
+
+      it('should clear all collected service groups', () => {
+        catalog.clean();
+
+        assert.equal(catalog.serviceGroups.preauth.length, 0);
+        assert.equal(catalog.serviceGroups.signin.length, 0);
+        assert.equal(catalog.serviceGroups.postauth.length, 0);
+      });
+    });
+
+    describe('#findAllowedDomain()', () => {
+      const domains = [];
+
+      beforeEach(() => {
+        domains.push('example-a', 'example-b', 'example-c');
+
+        catalog.setAllowedDomains(domains);
+      });
+
+      afterEach(() => {
+        domains.length = 0;
+      });
+
+      it('finds an allowed domain that matches a specific url', () => {
+        const domain = catalog.findAllowedDomain('http://example-a.com/resource/id');
+
+        assert.include(domains, domain);
+      });
+    });
+
+    describe('#getAllowedDomains()', () => {
+      const domains = [];
+
+      beforeEach(() => {
+        domains.push('example-a', 'example-b', 'example-c');
+
+        catalog.setAllowedDomains(domains);
+      });
+
+      afterEach(() => {
+        domains.length = 0;
+      });
+
+      it('returns a an array of allowed hosts', () => {
+        const list = catalog.getAllowedDomains();
+
+        assert.match(domains, list);
+      });
+    });
+
+    describe('#setAllowedDomains()', () => {
+      const domains = [];
+
+      beforeEach(() => {
+        domains.push('example-a', 'example-b', 'example-c');
+
+        catalog.setAllowedDomains(domains);
+      });
+
+      afterEach(() => {
+        domains.length = 0;
+      });
+
+      it('sets the allowed domain entries to new values', () => {
+        const newValues = ['example-d', 'example-e', 'example-f'];
+
+        catalog.setAllowedDomains(newValues);
+
+        assert.notDeepInclude(domains, newValues);
+      });
+    });
+
+    describe('#addAllowedDomains()', () => {
+      const domains = [];
+
+      beforeEach(() => {
+        domains.push('example-a', 'example-b', 'example-c');
+
+        catalog.setAllowedDomains(domains);
+      });
+
+      afterEach(() => {
+        domains.length = 0;
+      });
+
+      it('merge the allowed domain entries with new values', () => {
+        const newValues = ['example-c', 'example-e', 'example-f'];
+
+        catalog.addAllowedDomains(newValues);
+
+        const list = catalog.getAllowedDomains();
+
+        assert.match(['example-a', 'example-b', 'example-c', 'example-e', 'example-f'], list);
+      });
+    });
+
+    describe('#markFailedServiceUrl()', () => {
+      afterEach(() => {
+        catalog._getServiceDetail('urn:TEAM:us-east-2_a:conversation').serviceUrls[0].failed =
+          false;
+      });
+
+      it('marks service url failed, and retrieves next highest priority', () => {
+        catalog.updateServiceGroups('postauth', formattedServiceHostmapV2);
+
+        const currentHighest = catalog._getServiceDetail('urn:TEAM:us-east-2_a:conversation').get();
+
+        assert.equal(currentHighest, 'https://prod-achm-message.svc.webex.com/conversation/api/v1');
+
+        const nextHighest = catalog.markFailedServiceUrl(
+          'https://prod-achm-message.svc.webex.com/conversation/api/v1'
+        );
+
+        assert.equal(nextHighest, 'https://conv-a.wbx2.com/conversation/api/v1');
+      });
+
+      it('returns undefined if url does not exist', () => {
+        catalog.updateServiceGroups('postauth', formattedServiceHostmapV2);
+
+        const currentHighest = catalog._getServiceDetail('urn:TEAM:us-east-2_a:conversation').get();
+
+        assert.equal(currentHighest, 'https://prod-achm-message.svc.webex.com/conversation/api/v1');
+
+        const nextHighest = catalog.markFailedServiceUrl(
+          'https://doesnotexist.com/conversation/api/v1'
+        );
+
+        assert.equal(nextHighest, undefined);
+      });
+
+      it('returns original highest priority url if all urls in service were already marked as failure', () => {
+        catalog.updateServiceGroups('postauth', formattedServiceHostmapV2);
+
+        const currentHighest = catalog._getServiceDetail('urn:TEAM:us-east-2_a:conversation').get();
+
+        assert.equal(currentHighest, 'https://prod-achm-message.svc.webex.com/conversation/api/v1');
+
+        catalog
+          ._getServiceDetail('urn:TEAM:us-east-2_a:conversation')
+          .serviceUrls.forEach((url) => (url.failed = true));
+
+        const nextHighest = catalog.markFailedServiceUrl(
+          'https://prod-achm-message.svc.webex.com/conversation/api/v1'
+        );
+
+        assert.equal(nextHighest, 'https://prod-achm-message.svc.webex.com/conversation/api/v1');
+      });
+    });
+
+    describe('findServiceDetailFromUrl()', () => {
+      const otherService = {
+        serviceUrls: [
+          {baseUrl: 'https://example.com/differentresource'},
+          {baseUrl: 'https://example.com/differentresource'},
+        ],
+      };
+
+      it.each(['discovery', 'preauth', 'signin', 'postauth', 'override'])(
+        'matches a default url correctly',
+        (serviceGroup) => {
+          const url = 'https://example.com/resource/id';
+
+          const exampleService = {
+            serviceUrls: [
+              {baseUrl: 'https://example.com/resource'},
+              {baseUrl: 'https://example2.com/resource'},
+            ],
+          };
+
+          catalog.serviceGroups[serviceGroup].push(otherService, exampleService);
+
+          const service = catalog.findServiceDetailFromUrl(url);
+
+          assert.equal(service, exampleService);
+        }
+      );
+
+      it.each(['discovery', 'preauth', 'signin', 'postauth', 'override'])(
+        'matches an alternate host url',
+        (serviceGroup) => {
+          const url = 'https://example2.com/resource/id';
+
+          const exampleService = {
+            serviceUrls: [
+              {baseUrl: 'https://example.com/resource'},
+              {baseUrl: 'https://example2.com/resource'},
+            ],
+          };
+
+          catalog.serviceGroups[serviceGroup].push(otherService, exampleService);
+
+          const service = catalog.findServiceDetailFromUrl(url);
+
+          assert.equal(service, exampleService);
+        }
+      );
+    });
+  });
+});