@webex/webex-core 3.12.0-next.9 → 3.12.0-webex-services-ready.1

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

@@ -34,6 +34,53 @@ describe('webex-core', () => {
     });
 
     describe('#initialize', () => {
+      it('listens for "loaded" event instead of "ready" to avoid deadlock', () => {
+        services.listenToOnce = sinon.stub();
+        services.initialize();
+
+        // Second listenToOnce call should be for 'loaded' event
+        assert.equal(services.listenToOnce.getCall(1).args[1], 'loaded');
+      });
+
+      it('services.ready starts as false', () => {
+        assert.isFalse(services.ready);
+      });
+
+      it('sets ready to true and triggers services:initialized when initialization succeeds with credentials', async () => {
+        services.listenToOnce = sinon.stub();
+        services.initServiceCatalogs = sinon.stub().returns(Promise.resolve());
+        services.trigger = sinon.stub();
+        services.webex.credentials = {
+          supertoken: {
+            access_token: 'token',
+          },
+        };
+
+        services.initialize();
+
+        // call the onLoaded callback
+        services.listenToOnce.getCall(1).args[2]();
+        await waitForAsync();
+
+        assert.isTrue(services.ready);
+        sinon.assert.calledWith(services.trigger, 'services:initialized');
+      });
+
+      it('sets ready to true and triggers services:initialized when initialization succeeds without credentials', async () => {
+        services.listenToOnce = sinon.stub();
+        services.collectPreauthCatalog = sinon.stub().returns(Promise.resolve());
+        services.trigger = sinon.stub();
+
+        services.initialize();
+
+        // call the onLoaded callback
+        services.listenToOnce.getCall(1).args[2]();
+        await waitForAsync();
+
+        assert.isTrue(services.ready);
+        sinon.assert.calledWith(services.trigger, 'services:initialized');
+      });
+
       it('initFailed is false when initialization succeeds and credentials are available', async () => {
         services.listenToOnce = sinon.stub();
         services.initServiceCatalogs = sinon.stub().returns(Promise.resolve());
@@ -45,7 +92,7 @@ describe('webex-core', () => {
 
         services.initialize();
 
-        // call the onReady callback
+        // call the onLoaded callback
         services.listenToOnce.getCall(1).args[2]();
         await waitForAsync();
 
@@ -58,7 +105,7 @@ describe('webex-core', () => {
 
         services.initialize();
 
-        // call the onReady callback
+        // call the onLoaded callback
         services.listenToOnce.getCall(1).args[2]();
         await waitForAsync();
 
@@ -69,7 +116,7 @@ describe('webex-core', () => {
         {error: new Error('failed'), expectedMessage: 'failed'},
         {error: undefined, expectedMessage: undefined},
       ])(
-        'sets initFailed to true when collectPreauthCatalog errors',
+        'sets initFailed to true when collectPreauthCatalog errors but still sets ready to true',
         async ({error, expectedMessage}) => {
           services.collectPreauthCatalog = sinon.stub().callsFake(() => {
             return Promise.reject(error);
@@ -77,15 +124,18 @@ describe('webex-core', () => {
 
           services.listenToOnce = sinon.stub();
           services.logger.error = sinon.stub();
+          services.trigger = sinon.stub();
 
           services.initialize();
 
-          // call the onReady callback
+          // call the onLoaded callback
           services.listenToOnce.getCall(1).args[2]();
 
           await waitForAsync();
 
           assert.isTrue(services.initFailed);
+          assert.isTrue(services.ready);
+          sinon.assert.calledWith(services.trigger, 'services:initialized');
           sinon.assert.calledWith(
             services.logger.error,
             `services: failed to init initial services when no credentials available, ${expectedMessage}`
@@ -97,7 +147,7 @@ describe('webex-core', () => {
         {error: new Error('failed'), expectedMessage: 'failed'},
         {error: undefined, expectedMessage: undefined},
       ])(
-        'sets initFailed to true when initServiceCatalogs errors',
+        'sets initFailed to true when initServiceCatalogs errors but still sets ready to true',
         async ({error, expectedMessage}) => {
           services.initServiceCatalogs = sinon.stub().callsFake(() => {
             return Promise.reject(error);
@@ -110,21 +160,118 @@ describe('webex-core', () => {
 
           services.listenToOnce = sinon.stub();
           services.logger.error = sinon.stub();
+          services.trigger = sinon.stub();
 
           services.initialize();
 
-          // call the onReady callback
+          // call the onLoaded callback
           services.listenToOnce.getCall(1).args[2]();
 
           await waitForAsync();
 
           assert.isTrue(services.initFailed);
+          assert.isTrue(services.ready);
+          sinon.assert.calledWith(services.trigger, 'services:initialized');
           sinon.assert.calledWith(
             services.logger.error,
             `services: failed to init initial services when credentials available, ${expectedMessage}`
           );
         }
       );
+
+      describe('when change:canAuthorize fires', () => {
+        it('calls initServiceCatalogs when canAuthorize becomes true and postauth catalog is not ready', async () => {
+          services.listenToOnce = sinon.stub();
+          services._loadCatalogFromCache = sinon.stub().returns(Promise.resolve(false));
+          services.collectPreauthCatalog = sinon.stub().returns(Promise.resolve());
+          services.initServiceCatalogs = sinon.stub().returns(Promise.resolve());
+          services.trigger = sinon.stub();
+          // Ensure no credentials so we go to the preauth path
+          services.webex.credentials = {};
+
+          services.initialize();
+
+          // Get the catalog after initialize creates it
+          const testCatalog = services._getCatalog();
+          testCatalog.status.postauth.ready = false;
+
+          // call the onLoaded callback (preauth path)
+          services.listenToOnce.getCall(1).args[2]();
+          await waitForAsync();
+
+          // Now set canAuthorize to true to simulate auth completing
+          services.webex.canAuthorize = true;
+
+          // call the change:canAuthorize callback (should be call 2)
+          services.listenToOnce.getCall(2).args[2]();
+          await waitForAsync();
+
+          sinon.assert.calledOnce(services.initServiceCatalogs);
+          assert.isTrue(testCatalog.isReady);
+        });
+
+        it('does not call initServiceCatalogs when postauth catalog is already ready', async () => {
+          services.listenToOnce = sinon.stub();
+          services._loadCatalogFromCache = sinon.stub().returns(Promise.resolve(false));
+          services.collectPreauthCatalog = sinon.stub().returns(Promise.resolve());
+          services.initServiceCatalogs = sinon.stub().returns(Promise.resolve());
+          services.trigger = sinon.stub();
+          // Ensure no credentials so we go to the preauth path
+          services.webex.credentials = {};
+
+          services.initialize();
+
+          // Get the catalog after initialize creates it
+          const testCatalog = services._getCatalog();
+
+          // call the onLoaded callback (preauth path)
+          services.listenToOnce.getCall(1).args[2]();
+          await waitForAsync();
+
+          // Set canAuthorize to true and postauth as ready BEFORE calling the callback
+          services.webex.canAuthorize = true;
+          testCatalog.status.postauth.ready = true;
+
+          // call the change:canAuthorize callback (should be call 2)
+          services.listenToOnce.getCall(2).args[2]();
+          await waitForAsync();
+
+          sinon.assert.notCalled(services.initServiceCatalogs);
+        });
+
+        it('logs an error when initServiceCatalogs fails after auth', async () => {
+          services.listenToOnce = sinon.stub();
+          services._loadCatalogFromCache = sinon.stub().returns(Promise.resolve(false));
+          services.collectPreauthCatalog = sinon.stub().returns(Promise.resolve());
+          services.initServiceCatalogs = sinon.stub().rejects(new Error('auth failed'));
+          services.logger.error = sinon.stub();
+          services.trigger = sinon.stub();
+          // Ensure no credentials so we go to the preauth path
+          services.webex.credentials = {};
+
+          services.initialize();
+
+          // Get the catalog after initialize creates it
+          const testCatalog = services._getCatalog();
+          testCatalog.status.postauth.ready = false;
+
+          // call the onLoaded callback (preauth path)
+          services.listenToOnce.getCall(1).args[2]();
+          await waitForAsync();
+
+          // Now set canAuthorize to true to simulate auth completing
+          services.webex.canAuthorize = true;
+
+          // call the change:canAuthorize callback (should be call 2)
+          services.listenToOnce.getCall(2).args[2]();
+          await waitForAsync();
+
+          sinon.assert.calledWith(
+            services.logger.error,
+            'services: failed to init service catalogs after auth, auth failed'
+          );
+        });
+      });
     });
 
     describe('#initServiceCatalogs', () => {
@@ -278,7 +425,7 @@ describe('webex-core', () => {
 
         services.initServiceCatalogs = sinon.stub().returns(Promise.resolve());
         services.webex.credentials = {
-          getOrgId: sinon.stub().returns('')
+          getOrgId: sinon.stub().returns(''),
         };
         catalog.status = {};
       });
@@ -319,7 +466,7 @@ describe('webex-core', () => {
         const serviceGroup = 'postauth';
         const hostmap = {services: [{hostmap: 'hostmap'}]};
 
-        services._formatReceivedHostmap = sinon.stub().returns({services : [{some: 'hostmap'}]});
+        services._formatReceivedHostmap = sinon.stub().returns({services: [{some: 'hostmap'}]});
 
         catalog.updateServiceGroups = sinon.stub().returns(Promise.resolve([{some: 'value'}]));
 
@@ -335,7 +482,7 @@ describe('webex-core', () => {
         const serviceGroup = 'postauth';
         const hostmap = {};
 
-        services._formatReceivedHostmap = sinon.stub().returns({services : undefined});
+        services._formatReceivedHostmap = sinon.stub().returns({services: undefined});
 
         catalog.updateServiceGroups = sinon.stub().returns(Promise.resolve([{some: 'value'}]));
 
@@ -574,13 +721,13 @@ describe('webex-core', () => {
     });
 
     describe('#invalidateCache', () => {
-      beforeEach( () => {
+      beforeEach(() => {
         services.initServiceCatalogs = sinon.stub().returns(Promise.resolve());
         services.webex.credentials = {
-          getOrgId: sinon.stub().returns('')
+          getOrgId: sinon.stub().returns(''),
         };
         catalog.status = {};
-      })
+      });
       it('should log the timestamp parameter', async () => {
         const timestamp = '1234567890';
         services.logger.info = sinon.stub();
@@ -588,7 +735,11 @@ describe('webex-core', () => {
 
         await services.invalidateCache(timestamp);
 
-        assert.calledWith(services.logger.info, 'services: invalidate cache, timestamp:', timestamp);
+        assert.calledWith(
+          services.logger.info,
+          'services: invalidate cache, timestamp:',
+          timestamp
+        );
       });
 
       it('should call initServiceCatalogs when invalidate timestamp is newer than catalog timestamp', async () => {
@@ -715,30 +866,30 @@ describe('webex-core', () => {
         // Arrange: seed internal _services with mobius (including duplicate baseUrl)
         services._services = [
           {
-            "id": "urn:TEAM:us-east-2_a:mobius",
-            "serviceName": 'mobius',
-            "serviceUrls": [
-              {"baseUrl": 'https://mobius-us-east-2.prod.infra.webex.com/api/v1', "priority": 5},
-              {"baseUrl": 'https://mobius-eu-central-1.prod.infra.webex.com/api/v1', "priority": 10},
-              {"baseUrl": 'https://mobius-ap-southeast-2.prod.infra.webex.com/api/v1', "priority": 15}, // duplicate
+            id: 'urn:TEAM:us-east-2_a:mobius',
+            serviceName: 'mobius',
+            serviceUrls: [
+              {baseUrl: 'https://mobius-us-east-2.prod.infra.webex.com/api/v1', priority: 5},
+              {baseUrl: 'https://mobius-eu-central-1.prod.infra.webex.com/api/v1', priority: 10},
+              {baseUrl: 'https://mobius-ap-southeast-2.prod.infra.webex.com/api/v1', priority: 15}, // duplicate
             ],
           },
           {
-            "id": "urn:TEAM:ap-southeast-2_m:mobius",
-            "serviceName": "mobius",
-            "serviceUrls": [
-                {
-                    "baseUrl": "https://mobius-me-central-1.prod.infra.webex.com/api/v1",
-                    "priority": 5
-                },
-                {
-                    "baseUrl": "https://mobius-eu-central-1.prod.infra.webex.com/api/v1",
-                    "priority": 10
-                },
-                {
-                    "baseUrl": "https://mobius-ap-southeast-2.prod.infra.webex.com/api/v1",
-                    "priority": 15
-                },
+            id: 'urn:TEAM:ap-southeast-2_m:mobius',
+            serviceName: 'mobius',
+            serviceUrls: [
+              {
+                baseUrl: 'https://mobius-me-central-1.prod.infra.webex.com/api/v1',
+                priority: 5,
+              },
+              {
+                baseUrl: 'https://mobius-eu-central-1.prod.infra.webex.com/api/v1',
+                priority: 10,
+              },
+              {
+                baseUrl: 'https://mobius-ap-southeast-2.prod.infra.webex.com/api/v1',
+                priority: 15,
+              },
             ],
           },
           // Non-mobius service should be ignored by getMobiusClusters
@@ -756,42 +907,64 @@ describe('webex-core', () => {
         assert.deepEqual(
           clusters.map(({host, id, ttl, priority}) => ({host, id, ttl, priority})),
           [
-            {host: 'mobius-us-east-2.prod.infra.webex.com', id: 'urn:TEAM:us-east-2_a:mobius', ttl: 0, priority: 5},
-            {host: 'mobius-eu-central-1.prod.infra.webex.com', id: 'urn:TEAM:us-east-2_a:mobius', ttl: 0, priority: 10},
-            {host: 'mobius-ap-southeast-2.prod.infra.webex.com', id: 'urn:TEAM:us-east-2_a:mobius', ttl: 0, priority: 15},
-            {host: 'mobius-me-central-1.prod.infra.webex.com', id: 'urn:TEAM:ap-southeast-2_m:mobius', ttl: 0, priority: 5},
+            {
+              host: 'mobius-us-east-2.prod.infra.webex.com',
+              id: 'urn:TEAM:us-east-2_a:mobius',
+              ttl: 0,
+              priority: 5,
+            },
+            {
+              host: 'mobius-eu-central-1.prod.infra.webex.com',
+              id: 'urn:TEAM:us-east-2_a:mobius',
+              ttl: 0,
+              priority: 10,
+            },
+            {
+              host: 'mobius-ap-southeast-2.prod.infra.webex.com',
+              id: 'urn:TEAM:us-east-2_a:mobius',
+              ttl: 0,
+              priority: 15,
+            },
+            {
+              host: 'mobius-me-central-1.prod.infra.webex.com',
+              id: 'urn:TEAM:ap-southeast-2_m:mobius',
+              ttl: 0,
+              priority: 5,
+            },
           ]
         );
       });
     });
-    
+
     describe('#isValidHost', () => {
       beforeEach(() => {
         // Setting up a mock services list
-         services._services = [{
-            "id": "urn:IDENTITY:PC75:adminAudit",
-            "serviceName": "adminAudit",
-            "serviceUrls": [
-                {
-                    "baseUrl": "https://audit-ci-r.wbx2.com/audit-ci/api/v2",
-                    "priority": 5
-                },
-                 {
-                    "baseUrl": "https://audit-ci-t.wbx2.com/audit-ci/api/v2",
-                    "priority": 10
-                }
-            ]
-        },
-         {
-            "id": "urn:IDENTITY:PC75:cdf",
-            "serviceName": "cdf",
-            "serviceUrls": [
-                {
-                    "baseUrl": "https://wapdavis.webex.com/davis/api/v1",
-                    "priority": 5
-                }
-            ]
-        }];
+        services._services = [
+          {
+            id: 'urn:IDENTITY:PC75:adminAudit',
+            serviceName: 'adminAudit',
+            serviceUrls: [
+              {
+                baseUrl: 'https://audit-ci-r.wbx2.com/audit-ci/api/v2',
+                priority: 5,
+              },
+              {
+                baseUrl: 'https://audit-ci-t.wbx2.com/audit-ci/api/v2',
+                priority: 10,
+              },
+            ],
+          },
+          {
+            id: 'urn:IDENTITY:PC75:cdf',
+            serviceName: 'cdf',
+            serviceUrls: [
+              {
+                baseUrl: 'https://wapdavis.webex.com/davis/api/v1',
+                priority: 5,
+              },
+            ],
+          },
+        ];
       });
       afterAll(() => {
         // Clean up the mock services list

package/test/unit/spec/webex-core.js

@@ -397,6 +397,8 @@ describe('Webex', () => {
     return new Promise((resolve) => webex.once('loaded', resolve)).then(() => {
       assert.isFalse(webex.ready);
       assert.isFalse(webex.test.ready);
+      // Set services.ready to true since it now blocks webex.ready
+      webex.internal.services.ready = true;
       webex.test.ready = true;
       assert.isTrue(webex.test.ready);
       assert.isTrue(webex.ready);

package/test/unit/spec/webex-internal-core.js

@@ -82,6 +82,8 @@ describe('Webex', () => {
         assert.isFalse(webex.internal.test.ready);
         assert.isFalse(webex.internal.ready);
         assert.isFalse(webex.ready);
+        // Set services.ready to true since it now blocks webex.ready
+        webex.internal.services.ready = true;
         webex.internal.test.ready = true;
         assert.isTrue(webex.internal.ready);
         assert.isTrue(webex.ready);