Skip to content

The open alternative to Salesforce, designed for AI.

Show the Teams assistant progress while it answers (#29059)

Abdul Rahman231d92bfb573
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-assistant-status-steps.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-assistant-status-steps.ts
new file mode 100644
index 00000000000..d03552cd5bb
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-assistant-status-steps.ts
@@ -0,0 +1,8 @@
+import { type TeamsAssistantStatusStep } from 'src/features/chat/logic-functions/types/teams-assistant-status-step.type';
+
+export const TEAMS_ASSISTANT_INITIAL_STATUS = 'Thinking…';
+
+export const TEAMS_ASSISTANT_STATUS_STEPS: TeamsAssistantStatusStep[] = [
+ { afterSeconds: 30, text: 'Digging through your CRM…' },
+ { afterSeconds: 90, text: 'Still on it, thanks for waiting…' },
+];
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-assistant-stream-handoff-step.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-assistant-stream-handoff-step.ts
new file mode 100644
index 00000000000..0574b60afe5
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-assistant-stream-handoff-step.ts
@@ -0,0 +1,7 @@
+import { type TeamsAssistantStatusStep } from 'src/features/chat/logic-functions/types/teams-assistant-status-step.type';
+
+// Teams rejects stream updates two minutes after the stream opens, so the bubble is closed before that.
+export const TEAMS_ASSISTANT_STREAM_HANDOFF_STEP: TeamsAssistantStatusStep = {
+ afterSeconds: 105,
+ text: 'Still on it, thanks for waiting… The answer will follow in a moment.',
+};
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-personal-conversation-type.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-personal-conversation-type.ts
new file mode 100644
index 00000000000..61abe9d9f4b
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/constants/teams-personal-conversation-type.ts
@@ -0,0 +1 @@
+export const TEAMS_PERSONAL_CONVERSATION_TYPE = 'personal';
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity-entity.type.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity-entity.type.ts
index b919ce00894..416e69b6df4 100644
--- a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity-entity.type.ts
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity-entity.type.ts
@@ -4,4 +4,7 @@ export type TeamsActivityEntity = {
type?: string;
text?: string;
mentioned?: TeamsChannelAccount;
+ streamId?: string;
+ streamType?: 'informative' | 'streaming' | 'final';
+ streamSequence?: number;
};
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity.type.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity.type.ts
index 588f0ce4ed8..e7b4882e99e 100644
--- a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity.type.ts
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-activity.type.ts
@@ -1,7 +1,9 @@
import { type TeamsActivityAttachment } from 'src/features/chat/logic-functions/types/teams-activity-attachment.type';
+import { type TeamsActivityEntity } from 'src/features/chat/logic-functions/types/teams-activity-entity.type';
export type TeamsActivity = {
type: 'message' | 'typing';
text?: string;
attachments?: TeamsActivityAttachment[];
+ entities?: TeamsActivityEntity[];
};
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-assistant-status-step.type.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-assistant-status-step.type.ts
new file mode 100644
index 00000000000..616d384d8e0
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-assistant-status-step.type.ts
@@ -0,0 +1,4 @@
+export type TeamsAssistantStatusStep = {
+ afterSeconds: number;
+ text: string;
+};
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-assistant-status-writer.type.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-assistant-status-writer.type.ts
new file mode 100644
index 00000000000..c7fb9bc768f
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/types/teams-assistant-status-writer.type.ts
@@ -0,0 +1,4 @@
+export type TeamsAssistantStatusWriter = {
+ update: (text: string) => Promise<void>;
+ finish: (text: string) => Promise<void>;
+};
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/answer-teams-assistant-request.test.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/answer-teams-assistant-request.test.ts
index d7cfa26908c..7dd6559a9ec 100644
--- a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/answer-teams-assistant-request.test.ts
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/answer-teams-assistant-request.test.ts
@@ -10,14 +10,16 @@ const {
updateMock,
resolveSenderMock,
runAgentMock,
- sendActivityMock,
+ startStatusMock,
+ finishMock,
findHistoryMock,
} = vi.hoisted(() => ({
claimMock: vi.fn(),
updateMock: vi.fn(),
resolveSenderMock: vi.fn(),
runAgentMock: vi.fn(),
- sendActivityMock: vi.fn(),
+ startStatusMock: vi.fn(),
+ finishMock: vi.fn(),
findHistoryMock: vi.fn(),
}));
@@ -59,9 +61,10 @@ vi.mock(
() => ({ runTeamsAssistantAgentOrThrow: runAgentMock }),
);
-vi.mock('src/features/chat/logic-functions/utils/send-teams-activity', () => ({
- sendTeamsActivity: sendActivityMock,
-}));
+vi.mock(
+ 'src/features/chat/logic-functions/utils/start-teams-assistant-status',
+ () => ({ startTeamsAssistantStatus: startStatusMock }),
+);
const REQUEST = {
id: 'request-1',
@@ -81,18 +84,15 @@ const answer = () =>
agentDeadlineAtMs: Date.now() + 60_000,
});
-const sentMessageTexts = () =>
- sendActivityMock.mock.calls
- .map(([{ activity }]) => activity)
- .filter((activity) => activity.type === 'message')
- .map((activity) => activity.text);
+const finishedTexts = () => finishMock.mock.calls.map(([text]) => text);
describe('answerTeamsAssistantRequest', () => {
beforeEach(() => {
vi.clearAllMocks();
claimMock.mockResolvedValue(true);
updateMock.mockResolvedValue(undefined);
- sendActivityMock.mockResolvedValue({ id: 'activity-1' });
+ startStatusMock.mockResolvedValue({ finish: finishMock });
+ finishMock.mockResolvedValue(undefined);
resolveSenderMock.mockResolvedValue('workspace-member-1');
runAgentMock.mockResolvedValue('Acme has 3 open deals.');
findHistoryMock.mockResolvedValue([]);
@@ -101,6 +101,11 @@ describe('answerTeamsAssistantRequest', () => {
it('should answer as the matched workspace member and mark the request done', async () => {
await expect(answer()).resolves.toEqual({ status: 'answered' });
+ expect(startStatusMock).toHaveBeenCalledExactlyOnceWith({
+ serviceUrl: REQUEST.teamsServiceUrl,
+ conversationId: REQUEST.teamsConversationId,
+ conversationType: REQUEST.teamsConversationType,
+ });
expect(runAgentMock).toHaveBeenCalledTimes(1);
expect(runAgentMock).toHaveBeenCalledWith(
expect.objectContaining({
@@ -108,7 +113,7 @@ describe('answerTeamsAssistantRequest', () => {
workspaceMemberId: 'workspace-member-1',
}),
);
- expect(sentMessageTexts()).toEqual(['Acme has 3 open deals.']);
+ expect(finishedTexts()).toEqual(['Acme has 3 open deals.']);
expect(updateMock).toHaveBeenLastCalledWith(
expect.objectContaining({
id: REQUEST.id,
@@ -158,14 +163,14 @@ describe('answerTeamsAssistantRequest', () => {
});
await expect(answer()).resolves.toEqual({ status: 'answered' });
- expect(sentMessageTexts()).toEqual(['Acme has 3 open deals.']);
+ expect(finishedTexts()).toEqual(['Acme has 3 open deals.']);
});
it('should not answer a request another execution already claimed', async () => {
claimMock.mockResolvedValue(false);
await expect(answer()).resolves.toMatchObject({ status: 'skipped' });
- expect(sendActivityMock).not.toHaveBeenCalled();
+ expect(startStatusMock).not.toHaveBeenCalled();
});
it('should decline a sender that matches no workspace member without running the agent', async () => {
@@ -173,7 +178,7 @@ describe('answerTeamsAssistantRequest', () => {
await expect(answer()).resolves.toMatchObject({ status: 'declined' });
expect(runAgentMock).not.toHaveBeenCalled();
- expect(sentMessageTexts()).toEqual([TEAMS_ASSISTANT_UNMATCHED_SENDER_TEXT]);
+ expect(finishedTexts()).toEqual([TEAMS_ASSISTANT_UNMATCHED_SENDER_TEXT]);
});
it('should reply with a generic message and record the error when the agent fails', async () => {
@@ -183,7 +188,7 @@ describe('answerTeamsAssistantRequest', () => {
status: 'failed',
reason: 'Agent run failed',
});
- expect(sentMessageTexts()).toEqual([TEAMS_ASSISTANT_FAILURE_TEXT]);
+ expect(finishedTexts()).toEqual([TEAMS_ASSISTANT_FAILURE_TEXT]);
expect(updateMock).toHaveBeenLastCalledWith(
expect.objectContaining({
status: TEAMS_ASSISTANT_REQUEST_STATUS.FAILED,
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/start-teams-assistant-status.test.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/start-teams-assistant-status.test.ts
new file mode 100644
index 00000000000..5c1be75536d
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/start-teams-assistant-status.test.ts
@@ -0,0 +1,193 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import {
+ TEAMS_ASSISTANT_INITIAL_STATUS,
+ TEAMS_ASSISTANT_STATUS_STEPS,
+} from 'src/features/chat/logic-functions/constants/teams-assistant-status-steps';
+import { TEAMS_ASSISTANT_STREAM_HANDOFF_STEP } from 'src/features/chat/logic-functions/constants/teams-assistant-stream-handoff-step';
+import { startTeamsAssistantStatus } from 'src/features/chat/logic-functions/utils/start-teams-assistant-status';
+
+const { sendActivityMock, startStreamMock, updateMock, finishMock } =
+ vi.hoisted(() => ({
+ sendActivityMock: vi.fn(),
+ startStreamMock: vi.fn(),
+ updateMock: vi.fn(),
+ finishMock: vi.fn(),
+ }));
+
+vi.mock(
+ 'src/features/chat/logic-functions/utils/get-teams-connector-access-token-or-throw',
+ () => ({
+ getTeamsConnectorAccessTokenOrThrow: vi.fn().mockResolvedValue('token'),
+ }),
+);
+
+vi.mock('src/features/chat/logic-functions/utils/send-teams-activity', () => ({
+ sendTeamsActivity: sendActivityMock,
+}));
+
+vi.mock(
+ 'src/features/chat/logic-functions/utils/start-teams-assistant-stream',
+ () => ({ startTeamsAssistantStream: startStreamMock }),
+);
+
+const CONVERSATION = {
+ serviceUrl: 'https://smba.trafficmanager.net/amer/',
+ conversationId: 'a:personal-conversation',
+};
+
+const PERSONAL = { ...CONVERSATION, conversationType: 'personal' };
+
+const sentMessageTexts = () =>
+ sendActivityMock.mock.calls.map(([{ activity }]) => activity.text);
+
+describe('startTeamsAssistantStatus', () => {
+ beforeEach(() => {
+ vi.useFakeTimers();
+ sendActivityMock.mockResolvedValue({ id: 'activity-1' });
+ startStreamMock.mockResolvedValue({
+ update: updateMock,
+ finish: finishMock,
+ });
+ updateMock.mockResolvedValue(undefined);
+ finishMock.mockResolvedValue(undefined);
+ });
+
+ afterEach(() => {
+ vi.useRealTimers();
+ vi.clearAllMocks();
+ });
+
+ it('should stream the status steps in a personal chat and end the stream with the answer', async () => {
+ const status = await startTeamsAssistantStatus(PERSONAL);
+
+ expect(startStreamMock).toHaveBeenCalledExactlyOnceWith({
+ ...CONVERSATION,
+ text: TEAMS_ASSISTANT_INITIAL_STATUS,
+ });
+
+ await vi.advanceTimersByTimeAsync(
+ TEAMS_ASSISTANT_STATUS_STEPS[1].afterSeconds * 1000,
+ );
+
+ expect(updateMock.mock.calls.map(([text]) => text)).toEqual(
+ TEAMS_ASSISTANT_STATUS_STEPS.slice(0, 2).map((step) => step.text),
+ );
+
+ await status.finish('Acme has 3 open deals.');
+ await vi.runAllTimersAsync();
+
+ expect(updateMock).toHaveBeenCalledTimes(2);
+ expect(finishMock).toHaveBeenCalledExactlyOnceWith(
+ 'Acme has 3 open deals.',
+ );
+ expect(sendActivityMock).not.toHaveBeenCalled();
+ });
+
+ it('should send a plain message when the stream cannot be opened', async () => {
+ const warnSpy = vi
+ .spyOn(console, 'warn')
+ .mockImplementation(() => undefined);
+ startStreamMock.mockRejectedValue(new Error('403 ContentStreamNotAllowed'));
+
+ const status = await startTeamsAssistantStatus(PERSONAL);
+
+ await status.finish('Acme has 3 open deals.');
+ await vi.runAllTimersAsync();
+
+ expect(updateMock).not.toHaveBeenCalled();
+ expect(sentMessageTexts()).toEqual(['Acme has 3 open deals.']);
+ expect(warnSpy).toHaveBeenCalledTimes(1);
+
+ warnSpy.mockRestore();
+ });
+
+ it('should send a plain message when the stream can no longer be finished', async () => {
+ const warnSpy = vi
+ .spyOn(console, 'warn')
+ .mockImplementation(() => undefined);
+ finishMock.mockRejectedValue(new Error('403 exceeded streaming time'));
+
+ const status = await startTeamsAssistantStatus(PERSONAL);
+
+ await status.finish('Acme has 3 open deals.');
+
+ expect(sentMessageTexts()).toEqual(['Acme has 3 open deals.']);
+
+ warnSpy.mockRestore();
+ });
+
+ it('should keep going when a status update fails', async () => {
+ const warnSpy = vi
+ .spyOn(console, 'warn')
+ .mockImplementation(() => undefined);
+ updateMock.mockRejectedValueOnce(new Error('429'));
+
+ const status = await startTeamsAssistantStatus(PERSONAL);
+
+ await vi.advanceTimersByTimeAsync(
+ TEAMS_ASSISTANT_STATUS_STEPS[1].afterSeconds * 1000,
+ );
+ await status.finish('Acme has 3 open deals.');
+
+ expect(updateMock).toHaveBeenCalledTimes(2);
+ expect(finishMock).toHaveBeenCalledExactlyOnceWith(
+ 'Acme has 3 open deals.',
+ );
+ expect(warnSpy).toHaveBeenCalledTimes(1);
+
+ warnSpy.mockRestore();
+ });
+
+ it('should not hold the answer behind a status update that never returns', async () => {
+ updateMock.mockReturnValueOnce(new Promise<void>(() => undefined));
+
+ const status = await startTeamsAssistantStatus(PERSONAL);
+
+ await vi.advanceTimersByTimeAsync(
+ TEAMS_ASSISTANT_STATUS_STEPS[0].afterSeconds * 1000,
+ );
+
+ const finished = status.finish('Acme has 3 open deals.');
+
+ await vi.advanceTimersByTimeAsync(5000);
+ await finished;
+
+ expect(finishMock).toHaveBeenCalledExactlyOnceWith(
+ 'Acme has 3 open deals.',
+ );
+ });
+
+ it('should close the stream before the Teams time limit and send a late answer as a plain message', async () => {
+ const status = await startTeamsAssistantStatus(PERSONAL);
+
+ await vi.advanceTimersByTimeAsync(
+ TEAMS_ASSISTANT_STREAM_HANDOFF_STEP.afterSeconds * 1000,
+ );
+
+ expect(updateMock).toHaveBeenCalledTimes(
+ TEAMS_ASSISTANT_STATUS_STEPS.length,
+ );
+ expect(finishMock).toHaveBeenCalledExactlyOnceWith(
+ TEAMS_ASSISTANT_STREAM_HANDOFF_STEP.text,
+ );
+
+ await status.finish('Acme has 3 open deals.');
+
+ expect(finishMock).toHaveBeenCalledTimes(1);
+ expect(sentMessageTexts()).toEqual(['Acme has 3 open deals.']);
+ });
+
+ it('should only reply at the end outside personal chats', async () => {
+ const status = await startTeamsAssistantStatus({
+ ...CONVERSATION,
+ conversationType: 'groupChat',
+ });
+
+ await vi.runAllTimersAsync();
+ await status.finish('Acme has 3 open deals.');
+
+ expect(startStreamMock).not.toHaveBeenCalled();
+ expect(sentMessageTexts()).toEqual(['Acme has 3 open deals.']);
+ });
+});
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/start-teams-assistant-stream.test.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/start-teams-assistant-stream.test.ts
new file mode 100644
index 00000000000..421e2e3e110
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/__tests__/start-teams-assistant-stream.test.ts
@@ -0,0 +1,116 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { startTeamsAssistantStream } from 'src/features/chat/logic-functions/utils/start-teams-assistant-stream';
+
+const { sendActivityMock, requestConnectorMock } = vi.hoisted(() => ({
+ sendActivityMock: vi.fn(),
+ requestConnectorMock: vi.fn(),
+}));
+
+vi.mock(
+ 'src/features/chat/logic-functions/utils/get-teams-connector-access-token-or-throw',
+ () => ({
+ getTeamsConnectorAccessTokenOrThrow: vi.fn().mockResolvedValue('token'),
+ }),
+);
+
+vi.mock('src/features/chat/logic-functions/utils/send-teams-activity', () => ({
+ sendTeamsActivity: sendActivityMock,
+}));
+
+vi.mock(
+ 'src/features/chat/logic-functions/utils/request-teams-connector',
+ () => ({ requestTeamsConnector: requestConnectorMock }),
+);
+
+const CONVERSATION = {
+ serviceUrl: 'https://smba.trafficmanager.net/amer/',
+ conversationId: 'a:personal-conversation',
+};
+
+const streamedActivities = () =>
+ requestConnectorMock.mock.calls.map(([{ body }]) => body);
+
+describe('startTeamsAssistantStream', () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ sendActivityMock.mockResolvedValue({ id: 'stream-1' });
+ requestConnectorMock.mockResolvedValue('{}');
+ });
+
+ it('should open an informative stream and number every update in order', async () => {
+ const writer = await startTeamsAssistantStream({
+ ...CONVERSATION,
+ text: 'Thinking…',
+ });
+
+ expect(sendActivityMock).toHaveBeenCalledExactlyOnceWith({
+ ...CONVERSATION,
+ accessToken: 'token',
+ activity: {
+ type: 'typing',
+ text: 'Thinking…',
+ entities: [
+ { type: 'streaminfo', streamType: 'informative', streamSequence: 1 },
+ ],
+ },
+ });
+
+ await writer.update('Digging through your CRM…');
+ await writer.update('Still on it…');
+ await writer.finish('Acme has 3 open deals.');
+
+ expect(requestConnectorMock).toHaveBeenCalledWith(
+ expect.objectContaining({
+ serviceUrl: CONVERSATION.serviceUrl,
+ path: '/v3/conversations/a%3Apersonal-conversation/activities',
+ method: 'POST',
+ accessToken: 'token',
+ }),
+ );
+ expect(streamedActivities()).toEqual([
+ {
+ type: 'typing',
+ text: 'Digging through your CRM…',
+ entities: [
+ {
+ type: 'streaminfo',
+ streamId: 'stream-1',
+ streamType: 'informative',
+ streamSequence: 2,
+ },
+ ],
+ },
+ {
+ type: 'typing',
+ text: 'Still on it…',
+ entities: [
+ {
+ type: 'streaminfo',
+ streamId: 'stream-1',
+ streamType: 'informative',
+ streamSequence: 3,
+ },
+ ],
+ },
+ {
+ type: 'message',
+ text: 'Acme has 3 open deals.',
+ entities: [
+ { type: 'streaminfo', streamId: 'stream-1', streamType: 'final' },
+ ],
+ },
+ ]);
+ });
+
+ it('should not open a stream when Teams rejects the first update', async () => {
+ sendActivityMock.mockRejectedValue(
+ new Error('403 ContentStreamNotAllowed'),
+ );
+
+ await expect(
+ startTeamsAssistantStream({ ...CONVERSATION, text: 'Thinking…' }),
+ ).rejects.toThrow('ContentStreamNotAllowed');
+ expect(requestConnectorMock).not.toHaveBeenCalled();
+ });
+});
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/answer-teams-assistant-request.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/answer-teams-assistant-request.ts
index 2bfc95476ab..6ca71b41c51 100644
--- a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/answer-teams-assistant-request.ts
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/answer-teams-assistant-request.ts
@@ -8,13 +8,12 @@ import { TEAMS_ASSISTANT_UNMATCHED_SENDER_TEXT } from 'src/features/chat/logic-f
import { claimTeamsAssistantRequest } from 'src/features/chat/logic-functions/data/claim-teams-assistant-request';
import { findTeamsAssistantHistory } from 'src/features/chat/logic-functions/data/find-teams-assistant-history';
import { updateTeamsAssistantRequest } from 'src/features/chat/logic-functions/data/update-teams-assistant-request';
-import { type TeamsActivity } from 'src/features/chat/logic-functions/types/teams-activity.type';
import { type TeamsAssistantAnswerResult } from 'src/features/chat/logic-functions/types/teams-assistant-answer-result.type';
import { type TeamsAssistantRequestRecord } from 'src/features/chat/logic-functions/types/teams-assistant-request-record.type';
import { getTeamsConnectorAccessTokenOrThrow } from 'src/features/chat/logic-functions/utils/get-teams-connector-access-token-or-throw';
import { resolveTeamsSenderWorkspaceMemberId } from 'src/features/chat/logic-functions/utils/resolve-teams-sender-workspace-member-id';
import { runTeamsAssistantAgentOrThrow } from 'src/features/chat/logic-functions/utils/run-teams-assistant-agent-or-throw';
-import { sendTeamsActivity } from 'src/features/chat/logic-functions/utils/send-teams-activity';
+import { startTeamsAssistantStatus } from 'src/features/chat/logic-functions/utils/start-teams-assistant-status';
import { toErrorMessage } from 'src/utils/to-error-message';
export const answerTeamsAssistantRequest = async ({
@@ -27,6 +26,7 @@ export const answerTeamsAssistantRequest = async ({
const {
teamsServiceUrl,
teamsConversationId,
+ teamsConversationType,
teamsUserId,
teamsTenantId,
requestText,
@@ -35,6 +35,7 @@ export const answerTeamsAssistantRequest = async ({
if (
!isNonEmptyString(teamsServiceUrl) ||
!isNonEmptyString(teamsConversationId) ||
+ !isNonEmptyString(teamsConversationType) ||
!isNonEmptyString(teamsUserId) ||
!isNonEmptyString(teamsTenantId) ||
!isNonEmptyString(requestText)
@@ -48,17 +49,13 @@ export const answerTeamsAssistantRequest = async ({
return { status: 'skipped', reason: 'Request is already being processed' };
}
- const sendActivity = async (activity: TeamsActivity) =>
- sendTeamsActivity({
- serviceUrl: teamsServiceUrl,
- conversationId: teamsConversationId,
- accessToken: await getTeamsConnectorAccessTokenOrThrow(),
- activity,
- });
+ const status = await startTeamsAssistantStatus({
+ serviceUrl: teamsServiceUrl,
+ conversationId: teamsConversationId,
+ conversationType: teamsConversationType,
+ });
try {
- await sendActivity({ type: 'typing' }).catch(() => undefined);
-
const workspaceMemberId = await resolveTeamsSenderWorkspaceMemberId({
client,
serviceUrl: teamsServiceUrl,
@@ -69,10 +66,7 @@ export const answerTeamsAssistantRequest = async ({
});
if (!isDefined(workspaceMemberId)) {
- await sendActivity({
- type: 'message',
- text: TEAMS_ASSISTANT_UNMATCHED_SENDER_TEXT,
- });
+ await status.finish(TEAMS_ASSISTANT_UNMATCHED_SENDER_TEXT);
await updateTeamsAssistantRequest({
client,
id: request.id,
@@ -109,7 +103,7 @@ export const answerTeamsAssistantRequest = async ({
deadlineAtMs: agentDeadlineAtMs,
});
- await sendActivity({ type: 'message', text: responseText });
+ await status.finish(responseText);
await updateTeamsAssistantRequest({
client,
id: request.id,
@@ -121,10 +115,7 @@ export const answerTeamsAssistantRequest = async ({
} catch (error) {
const errorMessage = toErrorMessage(error);
- await sendActivity({
- type: 'message',
- text: TEAMS_ASSISTANT_FAILURE_TEXT,
- }).catch(() => undefined);
+ await status.finish(TEAMS_ASSISTANT_FAILURE_TEXT).catch(() => undefined);
await updateTeamsAssistantRequest({
client,
id: request.id,
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/parse-teams-assistant-request.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/parse-teams-assistant-request.ts
index 595b66a8772..e1427601835 100644
--- a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/parse-teams-assistant-request.ts
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/parse-teams-assistant-request.ts
@@ -1,5 +1,6 @@
import { isNonEmptyArray, isNonEmptyString } from '@sniptt/guards';
+import { TEAMS_PERSONAL_CONVERSATION_TYPE } from 'src/features/chat/logic-functions/constants/teams-personal-conversation-type';
import { type TeamsActivitiesDispatchPayload } from 'src/features/chat/logic-functions/types/teams-activities-dispatch-payload.type';
import { type TeamsAssistantRequestDraft } from 'src/features/chat/logic-functions/types/teams-assistant-request-draft.type';
import { collectTeamsBotMentionTexts } from 'src/features/chat/logic-functions/utils/collect-teams-bot-mention-texts';
@@ -7,8 +8,6 @@ import { normalizeTeamsRequestText } from 'src/features/chat/logic-functions/uti
const BOT_ACCOUNT_ID_PREFIX = '28:';
-const PERSONAL_CONVERSATION_TYPE = 'personal';
-
type ParsedTeamsAssistantRequest =
| { request: TeamsAssistantRequestDraft }
| { request: null; skipReason: string };
@@ -45,10 +44,10 @@ export const parseTeamsAssistantRequest = ({
}
const conversationType =
- activity.conversation?.conversationType ?? PERSONAL_CONVERSATION_TYPE;
+ activity.conversation?.conversationType ?? TEAMS_PERSONAL_CONVERSATION_TYPE;
if (
- conversationType !== PERSONAL_CONVERSATION_TYPE &&
+ conversationType !== TEAMS_PERSONAL_CONVERSATION_TYPE &&
!isNonEmptyArray(collectTeamsBotMentionTexts(activity))
) {
return { request: null, skipReason: 'Bot is not mentioned' };
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/start-teams-assistant-status.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/start-teams-assistant-status.ts
new file mode 100644
index 00000000000..5abe8348481
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/start-teams-assistant-status.ts
@@ -0,0 +1,117 @@
+import { isDefined } from 'twenty-sdk/utils';
+
+import {
+ TEAMS_ASSISTANT_INITIAL_STATUS,
+ TEAMS_ASSISTANT_STATUS_STEPS,
+} from 'src/features/chat/logic-functions/constants/teams-assistant-status-steps';
+import { TEAMS_ASSISTANT_STREAM_HANDOFF_STEP } from 'src/features/chat/logic-functions/constants/teams-assistant-stream-handoff-step';
+import { TEAMS_PERSONAL_CONVERSATION_TYPE } from 'src/features/chat/logic-functions/constants/teams-personal-conversation-type';
+import { type TeamsAssistantStatusWriter } from 'src/features/chat/logic-functions/types/teams-assistant-status-writer.type';
+import { getTeamsConnectorAccessTokenOrThrow } from 'src/features/chat/logic-functions/utils/get-teams-connector-access-token-or-throw';
+import { sendTeamsActivity } from 'src/features/chat/logic-functions/utils/send-teams-activity';
+import { startTeamsAssistantStream } from 'src/features/chat/logic-functions/utils/start-teams-assistant-stream';
+
+const PENDING_UPDATE_WAIT_MS = 5000;
+
+// Teams only streams in one-on-one chats, so other conversations get a plain reply at the end.
+export const startTeamsAssistantStatus = async ({
+ serviceUrl,
+ conversationId,
+ conversationType,
+}: {
+ serviceUrl: string;
+ conversationId: string;
+ conversationType: string;
+}): Promise<Pick<TeamsAssistantStatusWriter, 'finish'>> => {
+ const sendMessage = async (text: string) => {
+ await sendTeamsActivity({
+ serviceUrl,
+ conversationId,
+ accessToken: await getTeamsConnectorAccessTokenOrThrow(),
+ activity: { type: 'message', text },
+ });
+ };
+
+ if (conversationType !== TEAMS_PERSONAL_CONVERSATION_TYPE) {
+ return { finish: sendMessage };
+ }
+
+ const writer = await startTeamsAssistantStream({
+ serviceUrl,
+ conversationId,
+ text: TEAMS_ASSISTANT_INITIAL_STATUS,
+ }).catch((error: unknown) => {
+ console.warn(
+ `[teams] could not start a stream in ${conversationId}`,
+ error,
+ );
+
+ return undefined;
+ });
+
+ if (!isDefined(writer)) {
+ return { finish: sendMessage };
+ }
+
+ let isStreamOpen = true;
+ let pendingUpdate = Promise.resolve();
+
+ const queueStreamCall = (streamCall: () => Promise<void>) => {
+ pendingUpdate = pendingUpdate.then(streamCall).catch((error: unknown) => {
+ console.warn(
+ `[teams] could not update the status in ${conversationId}`,
+ error,
+ );
+ });
+ };
+
+ const handOffStream = async () => {
+ isStreamOpen = false;
+ await writer.finish(TEAMS_ASSISTANT_STREAM_HANDOFF_STEP.text);
+ };
+
+ const timers = [
+ ...TEAMS_ASSISTANT_STATUS_STEPS.map((step) =>
+ setTimeout(
+ () => queueStreamCall(() => writer.update(step.text)),
+ step.afterSeconds * 1000,
+ ),
+ ),
+ setTimeout(
+ () => queueStreamCall(handOffStream),
+ TEAMS_ASSISTANT_STREAM_HANDOFF_STEP.afterSeconds * 1000,
+ ),
+ ];
+
+ const waitForPendingUpdate = async () => {
+ let waitTimer: ReturnType<typeof setTimeout> | undefined;
+
+ await Promise.race([
+ pendingUpdate,
+ new Promise<void>((resolve) => {
+ waitTimer = setTimeout(resolve, PENDING_UPDATE_WAIT_MS);
+ }),
+ ]);
+ clearTimeout(waitTimer);
+ };
+
+ return {
+ finish: async (text) => {
+ timers.forEach(clearTimeout);
+ await waitForPendingUpdate();
+
+ if (!isStreamOpen) {
+ return sendMessage(text);
+ }
+
+ await writer.finish(text).catch((error: unknown) => {
+ console.warn(
+ `[teams] could not finish the stream in ${conversationId}`,
+ error,
+ );
+
+ return sendMessage(text);
+ });
+ },
+ };
+};
diff --git a/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/start-teams-assistant-stream.ts b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/start-teams-assistant-stream.ts
new file mode 100644
index 00000000000..ff97ceafeb3
--- /dev/null
+++ b/packages/twenty-apps/public/teams/src/features/chat/logic-functions/utils/start-teams-assistant-stream.ts
@@ -0,0 +1,67 @@
+import { type TeamsActivity } from 'src/features/chat/logic-functions/types/teams-activity.type';
+import { type TeamsAssistantStatusWriter } from 'src/features/chat/logic-functions/types/teams-assistant-status-writer.type';
+import { buildTeamsActivityPath } from 'src/features/chat/logic-functions/utils/build-teams-activity-path';
+import { getTeamsConnectorAccessTokenOrThrow } from 'src/features/chat/logic-functions/utils/get-teams-connector-access-token-or-throw';
+import { requestTeamsConnector } from 'src/features/chat/logic-functions/utils/request-teams-connector';
+import { sendTeamsActivity } from 'src/features/chat/logic-functions/utils/send-teams-activity';
+
+export const startTeamsAssistantStream = async ({
+ serviceUrl,
+ conversationId,
+ text,
+}: {
+ serviceUrl: string;
+ conversationId: string;
+ text: string;
+}): Promise<TeamsAssistantStatusWriter> => {
+ let streamSequence = 1;
+
+ const { id: streamId } = await sendTeamsActivity({
+ serviceUrl,
+ conversationId,
+ accessToken: await getTeamsConnectorAccessTokenOrThrow(),
+ activity: {
+ type: 'typing',
+ text,
+ entities: [
+ { type: 'streaminfo', streamType: 'informative', streamSequence },
+ ],
+ },
+ });
+
+ // Follow-up stream calls answer 202 with no payload to parse.
+ const sendStreamActivity = async (activity: TeamsActivity) => {
+ await requestTeamsConnector({
+ serviceUrl,
+ path: buildTeamsActivityPath({ conversationId }),
+ method: 'POST',
+ accessToken: await getTeamsConnectorAccessTokenOrThrow(),
+ body: activity,
+ });
+ };
+
+ return {
+ update: (text) => {
+ streamSequence += 1;
+
+ return sendStreamActivity({
+ type: 'typing',
+ text,
+ entities: [
+ {
+ type: 'streaminfo',
+ streamId,
+ streamType: 'informative',
+ streamSequence,
+ },
+ ],
+ });
+ },
+ finish: (text) =>
+ sendStreamActivity({
+ type: 'message',
+ text,
+ entities: [{ type: 'streaminfo', streamId, streamType: 'final' }],
+ }),
+ };
+};