diegosouzapw--omniroute/tests/unit/mcp-pool-tools-3368.test.ts

import test from "node:test";
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";

// Regression guard for #3368: the web-session pool MCP tools
// (open-sse/mcp-server/tools/poolTools.ts) existed in the repo but were never
// imported or registered in open-sse/mcp-server/server.ts, so omniroute_pool_*
// was defined-but-dead. This pins the wiring (import + registration loop +
// reserved-name entry), the scope contract, and the live handler behavior so
// the observability tools cannot silently fall out of the live MCP server again.

const { poolTools } = await import("../../open-sse/mcp-server/tools/poolTools.ts");
const {
  handlePoolStatus,
  handlePoolSessions,
  handlePoolReset,
  handlePoolWarm,
  handleBrowserPoolStatus,
} = await import("../../open-sse/mcp-server/tools/poolTools.ts");
const mcpScopesModule = await import("../../src/shared/constants/mcpScopes.ts");
const { MCP_TOOL_SCOPES, MCP_SCOPE_LIST } = mcpScopesModule;

const POOL_TOOL_NAMES = [
  "omniroute_pool_status",
  "omniroute_pool_sessions",
  "omniroute_pool_reset",
  "omniroute_pool_warm",
  "omniroute_pool_health",
  // #3368 PR7 — stealth browser pool observability
  "omniroute_browser_pool_status",
];

const serverSource = readFileSync(
  new URL("../../open-sse/mcp-server/server.ts", import.meta.url),
  "utf8"
);

// ── Wiring guard (the actual #3368 fix) ───────────────────────────────────
// These assertions fail on the pre-fix tree, where server.ts had no reference
// to poolTools at all.

test("server.ts imports the poolTools collection", () => {
  assert.match(
    serverSource,
    /import\s*\{\s*poolTools\s*\}\s*from\s*"\.\/tools\/poolTools\.ts"/,
    "server.ts must import poolTools so the tools reach the live MCP server"
  );
});

test("server.ts registers poolTools via the standard registration loop", () => {
  assert.match(
    serverSource,
    /Object\.values\(poolTools\)\.forEach/,
    "server.ts must iterate poolTools through server.registerTool like the other collections"
  );
});

test("server.ts reserves the poolTools names", () => {
  assert.match(
    serverSource,
    /\.\.\.Object\.keys\(poolTools\)/,
    "poolTools names must be in RESERVED_MCP_NAMES to avoid collisions"
  );
});

// ── Collection completeness ───────────────────────────────────────────────

test("poolTools exposes exactly the expected pool tools", () => {
  assert.deepEqual(Object.keys(poolTools).sort(), [...POOL_TOOL_NAMES].sort());
});

// ── Scope contract ────────────────────────────────────────────────────────

test("every poolTools inline scope is a known MCP scope", () => {
  const known = new Set(MCP_SCOPE_LIST as readonly string[]);
  for (const toolDef of Object.values(poolTools) as Array<{ name: string; scopes: string[] }>) {
    assert.ok(
      Array.isArray(toolDef.scopes) && toolDef.scopes.length > 0,
      `${toolDef.name}: scopes must be a non-empty array`
    );
    for (const scope of toolDef.scopes) {
      assert.ok(known.has(scope), `${toolDef.name}: "${scope}" is not in MCP_SCOPE_LIST`);
    }
  }
});

test("inline poolTools scopes match the canonical MCP_TOOL_SCOPES map", () => {
  for (const toolDef of Object.values(poolTools) as Array<{ name: string; scopes: string[] }>) {
    const canonical = (MCP_TOOL_SCOPES as Record<string, readonly string[]>)[toolDef.name];
    assert.ok(canonical, `${toolDef.name}: missing from MCP_TOOL_SCOPES`);
    assert.deepEqual(
      [...toolDef.scopes].sort(),
      [...canonical].sort(),
      `${toolDef.name}: inline scopes must equal MCP_TOOL_SCOPES entry`
    );
  }
});

test("read tools require read:health; lifecycle tools require write:resilience", () => {
  const tools = poolTools as Record<string, { scopes: string[] }>;
  assert.deepEqual(tools.omniroute_pool_status.scopes, ["read:health"]);
  assert.deepEqual(tools.omniroute_pool_sessions.scopes, ["read:health"]);
  assert.deepEqual(tools.omniroute_pool_health.scopes, ["read:health"]);
  assert.deepEqual(tools.omniroute_browser_pool_status.scopes, ["read:health"]);
  assert.deepEqual(tools.omniroute_pool_reset.scopes, ["write:resilience"]);
  assert.deepEqual(tools.omniroute_pool_warm.scopes, ["write:resilience"]);
});

test("MCP scope constants public surface excludes unused helper bundles", () => {
  assert.equal("MCP_SCOPE_PRESETS" in mcpScopesModule, false);
  assert.equal("hasRequiredScopes" in mcpScopesModule, false);
  assert.equal("getMissingScopes" in mcpScopesModule, false);
});

// ── Live handler behavior (against the in-memory PoolRegistry) ─────────────
// No pools are created here, so the registry stays empty: status returns the
// all-pools aggregate shape and per-provider tools return a clear error.

test("handlePoolStatus with no provider returns the aggregate shape", async () => {
  const result = (await handlePoolStatus({})) as {
    totalPools: number;
    providers: string[];
    pools: unknown[];
  };
  assert.equal(typeof result.totalPools, "number");
  assert.ok(Array.isArray(result.providers), "providers must be an array");
  assert.ok(Array.isArray(result.pools), "pools must be an array");
});

test("handlePoolStatus errors clearly for an unknown provider", async () => {
  const result = (await handlePoolStatus({ provider: "no-such-provider-3368" })) as {
    error?: string;
  };
  assert.match(String(result.error), /No pool found for provider 'no-such-provider-3368'/);
});

test("handlePoolSessions errors clearly for an unknown provider", async () => {
  const result = (await handlePoolSessions({ provider: "no-such-provider-3368" })) as {
    error?: string;
  };
  assert.match(String(result.error), /No pool found/);
});

test("handlePoolWarm errors clearly for an unknown provider", async () => {
  const result = (await handlePoolWarm({ provider: "no-such-provider-3368", count: 6 })) as {
    error?: string;
  };
  assert.match(String(result.error), /No pool found/);
});

test("handlePoolReset reports reset:false for an unknown provider", async () => {
  const result = (await handlePoolReset({ provider: "no-such-provider-3368" })) as {
    reset: boolean;
    provider: string;
  };
  assert.equal(result.reset, false);
  assert.equal(result.provider, "no-such-provider-3368");
});

// ── #3368 PR7 — browser pool observability ────────────────────────────────

test("handleBrowserPoolStatus returns status + cumulative metrics shape", async () => {
  const { __resetBrowserPoolMetricsForTest } =
    await import("../../open-sse/services/browserPool.ts");
  __resetBrowserPoolMetricsForTest();

  const result = (await handleBrowserPoolStatus()) as {
    status: { enabled: boolean; contexts: number; browserRunning: boolean };
    metrics: Record<string, number | string | null>;
  };

  assert.equal(typeof result.status.enabled, "boolean");
  assert.equal(typeof result.status.contexts, "number");
  assert.equal(typeof result.status.browserRunning, "boolean");
  for (const key of [
    "browserLaunches",
    "browserLaunchFailures",
    "contextsCreated",
    "contextsReused",
    "contextsEvicted",
    "contextsReleased",
    "contextCreateFailures",
    "shutdowns",
  ]) {
    assert.equal(typeof result.metrics[key], "number", `${key} must be a numeric counter`);
  }
  assert.equal(result.metrics.lastShutdownReason, null, "no shutdown yet → null reason");
});

test("shutdownPool increments the shutdowns counter and records the reason", async () => {
  const { shutdownPool, getBrowserPoolMetrics, __resetBrowserPoolMetricsForTest } =
    await import("../../open-sse/services/browserPool.ts");
  __resetBrowserPoolMetricsForTest();

  await shutdownPool("unit-test-reason");

  const { metrics } = getBrowserPoolMetrics();
  assert.equal(metrics.shutdowns, 1, "shutdownPool must increment the shutdowns counter");
  assert.equal(metrics.lastShutdownReason, "unit-test-reason");
});