Merge pull request #19769 from Budibase/fix/teams-source-delivery

fix: consistent delivery of teams source urls

Author: Dakuan

packages/server/src/api/controllers/webhook/ms-teams.ts

@@ -445,6 +445,7 @@ const createTeamsMessageHandler = ({
 export async function MSTeamsWebhook(
   ctx: Ctx<unknown, unknown, { instance: string; agentId: string }>
 ) {
+  let serviceUrl: string | undefined
   await runChatWebhook({
     ctx,
     providerName: "Teams",
@@ -457,7 +458,7 @@ export async function MSTeamsWebhook(
       ) {
         throw new HTTPError("Missing Microsoft Teams service URL", 400)
       }
-      validateMSTeamsServiceUrl(body.serviceUrl)
+      serviceUrl = validateMSTeamsServiceUrl(body.serviceUrl)
     },
     createWebhookHandler: async ({ workspaceId, agentId }) => {
       const {
@@ -488,6 +489,8 @@ export async function MSTeamsWebhook(
             appPassword: integration.appPassword,
             appTenantId: integration.tenantId,
             appType: "SingleTenant",
+            // Card posts use the adapter URL; DM streams use the activity URL.
+            apiUrl: serviceUrl,
           }),
         },
         state: await getTeamsState(),

packages/server/src/api/controllers/webhook/runChatWebhook.ts

@@ -31,12 +31,11 @@ export const runChatWebhook = async ({
     return
   }
 
-  let handleWebhook: (request: Request) => Promise<Response>
+  const rawBody = await readRawBody(ctx.req)
   try {
-    handleWebhook = await createWebhookHandler({
-      workspaceId: prodWorkspaceId,
-      agentId: ctx.params.agentId,
-    })
+    if (ctx.get("authorization")) {
+      validateBody?.(tryParseJson(rawBody))
+    }
   } catch (error) {
     if (error instanceof HTTPError) {
       ctx.status = error.status
@@ -46,11 +45,12 @@ export const runChatWebhook = async ({
     throw error
   }
 
-  const rawBody = await readRawBody(ctx.req)
+  let handleWebhook: (request: Request) => Promise<Response>
   try {
-    if (ctx.get("authorization")) {
-      validateBody?.(tryParseJson(rawBody))
-    }
+    handleWebhook = await createWebhookHandler({
+      workspaceId: prodWorkspaceId,
+      agentId: ctx.params.agentId,
+    })
   } catch (error) {
     if (error instanceof HTTPError) {
       ctx.status = error.status

packages/server/src/api/routes/tests/ai/agentTeams.spec.ts

@@ -68,6 +68,7 @@ import os from "os"
 import path from "path"
 
 import extract from "extract-zip"
+import { createTeamsAdapter } from "@chat-adapter/teams"
 import { context, docIds } from "@budibase/backend-core"
 import { generator } from "@budibase/backend-core/tests"
 import { ChatCommands } from "@budibase/shared-core"
@@ -87,6 +88,7 @@ import { webhookChat } from "../../../controllers/ai/chatConversations"
 const { getMockChatOptions, resetMockChatState, setMockPostEphemeralResult } =
   jest.requireActual("chat") as ChatMockModule
 const mockedWebhookChat = webhookChat as jest.MockedFunction<typeof webhookChat>
+const mockedCreateTeamsAdapter = jest.mocked(createTeamsAdapter)
 const mockedGetFileUrlForAgent = jest.mocked(sdk.ai.rag.getFileUrlForAgent)
 const TEAMS_APP_ID = generator.guid()
 
@@ -110,6 +112,7 @@ describe("agent teams integration provisioning", () => {
       "test-config"
     )
     mockedWebhookChat.mockClear()
+    mockedCreateTeamsAdapter.mockClear()
     mockedGetFileUrlForAgent.mockReset()
     resetMockChatState()
   })
@@ -524,6 +527,7 @@ describe("agent teams integration provisioning", () => {
 
       expect(response.body.error).toEqual("Invalid Microsoft Teams service URL")
       expect(mockedWebhookChat).not.toHaveBeenCalled()
+      expect(mockedCreateTeamsAdapter).not.toHaveBeenCalled()
     })
 
     it(`returns a private link prompt for ${ChatCommands.LINK} and /${ChatCommands.LINK} commands`, async () => {
@@ -800,56 +804,86 @@ describe("agent teams integration provisioning", () => {
       expect(mockedWebhookChat).toHaveBeenCalledTimes(1)
     })
 
-    it("appends downloadable RAG source links to Teams personal replies", async () => {
-      mockedGetFileUrlForAgent.mockResolvedValue(
-        "/files/signed/prod-budi-app-assets/source.pdf"
-      )
-      mockedWebhookChat.mockResolvedValueOnce({
-        messages: [
-          {
-            id: "assistant-1",
-            role: "assistant",
-            parts: [{ type: "text", text: "Answer with sources" }],
-          },
-        ] as any,
-        assistantText: "Answer with sources",
-        ragSources: [
-          {
-            sourceId: "source-1",
-            fileId: "file-1",
-            filename: "Source [One]\n@Draft.pdf",
-          },
-        ],
-        title: "Mock conversation",
-      })
+    it.each([false, true])(
+      "sends personal reply sources through the activity service URL (streaming: %s)",
+      async streaming => {
+        const serviceUrl = new URL(
+          "/emea/",
+          DEFAULT_MSTEAMS_SERVICE_URL
+        ).toString()
+        mockedGetFileUrlForAgent.mockResolvedValue(
+          "/files/signed/prod-budi-app-assets/source.pdf"
+        )
+        mockedWebhookChat.mockImplementationOnce(
+          async ({ onAssistantStream }) => {
+            if (streaming) {
+              async function* sourceAnswerStream() {
+                yield "Answer with "
+                yield "sources"
+              }
+              await onAssistantStream!(sourceAnswerStream())
+            }
+            return {
+              messages: [
+                {
+                  id: "assistant-1",
+                  role: "assistant",
+                  parts: [{ type: "text", text: "Answer with sources" }],
+                },
+              ],
+              assistantText: "Answer with sources",
+              allowKnowledgeSourceDownload: true,
+              ragSources: [
+                {
+                  sourceId: "source-1",
+                  fileId: "file-1",
+                  filename: "Source [One]\n@Draft.pdf",
+                },
+              ],
+              title: "Mock conversation",
+            }
+          }
+        )
 
-      const { agent, linkExternalUser } = await setupProvisionedTeamsAgent()
-      const path = `/api/webhooks/ms-teams/${config.getProdWorkspaceId()}/${agent._id}`
-      await linkExternalUser("user-1")
+        const { agent, linkExternalUser } = await setupProvisionedTeamsAgent()
+        const path = `/api/webhooks/ms-teams/${config.getProdWorkspaceId()}/${agent._id}`
+        await linkExternalUser("user-1")
 
-      const response = await postTeamsMessage({
-        path,
-        body: {
-          id: "activity-rag-personal",
-          type: "message",
-          text: "hello teams",
-          from: { id: "user-1", name: "Teams User" },
-          conversation: { id: "conversation-1", conversationType: "personal" },
-          channelData: { tenant: { id: "tenant-1" } },
-        },
-      })
+        const response = await postTeamsMessage({
+          path,
+          body: {
+            id: "activity-rag-personal",
+            serviceUrl,
+            type: "message",
+            text: "hello teams",
+            from: { id: "user-1", name: "Teams User" },
+            conversation: {
+              id: "conversation-1",
+              conversationType: "personal",
+            },
+            channelData: { tenant: { id: "tenant-1" } },
+          },
+        })
 
-      expect(response.body.messages).toContain("Answer with sources")
-      const cardMessage = response.body.messages.find((message: string) =>
-        message.includes("Source One Draft.pdf")
-      )
-      expect(cardMessage).toContain('"title":"Sources"')
-      expect(cardMessage).toContain(
-        "http://localhost:10000/files/signed/prod-budi-app-assets/source.pdf"
-      )
-      expect(mockedWebhookChat).toHaveBeenCalledTimes(1)
-      expect(mockedGetFileUrlForAgent).toHaveBeenCalledWith(agent._id, "file-1")
-    })
+        expect(response.body.messages).toHaveLength(2)
+        expect(response.body.messages[0]).toEqual("Answer with sources")
+        expect(mockedCreateTeamsAdapter).toHaveBeenLastCalledWith(
+          expect.objectContaining({ apiUrl: serviceUrl })
+        )
+        const cardMessage = response.body.messages.find((message: string) =>
+          message.includes("Source One Draft.pdf")
+        )
+        expect(cardMessage).toContain('"title":"Sources"')
+        expect(cardMessage).toContain(
+          "http://localhost:10000/files/signed/prod-budi-app-assets/source.pdf"
+        )
+        expect(mockedWebhookChat).toHaveBeenCalledTimes(1)
+        expect(mockedGetFileUrlForAgent).toHaveBeenCalledWith(
+          agent._id,
+          "file-1"
+        )
+      }
+    )
 
     it("does not append RAG source links to Teams channel replies", async () => {
       mockedWebhookChat.mockResolvedValueOnce({