@webex/internal-plugin-llm 3.11.0 → 3.12.0-llmrefactor.1

package/test/unit/spec/llm.js

@@ -2,152 +2,540 @@ import MockWebex from '@webex/test-helper-mock-webex';
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 import Mercury from '@webex/internal-plugin-mercury';
-import LLMService from '@webex/internal-plugin-llm';
+import LLMChannel from '@webex/internal-plugin-llm/src/llm';
 
 describe('plugin-llm', () => {
   const locusUrl = 'locusUrl';
   const datachannelUrl = 'datachannelUrl';
 
-  describe('llm', () => {
-    let webex, llmService;
+  describe('LLMChannel', () => {
+    let webex, llmChannel;
 
     beforeEach(() => {
       webex = new MockWebex({
         children: {
           mercury: Mercury,
-          llm: LLMService,
+          llm: LLMChannel,
         },
       });
 
-      llmService = webex.internal.llm;
-      llmService.connect = sinon.stub().callsFake(() => {
-        llmService.connected = true;
-      });
-      llmService.disconnect = sinon.stub().resolves(true);
-      llmService.request = sinon.stub().resolves({
+      webex.internal.feature = {
+        setFeature: sinon.stub().resolves({value: true}),
+        getFeature: sinon.stub().resolves(true),
+      };
+
+      llmChannel = webex.internal.llm;
+      // Stub Mercury's prototype disconnect so super.disconnect() works in tests
+      sinon.stub(Object.getPrototypeOf(Object.getPrototypeOf(llmChannel)), 'disconnect').resolves();
+      llmChannel.request = sinon.stub().resolves({
         headers: {},
         body: {
           binding: 'binding',
-          webSocketUrl: 'url',
+          webSocketUrl: 'wss://example.com/socket',
         },
       });
+      llmChannel.connect = sinon.stub().callsFake(() => {
+        llmChannel.connected = true;
+      });
     });
 
+    afterEach(() => sinon.restore());
+
     describe('#registerAndConnect', () => {
-      it('registers connection', async () => {
-        llmService.register = sinon.stub().resolves({
-          body: {
-            binding: 'binding',
-            webSocketUrl: 'url',
-          },
+      it('registers and connects', async () => {
+        assert.equal(llmChannel.isConnected(), false);
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        assert.equal(llmChannel.isConnected(), true);
+        assert.equal(llmChannel.getLocusUrl(), locusUrl);
+        assert.equal(llmChannel.getDatachannelUrl(), datachannelUrl);
+      });
+
+      it('connects with subscriptionAwareSubchannels when token enabled', async () => {
+        llmChannel.isDataChannelTokenEnabled = sinon.stub().resolves(true);
+
+        const buildSpy = sinon.spy(LLMChannel, 'buildUrlWithAwareSubchannels');
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl, 'abc123');
+
+        sinon.assert.calledOnce(buildSpy);
+        sinon.assert.calledOnce(llmChannel.connect);
+
+        const calledUrl = llmChannel.connect.getCall(0).args[0];
+        assert.include(calledUrl, 'subscriptionAwareSubchannels=');
+      });
+
+      it('connects without subscriptionAwareSubchannels when token disabled', async () => {
+        llmChannel.isDataChannelTokenEnabled = sinon.stub().resolves(false);
+
+        const buildSpy = sinon.spy(LLMChannel, 'buildUrlWithAwareSubchannels');
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        sinon.assert.notCalled(buildSpy);
+        sinon.assert.calledOnce(llmChannel.connect);
+
+        const calledUrl = llmChannel.connect.getCall(0).args[0];
+        assert.equal(calledUrl, 'wss://example.com/socket');
+      });
+
+      it('connects with subscriptionAwareSubchannels when token enabled but token missing', async () => {
+        llmChannel.isDataChannelTokenEnabled = sinon.stub().resolves(true);
+
+        const buildSpy = sinon.spy(LLMChannel, 'buildUrlWithAwareSubchannels');
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl, undefined);
+
+        sinon.assert.calledOnce(buildSpy);
+        sinon.assert.calledOnce(llmChannel.connect);
+
+        const calledUrl = llmChannel.connect.getCall(0).args[0];
+        assert.include(calledUrl, 'subscriptionAwareSubchannels=');
+
+        buildSpy.restore();
+      });
+
+      it('deduplicates concurrent calls', async () => {
+        const promise1 = llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        const promise2 = llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        assert.strictEqual(promise1, promise2);
+        await promise1;
+      });
+
+      it('avoids reconnect if already connected to same URLs', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        sinon.assert.calledOnce(llmChannel.connect);
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        sinon.assert.calledOnce(llmChannel.connect);
+      });
+
+      it('propagates error when registration request fails', async () => {
+        const error = new Error('Network failure');
+        llmChannel.request = sinon.stub().rejects(error);
+
+        try {
+          await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+          assert.fail('should have thrown');
+        } catch (e) {
+          assert.equal(e.message, 'Network failure');
+        }
+
+        sinon.assert.notCalled(llmChannel.connect);
+      });
+
+      it('returns timing data on successful connection', async () => {
+        const clock = sinon.useFakeTimers();
+
+        llmChannel.request = sinon.stub().callsFake(async () => {
+          clock.tick(37);
+
+          return {
+            headers: {},
+            body: {
+              binding: 'binding',
+              webSocketUrl: 'wss://example.com/socket',
+            },
+          };
+        });
+        llmChannel.connect = sinon.stub().callsFake(async () => {
+          clock.tick(23);
+          llmChannel.connected = true;
+        });
+
+        const result = await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        assert.deepEqual(result, {
+          clientLLMDatachannelResponseTime: 37,
+          clientLLMWebSocketConnectTime: 23,
+        });
+
+        clock.restore();
+      });
+
+      it('attaches timing to error when connect fails', async () => {
+        const clock = sinon.useFakeTimers();
+
+        llmChannel.request = sinon.stub().callsFake(async () => {
+          clock.tick(37);
+
+          return {
+            headers: {},
+            body: {
+              binding: 'binding',
+              webSocketUrl: 'wss://example.com/socket',
+            },
+          };
         });
-        assert.equal(llmService.isConnected(), false);
-        await llmService.registerAndConnect(locusUrl, datachannelUrl);
-        assert.equal(llmService.isConnected(), true);
+
+        const connectError = new Error('websocket connect failed');
+        llmChannel.connect = sinon.stub().rejects(connectError);
+
+        let caughtError;
+        try {
+          await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        } catch (error) {
+          caughtError = error;
+        }
+
+        assert.equal(caughtError, connectError);
+        assert.deepEqual(caughtError.timing, {clientLLMDatachannelResponseTime: 37});
+
+        clock.restore();
+      });
+
+      it('clears connectingPromise after successful connection', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        // After completion, a new call should create a fresh promise (not deduplicated)
+        llmChannel.connect.resetHistory();
+        llmChannel.request.resetHistory();
+
+        // Simulate different URLs to force new connection
+        await llmChannel.registerAndConnect('newLocusUrl', 'newDatachannelUrl');
+
+        // Should have called request again since connectingPromise was cleared
+        sinon.assert.calledOnce(llmChannel.request);
       });
 
-      it("doesn't registers connection for invalid input", async () => {
-        llmService.register = sinon.stub().resolves({
-          body: {
-            binding: 'binding',
-            webSocketUrl: 'url',
-          },
+      it('clears connectingPromise after failed connection', async () => {
+        llmChannel.connect = sinon.stub().rejects(new Error('connect failed'));
+
+        try {
+          await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        } catch (e) {
+          // expected
+        }
+
+        // Reset and try again - should not deduplicate since promise was cleared
+        llmChannel.connect = sinon.stub().callsFake(() => {
+          llmChannel.connected = true;
         });
-        await llmService.registerAndConnect();
-        assert.equal(llmService.isConnected(), false);
+        llmChannel.request.resetHistory();
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        // Should have called request again
+        sinon.assert.calledOnce(llmChannel.request);
+      });
+
+      it('returns undefined when already connected to same URLs', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        const result = await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        assert.equal(result, undefined);
       });
     });
 
-    describe('#register', () => {
-      it('registers connection', async () => {
-        await llmService.register(datachannelUrl);
+    describe('#register (via registerAndConnect)', () => {
+      it('sends request with token header when token enabled and provided', async () => {
+        llmChannel.isDataChannelTokenEnabled = sinon.stub().resolves(true);
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl, 'abc123');
+
+        sinon.assert.calledOnceWithExactly(
+          llmChannel.request,
+          sinon.match({
+            method: 'POST',
+            url: datachannelUrl,
+            body: {deviceUrl: webex.internal.device.url},
+            headers: {'Data-Channel-Auth-Token': 'abc123'},
+          })
+        );
+      });
+
+      it('sends request without token header when none provided', async () => {
+        llmChannel.isDataChannelTokenEnabled = sinon.stub().resolves(true);
+
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
 
         sinon.assert.calledOnceWithExactly(
-          llmService.request,
+          llmChannel.request,
           sinon.match({
             method: 'POST',
-            url: `${datachannelUrl}`,
+            url: datachannelUrl,
             body: {deviceUrl: webex.internal.device.url},
+            headers: {},
           })
         );
+      });
+
+      it('sends request without token header when toggle disabled', async () => {
+        llmChannel.isDataChannelTokenEnabled = sinon.stub().resolves(false);
 
-        assert.equal(llmService.getBinding(), 'binding');
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl, 'abc123');
+
+        sinon.assert.calledOnceWithExactly(
+          llmChannel.request,
+          sinon.match({
+            method: 'POST',
+            url: datachannelUrl,
+            body: {deviceUrl: webex.internal.device.url},
+            headers: {},
+          })
+        );
       });
     });
 
     describe('#getLocusUrl', () => {
       it('gets LocusUrl', async () => {
-        llmService.register = sinon.stub().resolves({
-          body: {
-            binding: 'binding',
-            webSocketUrl: 'url',
-          },
-        });
-        await llmService.registerAndConnect(locusUrl, datachannelUrl);
-        assert.equal(llmService.getLocusUrl(), locusUrl);
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        assert.equal(llmChannel.getLocusUrl(), locusUrl);
+      });
+
+      it('returns undefined before connection', () => {
+        assert.equal(llmChannel.getLocusUrl(), undefined);
       });
     });
 
     describe('#getDatachannelUrl', () => {
       it('gets dataChannel Url', async () => {
-        llmService.register = sinon.stub().resolves({
-          body: {
-            binding: 'binding',
-            webSocketUrl: 'url',
-          },
-        });
-        await llmService.registerAndConnect(locusUrl, datachannelUrl);
-        assert.equal(llmService.getDatachannelUrl(), datachannelUrl);
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        assert.equal(llmChannel.getDatachannelUrl(), datachannelUrl);
+      });
+
+      it('returns undefined before connection', () => {
+        assert.equal(llmChannel.getDatachannelUrl(), undefined);
+      });
+    });
+
+    describe('#getBinding', () => {
+      it('gets binding after connection', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        assert.equal(llmChannel.getBinding(), 'binding');
+      });
+
+      it('returns undefined before connection', () => {
+        assert.equal(llmChannel.getBinding(), undefined);
+      });
+    });
+
+    describe('#isConnecting', () => {
+      it('returns true while connection is in progress', () => {
+        // Start connection but don't await
+        llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        assert.equal(llmChannel.isConnecting(), true);
+      });
+
+      it('returns false after connection completes', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        assert.equal(llmChannel.isConnecting(), false);
+      });
+
+      it('returns false before any connection attempt', () => {
+        assert.equal(llmChannel.isConnecting(), false);
       });
     });
 
     describe('#disconnect', () => {
-      it('disconnects mercury', async () => {
-        await llmService.disconnect();
-        sinon.assert.calledOnce(llmService.disconnect);
-        assert.equal(llmService.isConnected(), false);
-        assert.equal(llmService.getLocusUrl(), undefined);
-        assert.equal(llmService.getDatachannelUrl(), undefined);
-        assert.equal(llmService.getBinding(), undefined);
+      it('calls super.disconnect and clears all connection state', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        llmChannel.setDatachannelToken('token123');
+
+        assert.equal(llmChannel.isConnected(), true);
+        assert.equal(llmChannel.getLocusUrl(), locusUrl);
+        assert.equal(llmChannel.getDatachannelUrl(), datachannelUrl);
+        assert.equal(llmChannel.getBinding(), 'binding');
+        assert.equal(llmChannel.getDatachannelToken(), 'token123');
+
+        await llmChannel.disconnect({code: 1000, reason: 'test'});
+
+        assert.equal(llmChannel.getLocusUrl(), undefined);
+        assert.equal(llmChannel.getDatachannelUrl(), undefined);
+        assert.equal(llmChannel.getBinding(), undefined);
+        assert.equal(llmChannel.getDatachannelToken(), undefined);
+      });
+
+      it('works without options', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+
+        await llmChannel.disconnect();
+
+        assert.equal(llmChannel.getLocusUrl(), undefined);
+      });
+
+      it('propagates disconnect errors', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        // Change the existing stub to reject
+        Object.getPrototypeOf(Object.getPrototypeOf(llmChannel)).disconnect.rejects(
+          new Error('disconnect failed')
+        );
+
+        try {
+          await llmChannel.disconnect({code: 1000, reason: 'test'});
+          assert.fail('should have thrown');
+        } catch (error) {
+          assert.equal(error.message, 'disconnect failed');
+        }
+      });
+
+      it('emits disconnected event', async () => {
+        await llmChannel.registerAndConnect(locusUrl, datachannelUrl);
+        const disconnectedSpy = sinon.spy();
+
+        llmChannel.on('disconnected', disconnectedSpy);
+
+        await llmChannel.disconnect({code: 1000, reason: 'test'});
+
+        sinon.assert.calledOnce(disconnectedSpy);
+      });
+    });
+
+    describe('#setRefreshHandler', () => {
+      it('stores the provided handler', async () => {
+        const handler = sinon.stub().resolves({body: {datachannelToken: 'newToken'}});
+        llmChannel.setRefreshHandler(handler);
+
+        const result = await llmChannel.refreshDataChannelToken();
+
+        assert.equal(result.body.datachannelToken, 'newToken');
+        sinon.assert.calledOnce(handler);
+      });
+    });
+
+    describe('#isDataChannelTokenEnabled', () => {
+      it('returns value from feature toggle', async () => {
+        webex.internal.feature.getFeature.resolves(true);
+
+        const result = await llmChannel.isDataChannelTokenEnabled();
+
+        sinon.assert.calledOnceWithExactly(
+          webex.internal.feature.getFeature,
+          'developer',
+          'data-channel-with-jwt-token'
+        );
+
+        assert.equal(result, true);
+      });
+    });
+
+    describe('#refreshDataChannelToken', () => {
+      it('returns null and logs warn if no handler is set', async () => {
+        const warnSpy = llmChannel.logger.warn;
+
+        const result = await llmChannel.refreshDataChannelToken();
+
+        assert.equal(result, null);
+
+        sinon.assert.calledOnce(warnSpy);
+        sinon.assert.calledWithMatch(warnSpy, sinon.match('LLM refreshHandler is not set'));
+      });
+
+      it('returns token when handler resolves', async () => {
+        const mockToken = {body: {datachannelToken: 'newToken', datachannelTokenType: 'default'}};
+        const handler = sinon.stub().resolves(mockToken);
+
+        llmChannel.setRefreshHandler(handler);
+
+        const token = await llmChannel.refreshDataChannelToken();
+
+        assert.equal(token, mockToken);
+        sinon.assert.calledOnce(handler);
+      });
+
+      it('logs warn and returns null when handler rejects', async () => {
+        const handler = sinon.stub().rejects(new Error('throw error'));
+        llmChannel.setRefreshHandler(handler);
+
+        const warnSpy = llmChannel.logger.warn;
+
+        const result = await llmChannel.refreshDataChannelToken();
+
+        assert.equal(result, null);
+
+        sinon.assert.calledOnce(warnSpy);
+        sinon.assert.calledWithMatch(warnSpy, sinon.match('DataChannel token refresh failed'));
+      });
+    });
+
+    describe('#getDatachannelToken / #setDatachannelToken / #clearDatachannelToken', () => {
+      it('sets and gets datachannel token', () => {
+        llmChannel.setDatachannelToken('abc123');
+        assert.equal(llmChannel.getDatachannelToken(), 'abc123');
+      });
+
+      it('returns undefined when no token is set', () => {
+        assert.equal(llmChannel.getDatachannelToken(), undefined);
+      });
+
+      it('clears datachannel token', () => {
+        llmChannel.setDatachannelToken('abc123');
+        assert.equal(llmChannel.getDatachannelToken(), 'abc123');
+
+        llmChannel.clearDatachannelToken();
+        assert.equal(llmChannel.getDatachannelToken(), undefined);
       });
     });
 
-    describe('disconnectLLM', () => {
-      let instance;
+    describe('.matchesDatachannelRequestUrl', () => {
+      it('returns true when request URL starts with registration URL', () => {
+        const registrationUrl =
+          'https://board.wbx2.com/datachannel/api/v1/locus/ps-encoded/registrations';
+        const requestUrl = registrationUrl + '/some-path';
+
+        const result = LLMChannel.matchesDatachannelRequestUrl(requestUrl, registrationUrl);
+
+        assert.equal(result, true);
+      });
+
+      it('returns false when URLs do not match', () => {
+        const registrationUrl =
+          'https://board.wbx2.com/datachannel/api/v1/locus/ps-encoded/registrations';
+        const requestUrl = 'https://unknown.example.com/path';
+
+        const result = LLMChannel.matchesDatachannelRequestUrl(requestUrl, registrationUrl);
+
+        assert.equal(result, false);
+      });
+
+      it('returns true when request host is rewritten but pathname matches', () => {
+        const registrationUrl =
+          'https://board-b.wbx2.com/datachannel/api/v1/locus/ps-encoded/registrations';
+        const requestUrl =
+          'https://hostmap-rewritten.example.com/datachannel/api/v1/locus/ps-encoded/registrations/events';
+
+        const result = LLMChannel.matchesDatachannelRequestUrl(requestUrl, registrationUrl);
+
+        assert.equal(result, true);
+      });
 
-      beforeEach(() => {
-        instance = {
-          disconnect: jest.fn(() => Promise.resolve()),
-          locusUrl: 'someUrl',
-          datachannelUrl: 'someUrl',
-          binding: {},
-          webSocketUrl: 'someUrl',
-          disconnectLLM: function (options) {
-            return this.disconnect(options).then(() => {
-              this.locusUrl = undefined;
-              this.datachannelUrl = undefined;
-              this.binding = undefined;
-              this.webSocketUrl = undefined;
-            });
-          }
-        };
+      it('returns false for empty or null URLs', () => {
+        assert.equal(LLMChannel.matchesDatachannelRequestUrl('', 'https://example.com'), false);
+        assert.equal(LLMChannel.matchesDatachannelRequestUrl('https://example.com', ''), false);
+        assert.equal(LLMChannel.matchesDatachannelRequestUrl(null, 'https://example.com'), false);
+        assert.equal(LLMChannel.matchesDatachannelRequestUrl('https://example.com', null), false);
       });
 
-      it('should call disconnect and clear relevant properties', async () => {
-        await instance.disconnectLLM({});
+      it('returns false for invalid URLs', () => {
+        const result = LLMChannel.matchesDatachannelRequestUrl('not-a-url', 'also-not-a-url');
 
-        expect(instance.disconnect).toHaveBeenCalledWith({});
-        expect(instance.locusUrl).toBeUndefined();
-        expect(instance.datachannelUrl).toBeUndefined();
-        expect(instance.binding).toBeUndefined();
-        expect(instance.webSocketUrl).toBeUndefined();
+        assert.equal(result, false);
       });
+    });
+
+    describe('.buildUrlWithAwareSubchannels', () => {
+      it('adds subscriptionAwareSubchannels query param', () => {
+        const baseUrl = 'wss://example.com/socket';
+        const subchannels = ['channel1', 'channel2'];
 
-      it('should handle errors from disconnect gracefully', async () => {
-        instance.disconnect.mockRejectedValue(new Error('Disconnect failed'));
+        const result = LLMChannel.buildUrlWithAwareSubchannels(baseUrl, subchannels);
 
-        await expect(instance.disconnectLLM({})).rejects.toThrow('Disconnect failed');
+        assert.include(result, 'subscriptionAwareSubchannels=channel1%2Cchannel2');
+      });
+
+      it('preserves existing query params', () => {
+        const baseUrl = 'wss://example.com/socket?existing=param';
+        const subchannels = ['channel1'];
+
+        const result = LLMChannel.buildUrlWithAwareSubchannels(baseUrl, subchannels);
+
+        assert.include(result, 'existing=param');
+        assert.include(result, 'subscriptionAwareSubchannels=channel1');
       });
     });
+
   });
 });