The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(slack): honour silent channel rules outside the assistant path (#26417)
Abdul Rahman20fd8c9f75fc
diff --git a/packages/twenty-apps/public/slack/package.json b/packages/twenty-apps/public/slack/package.jsonindex 78972d3a254..ae5ca40476b 100644--- a/packages/twenty-apps/public/slack/package.json+++ b/packages/twenty-apps/public/slack/package.json@@ -1,6 +1,6 @@{"name": "@twentyhq/slack",- "version": "1.4.0",+ "version": "1.4.1","description": "Slack assistant and workflow steps for Twenty","license": "MIT","engines": {diff --git a/packages/twenty-apps/public/slack/src/logic-functions/constants/slack-channel-silenced-skip-reason.ts b/packages/twenty-apps/public/slack/src/logic-functions/constants/slack-channel-silenced-skip-reason.tsnew file mode 100644index 00000000000..7fb839b2d1d--- /dev/null+++ b/packages/twenty-apps/public/slack/src/logic-functions/constants/slack-channel-silenced-skip-reason.ts@@ -0,0 +1,2 @@+export const SLACK_CHANNEL_SILENCED_SKIP_REASON =+ 'Channel is silenced by a channel rule';diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/post-slack-channel-welcome.test.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/post-slack-channel-welcome.test.tsindex 44d4e0402cc..61e9cbae211 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/post-slack-channel-welcome.test.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/post-slack-channel-welcome.test.ts@@ -5,18 +5,26 @@ import { postSlackChannelWelcome } from 'src/logic-functions/utils/post-slack-chconst {claimSlackChannelWelcomeMock,+ coreApiClientMock,getSlackClientMock,+ isSlackChannelSilencedMock,postSlackMessageMock,releaseSlackChannelWelcomeMock,resolveSlackBotUserIdOrThrowMock,} = vi.hoisted(() => ({claimSlackChannelWelcomeMock: vi.fn(),+ coreApiClientMock: vi.fn(),getSlackClientMock: vi.fn(),+ isSlackChannelSilencedMock: vi.fn(),postSlackMessageMock: vi.fn(),releaseSlackChannelWelcomeMock: vi.fn(),resolveSlackBotUserIdOrThrowMock: vi.fn(),}));+vi.mock('twenty-client-sdk/core', () => ({+ CoreApiClient: coreApiClientMock,+}));+vi.mock('src/logic-functions/utils/claim-slack-channel-welcome', () => ({claimSlackChannelWelcome: claimSlackChannelWelcomeMock,}));@@ -25,6 +33,10 @@ vi.mock('src/logic-functions/utils/get-slack-client', () => ({getSlackClient: getSlackClientMock,}));+vi.mock('src/logic-functions/utils/is-slack-channel-silenced', () => ({+ isSlackChannelSilenced: isSlackChannelSilencedMock,+}));+vi.mock('src/logic-functions/utils/post-slack-message', () => ({postSlackMessage: postSlackMessageMock,}));@@ -53,6 +65,7 @@ const buildJoinEvent = (slackUserId: string): SlackEventsRequestBody => ({describe('postSlackChannelWelcome', () => {beforeEach(() => {vi.clearAllMocks();+ isSlackChannelSilencedMock.mockResolvedValue(false);resolveSlackBotUserIdOrThrowMock.mockResolvedValue(BOT_USER_ID);claimSlackChannelWelcomeMock.mockResolvedValue(true);releaseSlackChannelWelcomeMock.mockResolvedValue(undefined);@@ -83,6 +96,26 @@ describe('postSlackChannelWelcome', () => {expect(getSlackClientMock).not.toHaveBeenCalled();});+ it('should stay silent when a channel rule silences the channel', async () => {+ isSlackChannelSilencedMock.mockResolvedValue(true);++ const result = await postSlackChannelWelcome(buildJoinEvent(BOT_USER_ID));++ expect(result).toEqual({+ ok: true,+ skipped: 'Channel is silenced by a channel rule',+ });+ expect(postSlackMessageMock).not.toHaveBeenCalled();+ });++ it('should leave the welcome claim unspent when the channel is silenced', async () => {+ isSlackChannelSilencedMock.mockResolvedValue(true);++ await postSlackChannelWelcome(buildJoinEvent(BOT_USER_ID));++ expect(claimSlackChannelWelcomeMock).not.toHaveBeenCalled();+ });+it('should post the channel message and its thread reply on the bot join', async () => {const result = await postSlackChannelWelcome(buildJoinEvent(BOT_USER_ID));diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/unfurl-slack-record-links.test.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/unfurl-slack-record-links.test.tsnew file mode 100644index 00000000000..9ef91db5865--- /dev/null+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/__tests__/unfurl-slack-record-links.test.ts@@ -0,0 +1,145 @@+import { beforeEach, describe, expect, it, vi } from 'vitest';++import { type SlackEventsRequestBody } from 'src/logic-functions/types/slack-events-request-body.type';+import { unfurlSlackRecordLinks } from 'src/logic-functions/utils/unfurl-slack-record-links';++const {+ coreApiClientMock,+ fetchSlackRecordEntitiesMock,+ fetchSlackUserIdentityMock,+ fetchWorkspaceBaseUrlsMock,+ getSlackClientMock,+ isSlackChannelSilencedMock,+ resolveSlackRunAsWorkspaceMemberIdMock,+ unfurlMock,+} = vi.hoisted(() => ({+ coreApiClientMock: vi.fn(),+ fetchSlackRecordEntitiesMock: vi.fn(),+ fetchSlackUserIdentityMock: vi.fn(),+ fetchWorkspaceBaseUrlsMock: vi.fn(),+ getSlackClientMock: vi.fn(),+ isSlackChannelSilencedMock: vi.fn(),+ resolveSlackRunAsWorkspaceMemberIdMock: vi.fn(),+ unfurlMock: vi.fn(),+}));++vi.mock('twenty-client-sdk/core', () => ({+ CoreApiClient: coreApiClientMock,+}));++vi.mock('src/logic-functions/utils/fetch-slack-record-entities', () => ({+ fetchSlackRecordEntities: fetchSlackRecordEntitiesMock,+}));++vi.mock('src/logic-functions/utils/fetch-slack-user-identity', () => ({+ fetchSlackUserIdentity: fetchSlackUserIdentityMock,+}));++vi.mock('src/logic-functions/utils/fetch-workspace-base-urls', () => ({+ fetchWorkspaceBaseUrls: fetchWorkspaceBaseUrlsMock,+}));++vi.mock('src/logic-functions/utils/get-slack-client', () => ({+ getSlackClient: getSlackClientMock,+}));++vi.mock('src/logic-functions/utils/is-slack-channel-silenced', () => ({+ isSlackChannelSilenced: isSlackChannelSilencedMock,+}));++vi.mock(+ 'src/logic-functions/utils/resolve-slack-run-as-workspace-member-id',+ () => ({+ resolveSlackRunAsWorkspaceMemberId: resolveSlackRunAsWorkspaceMemberIdMock,+ }),+);++const CHANNEL_ID = 'C123';+const RECORD_URL =+ 'https://app.twenty.com/object/person/20202020-ac73-4797-824e-87a1f5aea9e0';++const buildPostedLinkEvent = (): SlackEventsRequestBody => ({+ type: 'event_callback',+ team_id: 'T123',+ event: {+ type: 'link_shared',+ channel: CHANNEL_ID,+ message_ts: '1.1',+ user: 'UHUMAN',+ links: [{ url: RECORD_URL }],+ },+});++const buildComposerLinkEvent = (): SlackEventsRequestBody => ({+ type: 'event_callback',+ team_id: 'T123',+ event: {+ type: 'link_shared',+ source: 'composer',+ unfurl_id: 'unfurl-1',+ user: 'UHUMAN',+ links: [{ url: RECORD_URL }],+ },+});++describe('unfurlSlackRecordLinks', () => {+ beforeEach(() => {+ vi.clearAllMocks();+ isSlackChannelSilencedMock.mockResolvedValue(false);+ fetchWorkspaceBaseUrlsMock.mockResolvedValue(['https://app.twenty.com']);+ getSlackClientMock.mockResolvedValue({+ success: true,+ client: { chat: { unfurl: unfurlMock } },+ });+ fetchSlackUserIdentityMock.mockResolvedValue({+ slackUserId: 'UHUMAN',+ slackTeamId: 'T123',+ });+ resolveSlackRunAsWorkspaceMemberIdMock.mockResolvedValue('member-1');+ fetchSlackRecordEntitiesMock.mockResolvedValue([{ entity_type: 'item' }]);+ unfurlMock.mockResolvedValue({ ok: true });+ });++ it('should unfurl a record link posted in a channel with no rule', async () => {+ const result = await unfurlSlackRecordLinks(buildPostedLinkEvent());++ expect(result).toEqual({ ok: true, unfurledCount: 1 });+ expect(unfurlMock).toHaveBeenCalledTimes(1);+ });++ it('should not unfurl in a channel a rule silences', async () => {+ isSlackChannelSilencedMock.mockResolvedValue(true);++ const result = await unfurlSlackRecordLinks(buildPostedLinkEvent());++ expect(result).toEqual({+ ok: true,+ skipped: 'Channel is silenced by a channel rule',+ });+ expect(unfurlMock).not.toHaveBeenCalled();+ });++ it('should not read records for a silenced channel', async () => {+ isSlackChannelSilencedMock.mockResolvedValue(true);++ await unfurlSlackRecordLinks(buildPostedLinkEvent());++ expect(fetchSlackRecordEntitiesMock).not.toHaveBeenCalled();+ expect(fetchWorkspaceBaseUrlsMock).not.toHaveBeenCalled();+ });++ it('should check the rule against the channel the link was posted in', async () => {+ await unfurlSlackRecordLinks(buildPostedLinkEvent());++ expect(isSlackChannelSilencedMock).toHaveBeenCalledWith(+ expect.objectContaining({ slackChannelId: CHANNEL_ID }),+ );+ });++ it('should skip the rule lookup for a composer preview, which carries no channel', async () => {+ const result = await unfurlSlackRecordLinks(buildComposerLinkEvent());++ expect(result).toEqual({ ok: true, unfurledCount: 1 });+ expect(isSlackChannelSilencedMock).not.toHaveBeenCalled();+ });+});diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/enqueue-slack-assistant-request.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/enqueue-slack-assistant-request.tsindex f4f2e9f82b3..06f907ce530 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/enqueue-slack-assistant-request.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/enqueue-slack-assistant-request.ts@@ -2,6 +2,7 @@ import { isNonEmptyString } from '@sniptt/guards';import { CoreApiClient } from 'twenty-client-sdk/core';import { isDefined } from 'twenty-sdk/utils';+import { SLACK_CHANNEL_SILENCED_SKIP_REASON } from 'src/logic-functions/constants/slack-channel-silenced-skip-reason';import { type SlackEventsEnqueueResult } from 'src/logic-functions/types/slack-events-enqueue-result.type';import { type SlackEventsRequestBody } from 'src/logic-functions/types/slack-events-request-body.type';import { enqueueSlackAssistantRequestRecord } from 'src/logic-functions/utils/enqueue-slack-assistant-request-record';@@ -11,8 +12,6 @@ import { notifySilencedSlackChannel } from 'src/logic-functions/utils/notify-silimport { parseSlackAssistantRequest } from 'src/logic-functions/utils/parse-slack-assistant-request';import { replyToEmptySlackAssistantRequest } from 'src/logic-functions/utils/reply-to-empty-slack-assistant-request';-const SILENCED_CHANNEL_SKIP_REASON = 'Channel is silenced by a channel rule';-const DIRECT_MESSAGE_CHANNEL_TYPE = 'im';const gateSilencedChannelEvent = async ({@@ -47,7 +46,7 @@ const gateSilencedChannelEvent = async ({});}- return { ok: true, skipped: SILENCED_CHANNEL_SKIP_REASON };+ return { ok: true, skipped: SLACK_CHANNEL_SILENCED_SKIP_REASON };};export const enqueueSlackAssistantRequest = async (diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/post-slack-channel-welcome.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/post-slack-channel-welcome.tsindex 3a15b33ad3c..50ed70746ca 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/post-slack-channel-welcome.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/post-slack-channel-welcome.ts@@ -1,10 +1,13 @@import { isNonEmptyString } from '@sniptt/guards';+import { CoreApiClient } from 'twenty-client-sdk/core';+import { SLACK_CHANNEL_SILENCED_SKIP_REASON } from 'src/logic-functions/constants/slack-channel-silenced-skip-reason';import { SLACK_CHANNEL_WELCOME_TEXT } from 'src/logic-functions/constants/slack-channel-welcome-text';import { SLACK_CHANNEL_WELCOME_THREAD_TEXT } from 'src/logic-functions/constants/slack-channel-welcome-thread-text';import { type SlackEventsRequestBody } from 'src/logic-functions/types/slack-events-request-body.type';import { claimSlackChannelWelcome } from 'src/logic-functions/utils/claim-slack-channel-welcome';import { getSlackClient } from 'src/logic-functions/utils/get-slack-client';+import { isSlackChannelSilenced } from 'src/logic-functions/utils/is-slack-channel-silenced';import { parseSlackChannelWelcomeEvent } from 'src/logic-functions/utils/parse-slack-channel-welcome-event';import { postSlackMessage } from 'src/logic-functions/utils/post-slack-message';import { releaseSlackChannelWelcome } from 'src/logic-functions/utils/release-slack-channel-welcome';@@ -29,6 +32,15 @@ export const postSlackChannelWelcome = async (return { ok: true, skipped: 'Someone other than the bot joined' };}+ const isSilenced = await isSlackChannelSilenced({+ client: new CoreApiClient(),+ slackChannelId,+ });++ if (isSilenced) {+ return { ok: true, skipped: SLACK_CHANNEL_SILENCED_SKIP_REASON };+ }+const isFirstWelcome = await claimSlackChannelWelcome(slackChannelId);if (!isFirstWelcome) {diff --git a/packages/twenty-apps/public/slack/src/logic-functions/utils/unfurl-slack-record-links.ts b/packages/twenty-apps/public/slack/src/logic-functions/utils/unfurl-slack-record-links.tsindex dc33d2b2ad5..ef10c69bc5f 100644--- a/packages/twenty-apps/public/slack/src/logic-functions/utils/unfurl-slack-record-links.ts+++ b/packages/twenty-apps/public/slack/src/logic-functions/utils/unfurl-slack-record-links.ts@@ -1,12 +1,14 @@import { isNonEmptyString } from '@sniptt/guards';import { CoreApiClient } from 'twenty-client-sdk/core';+import { SLACK_CHANNEL_SILENCED_SKIP_REASON } from 'src/logic-functions/constants/slack-channel-silenced-skip-reason';import { SLACK_UNFURL_MAX_ENTITIES } from 'src/logic-functions/constants/slack-unfurl-max-entities';import { type SlackEventsRequestBody } from 'src/logic-functions/types/slack-events-request-body.type';import { fetchSlackRecordEntities } from 'src/logic-functions/utils/fetch-slack-record-entities';import { fetchSlackUserIdentity } from 'src/logic-functions/utils/fetch-slack-user-identity';import { fetchWorkspaceBaseUrls } from 'src/logic-functions/utils/fetch-workspace-base-urls';import { getSlackClient } from 'src/logic-functions/utils/get-slack-client';+import { isSlackChannelSilenced } from 'src/logic-functions/utils/is-slack-channel-silenced';import { parseSlackLinkSharedEvent } from 'src/logic-functions/utils/parse-slack-link-shared-event';import { parseTwentyRecordLinks } from 'src/logic-functions/utils/parse-twenty-record-links';import { resolveSlackRunAsWorkspaceMemberId } from 'src/logic-functions/utils/resolve-slack-run-as-workspace-member-id';@@ -29,6 +31,19 @@ export const unfurlSlackRecordLinks = async (const { unfurlTarget, slackUserId, urls } = parsed.linkShared;+ const client = new CoreApiClient();++ if (unfurlTarget.source === 'conversations_history') {+ const isSilenced = await isSlackChannelSilenced({+ client,+ slackChannelId: unfurlTarget.slackChannelId,+ });++ if (isSilenced) {+ return { ok: true, skipped: SLACK_CHANNEL_SILENCED_SKIP_REASON };+ }+ }+const workspaceBaseUrls = await fetchWorkspaceBaseUrls();if (workspaceBaseUrls.length === 0) {@@ -51,7 +66,6 @@ export const unfurlSlackRecordLinks = async (}const slackClient = slackClientResult.client;- const client = new CoreApiClient();const identity = await fetchSlackUserIdentity({client: slackClient,