mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Runs E2E Fallback Tests / E2E Fallback Tests (Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Lint & build / lint_and_build (24) (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
## Summary **Stacked on [#1475](https://github.com/hexclave/stack-auth/pull/1475)** (`cl/hexclave-pr1`, the invisible compatibility layer). Diff vs that base = the actual PR 2 code. This is **PR 2 of the Stack Auth → Hexclave rebrand: the visible flip**. Old wire identifiers (cookies, request/response headers, Bearer prefix, JWT issuers, MCP tool name) keep working indefinitely via PR 1's dual-accept. This PR flips every user-visible surface — package names taught in docs, SDK class names in code examples, dashboard setup snippets, page titles, error messages, email content, CLI binary, default base URLs, GitHub repo slug, contributor guidance — to the Hexclave brand. See [`RENAME-TO-HEXCLAVE.md`](./RENAME-TO-HEXCLAVE.md) → *"PR 2: Rebrand to Hexclave (visible)"* for the full per-work-area spec. ## What's implemented (per the plan's PR 2 scope) - **SDK base URLs** flipped: `defaultBaseUrl` and `defaultAnalyticsBaseUrl` in [common.ts](packages/template/src/lib/stack-app/apps/implementations/common.ts:127) → `https://api.hexclave.com` / `https://r.hexclave.com`. PR 1's [`getHardcodedFallbackUrls`](packages/stack-shared/src/utils/urls.tsx:199) table now keys on the Hexclave domain. - **Domain inventory sweep** (16 subdomains from the plan): every `api/app/docs/discord/demo/mcp/skill/feedback/test/preview/r/api2/api.staging/idp-jwk-audience/built-with.stack-auth.com` reference in production code, docs-mintlify, examples, READMEs, and contributor guidance flipped to `*.hexclave.com`. Carve-outs: PR 1's intentional JWT issuer dual-accept table in [tokens.tsx](apps/backend/src/lib/tokens.tsx), the legacy `./docs/` folder, the `unified-docs-widget` allowlist (deliberately accepts both during DNS transition), and `url-targets.ts` hosted-component default (baked into existing customer deploys). - **`@deprecated` JSDoc** on every `Stack*` public export ([packages/template/src/lib/stack-app/index.ts](packages/template/src/lib/stack-app/index.ts) + [packages/template/src/index.ts](packages/template/src/index.ts)) — `StackClientApp`, `StackServerApp`, `StackAdminApp` + every constructor/options/JSON type, `StackHandler`, `StackProvider`, `StackTheme`, `useStackApp`, `defineStackConfig`, `StackConfig`. Hexclave\* aliases are now canonical. - **Runtime `console.warn`** ([packages/template/src/internal/deprecation-warning.ts](packages/template/src/internal/deprecation-warning.ts)) — once-per-process when the SDK is loaded from a `@stackframe/*` artifact. Detection uses the existing `STACK_COMPILE_TIME_CLIENT_PACKAGE_VERSION_SENTINEL` (rewritten at build time to e.g. `js @stackframe/stack@2.8.92` or `js @hexclave/next@1.0.0`); `@hexclave/*` mirror artifacts short-circuit the warning. - **Tier 3 data migration**: new idempotent SQL migration [`20260523000000_rename_internal_project_to_hexclave`](apps/backend/prisma/migrations/20260523000000_rename_internal_project_to_hexclave/migration.sql) — updates the internal Project `displayName` 'Stack Dashboard' → 'Hexclave Dashboard' and `description` only if both still hold the pre-rebrand defaults. Operator-renamed projects untouched, missing row no-ops, re-runs are no-ops. [`seed.ts`](apps/backend/prisma/seed.ts:87) default flipped. `getSharedEmailConfig("Stack Auth")` → `("Hexclave")`. - **Tier 4 brand strings** (mechanical sweep, ~340 files): - Page + OpenAPI titles (Hexclave API / Dashboard / REST API / Webhooks API / Documentation). OpenAPI `info.description` documents `X-Hexclave-*` headers as canonical with compat note on `X-Stack-*`. - `HexclaveAssertionError` message text ([errors.tsx:71](packages/stack-shared/src/utils/errors.tsx:71)) — "an error in Stack." → "an error in Hexclave." - Known-error message templates ([known-errors.tsx](packages/stack-shared/src/known-errors.tsx)) flipped to lead with `x-hexclave-*` + the new `docs.hexclave.com` URL; legacy `x-stack-*` mentioned as compat aliases. **25 e2e test files updated in lockstep**. - Email content: failed-emails-digest body, sendTestEmail recipient (now `sent-with-hexclave.com`), test-email-recipient default. - `CHANGELOG.md` title → "Hexclave Changelog". - `AGENTS.md` env var convention: new vars prefix `HEXCLAVE_` / `NEXT_PUBLIC_HEXCLAVE_` for Category A/B; legacy `STACK_*` explicitly noted as accepted via PR 1's dual-read. - **CLI / init wizard**: - Every dashboard setup snippet, init-stack template, and docs-mintlify page teaches `npx @hexclave/cli@latest init` (was `@stackframe/stack-cli`). [setup-page.tsx](apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/(overview)/setup-page.tsx) + [link-existing-onboarding](apps/dashboard/src/app/(main)/(protected)/(outside-dashboard)/new-project/page-client-parts/link-existing-onboarding.tsx). - [init-stack](packages/init-stack/src/index.ts:634) `STACK_*_INSTALL_PACKAGE_NAME_OVERRIDE` defaults flipped to `@hexclave/*`. - Generated `stack/client.ts` / `stack/server.ts` import from `@hexclave/next` and reference `HexclaveClientApp` / `HexclaveServerApp`. - Internal `StackAuthKeys` dashboard component renamed to `HexclaveKeys`. - **docs-mintlify rewrite** (legacy `./docs/` intentionally untouched per scoping decision): - **78 MDX files swept**. `@stackframe/{react,stack,js,tanstack-start,...}` → `@hexclave/{react,stack,js,...}` in install snippets and code blocks; `Stack*` SDK class names → `Hexclave*` in all code examples; 'Stack Auth' brand phrase → 'Hexclave'. - `openapi/{server,admin,client,webhooks}.json` titles → 'Hexclave REST API' / 'Hexclave Webhooks API'. - **Generators flipped before regeneration**: - [`packages/stack-shared/src/helpers/init-prompt.ts`](packages/stack-shared/src/helpers/init-prompt.ts), [`/ai/prompts.ts`](packages/stack-shared/src/ai/prompts.ts), [`apps/backend/src/lib/ai/prompts.ts`](apps/backend/src/lib/ai/prompts.ts), [`apps/backend/src/lib/ai/tools/create-email-{template,draft}.ts`](apps/backend/src/lib/ai/tools/create-email-template.ts), [`apps/skills/src/app/route.ts`](apps/skills/src/app/route.ts) (taught MCP tool → `ask_hexclave` with compat note; CLI binary teach → `hexclave`), [`docs-mintlify/snippets/home-prompt-island.jsx`](docs-mintlify/snippets/home-prompt-island.jsx), [`packages/template/README.md`](packages/template/README.md) + integrations/convex/component/README.md. - `generate-sdks` propagated changes to `packages/{react,stack,js}`. - **OpenAPI dual-documentation**: [`apps/backend/src/app/api/latest/route.ts`](apps/backend/src/app/api/latest/route.ts) now lists `X-Hexclave-*` headers as primary documented schemas with `X-Stack-*` duplicates marked `.optional()` (both accepted at runtime by PR 1's normalize-at-proxy shim). - **`@stackframe/emails` virtual module**: dual-aliased to `@hexclave/emails` at the bundler boundary ([email-rendering.tsx:89](apps/backend/src/lib/email-rendering.tsx:89)). Stored email templates continue to import from either name; new AI-generated templates and the system prompt teach `@hexclave/emails`. - **Tier 2 mirror-publish wiring** (new this PR, lays the groundwork for `@hexclave/*` first publish): - [`scripts/rewrite-packages-to-hexclave.ts`](scripts/rewrite-packages-to-hexclave.ts) — rewrites 9 publishable `@stackframe/*` → `@hexclave/*` `package.json` files (reads `HEXCLAVE_VERSION` env or `--version=` flag), pins cross-deps to the shared `@hexclave` version, registers `hexclave` bin alongside `stack` for `@hexclave/cli`. - [`.github/workflows/npm-publish.yaml`](.github/workflows/npm-publish.yaml) appended with rewrite-then-republish step. `pnpm publish` skips already-on-npm versions so reruns are safe. - **Sender email domain**: `noreply@stackframe.co` → `noreply@sent-with-hexclave.com` (the dedicated transactional-sender domain split per the plan, to isolate bulk deliverability from `hexclave.com` reputation); `security@` / `team@stack-auth.com` inbound mailboxes → `@hexclave.com`. - **Self-host docs**: docker network / container names in the bash examples flipped from `stack-auth` to `hexclave` (`hexclave-postgres`, `hexclave-clickhouse`, `hexclave.env`). The docker image tag `stackauth/server:latest` stays per the plan's locked decision. - **GitHub repo slug**: `hexclave/stack-auth` → `hexclave/hexclave` in every `package.json` `repository` field, README link, CHANGELOG raw-asset URL. ## Carve-outs (deliberately untouched) - **[`apps/backend/src/lib/tokens.tsx`](apps/backend/src/lib/tokens.tsx)** JWT issuer dual-accept table — PR 1 intentional infrastructure, kept indefinitely. - **Legacy `./docs/` folder** — per scoping decision (only `docs-mintlify/` rewritten). - **`unified-docs-widget` hostname allowlist** — accepts both `.hexclave.com` (canonical) and `.stack-auth.com` (transition window) for DNS rollout. - **`url-targets.ts`** hosted-domain default `.built-with-stack-auth.com` — wire identifier baked into existing customer deploys; indefinite read-fallback. - **Binary visual assets** (logos, favicons, OG images, README screenshots) — out of scope for this PR. Need design work; tracked separately. ## Verification - **`pnpm typecheck`** on `packages/{template,stack-shared,react,stack,js}` + `apps/dashboard`: **all green**. The remaining backend / e-commerce-demo typecheck errors are pre-existing (Prisma codegen output + `./generated/api-versions.json` not present in fresh worktrees without `pnpm run codegen-prisma` + a live DB) and unrelated to this diff. - **`pnpm lint`** on the same 6 packages: all green. - **Final grep** for residual `Stack Auth` / `stack-auth.com` / `@stackframe/stack-cli@latest` references: zero outside the intentional carve-outs above. - **25 e2e test files updated in lockstep** with the known-error message changes (asserted strings flipped to match the new x-hexclave-* + compat-note messages). ## Deploy blockers (ops sequencing before this rebrand goes live) This PR is code-complete, but the rebrand's visible surfaces (SDK default URLs, dashboard links, npm READMEs, REST error messages, runtime deprecation warning) all point at `*.hexclave.com` / `@hexclave/*` resources that don't exist yet. None of these are fixable from a PR — they're ops/registrar/npm work that has to be sequenced before merging this to a release tag. Suggested ordering, hardest blockers first: ### Tier 1 — required before customer-facing deploy (everything below this line *will visibly break customers on day 1* if skipped) 1. **DNS + TLS for `api.hexclave.com` + `api1./api2.hexclave.com`** → must point at the same backend that serves `api.stack-auth.com` (or a backend that mirrors PR 1's dual-accept). The SDK's new `defaultBaseUrl` is `https://api.hexclave.com`; every customer that relied on the old default and upgrades to a post-PR2 SDK build sends API requests here. Until this resolves, every default-config customer's API call NXDOMAINs. 2. **DNS for `app.hexclave.com`** → the dashboard. Referenced in the SDK's default-error messages ("Please create a project on the Hexclave dashboard at https://app.hexclave.com"), the init-stack flow's `wizard-congrats` redirect, and the OAuth dashboard handoff. 3. **DNS for `docs.hexclave.com`** + Mintlify deploy → the SDK runtime deprecation warning (`https://docs.hexclave.com/migration`), every README, every "Learn more" link in the dashboard, and every REST API error body (`/api/overview#authentication`) points here. The MDX is in this PR; the docs build target needs DNS. 4. **DNS for `mcp.hexclave.com`** → the MCP server endpoint that every taught agent integration (`claude mcp add ...`, `cursor`, `codex`, `vscode`) registers. Until this resolves, every `npx @hexclave/cli@latest init` MCP-registration step fails. 5. **Reserve the `@hexclave` npm scope + set repo variable `HEXCLAVE_VERSION`** → the mirror-publish step in `.github/workflows/npm-publish.yaml` is gated on this variable. Without it, the entire taught onboarding command `npx @hexclave/cli@latest init` 404s from the npm registry, *and* every README that says "install `@hexclave/next`" leads to install failure. Pick the initial version intentionally (`1.0.0` or aligned to `@stackframe/stack`); don't accept a silent default. ### Tier 2 — required before announcing the rebrand publicly (lookalike or low-traffic surfaces, but visibly broken) 6. **DNS for `r.hexclave.com`** → the analytics beacon `defaultAnalyticsBaseUrl`. Silent failure if missing (analytics drops), but should land alongside Tier 1. 7. **Register `sent-with-hexclave.com` + full email auth (SPF / DKIM / DMARC)** → the new default sender domain for shared-sender transactional emails. Without it the dashboard "send test email" path emits bounces, and shared-sender flows (`getSharedEmailConfig("Hexclave")`) deliver to spam at best. 8. **MX + SPF / DMARC for `hexclave.com`** → `team@hexclave.com` and `security@hexclave.com` mailboxes. The security disclosure mailbox is referenced in [`.github/SECURITY.md`](.github/SECURITY.md); `team@hexclave.com` is the actual recipient of internal feedback emails sent at runtime by [`apps/backend/src/lib/internal-feedback-emails.tsx`](apps/backend/src/lib/internal-feedback-emails.tsx). Today, every runtime feedback email bounces. 9. **DNS for `skill.hexclave.com`** → the canonical AI-agent skill fetch URL (the agent bootstrap pivot). Without it, the entire "agent downloads `SKILL.md` from a known URL" flow taught in [`packages/stack-shared/src/helpers/init-prompt.ts`](packages/stack-shared/src/helpers/init-prompt.ts) fails. 10. **Create `github.com/hexclave/hexclave` as a public repo** (even as a redirect to `hexclave/stack-auth`) **OR** rewrite every `package.json` `"repository"` field + dashboard footer "view on GitHub" link to point at `hexclave/stack-auth` (which already exists). Currently every npm package page's "Repository" link is dead, and the dashboard's GitHub button + dev-tool repo link are dead. ### Tier 3 — broken but low-visibility / low-traffic 11. **DNS for `discord.hexclave.com`** → Discord invite redirect, used in every README's chip and the dashboard footer. 12. **DNS for `demo.hexclave.com`** → "✨ Demo" badge in every npm package README. Broken-image badge on the package page. 13. **DNS + TLS for `built-with-hexclave.com`** → optional hosted-handler domain (the default reverted to `.built-with-stack-auth.com` in this PR's carve-outs, so this only matters for projects that manually flip). ## Other follow-ups (not deploy-blocking) - **E2E snapshot regen across the full suite** for the dual-emitted `x-hexclave-*` response headers (PR 1 follow-up; `vitest -u` in CI absorbs). - **Binary visual assets** — logos, favicons, OG images, README screenshots; need design pass. - **Backend OpenAPI fumadocs regen** in CI flow — the JSON files in `docs-mintlify/openapi/` are committed but regen runs in CI. Verify the workflow that does this still works against the post-PR2 source. - **Backend typecheck infra debt** — needs `codegen-prisma` + `codegen-route-info` to clear; pre-existing, unaffected by this PR. ## Test plan - [ ] CI runs full e2e suite (with `vitest -u` to absorb residual snapshot deltas, then committed back). - [ ] Spot-check: new `@hexclave/cli init` (once published) generates `hexclave.config.ts` and works against a fresh project. - [ ] Spot-check: existing customer with `@stackframe/stack` import sees the once-per-process `console.warn` recommending `@hexclave/next` on SDK init. - [ ] Manual: dashboard setup page renders the `npx @hexclave/cli@latest init` snippet and the `x-hexclave-publishable-client-key` API header in the curl example. - [ ] Manual: a fresh `pnpm run prisma migrate` against a clean DB sets the internal project displayName to 'Hexclave Dashboard'. --------- Co-authored-by: Konstantin Wohlwend <n2d4xc@gmail.com>
406 lines
15 KiB
TypeScript
406 lines
15 KiB
TypeScript
import type { SpawnSyncOptions } from "child_process";
|
|
import * as fs from "fs";
|
|
import * as os from "os";
|
|
import * as path from "path";
|
|
|
|
import type { Colorize, JsonRecord } from "./util";
|
|
import { getCommandPath, logVerbose, shouldWriteConfigFile } from "./util";
|
|
|
|
const MCP_SERVER_NAME = "stack-auth";
|
|
const MCP_SERVER_URL = "https://mcp.hexclave.com/mcp";
|
|
const MCP_ACCEPT_HEADER = "application/json, text/event-stream";
|
|
|
|
type JsonUpdater = (current: JsonRecord) => JsonRecord | null | undefined;
|
|
type JsonTarget = { path: string, allowCreate?: boolean };
|
|
|
|
const VS_CODE_PAYLOAD = JSON.stringify({ type: "http", name: MCP_SERVER_NAME, url: MCP_SERVER_URL });
|
|
const CLAUDE_BASE_ARGS = ["mcp", "add", "--transport", "http", MCP_SERVER_NAME, MCP_SERVER_URL] as const;
|
|
type RunScheduledCommandMetadata = {
|
|
recordInCommandsExecuted?: boolean,
|
|
};
|
|
|
|
type McpSchedulerContext = {
|
|
projectPath: string,
|
|
isDryRun: boolean,
|
|
colorize: Colorize,
|
|
registerWriteHandler: (handler: () => Promise<void>) => void,
|
|
registerCommandHandler: (handler: () => Promise<void>) => void,
|
|
recordFileChange: (fullPath: string, existed: boolean) => Promise<void>,
|
|
runScheduledCommand: (
|
|
command: string,
|
|
args: string[],
|
|
options?: SpawnSyncOptions,
|
|
metadata?: RunScheduledCommandMetadata,
|
|
) => Promise<void>,
|
|
};
|
|
|
|
export function scheduleMcpConfiguration(ctx: McpSchedulerContext): void {
|
|
const workspaceRoot = path.resolve(ctx.projectPath);
|
|
const homeDir = os.homedir();
|
|
|
|
logMcpVerbose("scheduleMcpConfiguration invoked", { workspaceRoot, homeDir });
|
|
scheduleCursorConfigs(ctx, homeDir, workspaceRoot);
|
|
scheduleVsCodeConfigs(ctx, homeDir, workspaceRoot);
|
|
scheduleClaudeConfigs(ctx, workspaceRoot);
|
|
scheduleWindsurfConfigs(ctx, homeDir);
|
|
scheduleGeminiConfig(ctx, homeDir);
|
|
}
|
|
|
|
function scheduleCursorConfigs(ctx: McpSchedulerContext, homeDir: string, workspaceRoot: string): void {
|
|
const updater = createServerUpdater("mcpServers", { url: MCP_SERVER_URL });
|
|
logMcpVerbose("Scheduling Cursor MCP configs", { homeDir, workspaceRoot });
|
|
const targets = [
|
|
{ path: path.join(homeDir, ".cursor", "mcp.json"), allowCreate: false, scope: "home" },
|
|
{ path: path.join(workspaceRoot, ".cursor", "mcp.json"), allowCreate: true, scope: "workspace" },
|
|
];
|
|
for (const target of targets) {
|
|
logInvestigationStatus("Cursor", target.path, target.scope);
|
|
}
|
|
scheduleJsonTargets(
|
|
ctx,
|
|
targets.map(({ path: targetPath, allowCreate }) => ({ path: targetPath, allowCreate })),
|
|
updater,
|
|
);
|
|
}
|
|
|
|
function scheduleVsCodeConfigs(ctx: McpSchedulerContext, homeDir: string, workspaceRoot: string): void {
|
|
const updater = createServerUpdater("servers", { type: "http", url: MCP_SERVER_URL });
|
|
const paths = getVsCodeUserConfigPaths(homeDir);
|
|
|
|
logMcpVerbose("Scheduling VS Code MCP configs", { homeDir, paths });
|
|
paths.stable.forEach((configPath) => logInvestigationStatus("VS Code (stable)", configPath));
|
|
paths.insiders.forEach((configPath) => logInvestigationStatus("VS Code (insiders)", configPath));
|
|
const workspaceTarget = path.join(workspaceRoot, ".vscode", "mcp.json");
|
|
logInvestigationStatus("VS Code (workspace)", workspaceTarget);
|
|
const stableChanged = scheduleJsonTargets(
|
|
ctx,
|
|
paths.stable.map((configPath) => ({ path: configPath })),
|
|
updater,
|
|
);
|
|
const insidersChanged = scheduleJsonTargets(
|
|
ctx,
|
|
paths.insiders.map((configPath) => ({ path: configPath })),
|
|
updater,
|
|
);
|
|
const workspaceChanged = scheduleJsonTargets(
|
|
ctx,
|
|
[{ path: path.join(workspaceRoot, ".vscode", "mcp.json"), allowCreate: true }],
|
|
updater,
|
|
);
|
|
|
|
scheduleCliIfAvailable(ctx, "code", ["--add-mcp", VS_CODE_PAYLOAD], true);
|
|
scheduleCliIfAvailable(ctx, "code-insiders", ["--add-mcp", VS_CODE_PAYLOAD], true);
|
|
}
|
|
|
|
function findClaudeExecutable(): string {
|
|
// Check for local installations first
|
|
// (Claude installs itself via alias so it may not be in the system PATH)
|
|
const homeDir = os.homedir();
|
|
const localBinPath = path.join(homeDir, ".local", "bin", "claude");
|
|
const claudeLocalPath = path.join(homeDir, ".claude", "local", "claude");
|
|
|
|
if (fs.existsSync(localBinPath)) {
|
|
return localBinPath;
|
|
}
|
|
|
|
if (fs.existsSync(claudeLocalPath)) {
|
|
return claudeLocalPath;
|
|
}
|
|
|
|
// Fall back to system PATH
|
|
return "claude";
|
|
}
|
|
|
|
function scheduleClaudeConfigs(ctx: McpSchedulerContext, workspaceRoot: string): void {
|
|
const updater = createServerUpdater("mcpServers", { type: "http", url: MCP_SERVER_URL });
|
|
logMcpVerbose("Scheduling Claude MCP configs", { workspaceRoot });
|
|
const targetPath = path.join(workspaceRoot, ".mcp.json");
|
|
logInvestigationStatus("Claude (project)", targetPath);
|
|
const projectConfigChanged = scheduleJsonTargets(
|
|
ctx,
|
|
[{ path: targetPath, allowCreate: true }],
|
|
updater,
|
|
);
|
|
|
|
const claudeExecutable = findClaudeExecutable();
|
|
scheduleCliIfAvailable(ctx, claudeExecutable, [...CLAUDE_BASE_ARGS, "--scope", "user"], projectConfigChanged);
|
|
scheduleCliIfAvailable(
|
|
ctx,
|
|
claudeExecutable,
|
|
[...CLAUDE_BASE_ARGS, "--scope", "project"],
|
|
projectConfigChanged,
|
|
{ cwd: workspaceRoot },
|
|
);
|
|
}
|
|
|
|
function scheduleWindsurfConfigs(ctx: McpSchedulerContext, homeDir: string): void {
|
|
const updater = createServerUpdater("mcpServers", { serverUrl: MCP_SERVER_URL });
|
|
logMcpVerbose("Scheduling Windsurf MCP configs", { homeDir });
|
|
const paths = getWindsurfConfigPaths(homeDir);
|
|
paths.forEach((configPath) => logInvestigationStatus("Windsurf", configPath));
|
|
scheduleJsonTargets(ctx, paths.map((configPath) => ({ path: configPath })), updater);
|
|
}
|
|
|
|
function scheduleGeminiConfig(ctx: McpSchedulerContext, homeDir: string): void {
|
|
const updater = createServerUpdater("mcpServers", {
|
|
httpUrl: MCP_SERVER_URL,
|
|
headers: { Accept: MCP_ACCEPT_HEADER },
|
|
});
|
|
|
|
logMcpVerbose("Scheduling Gemini MCP configs", { homeDir });
|
|
const targetPath = path.join(homeDir, ".gemini", "settings.json");
|
|
logInvestigationStatus("Gemini", targetPath);
|
|
scheduleJsonTargets(
|
|
ctx,
|
|
[{ path: targetPath }],
|
|
updater,
|
|
);
|
|
}
|
|
|
|
function scheduleJsonFileUpdate(
|
|
ctx: McpSchedulerContext,
|
|
fullPath: string | null | undefined,
|
|
update: JsonUpdater,
|
|
options: { allowCreate?: boolean } = {}
|
|
): boolean {
|
|
logMcpVerbose("scheduleJsonFileUpdate invoked", { fullPath, allowCreate: options.allowCreate });
|
|
if (!fullPath) {
|
|
logMcpVerbose("scheduleJsonFileUpdate skipped: no path provided");
|
|
return false;
|
|
}
|
|
|
|
const allowCreate = options.allowCreate ?? false;
|
|
if (!shouldWriteConfigFile(fullPath, { allowCreate })) {
|
|
logMcpVerbose("scheduleJsonFileUpdate skipped: shouldWriteConfigFile returned false", { fullPath, allowCreate });
|
|
return false;
|
|
}
|
|
|
|
const absolutePath = path.resolve(fullPath);
|
|
const info = readJsonOrEmpty(absolutePath);
|
|
logMcpVerbose("scheduleJsonFileUpdate current file info", { absolutePath, existed: info.existed, parseError: info.parseError?.message });
|
|
const draft = cloneJsonRecord(info.data);
|
|
const updated = update(draft);
|
|
if (!updated) {
|
|
logMcpVerbose("scheduleJsonFileUpdate skipped: updater returned nullish", { absolutePath });
|
|
return false;
|
|
}
|
|
|
|
const nextContent = JSON.stringify(updated, null, 2) + "\n";
|
|
const currentContent = info.existed && !info.parseError ? JSON.stringify(info.data, null, 2) + "\n" : null;
|
|
if (!info.parseError && currentContent === nextContent) {
|
|
logMcpVerbose("scheduleJsonFileUpdate skipped: content unchanged", { absolutePath });
|
|
return false;
|
|
}
|
|
|
|
ctx.registerWriteHandler(async () => {
|
|
await writeJsonFile(ctx, absolutePath, update, { allowCreate });
|
|
});
|
|
|
|
logMcpVerbose("scheduleJsonFileUpdate scheduled write", { absolutePath });
|
|
return true;
|
|
}
|
|
|
|
type WriteJsonOptions = { allowCreate?: boolean };
|
|
|
|
async function writeJsonFile(
|
|
ctx: McpSchedulerContext,
|
|
absolutePath: string,
|
|
update: JsonUpdater,
|
|
options: WriteJsonOptions
|
|
): Promise<void> {
|
|
logMcpVerbose("writeJsonFile invoked", { absolutePath, allowCreate: options.allowCreate });
|
|
const allowCreate = options.allowCreate ?? false;
|
|
const info = readJsonOrEmpty(absolutePath);
|
|
|
|
if (!info.existed && !allowCreate) {
|
|
logMcpVerbose("writeJsonFile skipped: file missing and allowCreate false", { absolutePath });
|
|
return;
|
|
}
|
|
|
|
let current = info.data;
|
|
if (info.parseError) {
|
|
console.warn(
|
|
ctx.colorize.yellow`Warning: Unable to parse MCP config at ${absolutePath}. It will be replaced with a fresh configuration.`
|
|
);
|
|
current = {};
|
|
logMcpVerbose("writeJsonFile parse error encountered; falling back to empty object", { absolutePath, error: info.parseError.message });
|
|
}
|
|
|
|
const draft = cloneJsonRecord(current);
|
|
const updated = update(draft);
|
|
if (!updated) {
|
|
logMcpVerbose("writeJsonFile skipped: updater returned nullish", { absolutePath });
|
|
return;
|
|
}
|
|
|
|
const nextContent = JSON.stringify(updated, null, 2) + "\n";
|
|
const currentContent = info.existed && !info.parseError ? JSON.stringify(current, null, 2) + "\n" : null;
|
|
if (currentContent === nextContent && !info.parseError) {
|
|
logMcpVerbose("writeJsonFile skipped: current content matches desired content", { absolutePath });
|
|
return;
|
|
}
|
|
|
|
if (ctx.isDryRun) {
|
|
console.log(`[DRY-RUN] Would write ${absolutePath}`);
|
|
logMcpVerbose("writeJsonFile dry-run; write skipped", { absolutePath });
|
|
return;
|
|
}
|
|
|
|
fs.mkdirSync(path.dirname(absolutePath), { recursive: true });
|
|
|
|
if (info.existed) {
|
|
try {
|
|
fs.copyFileSync(absolutePath, `${absolutePath}.bak`);
|
|
} catch {
|
|
// Ignore backup failures; the write below is still valid.
|
|
}
|
|
}
|
|
|
|
fs.writeFileSync(absolutePath, nextContent, "utf-8");
|
|
await ctx.recordFileChange(absolutePath, info.existed);
|
|
logMcpVerbose("writeJsonFile completed write", { absolutePath, existed: info.existed });
|
|
}
|
|
|
|
function scheduleJsonTargets(ctx: McpSchedulerContext, targets: JsonTarget[], update: JsonUpdater): boolean {
|
|
let changed = false;
|
|
logMcpVerbose("scheduleJsonTargets invoked", { targetCount: targets.length });
|
|
for (const target of targets) {
|
|
if (!target.path) continue;
|
|
if (scheduleJsonFileUpdate(ctx, target.path, update, { allowCreate: target.allowCreate })) {
|
|
changed = true;
|
|
}
|
|
}
|
|
logMcpVerbose("scheduleJsonTargets completed", { changed });
|
|
return changed;
|
|
}
|
|
|
|
function scheduleCliIfAvailable(
|
|
ctx: McpSchedulerContext,
|
|
command: string,
|
|
args: string[],
|
|
shouldRun: boolean,
|
|
options?: SpawnSyncOptions,
|
|
): void {
|
|
logMcpVerbose("scheduleCliIfAvailable invoked", { command, args, shouldRun });
|
|
if (!shouldRun) {
|
|
logMcpVerbose("scheduleCliIfAvailable skipped: shouldRun false", { command });
|
|
return;
|
|
}
|
|
const commandPath = getCommandPath(command);
|
|
if (!commandPath) {
|
|
logMcpVerbose("scheduleCliIfAvailable skipped: command not available", { command });
|
|
return;
|
|
}
|
|
logMcpVerbose("scheduleCliIfAvailable scheduling CLI registration", { command });
|
|
scheduleCliRegistration(ctx, commandPath, args, options);
|
|
}
|
|
|
|
function createServerUpdater(containerKey: string, entry: JsonRecord): JsonUpdater {
|
|
logMcpVerbose("createServerUpdater invoked", { containerKey });
|
|
return (current: JsonRecord): JsonRecord => {
|
|
const next = { ...current };
|
|
const servers = { ...(next[containerKey] ?? {}) };
|
|
servers[MCP_SERVER_NAME] = cloneJsonRecord(entry);
|
|
next[containerKey] = servers;
|
|
return next;
|
|
};
|
|
}
|
|
|
|
function getVsCodeUserConfigPaths(homeDir: string): { stable: string[], insiders: string[] } {
|
|
const stable = new Set<string>();
|
|
const insiders = new Set<string>();
|
|
const platform = process.platform;
|
|
|
|
logMcpVerbose("getVsCodeUserConfigPaths invoked", { homeDir, platform });
|
|
if (platform === "darwin") {
|
|
stable.add(path.join(homeDir, "Library", "Application Support", "Code", "User", "mcp.json"));
|
|
insiders.add(path.join(homeDir, "Library", "Application Support", "Code - Insiders", "User", "mcp.json"));
|
|
} else if (platform === "win32") {
|
|
const appData = process.env.APPDATA;
|
|
if (appData) {
|
|
stable.add(path.join(appData, "Code", "User", "mcp.json"));
|
|
insiders.add(path.join(appData, "Code - Insiders", "User", "mcp.json"));
|
|
}
|
|
} else {
|
|
stable.add(path.join(homeDir, ".config", "Code", "User", "mcp.json"));
|
|
insiders.add(path.join(homeDir, ".config", "Code - Insiders", "User", "mcp.json"));
|
|
}
|
|
|
|
return {
|
|
stable: Array.from(stable),
|
|
insiders: Array.from(insiders),
|
|
};
|
|
}
|
|
|
|
function getWindsurfConfigPaths(homeDir: string): string[] {
|
|
const paths = new Set<string>();
|
|
|
|
logMcpVerbose("getWindsurfConfigPaths invoked", { homeDir, platform: process.platform });
|
|
if (process.platform === "darwin") {
|
|
paths.add(path.join(homeDir, ".codeium", "windsurf", "mcp_config.json"));
|
|
} else if (process.platform === "win32") {
|
|
const appData = process.env.APPDATA;
|
|
if (appData) {
|
|
paths.add(path.join(appData, "Codeium", "Windsurf", "mcp_config.json"));
|
|
}
|
|
} else {
|
|
paths.add(path.join(homeDir, ".config", "Codeium", "Windsurf", "mcp_config.json"));
|
|
paths.add(path.join(homeDir, ".codeium", "windsurf", "mcp_config.json"));
|
|
paths.add(path.join(homeDir, ".var", "app", "com.codeium.windsurf", "config", "Codeium", "Windsurf", "mcp_config.json"));
|
|
}
|
|
|
|
return Array.from(paths);
|
|
}
|
|
|
|
type JsonReadResult = { existed: boolean, data: JsonRecord, parseError: Error | null };
|
|
|
|
function readJsonOrEmpty(fullPath: string): JsonReadResult {
|
|
logMcpVerbose("readJsonOrEmpty invoked", { fullPath });
|
|
if (!fs.existsSync(fullPath)) {
|
|
logMcpVerbose("readJsonOrEmpty no file found", { fullPath });
|
|
return { existed: false, data: {}, parseError: null };
|
|
}
|
|
|
|
try {
|
|
const raw = fs.readFileSync(fullPath, "utf-8");
|
|
const data = raw.trim() ? JSON.parse(raw) : {};
|
|
logMcpVerbose("readJsonOrEmpty parsed file", { fullPath, hasContent: Boolean(raw.trim()) });
|
|
return { existed: true, data, parseError: null };
|
|
} catch (error) {
|
|
const parseError = error instanceof Error ? error : new Error(String(error));
|
|
logMcpVerbose("readJsonOrEmpty parse error", { fullPath, error: parseError.message });
|
|
return { existed: true, data: {}, parseError };
|
|
}
|
|
}
|
|
|
|
function cloneJsonRecord<T extends JsonRecord>(value: T): T {
|
|
return JSON.parse(JSON.stringify(value)) as T;
|
|
}
|
|
|
|
function scheduleCliRegistration(
|
|
ctx: McpSchedulerContext,
|
|
command: string,
|
|
args: string[],
|
|
options: SpawnSyncOptions = {}
|
|
): void {
|
|
logMcpVerbose("scheduleCliRegistration invoked", { command, args, options });
|
|
ctx.registerCommandHandler(async () => {
|
|
try {
|
|
await ctx.runScheduledCommand(command, args, options, {
|
|
recordInCommandsExecuted: false,
|
|
});
|
|
} catch (error) {
|
|
logMcpVerbose("scheduleCliRegistration encountered error. Ignoring.", { command, args, options, error: error instanceof Error ? { message: error.message, stack: error.stack } : error });
|
|
}
|
|
});
|
|
}
|
|
|
|
function logMcpVerbose(message: string, details?: unknown): void {
|
|
logVerbose(`[mcp] ${message}`, details);
|
|
}
|
|
|
|
function logInvestigationStatus(editorLabel: string, configPath: string, scope?: string): void {
|
|
const exists = fs.existsSync(configPath);
|
|
logMcpVerbose(`Investigating ${editorLabel} config${scope ? ` (${scope})` : ""}`, { path: configPath, exists });
|
|
}
|