swallowkit 2.0.0-alpha.3 → 2.0.0-alpha.4

package/src/mcp/version-selection.ts

@@ -0,0 +1,163 @@
+/**
+ * Runtime version selection for `swallowkit-mcp`.
+ *
+ * Policy: when launched as `latest` (or without an explicit version), use whichever is
+ * newer of this MCP package and the project-installed `swallowkit`. A newer project
+ * install takes over through its own `swallowkit-mcp`, so prerelease projects never get
+ * an older contract. An explicit SWALLOWKIT_MCP_VERSION is always honored.
+ */
+
+import * as fs from "fs";
+import * as path from "path";
+import type { MachineNextAction } from "../machine/contracts";
+import { MCP_LATEST, MCP_VERSION_ENV } from "../core/project/mcp-config";
+import { compareSemver } from "../utils/semver";
+
+export const MCP_DELEGATED_FROM_ENV = "SWALLOWKIT_MCP_DELEGATED_FROM";
+
+export interface ProjectSwallowKitInstall {
+  version: string;
+  packageRoot: string;
+  mcpEntrypoint: string | null;
+}
+
+export type McpVersionSelection =
+  | "running-version"
+  | "project-version"
+  | "pinned";
+
+export interface McpVersionContext {
+  /** Version of the MCP server answering the request. */
+  mcpVersion: string;
+  /** SWALLOWKIT_MCP_VERSION as requested by the launcher (`latest` when unset). */
+  requestedVersion: string;
+  projectVersion: string | null;
+  selection: McpVersionSelection;
+  delegated: boolean;
+  delegatedFrom?: string;
+  warnings: string[];
+  nextActions: MachineNextAction[];
+}
+
+export type McpLaunchDecision =
+  | { action: "delegate"; entrypoint: string; fromVersion: string; toVersion: string }
+  | { action: "serve"; context: McpVersionContext };
+
+export interface McpLaunchInput {
+  selfVersion: string;
+  selfPackageRoot: string;
+  env: NodeJS.ProcessEnv;
+  project: ProjectSwallowKitInstall | null;
+  execCommand?: string;
+}
+
+function normalizeRoot(value: string): string {
+  const resolved = path.resolve(value);
+  try {
+    return fs.realpathSync.native(resolved).toLowerCase();
+  } catch {
+    return resolved.toLowerCase();
+  }
+}
+
+export function resolveProjectSwallowKit(cwd: string): ProjectSwallowKitInstall | null {
+  // Same lookup order as Node's node_modules resolution from the project directory.
+  let packageJsonPath: string | null = null;
+  for (let directory = path.resolve(cwd); ; directory = path.dirname(directory)) {
+    const candidate = path.join(directory, "node_modules", "swallowkit", "package.json");
+    if (fs.existsSync(candidate)) {
+      packageJsonPath = fs.realpathSync(candidate);
+      break;
+    }
+    if (path.dirname(directory) === directory) return null;
+  }
+
+  try {
+    const manifest = JSON.parse(fs.readFileSync(packageJsonPath, "utf8")) as {
+      version?: string;
+      bin?: string | Record<string, string>;
+    };
+    if (!manifest.version) return null;
+    const packageRoot = path.dirname(packageJsonPath);
+    const bin = typeof manifest.bin === "object" ? manifest.bin["swallowkit-mcp"] : undefined;
+    const candidate = path.resolve(packageRoot, bin ?? path.join("dist", "mcp", "index.js"));
+    return {
+      version: manifest.version,
+      packageRoot,
+      mcpEntrypoint: fs.existsSync(candidate) ? candidate : null,
+    };
+  } catch {
+    return null;
+  }
+}
+
+export function decideMcpLaunch(input: McpLaunchInput): McpLaunchDecision {
+  const { selfVersion, env, project } = input;
+  const exec = input.execCommand ?? "npx";
+  const requested = (env[MCP_VERSION_ENV] ?? "").trim() || MCP_LATEST;
+  const pinned = requested !== MCP_LATEST;
+  const delegatedFrom = (env[MCP_DELEGATED_FROM_ENV] ?? "").trim() || undefined;
+  const projectVersion = project?.version ?? null;
+  const projectNewer = projectVersion ? (compareSemver(projectVersion, selfVersion) ?? 0) > 0 : false;
+  const sameInstall = project ? normalizeRoot(project.packageRoot) === normalizeRoot(input.selfPackageRoot) : false;
+
+  if (!pinned && !delegatedFrom && project && projectNewer && !sameInstall && project.mcpEntrypoint) {
+    return { action: "delegate", entrypoint: project.mcpEntrypoint, fromVersion: selfVersion, toVersion: project.version };
+  }
+
+  const warnings: string[] = [];
+  const nextActions: MachineNextAction[] = [];
+  if (projectVersion && projectNewer) {
+    warnings.push(
+      `mcp-older-than-project: swallowkit-mcp ${selfVersion} is older than the project's swallowkit ${projectVersion}. ` +
+        "Its capabilities, boundaries, and plan/apply contracts may be outdated for this project."
+    );
+    nextActions.push({
+      command: `${exec} swallowkit machine inspect capabilities`,
+      description: "Use the project-local machine interface, which matches the installed SwallowKit version, until MCP is updated.",
+    });
+    nextActions.push({
+      command: `${exec} swallowkit configure-mcp`,
+      description: pinned
+        ? `Re-select the MCP version (${MCP_VERSION_ENV} is pinned to ${requested}), then restart the MCP server.`
+        : "Pin the MCP launcher to the project version, then restart the MCP server.",
+    });
+  }
+
+  return {
+    action: "serve",
+    context: {
+      mcpVersion: selfVersion,
+      requestedVersion: requested,
+      projectVersion,
+      selection: delegatedFrom ? "project-version" : pinned ? "pinned" : "running-version",
+      delegated: Boolean(delegatedFrom),
+      ...(delegatedFrom ? { delegatedFrom } : {}),
+      warnings,
+      nextActions,
+    },
+  };
+}
+
+/**
+ * For an explicitly pinned launcher, report when the published `latest` has caught up
+ * with or passed the pinned version so the pin can be removed.
+ */
+export function buildPinnedUpdateNotice(
+  context: McpVersionContext,
+  publishedLatest: string | null,
+  execCommand = "npx"
+): { warning: string; nextAction: MachineNextAction } | null {
+  if (context.selection !== "pinned" || !publishedLatest) return null;
+  const comparison = compareSemver(publishedLatest, context.requestedVersion);
+  if (comparison === null || comparison < 0) return null;
+  return {
+    warning:
+      `mcp-pin-outdated: ${MCP_VERSION_ENV} is pinned to ${context.requestedVersion}, but published latest is ${publishedLatest}. ` +
+      `Switch the launcher back to "${MCP_LATEST}".`,
+    nextAction: {
+      command: `${execCommand} swallowkit configure-mcp`,
+      description: `Re-select the MCP launcher version (returns to "${MCP_LATEST}" when it is at least the project version), then restart the MCP server.`,
+    },
+  };
+}

package/src/utils/azure-cli.ts

@@ -0,0 +1,154 @@
+/**
+ * Azure CLI invocation that works without a shell on every platform.
+ *
+ * On Windows `az` is a batch wrapper (az.cmd). Node cannot spawn it with `shell: false`
+ * (ENOENT for "az", EINVAL for "az.cmd"), so the wrapper is resolved explicitly:
+ * the MSI layout runs its bundled Python exactly like az.cmd does, and other wrappers
+ * run through cmd.exe with every argument quoted.
+ */
+
+import { spawnSync, SpawnSyncOptions } from "child_process";
+import * as fs from "fs";
+import * as path from "path";
+
+export interface AzCliInvocation {
+  command: string;
+  prefixArgs: string[];
+  env?: NodeJS.ProcessEnv;
+  /** Batch wrapper that must be started through cmd.exe. */
+  batchScript?: string;
+  /** Resolved executable or wrapper, for diagnostics. */
+  source: string;
+}
+
+export interface AzCliResult {
+  status: number | null;
+  stdout: string;
+  stderr: string;
+  error?: Error;
+}
+
+export type AzCliAvailability =
+  | { available: true; invocation: AzCliInvocation }
+  | { available: false; reason: "not-found" | "not-runnable"; detail: string };
+
+function findOnWindowsPath(name: string, env: NodeJS.ProcessEnv): string | null {
+  const pathValue = env.PATH ?? env.Path ?? "";
+  const extensions = (env.PATHEXT ?? ".COM;.EXE;.BAT;.CMD").split(";").filter(Boolean).map((ext) => ext.toLowerCase());
+  for (const directory of pathValue.split(";").filter(Boolean)) {
+    for (const extension of extensions) {
+      const candidate = path.join(directory.replace(/^"|"$/g, ""), `${name}${extension}`);
+      try {
+        if (fs.statSync(candidate).isFile()) return candidate;
+      } catch {
+        // Keep searching PATH.
+      }
+    }
+  }
+  return null;
+}
+
+export function resolveAzCliInvocation(
+  env: NodeJS.ProcessEnv = process.env,
+  platform: NodeJS.Platform = process.platform
+): AzCliInvocation | null {
+  if (platform !== "win32") return { command: "az", prefixArgs: [], source: "az" };
+
+  const resolved = findOnWindowsPath("az", env);
+  if (!resolved) return null;
+  const extension = path.extname(resolved).toLowerCase();
+  if (extension === ".exe" || extension === ".com") {
+    return { command: resolved, prefixArgs: [], source: resolved };
+  }
+
+  // MSI install: wbin\az.cmd runs "..\python.exe -IBm azure.cli %*" with AZ_INSTALLER=MSI.
+  const bundledPython = path.join(path.dirname(resolved), "..", "python.exe");
+  if (path.basename(path.dirname(resolved)).toLowerCase() === "wbin" && fs.existsSync(bundledPython)) {
+    return {
+      command: path.resolve(bundledPython),
+      prefixArgs: ["-IBm", "azure.cli"],
+      env: { AZ_INSTALLER: "MSI" },
+      source: resolved,
+    };
+  }
+
+  return { command: env.ComSpec ?? "cmd.exe", prefixArgs: [], batchScript: resolved, source: resolved };
+}
+
+/** Builds the cmd.exe /s /c payload. Rejects characters cmd.exe would reinterpret even inside quotes. */
+export function buildBatchCommandLine(script: string, args: string[]): string {
+  for (const value of [script, ...args]) {
+    if (/["%\r\n]/.test(value)) {
+      throw new Error(`Azure CLI argument cannot be passed safely through ${path.basename(script)}: ${JSON.stringify(value)}`);
+    }
+  }
+  return `"${[script, ...args].map((value) => `"${value}"`).join(" ")}"`;
+}
+
+let cachedInvocation: AzCliInvocation | null | undefined;
+
+export function getAzCliInvocation(): AzCliInvocation | null {
+  if (cachedInvocation === undefined) cachedInvocation = resolveAzCliInvocation();
+  return cachedInvocation;
+}
+
+export function resetAzCliInvocationCache(): void {
+  cachedInvocation = undefined;
+}
+
+/** Test hook: pin the resolved invocation (null = not found). */
+export function setAzCliInvocationForTesting(invocation: AzCliInvocation | null | undefined): void {
+  cachedInvocation = invocation;
+}
+
+export function runAzCli(
+  args: string[],
+  options: { timeout?: number; invocation?: AzCliInvocation | null } = {}
+): AzCliResult {
+  const invocation = options.invocation === undefined ? getAzCliInvocation() : options.invocation;
+  if (!invocation) {
+    return { status: null, stdout: "", stderr: "", error: Object.assign(new Error("az was not found on PATH"), { code: "ENOENT" }) };
+  }
+  const spawnOptions: SpawnSyncOptions = {
+    shell: false,
+    encoding: "utf-8",
+    timeout: options.timeout ?? 300_000,
+    env: invocation.env ? { ...process.env, ...invocation.env } : process.env,
+  };
+  let result;
+  try {
+    result = invocation.batchScript
+      ? spawnSync(invocation.command, ["/d", "/s", "/v:off", "/c", buildBatchCommandLine(invocation.batchScript, args)], {
+        ...spawnOptions,
+        windowsVerbatimArguments: true,
+      })
+      : spawnSync(invocation.command, [...invocation.prefixArgs, ...args], spawnOptions);
+  } catch (error) {
+    return { status: null, stdout: "", stderr: "", error: error instanceof Error ? error : new Error(String(error)) };
+  }
+  return {
+    status: result.status,
+    stdout: String(result.stdout ?? ""),
+    stderr: String(result.stderr ?? ""),
+    ...(result.error ? { error: result.error } : {}),
+  };
+}
+
+export function checkAzCliAvailability(): AzCliAvailability {
+  const invocation = getAzCliInvocation();
+  if (!invocation) {
+    return { available: false, reason: "not-found", detail: "az was not found on PATH." };
+  }
+  const result = runAzCli(["--version"], { timeout: 60_000, invocation });
+  if (result.status === 0) return { available: true, invocation };
+  const errorCode = (result.error as NodeJS.ErrnoException | undefined)?.code;
+  if (errorCode === "ENOENT") {
+    return { available: false, reason: "not-found", detail: "az was not found on PATH." };
+  }
+  const output = `${result.stderr || result.stdout}`.trim().split(/\r?\n/).slice(-3).join(" ");
+  return {
+    available: false,
+    reason: "not-runnable",
+    detail: `${invocation.source} could not run "az --version" (${result.error?.message ?? `exit ${result.status}`})${output ? `: ${output}` : ""}`,
+  };
+}

package/src/utils/semver.ts

@@ -0,0 +1,59 @@
+export interface ParsedSemver {
+  major: number;
+  minor: number;
+  patch: number;
+  prerelease: Array<string | number>;
+}
+
+const SEMVER_PATTERN =
+  /^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$/;
+
+export function parseSemver(value: string | null | undefined): ParsedSemver | null {
+  const match = typeof value === "string" ? SEMVER_PATTERN.exec(value.trim()) : null;
+  if (!match) return null;
+  return {
+    major: Number(match[1]),
+    minor: Number(match[2]),
+    patch: Number(match[3]),
+    prerelease: match[4]
+      ? match[4].split(".").map((identifier) => (/^\d+$/.test(identifier) ? Number(identifier) : identifier))
+      : [],
+  };
+}
+
+export function isPrerelease(value: string): boolean {
+  return (parseSemver(value)?.prerelease.length ?? 0) > 0;
+}
+
+/**
+ * Compares versions by SemVer 2.0 precedence. Build metadata is ignored.
+ * Returns null when either value is not a valid version.
+ */
+export function compareSemver(left: string, right: string): number | null {
+  const a = parseSemver(left);
+  const b = parseSemver(right);
+  if (!a || !b) return null;
+
+  for (const key of ["major", "minor", "patch"] as const) {
+    if (a[key] !== b[key]) return a[key] < b[key] ? -1 : 1;
+  }
+
+  if (a.prerelease.length === 0 || b.prerelease.length === 0) {
+    if (a.prerelease.length === b.prerelease.length) return 0;
+    return a.prerelease.length === 0 ? 1 : -1;
+  }
+
+  const length = Math.max(a.prerelease.length, b.prerelease.length);
+  for (let index = 0; index < length; index++) {
+    const leftId = a.prerelease[index];
+    const rightId = b.prerelease[index];
+    if (leftId === undefined) return -1;
+    if (rightId === undefined) return 1;
+    if (leftId === rightId) continue;
+    if (typeof leftId === "number" && typeof rightId === "number") return leftId < rightId ? -1 : 1;
+    if (typeof leftId === "number") return -1;
+    if (typeof rightId === "number") return 1;
+    return leftId < rightId ? -1 : 1;
+  }
+  return 0;
+}