Skip to content

Open-source status page, incident response and uptime monitoring

8.1 KB
Raw Blame
import crypto from "node:crypto";

import { SLACK_BOT_SCOPES } from "@openstatus/services/integration";
import { Hono } from "hono";
import { describe, expect, test } from "vitest";

import {
  TEST_SIGNING_SECRET as SIGNING_SECRET,
  withSlackConfig,
} from "@/libs/test/slack-config";

import manifest from "../../../slack-manifest.json" with { type: "json" };
import type { SlackEnv } from "./config";
import { handleSlackInstall, handleSlackOAuthCallback } from "./oauth";

function createTestApp() {
  const app = withSlackConfig(new Hono<SlackEnv>());
  app.get("/slack/install", handleSlackInstall);
  app.get("/slack/oauth/callback", handleSlackOAuthCallback);
  return app;
}

function signToken(data: {
  workspaceId: number;
  userId?: number;
  ts: number;
}): string {
  const payload = JSON.stringify(data);
  const signature = crypto
    .createHmac("sha256", SIGNING_SECRET)
    .update(payload)
    .digest("hex");
  return Buffer.from(`${payload}.${signature}`).toString("base64url");
}

function encodeState(state: { workspaceId: number; ts: number }): string {
  return signToken({ userId: 1, ...state });
}

function makeInstallToken(workspaceId: number): string {
  return signToken({ workspaceId, userId: 1, ts: Date.now() });
}

describe("slack manifest", () => {
  test("requests exactly the bot scopes the code asks for", () => {
    expect([...manifest.oauth_config.scopes.bot].sort()).toEqual(
      [...SLACK_BOT_SCOPES].sort(),
    );
  });

  // Subscribed ahead of their handlers so workspaces reconnect only once.
  test("subscribes to every event the incident stack needs", () => {
    for (const event of [
      "app_uninstalled",
      "tokens_revoked",
      "reaction_added",
      "channel_deleted",
      "channel_archive",
    ]) {
      expect(manifest.settings.event_subscriptions.bot_events).toContain(event);
    }
  });
});

describe("handleSlackInstall", () => {
  const app = createTestApp();

  test("redirects to Slack OAuth URL with correct params", async () => {
    const token = makeInstallToken(1);
    const res = await app.request(`/slack/install?token=${token}`);

    expect(res.status).toBe(302);
    const location = res.headers.get("location");
    expect(location).toBeDefined();
    expect(location).toContain("https://slack.com/oauth/v2/authorize");
    expect(location).toContain("client_id=test-client-id");
    expect(location).toContain("scope=");
    expect(location).toContain("state=");
    expect(location).toContain("redirect_uri=");
  });

  test("returns 400 when token is missing", async () => {
    const res = await app.request("/slack/install");

    expect(res.status).toBe(400);
    const json = (await res.json()) as { error: string };
    expect(json.error).toBe("token is required");
  });

  test("returns 403 for invalid token", async () => {
    const res = await app.request("/slack/install?token=invalid-token");

    expect(res.status).toBe(403);
    const json = (await res.json()) as { error: string };
    expect(json.error).toBe("Invalid or expired token");
  });

  test("returns 403 for expired token", async () => {
    const expired = signToken({
      workspaceId: 1,
      userId: 1,
      ts: Date.now() - 10 * 60 * 1000,
    });
    const res = await app.request(`/slack/install?token=${expired}`);

    expect(res.status).toBe(403);
    const json = (await res.json()) as { error: string };
    expect(json.error).toBe("Invalid or expired token");
  });

  test("includes all required bot scopes", async () => {
    const token = makeInstallToken(1);
    const res = await app.request(`/slack/install?token=${token}`);
    const location = res.headers.get("location");
    expect(location).toBeDefined();
    const url = new URL(location as string);
    const scope = url.searchParams.get("scope");

    const expectedScopes = [
      "app_mentions:read",
      "assistant:write",
      "channels:history",
      "chat:write",
      "groups:history",
      "groups:read",
      "groups:write",
      "im:history",
      "users:read",
      "users:read.email",
    ];

    for (const s of expectedScopes) {
      expect(scope).toContain(s);
    }
  });

  test("state contains signed workspaceId", async () => {
    const token = makeInstallToken(42);
    const res = await app.request(`/slack/install?token=${token}`);
    const location = res.headers.get("location");
    expect(location).toBeDefined();
    const url = new URL(location as string);
    const state = url.searchParams.get("state");
    expect(state).toBeDefined();

    const decoded = Buffer.from(state as string, "base64url").toString();
    const dotIdx = decoded.lastIndexOf(".");
    const payload = JSON.parse(decoded.slice(0, dotIdx));

    expect(payload.workspaceId).toBe(42);
    expect(payload.ts).toBeGreaterThan(0);
  });
});

describe("handleSlackOAuthCallback", () => {
  const app = createTestApp();

  test("redirects to error page on Slack error", async () => {
    const res = await app.request("/slack/oauth/callback?error=access_denied");

    expect(res.status).toBe(302);
    const location = res.headers.get("location");
    expect(location).toContain("slack=error");
  });

  test("returns 400 when code is missing", async () => {
    const state = encodeState({ workspaceId: 1, ts: Date.now() });
    const res = await app.request(`/slack/oauth/callback?state=${state}`);

    expect(res.status).toBe(400);
  });

  test("returns 400 when state is missing", async () => {
    const res = await app.request("/slack/oauth/callback?code=test-code");

    expect(res.status).toBe(400);
  });

  test("returns 400 for expired state", async () => {
    const expiredState = encodeState({
      workspaceId: 1,
      ts: Date.now() - 15 * 60 * 1000,
    });
    const res = await app.request(
      `/slack/oauth/callback?code=test-code&state=${expiredState}`,
    );

    expect(res.status).toBe(400);
    const json = (await res.json()) as { error: string };
    expect(json.error).toBe("Invalid or expired state");
  });

  test("returns 400 for tampered state", async () => {
    const payload = JSON.stringify({
      workspaceId: 1,
      userId: 1,
      ts: Date.now(),
    });
    const tamperedState = Buffer.from(`${payload}.invalidsignature`).toString(
      "base64url",
    );
    const res = await app.request(
      `/slack/oauth/callback?code=test-code&state=${tamperedState}`,
    );

    expect(res.status).toBe(400);
    const json = (await res.json()) as { error: string };
    expect(json.error).toBe("Invalid or expired state");
  });

  test("returns 400 for invalid base64 state", async () => {
    const res = await app.request(
      "/slack/oauth/callback?code=test-code&state=not-valid-base64!!!",
    );

    expect(res.status).toBe(400);
  });

  test("returns 400 for state without dot separator", async () => {
    const noDotState = Buffer.from("nodothere").toString("base64url");
    const res = await app.request(
      `/slack/oauth/callback?code=test-code&state=${noDotState}`,
    );

    expect(res.status).toBe(400);
  });

  test("returns 400 for state with valid signature but invalid JSON", async () => {
    const payload = "not-json";
    const signature = crypto
      .createHmac("sha256", SIGNING_SECRET)
      .update(payload)
      .digest("hex");
    const state = Buffer.from(`${payload}.${signature}`).toString("base64url");

    const res = await app.request(
      `/slack/oauth/callback?code=test-code&state=${state}`,
    );

    expect(res.status).toBe(400);
  });

  test("returns 400 when both code and state are missing", async () => {
    const res = await app.request("/slack/oauth/callback");
    expect(res.status).toBe(400);
  });

  test("accepts state within 10 minute window", async () => {
    const validState = encodeState({
      workspaceId: 1,
      ts: Date.now() - 9 * 60 * 1000,
    });
    // This will proceed to the token exchange which will fail (no mock for fetch)
    // but it won't fail on state validation
    const res = await app.request(
      `/slack/oauth/callback?code=test-code&state=${validState}`,
    );

    // Will get a redirect to error page because token exchange fails,
    // but NOT a 400 for invalid state
    expect(res.status).not.toBe(400);
  });
});