The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(slack): keep assistant feedback buttons on long answers (#25693)
Abdul Rahman15955aeaae58
diff --git a/packages/twenty-apps/public/slack/src/__tests__/slack-assistant-worker.integration-test.ts b/packages/twenty-apps/public/slack/src/__tests__/slack-assistant-worker.integration-test.tsindex 035766a7b41..92deabc37bc 100644--- a/packages/twenty-apps/public/slack/src/__tests__/slack-assistant-worker.integration-test.ts+++ b/packages/twenty-apps/public/slack/src/__tests__/slack-assistant-worker.integration-test.ts@@ -457,7 +457,7 @@ describe('Slack assistant worker', () => {);});- it('should send a long answer as markdown text because Slack blocks cannot hold it', async () => {+ it('should keep the feedback buttons on an answer too long for a markdown block', async () => {slack.addChannel({ id: CHANNEL_ID, name: 'sales' });const slackMessageTimestamp = nextMessageTimestamp();const longResponse = 'a'.repeat(SLACK_MARKDOWN_BLOCK_MAX_LENGTH + 1);@@ -485,9 +485,27 @@ describe('Slack assistant worker', () => {const channelMessages = slack.messagesIn(CHANNEL_ID);const postedAnswer = channelMessages[channelMessages.length - 1];+ const [markdownBlock, feedbackBlock] = postedAnswer?.blocks ?? [];- expect(postedAnswer?.blocks).toBeUndefined();- expect(postedAnswer?.markdownText).toContain(longResponse);+ expect(markdownBlock).toEqual({+ type: 'markdown',+ text: expect.stringContaining('_Shortened to fit Slack.'),+ });+ expect((markdownBlock as { text: string }).text.length).toBeLessThanOrEqual(+ SLACK_MARKDOWN_BLOCK_MAX_LENGTH,+ );+ expect(feedbackBlock).toEqual(+ expect.objectContaining({+ type: 'context_actions',+ block_id: request.id,+ }),+ );+ await expect(readRequest(request.id)).resolves.toEqual(+ expect.objectContaining({+ status: SLACK_ASSISTANT_REQUEST_STATUS.DONE,+ responseText: longResponse,+ }),+ );});it('should skip a request that another worker already picked up', async () => {diff --git a/packages/twenty-apps/public/slack/src/logic-functions/constants/slack-assistant-request-object-name.ts b/packages/twenty-apps/public/slack/src/logic-functions/constants/slack-assistant-request-object-name.tsnew file mode 100644index 00000000000..659b5867ca2--- /dev/null+++ b/packages/twenty-apps/public/slack/src/logic-functions/constants/slack-assistant-request-object-name.ts@@ -0,0 +1 @@+export const SLACK_ASSISTANT_REQUEST_OBJECT_NAME = 'slackAssistantRequest';diff --git a/packages/twenty-apps/public/slack/src/logic-functions/slack-assistant-worker.ts b/packages/twenty-apps/public/slack/src/logic-functions/slack-assistant-worker.tsindex ef3564a140c..8705290aaba 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/slack-assistant-worker.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/slack-assistant-worker.ts@@ -12,9 +12,9 @@ import {} from 'src/constants/universal-identifiers';import { SLACK_ASSISTANT_AGENT_BUDGET_SECONDS } from 'src/logic-functions/constants/slack-assistant-agent-budget-seconds';import { SLACK_ASSISTANT_EMPTY_RESPONSE_ERROR } from 'src/logic-functions/constants/slack-assistant-empty-response-error';+import { SLACK_ASSISTANT_REQUEST_OBJECT_NAME } from 'src/logic-functions/constants/slack-assistant-request-object-name';import { SLACK_ASSISTANT_REQUEST_STATUS } from 'src/logic-functions/constants/slack-assistant-request-status';import { SLACK_ASSISTANT_WORKER_TIMEOUT_SECONDS } from 'src/logic-functions/constants/slack-assistant-worker-timeout-seconds';-import { SLACK_MARKDOWN_BLOCK_MAX_LENGTH } from 'src/logic-functions/constants/slack-markdown-block-max-length';import { updateSlackAssistantRequest } from 'src/logic-functions/data/update-slack-assistant-request';import { slackPostMessageHandler } from 'src/logic-functions/handlers/slack-post-message-handler';import { type SlackAssistantRequestRecord } from 'src/logic-functions/types/slack-assistant-request-record.type';@@ -32,8 +32,6 @@ import { setSlackAssistantThreadTitle } from 'src/logic-functions/utils/set-slacimport { startSlackAssistantStatusUpdates } from 'src/logic-functions/utils/start-slack-assistant-status-updates';import { subscribeSlackThread } from 'src/logic-functions/utils/subscribe-slack-thread';-const SLACK_ASSISTANT_REQUEST_OBJECT_NAME = 'slackAssistantRequest';-type SlackAssistantRequestCreatedEvent = DatabaseEventPayload<ObjectRecordCreateEvent<SlackAssistantRequestRecord>>;@@ -172,13 +170,11 @@ export const slackAssistantWorkerHandler = async (messageFormat: 'markdown',unfurlLinks: false,unfurlMedia: false,- messageBlocks:- responseText.length > SLACK_MARKDOWN_BLOCK_MAX_LENGTH- ? undefined- : buildSlackAssistantAnswerBlocks({- responseText,- requestId: record.id,- }),+ messageBlocks: buildSlackAssistantAnswerBlocks({+ responseText,+ requestId: record.id,+ workspaceBaseUrl: workspaceBaseUrls[0],+ }),});if (!deliveryResult.success) {diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/build-slack-assistant-answer-blocks.test.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/build-slack-assistant-answer-blocks.test.tsindex 43e814c3092..6db138ff755 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/build-slack-assistant-answer-blocks.test.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/build-slack-assistant-answer-blocks.test.ts@@ -1,5 +1,6 @@import { describe, expect, it } from 'vitest';+import { SLACK_MARKDOWN_BLOCK_MAX_LENGTH } from 'src/logic-functions/constants/slack-markdown-block-max-length';import { buildSlackAssistantAnswerBlocks } from 'src/logic-functions/utils/build-slack-assistant-answer-blocks';const REQUEST_ID = '3f77d0b1-30a1-4c3d-9d02-2f2a9f6f9d10';@@ -50,4 +51,85 @@ describe('buildSlackAssistantAnswerBlocks', () => {expect(markdownBlock).toEqual({ type: 'markdown', text: responseText });});+ it('should keep the feedback buttons when the answer is too long for a markdown block', () => {+ const [markdownBlock, feedbackBlock] = buildSlackAssistantAnswerBlocks({+ responseText: 'a'.repeat(SLACK_MARKDOWN_BLOCK_MAX_LENGTH + 5000),+ requestId: REQUEST_ID,+ workspaceBaseUrl: 'https://acme.twenty.com',+ });++ expect(feedbackBlock).toEqual(+ expect.objectContaining({+ type: 'context_actions',+ block_id: REQUEST_ID,+ elements: [+ expect.objectContaining({+ type: 'feedback_buttons',+ action_id: 'slack-assistant-feedback',+ }),+ ],+ }),+ );+ expect(markdownBlock).toEqual({+ type: 'markdown',+ text: expect.stringContaining(+ `[Read the full answer in Twenty](https://acme.twenty.com/object/slackAssistantRequest/${REQUEST_ID})`,+ ),+ });+ });++ it('should keep a too long answer within the Slack markdown limit', () => {+ const [markdownBlock] = buildSlackAssistantAnswerBlocks({+ responseText: 'a'.repeat(SLACK_MARKDOWN_BLOCK_MAX_LENGTH + 5000),+ requestId: REQUEST_ID,+ workspaceBaseUrl: 'https://acme.twenty.com',+ });++ expect((markdownBlock as { text: string }).text.length).toBeLessThanOrEqual(+ SLACK_MARKDOWN_BLOCK_MAX_LENGTH,+ );+ });++ it('should cut a too long answer on a line break so markdown stays renderable', () => {+ const responseText = `${'a'.repeat(999)}\n`.repeat(20);++ const [markdownBlock] = buildSlackAssistantAnswerBlocks({+ responseText,+ requestId: REQUEST_ID,+ });++ const { text } = markdownBlock as { text: string };+ const keptText = text.slice(0, text.indexOf('\n\n_Shortened'));++ expect(text).toContain(+ '_Shortened to fit Slack. The full answer is on this request in Twenty._',+ );+ expect(responseText.startsWith(keptText)).toBe(true);+ expect(responseText[keptText.length]).toBe('\n');+ });+ it('should not split an emoji when cutting a too long answer', () => {+ const responseText =+ '\u{1F468}\u200D\u{1F469}\u200D\u{1F467}\u200D\u{1F466}'.repeat(2000);++ const [markdownBlock] = buildSlackAssistantAnswerBlocks({+ responseText,+ requestId: REQUEST_ID,+ });++ const { text } = markdownBlock as { text: string };+ const keptText = text.slice(0, text.indexOf('\n\n_Shortened'));++ expect(text.length).toBeLessThanOrEqual(SLACK_MARKDOWN_BLOCK_MAX_LENGTH);+ expect(responseText.startsWith(keptText)).toBe(true);+ expect(+ [...keptText].some(+ (character) =>+ /[\uD800-\uDFFF]/.test(character) && character.length === 1,+ ),+ ).toBe(false);+ expect(+ keptText.length %+ '\u{1F468}\u200D\u{1F469}\u200D\u{1F467}\u200D\u{1F466}'.length,+ ).toBe(0);+ });});diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/build-slack-assistant-answer-blocks.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/build-slack-assistant-answer-blocks.tsindex 004954a0a93..eb07a575b1f 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/build-slack-assistant-answer-blocks.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/build-slack-assistant-answer-blocks.ts@@ -1,16 +1,66 @@+import { isNonEmptyString } from '@sniptt/guards';import { type KnownBlock } from '@slack/web-api';import { SLACK_ASSISTANT_FEEDBACK_ACTION_ID } from 'src/logic-functions/constants/slack-assistant-feedback-action-id';import { SLACK_ASSISTANT_FEEDBACK_BUTTON_VALUE } from 'src/logic-functions/constants/slack-assistant-feedback-button-value';+import { SLACK_ASSISTANT_REQUEST_OBJECT_NAME } from 'src/logic-functions/constants/slack-assistant-request-object-name';+import { SLACK_MARKDOWN_BLOCK_MAX_LENGTH } from 'src/logic-functions/constants/slack-markdown-block-max-length';+import { truncateOnGraphemeBoundary } from 'src/logic-functions/utils/truncate-on-grapheme-boundary';++const buildTruncationNotice = ({+ requestId,+ workspaceBaseUrl,+}: {+ requestId: string;+ workspaceBaseUrl: string | undefined;+}): string =>+ isNonEmptyString(workspaceBaseUrl)+ ? `\n\n_Shortened to fit Slack. [Read the full answer in Twenty](${workspaceBaseUrl}/object/${SLACK_ASSISTANT_REQUEST_OBJECT_NAME}/${requestId})_`+ : '\n\n_Shortened to fit Slack. The full answer is on this request in Twenty._';++const buildAnswerMarkdown = ({+ responseText,+ requestId,+ workspaceBaseUrl,+}: {+ responseText: string;+ requestId: string;+ workspaceBaseUrl: string | undefined;+}): string => {+ if (responseText.length <= SLACK_MARKDOWN_BLOCK_MAX_LENGTH) {+ return responseText;+ }++ const notice = buildTruncationNotice({ requestId, workspaceBaseUrl });+ const budget = Math.max(SLACK_MARKDOWN_BLOCK_MAX_LENGTH - notice.length, 0);+ const head = truncateOnGraphemeBoundary({+ text: responseText,+ maxLength: budget,+ });+ const lastLineBreakIndex = head.lastIndexOf('\n');+ const lastWhitespaceIndex = head.search(/\s+\S*$/);+ const boundaryIndex =+ lastLineBreakIndex > budget / 2 ? lastLineBreakIndex : lastWhitespaceIndex;++ const keptText =+ boundaryIndex > budget / 2 ? head.slice(0, boundaryIndex) : head;++ return `${keptText}${notice}`;+};export const buildSlackAssistantAnswerBlocks = ({responseText,requestId,+ workspaceBaseUrl,}: {responseText: string;requestId: string;+ workspaceBaseUrl?: string;}): KnownBlock[] => [- { type: 'markdown', text: responseText },+ {+ type: 'markdown',+ text: buildAnswerMarkdown({ responseText, requestId, workspaceBaseUrl }),+ },{type: 'context_actions',block_id: requestId,diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/read-slack-body-preview.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/read-slack-body-preview.tsindex a44f60bc4f2..b4d4507490e 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/read-slack-body-preview.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/read-slack-body-preview.ts@@ -2,13 +2,10 @@ import { isNonEmptyString } from '@sniptt/guards';import { asRecord } from 'src/logic-functions/utils/as-record.util';import { readOptionalString } from 'src/logic-functions/utils/read-optional-string.util';+import { truncateOnGraphemeBoundary } from 'src/logic-functions/utils/truncate-on-grapheme-boundary';const BODY_PREVIEW_MAX_LENGTH = 300;-const GRAPHEME_SEGMENTER = new Intl.Segmenter(undefined, {- granularity: 'grapheme',-});-export const readSlackBodyPreview = ({bodyValue,maxLength = BODY_PREVIEW_MAX_LENGTH,@@ -26,12 +23,5 @@ export const readSlackBodyPreview = ({return markdown;}- // Slack counts the characters it stores, so the budget is code units, cut on- // grapheme boundaries to keep sequences such as π¨βπ©βπ§βπ¦ whole- const truncated = [...GRAPHEME_SEGMENTER.segment(markdown)]- .filter(({ index, segment }) => index + segment.length <= maxLength - 1)- .map(({ segment }) => segment)- .join('');-- return `${truncated}β¦`;+ return `${truncateOnGraphemeBoundary({ text: markdown, maxLength: maxLength - 1 })}β¦`;};diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/truncate-on-grapheme-boundary.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/truncate-on-grapheme-boundary.tsnew file mode 100644index 00000000000..b6ccce9c335--- /dev/null+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/truncate-on-grapheme-boundary.ts@@ -0,0 +1,22 @@+const GRAPHEME_SEGMENTER = new Intl.Segmenter(undefined, {+ granularity: 'grapheme',+});++export const truncateOnGraphemeBoundary = ({+ text,+ maxLength,+}: {+ text: string;+ maxLength: number;+}): string => {+ if (text.length <= maxLength) {+ return text;+ }++ // Slack counts the characters it stores, so the budget is code units, cut on+ // grapheme boundaries to keep sequences such as π¨βπ©βπ§βπ¦ whole+ return [...GRAPHEME_SEGMENTER.segment(text)]+ .filter(({ index, segment }) => index + segment.length <= maxLength)+ .map(({ segment }) => segment)+ .join('');+};