@shipfox/api-integration-slack 4.0.0 → 5.0.0

package/drizzle/0001_dark_tyrannus.sql

@@ -0,0 +1 @@
+ALTER TABLE "integrations_slack_installations" ADD COLUMN "generation" integer DEFAULT 1 NOT NULL;

package/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,139 @@
+{
+  "id": "5acf9796-7da0-4134-b7f8-000a1a5a7de0",
+  "prevId": "62801d4c-2399-4306-8d37-9773d10cbb02",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.integrations_slack_installations": {
+      "name": "integrations_slack_installations",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "connection_id": {
+          "name": "connection_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "team_id": {
+          "name": "team_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "team_name": {
+          "name": "team_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "app_id": {
+          "name": "app_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "bot_user_id": {
+          "name": "bot_user_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "scopes": {
+          "name": "scopes",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "status": {
+          "name": "status",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "generation": {
+          "name": "generation",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "default": 1
+        },
+        "token_expires_at": {
+          "name": "token_expires_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {
+        "integrations_slack_installations_connection_unique": {
+          "name": "integrations_slack_installations_connection_unique",
+          "columns": [
+            {
+              "expression": "connection_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "integrations_slack_installations_team_unique": {
+          "name": "integrations_slack_installations_team_unique",
+          "columns": [
+            {
+              "expression": "team_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/drizzle/meta/_journal.json

@@ -8,6 +8,13 @@
       "when": 1784372558063,
       "tag": "0000_calm_fantastic_four",
       "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1784407778470,
+      "tag": "0001_dark_tyrannus",
+      "breakpoints": true
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-integration-slack",
   "license": "MIT",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -13,51 +13,41 @@
   "types": "dist/index.d.ts",
   "imports": {
     "#test/*": "./test/*",
-    "#*": {
-      "workspace-source": "./src/*",
-      "development": "./src/*",
-      "default": "./dist/*"
-    }
+    "#*": "./dist/*"
   },
   "exports": {
     ".": {
-      "development": {
-        "types": "./src/index.ts",
-        "default": "./src/index.ts"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     }
   },
   "dependencies": {
     "drizzle-orm": "^0.45.2",
     "ky": "^2.0.0",
     "zod": "^4.4.3",
-    "@shipfox/api-auth-context": "3.0.0",
-    "@shipfox/api-integration-core-dto": "3.0.0",
-    "@shipfox/config": "1.2.1",
-    "@shipfox/api-integration-slack-dto": "4.0.0",
-    "@shipfox/api-workspaces": "4.0.0",
-    "@shipfox/node-drizzle": "0.3.0",
-    "@shipfox/node-fastify": "0.2.2",
-    "@shipfox/node-opentelemetry": "0.5.1",
-    "@shipfox/node-postgres": "0.4.1"
+    "@shipfox/api-auth-context": "5.0.0",
+    "@shipfox/api-integration-core-dto": "5.0.0",
+    "@shipfox/api-integration-slack-dto": "5.0.0",
+    "@shipfox/api-workspaces": "5.0.0",
+    "@shipfox/config": "1.2.2",
+    "@shipfox/node-drizzle": "0.3.1",
+    "@shipfox/node-fastify": "0.2.3",
+    "@shipfox/node-opentelemetry": "0.5.2",
+    "@shipfox/node-postgres": "0.4.2"
   },
   "peerDependencies": {
-    "@shipfox/api-secrets": "4.0.0"
+    "@shipfox/api-secrets": "5.0.0"
   },
   "devDependencies": {
     "@types/pg": "^8.15.5",
     "drizzle-kit": "^0.31.10",
     "fastify": "^5.3.3",
     "fishery": "^2.4.0",
-    "@shipfox/swc": "1.2.5",
-    "@shipfox/biome": "1.8.1",
+    "@shipfox/biome": "1.8.2",
+    "@shipfox/swc": "1.2.6",
     "@shipfox/ts-config": "1.3.8",
-    "@shipfox/typescript": "1.1.6",
-    "@shipfox/vitest": "1.2.2"
+    "@shipfox/typescript": "1.1.7",
+    "@shipfox/vitest": "1.2.3"
   },
   "scripts": {
     "build": "shipfox-swc",

package/src/api/client.test.ts

@@ -217,6 +217,30 @@ describe('createSlackApiClient', () => {
     expect(options.body.has('latest')).toBe(false);
   });
 
+  it('normalizes a trailing slash in the Slack API base URL', async () => {
+    vi.stubEnv('SLACK_API_BASE_URL', 'http://127.0.0.1:0/');
+    vi.resetModules();
+    mocks.post.mockReturnValue(resolves({ok: true}));
+    try {
+      const {createSlackApiClient: createClient} = await import('./client.js');
+
+      await createClient().callMethod({
+        method: 'conversations.replies',
+        token: 'xoxb-secret',
+        arguments: {channel: 'C123', ts: '1721300000.000001'},
+      });
+
+      expect(mocks.post).toHaveBeenCalledWith('http://127.0.0.1:0/conversations.replies', {
+        headers: {authorization: 'Bearer xoxb-secret'},
+        body: new URLSearchParams({channel: 'C123', ts: '1721300000.000001'}),
+        timeout: 10_000,
+      });
+    } finally {
+      vi.unstubAllEnvs();
+      vi.resetModules();
+    }
+  });
+
   it.each([
     [httpError(429, {'retry-after': '17'}), 'rate-limited', 17],
     [httpError(413), 'content-too-large', undefined],

package/src/api/client.ts

@@ -8,6 +8,7 @@ import {
 } from '#core/errors.js';
 
 const SLACK_API_TIMEOUT_MS = 10_000;
+const trailingSlashesPattern = /\/+$/;
 
 export interface SlackAuthorization {
   accessToken: string;
@@ -232,7 +233,8 @@ function slackMethodArguments(input: Record<string, unknown>): URLSearchParams {
 }
 
 function slackApiUrl(path: string): string {
-  return new URL(path, `${config.SLACK_API_BASE_URL}/`).toString();
+  const baseUrl = config.SLACK_API_BASE_URL.replace(trailingSlashesPattern, '');
+  return new URL(path, `${baseUrl}/`).toString();
 }
 
 function retryAfterSeconds(headers: Headers): number | undefined {

package/src/core/disconnect.test.ts

@@ -0,0 +1,49 @@
+import {disconnectSlackInstallation} from './disconnect.js';
+
+vi.mock('#db/installations.js', () => ({
+  deleteSlackInstallationByConnectionId: vi.fn(() => Promise.resolve(true)),
+}));
+
+const {deleteSlackInstallationByConnectionId} = await import('#db/installations.js');
+const deleteSlackInstallationByConnectionIdMock = vi.mocked(deleteSlackInstallationByConnectionId);
+
+describe('disconnectSlackInstallation', () => {
+  beforeEach(() => {
+    deleteSlackInstallationByConnectionIdMock.mockClear();
+  });
+
+  it('deletes stored tokens before deleting connection records', async () => {
+    const tx = Symbol('tx');
+    const calls: string[] = [];
+    const deleteSecrets = vi.fn(() => {
+      calls.push('secrets');
+      return Promise.resolve(1);
+    });
+    const deleteConnection = vi.fn(() => {
+      calls.push('connection');
+      return Promise.resolve(true);
+    });
+
+    await disconnectSlackInstallation({
+      connectionId: 'connection-1',
+      getConnection: vi.fn(() => Promise.resolve({workspaceId: 'workspace-1'})),
+      deleteSecrets,
+      transaction: async (fn) => await fn(tx),
+      deleteConnection,
+    });
+
+    expect(deleteSecrets).toHaveBeenCalledWith({
+      workspaceId: 'workspace-1',
+      namespace: 'system/integrations/slack/connection-1',
+    });
+    expect(deleteSlackInstallationByConnectionIdMock).toHaveBeenCalledWith('connection-1', {tx});
+    expect(deleteConnection).toHaveBeenCalledWith({connectionId: 'connection-1'}, {tx});
+    expect(calls).toEqual(['secrets', 'connection']);
+    expect(deleteSecrets.mock.invocationCallOrder[0]).toBeLessThan(
+      deleteSlackInstallationByConnectionIdMock.mock.invocationCallOrder[0] ?? 0,
+    );
+    expect(deleteSlackInstallationByConnectionIdMock.mock.invocationCallOrder[0]).toBeLessThan(
+      deleteConnection.mock.invocationCallOrder[0] ?? 0,
+    );
+  });
+});

package/src/core/webhook.test.ts

@@ -4,7 +4,7 @@ import type {
   IntegrationConnection,
 } from '@shipfox/api-integration-core-dto';
 import {db} from '#db/db.js';
-import {upsertSlackInstallation} from '#db/installations.js';
+import {getSlackInstallationByTeamId, upsertSlackInstallation} from '#db/installations.js';
 import {slackInstallations} from '#db/schema/installations.js';
 import {handleSlackCommand, handleSlackEvent} from './webhook.js';
 
@@ -30,7 +30,7 @@ function eventEnvelope(overrides: Record<string, unknown> = {}) {
     api_app_id: 'A1',
     event: {type: 'app_mention', channel: 'C1', user: 'U1', text: 'hello', ts: '1.0'},
     event_id: 'Ev1',
-    event_time: 1_721_300_000,
+    event_time: Math.floor(Date.now() / 1000) + 60,
     ...overrides,
   };
 }
@@ -69,6 +69,7 @@ function handlers(connection = fakeConnection()) {
     connection,
     publishIntegrationEventReceived: vi.fn(() => Promise.resolve({published: true})),
     recordDeliveryOnly: vi.fn(() => Promise.resolve()),
+    claimWebhookDelivery: vi.fn(() => Promise.resolve({claimed: true})),
     getIntegrationConnectionById: vi.fn<GetIntegrationConnectionByIdFn>(() =>
       Promise.resolve(connection),
     ),
@@ -126,6 +127,134 @@ describe('Slack webhook handlers', () => {
     );
   });
 
+  it('revokes an installation when Slack uninstalls the app', async () => {
+    const deps = handlers();
+    await seedInstallation(deps.connection);
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-uninstalled',
+      envelope: eventEnvelope({event: {type: 'app_uninstalled'}}),
+      ...deps,
+    });
+
+    const installation = await getSlackInstallationByTeamId('T1');
+    expect(result.outcome).toBe('revoked');
+    expect(installation?.status).toBe('revoked');
+    expect(deps.claimWebhookDelivery).toHaveBeenCalledTimes(1);
+    expect(deps.publishIntegrationEventReceived).not.toHaveBeenCalled();
+    expect(deps.getIntegrationConnectionById).not.toHaveBeenCalled();
+  });
+
+  it('revokes an installation when its bot token is revoked', async () => {
+    const deps = handlers();
+    await seedInstallation(deps.connection);
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-bot-revoked',
+      envelope: eventEnvelope({event: {type: 'tokens_revoked', tokens: {bot: ['UBOT']}}}),
+      ...deps,
+    });
+
+    const installation = await getSlackInstallationByTeamId('T1');
+    expect(result.outcome).toBe('revoked');
+    expect(installation?.status).toBe('revoked');
+  });
+
+  it.each([
+    ['an OAuth token is revoked', {oauth: ['UOAUTH']}],
+    ['the revoked token set is missing', undefined],
+    ['the revoked bot token set is empty', {bot: []}],
+  ])('keeps an installation active when %s', async (_description, tokens) => {
+    const deps = handlers();
+    await seedInstallation(deps.connection);
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-oauth-revoked',
+      envelope: eventEnvelope({event: {type: 'tokens_revoked', tokens}}),
+      ...deps,
+    });
+
+    const installation = await getSlackInstallationByTeamId('T1');
+    expect(result.outcome).toBe('unaffected-revocation');
+    expect(installation?.status).toBe('installed');
+    expect(deps.publishIntegrationEventReceived).not.toHaveBeenCalled();
+    expect(deps.claimWebhookDelivery).toHaveBeenCalledTimes(1);
+  });
+
+  it('records an unknown lifecycle-event team without resolving a connection', async () => {
+    const deps = handlers();
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-uninstalled-missing',
+      envelope: eventEnvelope({
+        team_id: 'T-missing',
+        event: {type: 'app_uninstalled'},
+      }),
+      ...deps,
+    });
+
+    expect(result.outcome).toBe('unknown-team');
+    expect(deps.getIntegrationConnectionById).not.toHaveBeenCalled();
+    expect(deps.claimWebhookDelivery).toHaveBeenCalledTimes(1);
+  });
+
+  it('records an already revoked lifecycle-event installation without throwing', async () => {
+    const deps = handlers();
+    await seedInstallation(deps.connection, 'revoked');
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-uninstalled-replay',
+      envelope: eventEnvelope({event: {type: 'app_uninstalled'}}),
+      ...deps,
+    });
+
+    expect(result.outcome).toBe('revoked-installation');
+    expect(deps.claimWebhookDelivery).toHaveBeenCalledTimes(1);
+  });
+
+  it('does not revoke an installation after a duplicate lifecycle delivery', async () => {
+    const deps = handlers();
+    deps.claimWebhookDelivery.mockResolvedValue({claimed: false});
+    await seedInstallation(deps.connection);
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-uninstalled-duplicate',
+      envelope: eventEnvelope({event: {type: 'app_uninstalled'}}),
+      ...deps,
+    });
+
+    const installation = await getSlackInstallationByTeamId('T1');
+    expect(result.outcome).toBe('duplicate');
+    expect(installation?.status).toBe('installed');
+    expect(deps.getIntegrationConnectionById).not.toHaveBeenCalled();
+  });
+
+  it('does not revoke a reconnected installation for a delayed lifecycle event', async () => {
+    const deps = handlers();
+    await seedInstallation(deps.connection);
+    await seedInstallation(deps.connection);
+
+    const result = await handleSlackEvent({
+      tx: db(),
+      deliveryId: 'Ev-uninstalled-stale',
+      envelope: eventEnvelope({
+        event: {type: 'app_uninstalled'},
+        event_time: Math.floor(Date.now() / 1000) - 60,
+      }),
+      ...deps,
+    });
+
+    const installation = await getSlackInstallationByTeamId('T1');
+    expect(result.outcome).toBe('stale-lifecycle-event');
+    expect(installation?.status).toBe('installed');
+  });
+
   it.each([
     ['a bot-authored event', {event: {type: 'message', bot_id: 'B1'}}],
     ['an event from this installation bot', {event: {type: 'reaction_added', user: 'UBOT'}}],