fix(slack): narrow cached write client options

RomneyDa · RomneyDa · commit e2a707746ae0 · 2026-06-28T18:42:40.000-07:00
diff --git a/extensions/slack/src/client.test.ts b/extensions/slack/src/client.test.ts
@@ -2,7 +2,8 @@
 import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
 import os from "node:os";
 import path from "node:path";
-import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
+import type { WebClientOptions } from "@slack/web-api";
+import { afterEach, beforeAll, beforeEach, describe, expect, expectTypeOf, it, vi } from "vitest";
 
 vi.mock("@slack/web-api", () => {
   const WebClient = vi.fn(function WebClientMock(
@@ -255,16 +256,20 @@ describe("slack web client config", () => {
     expect(WebClient).toHaveBeenCalledTimes(2);
   });
 
+  it("only exposes API-root options on cached write clients", () => {
+    expectTypeOf<NonNullable<Parameters<typeof getSlackWriteClient>[1]>>().toEqualTypeOf<
+      Pick<WebClientOptions, "slackApiUrl">
+    >();
+  });
+
   it("keeps write clients separated by Slack API URL client options", () => {
     clearProxyEnvForTest();
     try {
       const firstOptions = {
         slackApiUrl: "http://127.0.0.1:49152/api/",
-        timeout: 1000,
       };
       const secondOptions = {
         slackApiUrl: "http://127.0.0.1:49153/api/",
-        timeout: 1000,
       };
       const first = getSlackWriteClient("xoxb-test", firstOptions);
       const second = getSlackWriteClient("xoxb-test", secondOptions);
diff --git a/extensions/slack/src/client.ts b/extensions/slack/src/client.ts
@@ -1,14 +1,13 @@
 // Slack plugin module implements client behavior.
 import { createHash } from "node:crypto";
 import { type WebClientOptions, WebClient } from "@slack/web-api";
-import {
-  resolveSlackWebClientOptions,
-  resolveSlackWriteClientOptions,
-} from "./client-options.js";
+import { resolveSlackWebClientOptions, resolveSlackWriteClientOptions } from "./client-options.js";
 
 const SLACK_WRITE_CLIENT_CACHE_MAX = 32;
 const slackWriteClientCache = new Map<string, WebClient>();
 
+type SlackWriteClientCacheOptions = Pick<WebClientOptions, "slackApiUrl">;
+
 export {
   resolveSlackWebClientOptions,
   resolveSlackWriteClientOptions,
@@ -28,12 +27,15 @@ export function createSlackTokenCacheKey(token: string): string {
   return `sha256:${createHash("sha256").update(token).digest("base64url")}`;
 }
 
-function slackWriteClientCacheKey(token: string, options: WebClientOptions): string {
+function slackWriteClientCacheKey(token: string, options: SlackWriteClientCacheOptions): string {
   const tokenKey = createSlackTokenCacheKey(token);
   return options.slackApiUrl ? `${tokenKey}:api:${options.slackApiUrl}` : tokenKey;
 }
 
-export function getSlackWriteClient(token: string, options: WebClientOptions = {}): WebClient {
+export function getSlackWriteClient(
+  token: string,
+  options: SlackWriteClientCacheOptions = {},
+): WebClient {
   const resolvedOptions = resolveSlackWriteClientOptions(options);
   const tokenKey = slackWriteClientCacheKey(token, resolvedOptions);
   const cached = slackWriteClientCache.get(tokenKey);
