@webex/internal-plugin-ai-assistant 3.11.0 → 3.12.0

package/test/unit/spec/ai-assistant.ts

@@ -16,7 +16,14 @@ import {
   AI_ASSISTANT_ERROR_CODES,
   AI_ASSISTANT_ERRORS,
 } from '@webex/internal-plugin-ai-assistant/src/constants';
-import {jsonResponse, messageResponse, workspaceResponse, scheduleMeetingResponse} from '../data/messages';
+import {
+  jsonResponse,
+  messageResponse,
+  workspaceResponse,
+  scheduleMeetingResponse,
+  assistantActivity,
+  citedAnswerWithSourcesResponse,
+} from '../data/messages';
 
 const waitForAsync = () =>
   new Promise<void>((resolve) =>
@@ -78,12 +85,15 @@ describe('plugin-ai-assistant', () => {
       it('registers correctly', async () => {
         await webex.internal.aiAssistant.register();
 
-        assert.callCount(webex.internal.mercury.on, 1);
+        assert.callCount(webex.internal.mercury.on, 2);
 
-        const callArgs = webex.internal.mercury.on.getCall(0).args;
+        const firstCallArgs = webex.internal.mercury.on.getCall(0).args;
+        expect(firstCallArgs[0]).to.equal('event:assistant-api.response');
+        expect(firstCallArgs[1]).to.be.a('function');
 
-        expect(callArgs[0]).to.equal('event:assistant-api.response');
-        expect(callArgs[1]).to.be.a('function');
+        const secondCallArgs = webex.internal.mercury.on.getCall(1).args;
+        expect(secondCallArgs[0]).to.equal('assistant-api.activity');
+        expect(secondCallArgs[1]).to.be.a('function');
 
         assert.equal(webex.internal.aiAssistant.registered, true);
       });
@@ -115,11 +125,13 @@ describe('plugin-ai-assistant', () => {
 
         await webex.internal.aiAssistant.unregister();
 
-        assert.callCount(webex.internal.mercury.off, 1);
+        assert.callCount(webex.internal.mercury.off, 2);
 
-        const callArgs = webex.internal.mercury.off.getCall(0).args;
+        const firstCallOrg = webex.internal.mercury.off.getCall(0).args;
+        expect(firstCallOrg[0]).to.equal('event:assistant-api.response');
 
-        expect(callArgs[0]).to.equal('event:assistant-api.response');
+        const secondCallOrg = webex.internal.mercury.off.getCall(1).args;
+        expect(secondCallOrg[0]).to.equal('assistant-api.activity');
 
         assert.equal(webex.internal.aiAssistant.registered, false);
       });
@@ -130,7 +142,6 @@ describe('plugin-ai-assistant', () => {
         const result = await webex.internal.aiAssistant.unregister();
 
         expect(result).to.be.undefined;
-        assert.callCount(webex.internal.mercury.disconnect, 0);
         assert.equal(webex.internal.aiAssistant.registered, false);
       });
     });
@@ -225,6 +236,47 @@ describe('plugin-ai-assistant', () => {
             clientRequestId: 'test-request-id',
             param1: 'value1',
           },
+          headers: undefined,
+        });
+
+        const result = await requestPromise;
+
+        expect(result).to.deep.equal({
+          id: 'test-message-id',
+          url: 'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id/messages/test-message-id',
+          sessionId: 'test-session-id',
+          sessionUrl:
+            'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id',
+          creatorId: 'test-creator-id',
+          createdAt: '2025-08-05T02:11:12.361Z',
+          requestId: 'test-request-id',
+          streamEventName: 'aiassistant:stream:test-request-id',
+        });
+      });
+
+      it('makes a request with additional headers', async () => {
+        const requestPromise = webex.internal.aiAssistant._request({
+          resource: 'test-resource',
+          params: {param1: 'value1'},
+          headers: {
+            'X-Custom-Header': 'foo',
+            'X-Another-Header': 'bar',
+          },
+        });
+
+        expect(webex.request.getCall(0).args[0]).to.deep.equal({
+          service: 'assistant-api',
+          resource: 'test-resource',
+          method: 'POST',
+          contentType: 'application/json',
+          body: {
+            clientRequestId: 'test-request-id',
+            param1: 'value1',
+          },
+          headers: {
+            'X-Custom-Header': 'foo',
+            'X-Another-Header': 'bar',
+          },
         });
 
         const result = await requestPromise;
@@ -282,6 +334,28 @@ describe('plugin-ai-assistant', () => {
         expect(triggerSpy.getCall(2).args[1]).to.deep.equal(expectedResult);
       });
 
+      it('handles an activity', async () => {
+        const triggerSpy = sinon.spy(webex.internal.aiAssistant, 'trigger');
+
+        webex.internal.encryption.decryptText.callsFake(async (keyUrl, value) => {
+          return `decrypted-with-${keyUrl}-${value}`;
+        });
+
+        // assume assistant event is received
+        await webex.internal.aiAssistant._handleAssistantActivity(cloneDeep(assistantActivity[0]));
+
+        await waitForAsync();
+
+        let expectedResult = set(
+          cloneDeep(assistantActivity[0]),
+          'activity.content.value.message',
+          'decrypted-with-kms://kms-cisco.wbx2.com/keys/9b838423-f31b-49d5-a7c7-182572340a37-message_encrypted_value_for_activity'
+        );
+
+        expect(triggerSpy.getCall(0).args[0]).to.deep.equal('aiassistant:activityReceived');
+        expect(triggerSpy.getCall(0).args[1]).to.deep.equal(expectedResult);
+      });
+
       it('decrypts a chunked json response', async () => {
         const triggerSpy = sinon.spy(webex.internal.aiAssistant, 'trigger');
         webex.internal.encryption.decryptText.callsFake(async (keyUrl, value) => {
@@ -332,9 +406,7 @@ describe('plugin-ai-assistant', () => {
           responseType: 'thought',
         };
         expect(triggerSpy.getCall(1).args[0]).to.deep.equal('aiassistant:stream:test-request-id');
-        expect(triggerSpy.getCall(1).args[1]).to.deep.equal(
-          expectedResult
-        );
+        expect(triggerSpy.getCall(1).args[1]).to.deep.equal(expectedResult);
 
         triggerSpy.resetHistory();
 
@@ -443,7 +515,8 @@ describe('plugin-ai-assistant', () => {
             type: 'json',
             encryptionKeyUrl: 'kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e',
             value: {
-              value: 'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_3_encrypted_value',
+              value:
+                'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_3_encrypted_value',
               type: 'markdown',
             },
           },
@@ -574,12 +647,10 @@ describe('plugin-ai-assistant', () => {
         // Update the clientRequestId to match the test setup
         const firstEvent = cloneDeep(workspaceResponse[0]);
         firstEvent.clientRequestId = 'test-request-id';
-        
+
         await webex.internal.aiAssistant._handleEvent(firstEvent);
 
-        expect(triggerSpy.getCall(0).args[0]).to.equal(
-          `aiassistant:result:test-request-id`
-        );
+        expect(triggerSpy.getCall(0).args[0]).to.equal(`aiassistant:result:test-request-id`);
 
         await waitForAsync();
 
@@ -594,7 +665,7 @@ describe('plugin-ai-assistant', () => {
         // second event is another workspace chunk with an encrypted value
         const secondEvent = cloneDeep(workspaceResponse[1]);
         secondEvent.clientRequestId = 'test-request-id';
-        
+
         await webex.internal.aiAssistant._handleEvent(secondEvent);
 
         expectedResult = set(
@@ -604,7 +675,7 @@ describe('plugin-ai-assistant', () => {
         );
 
         expect(triggerSpy.getCall(2).args[1]).to.deep.equal(expectedResult);
-      });      
+      });
 
       it('handles a schedule meeting response', async () => {
         const triggerSpy = sinon.spy(webex.internal.aiAssistant, 'trigger');
@@ -620,35 +691,130 @@ describe('plugin-ai-assistant', () => {
         // Handle schedule meeting event with encrypted fields
         const event = cloneDeep(scheduleMeetingResponse[0]);
         event.clientRequestId = 'test-request-id';
-        
+
         await webex.internal.aiAssistant._handleEvent(event);
 
-        expect(triggerSpy.getCall(0).args[0]).to.equal(
-          `aiassistant:result:test-request-id`
-        );
+        expect(triggerSpy.getCall(0).args[0]).to.equal(`aiassistant:result:test-request-id`);
 
         await waitForAsync();
 
         // Verify all encrypted fields were decrypted
         const expectedResult = cloneDeep(event);
-        expectedResult.response.content.parameters.commentary = 
+        expectedResult.response.content.parameters.commentary =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_commentary';
-        expectedResult.response.content.value.results.data.attendees[0].email = 
+        expectedResult.response.content.value.results.data.attendees[0].email =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_email_0';
-        expectedResult.response.content.value.results.data.attendees[1].email = 
+        expectedResult.response.content.value.results.data.attendees[1].email =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_email_1';
-        expectedResult.response.content.value.results.data.title = 
+        expectedResult.response.content.value.results.data.title =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_title';
-        expectedResult.response.content.value.results.data.description = 
+        expectedResult.response.content.value.results.data.description =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_description';
-        expectedResult.response.content.value.results.data.inScopeReply = 
+        expectedResult.response.content.value.results.data.inScopeReply =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_inScopeReply';
-        expectedResult.response.content.value.results.data.meetingLink = 
+        expectedResult.response.content.value.results.data.meetingLink =
           'decrypted-with-kms://kms-cisco.wbx2.com/keys/dd6053f0-a1b3-428d-8104-317527d73630-schedule_meeting_encrypted_meetingLink';
 
         expect(triggerSpy.getCall(0).args[1]).to.deep.equal(expectedResult);
       });
 
+      it('handles a cited answer with sources response', async () => {
+        const triggerSpy = sinon.spy(webex.internal.aiAssistant, 'trigger');
+        webex.internal.encryption.decryptText.callsFake(async (keyUrl, value) => {
+          return `decrypted-with-${keyUrl}-${value}`;
+        });
+
+        await webex.internal.aiAssistant._request({
+          resource: 'test-resource',
+          params: {param1: 'value1'},
+        });
+
+        const event = cloneDeep(citedAnswerWithSourcesResponse[0]);
+        event.clientRequestId = 'test-request-id';
+
+        await webex.internal.aiAssistant._handleEvent(event);
+
+        expect(triggerSpy.getCall(0).args[0]).to.equal(`aiassistant:result:test-request-id`);
+
+        await waitForAsync();
+
+        const expectedResult = {
+          sessionId: '3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5',
+          sessionUrl:
+            'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5',
+          messageId: '3c19fd10-92fe-11f0-8e9f-1bafc66fbbc5',
+          messageUrl:
+            'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5/messages/3c19fd10-92fe-11f0-8e9f-1bafc66fbbc5',
+          responseId: '3c1a4b30-92fe-11f0-8e9f-1bafc66fbbc5',
+          responseUrl:
+            'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5/messages/3c1a4b30-92fe-11f0-8e9f-1bafc66fbbc5',
+          content: {
+            name: 'cited_answer',
+            type: 'json',
+            encryptionKeyUrl: 'kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e',
+            value: {
+              value:
+                'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_1_encrypted_value',
+              type: 'markdown',
+              citations: [
+                {
+                  id: '6ccc8286e2084e05a6b9a29faae77095',
+                  index: 1,
+                  name: 'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_1_encrypted_citation_0',
+                  url: 'https://co.webex.com/webappng/sites/co/recording/playback/6ccc8286e2084e05a6b9a29faae77095',
+                  metadata: {
+                    provider: 'webex',
+                    type: 'meeting_recording',
+                  },
+                },
+              ],
+              sources: [
+                {
+                  id: '6ccc8286e2084e05a6b9a29faae77096',
+                  index: 1,
+                  type: 'post_meeting',
+                  name: 'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_1_encrypted_source_0',
+                  metadata: {
+                    meetingContainerId: 'mccc8286e2084e05a6b9a29faae77096',
+                  },
+                },
+                {
+                  id: '6ccc8286e2084e05a6b9a29faae77096',
+                  index: 2,
+                  type: 'post_call',
+                  name: 'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_1_encrypted_source_1',
+                  metadata: {
+                    callContainerId: 'mccc8286e2084e05a6b9a29faae77096',
+                  },
+                },
+                {
+                  id: '6ccc8286e2084e05a6b9a29faae77096',
+                  index: 3,
+                  type: 'message',
+                  name: 'decrypted-with-kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e-json_1_encrypted_source_2',
+                  metadata: {
+                    spaceId: 'mccc8286e2084e05a6b9a29faae77096',
+                  },
+                },
+              ],
+            },
+          },
+          createdAt: '2025-09-16T13:08:30.594220705Z',
+          creator: {
+            role: 'assistant',
+          },
+          // the below fields are added by the SDK
+          errorCode: undefined,
+          errorMessage: undefined,
+          finished: true,
+          requestId: 'test-request-id',
+          responseType: 'response',
+        };
+
+        expect(triggerSpy.getCall(1).args[0]).to.deep.equal('aiassistant:stream:test-request-id');
+        expect(triggerSpy.getCall(1).args[1]).to.deep.equal(expectedResult);
+      });
+
       it('decrypts and emits data when receiving event data', async () => {
         const triggerSpy = sinon.spy(webex.internal.aiAssistant, 'trigger');
 
@@ -830,7 +996,8 @@ describe('plugin-ai-assistant', () => {
             id: 'test-message-id',
             url: 'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id/messages/test-message-id',
             sessionId: 'test-session-id',
-            sessionUrl: 'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id',
+            sessionUrl:
+              'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id',
             creatorId: 'test-creator-id',
             createdAt: '2025-08-05T02:11:12.361Z',
           },
@@ -867,7 +1034,7 @@ describe('plugin-ai-assistant', () => {
         // Verify the request was made correctly
         expect(webex.request.calledOnce).to.be.true;
         const requestArgs = webex.request.getCall(0).args[0];
-        
+
         expect(requestArgs.service).to.equal('assistant-api');
         expect(requestArgs.resource).to.equal('sessions/test-session-id/messages');
         expect(requestArgs.method).to.equal('POST');
@@ -901,7 +1068,8 @@ describe('plugin-ai-assistant', () => {
           id: 'test-message-id',
           url: 'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id/messages/test-message-id',
           sessionId: 'test-session-id',
-          sessionUrl: 'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id',
+          sessionUrl:
+            'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/test-session-id',
           creatorId: 'test-creator-id',
           createdAt: '2025-08-05T02:11:12.361Z',
           requestId: 'custom-request-id',
@@ -1003,7 +1171,7 @@ describe('plugin-ai-assistant', () => {
         // Should use the UUID stub
         expect(result.requestId).to.equal('test-request-id');
         expect(result.streamEventName).to.equal('aiassistant:stream:test-request-id');
-        
+
         const requestArgs = webex.request.getCall(0).args[0];
         expect(requestArgs.body.clientRequestId).to.equal('test-request-id');
       });
@@ -1054,6 +1222,24 @@ describe('plugin-ai-assistant', () => {
         expect(requestArgs.body.entryPoint).to.be.undefined;
       });
 
+      it('includes AI-Assistant-Render-Protocol in the request header when renderProtocolVersion is provided', async () => {
+        const options = {
+          sessionId: 'test-session-id',
+          encryptionKeyUrl: 'test-key-url',
+          contextResources: [],
+          contentType: 'action' as const,
+          contentValue: 'test_action',
+          renderProtocolVersion: '1.0',
+        };
+
+        await webex.internal.aiAssistant.makeAiAssistantRequest(options);
+
+        const requestArgs = webex.request.getCall(0).args[0];
+        expect(requestArgs.headers).to.deep.equal({
+          'AI-Assistant-Render-Protocol': '1.0',
+        });
+      });
+
       it('handles request rejection', async () => {
         webex.request.rejects(new Error('Network error'));
 
@@ -1065,9 +1251,9 @@ describe('plugin-ai-assistant', () => {
           contentValue: 'test_action',
         };
 
-        await expect(
-          webex.internal.aiAssistant.makeAiAssistantRequest(options)
-        ).to.be.rejectedWith('Network error');
+        await expect(webex.internal.aiAssistant.makeAiAssistantRequest(options)).to.be.rejectedWith(
+          'Network error'
+        );
       });
 
       it('starts timer when making a request', async () => {
@@ -1087,7 +1273,7 @@ describe('plugin-ai-assistant', () => {
 
       it('handles timeout when no streaming response comes back', async () => {
         const triggerSpy = sinon.spy(webex.internal.aiAssistant, 'trigger');
-        
+
         const options = {
           sessionId: 'test-session-id',
           encryptionKeyUrl: 'test-key-url',
@@ -1105,10 +1291,13 @@ describe('plugin-ai-assistant', () => {
 
         // Should trigger timeout event on the stream
         expect(triggerSpy.calledWith('aiassistant:stream:test-request-id')).to.be.true;
-        const timeoutCall = triggerSpy.getCalls().find(call => 
-          call.args[0] === 'aiassistant:stream:test-request-id' &&
-          call.args[1].errorMessage === AI_ASSISTANT_ERRORS.AI_ASSISTANT_TIMEOUT
-        );
+        const timeoutCall = triggerSpy
+          .getCalls()
+          .find(
+            (call) =>
+              call.args[0] === 'aiassistant:stream:test-request-id' &&
+              call.args[1].errorMessage === AI_ASSISTANT_ERRORS.AI_ASSISTANT_TIMEOUT
+          );
         expect(timeoutCall).to.exist;
         expect(timeoutCall.args[1]).to.deep.include({
           requestId: 'test-request-id',
@@ -1121,7 +1310,7 @@ describe('plugin-ai-assistant', () => {
       it('resets timer when streaming responses are received', async () => {
         const timerResetSpy = sinon.spy(Timer.prototype, 'reset');
         const timerCancelSpy = sinon.spy(Timer.prototype, 'cancel');
-        
+
         const options = {
           sessionId: 'test-session-id',
           encryptionKeyUrl: 'test-key-url',