refactor: remove remaining contract path leaks

steipete · steipete · commit 36080283e4b6 · 2026-04-05T20:59:56.000+01:00
diff --git a/src/agents/models-config.providers.static.ts b/src/agents/models-config.providers.static.ts
@@ -1,9 +1,7 @@
 import path from "node:path";
 import { pathToFileURL } from "node:url";
-import {
-  listBundledPluginMetadata,
-  resolveBundledPluginPublicSurfacePath,
-} from "../plugins/bundled-plugin-metadata.js";
+import { listBundledPluginMetadata } from "../plugins/bundled-plugin-metadata.js";
+import { resolveBundledPluginPublicSurfacePath } from "../plugins/public-surface-runtime.js";
 
 const PROVIDER_CATALOG_ARTIFACT_BASENAME = "provider-catalog.js";
 const DEFAULT_PROVIDER_CATALOG_ROOT = path.resolve(import.meta.dirname, "../..");
diff --git a/src/channels/plugins/bundled.shape-guard.test.ts b/src/channels/plugins/bundled.shape-guard.test.ts
@@ -3,6 +3,7 @@ import os from "node:os";
 import path from "node:path";
 import { afterEach, describe, expect, it, vi } from "vitest";
 import { importFreshModule } from "../../../test/helpers/import-fresh.ts";
+import { loadPluginManifestRegistry } from "../../plugins/manifest-registry.js";
 
 afterEach(() => {
   vi.doUnmock("../../plugins/discovery.js");
@@ -12,6 +13,10 @@ afterEach(() => {
 });
 
 describe("bundled channel entry shape guards", () => {
+  const bundledPluginRoots = loadPluginManifestRegistry({ cache: true, config: {} })
+    .plugins.filter((plugin) => plugin.origin === "bundled")
+    .map((plugin) => plugin.rootDir);
+
   it("treats missing bundled discovery results as empty", async () => {
     vi.doMock("../../plugins/discovery.js", () => ({
       discoverOpenClawPlugins: () => ({
@@ -35,14 +40,9 @@ describe("bundled channel entry shape guards", () => {
     expect(bundled.listBundledChannelSetupPlugins()).toEqual([]);
   });
   it("keeps channel entrypoints on the dedicated entry-contract SDK surface", () => {
-    const extensionRoot = path.resolve("extensions");
     const offenders: string[] = [];
 
-    for (const extensionId of fs.readdirSync(extensionRoot)) {
-      const extensionDir = path.join(extensionRoot, extensionId);
-      if (!fs.statSync(extensionDir).isDirectory()) {
-        continue;
-      }
+    for (const extensionDir of bundledPluginRoots) {
       for (const relativePath of ["index.ts", "channel-entry.ts", "setup-entry.ts"]) {
         const filePath = path.join(extensionDir, relativePath);
         if (!fs.existsSync(filePath)) {
@@ -69,14 +69,9 @@ describe("bundled channel entry shape guards", () => {
   });
 
   it("keeps bundled channel entrypoints free of static src imports", () => {
-    const extensionRoot = path.resolve("extensions");
     const offenders: string[] = [];
 
-    for (const extensionId of fs.readdirSync(extensionRoot)) {
-      const extensionDir = path.join(extensionRoot, extensionId);
-      if (!fs.statSync(extensionDir).isDirectory()) {
-        continue;
-      }
+    for (const extensionDir of bundledPluginRoots) {
       for (const relativePath of ["index.ts", "channel-entry.ts", "setup-entry.ts"]) {
         const filePath = path.join(extensionDir, relativePath);
         if (!fs.existsSync(filePath)) {
@@ -99,14 +94,9 @@ describe("bundled channel entry shape guards", () => {
   });
 
   it("keeps channel implementations off the broad core SDK surface", () => {
-    const extensionRoot = path.resolve("extensions");
     const offenders: string[] = [];
 
-    for (const extensionId of fs.readdirSync(extensionRoot)) {
-      const extensionDir = path.join(extensionRoot, extensionId);
-      if (!fs.statSync(extensionDir).isDirectory()) {
-        continue;
-      }
+    for (const extensionDir of bundledPluginRoots) {
       for (const relativePath of ["src/channel.ts", "src/plugin.ts"]) {
         const filePath = path.join(extensionDir, relativePath);
         if (!fs.existsSync(filePath)) {
diff --git a/src/channels/plugins/contracts/registry-session-binding.ts b/src/channels/plugins/contracts/registry-session-binding.ts
@@ -13,6 +13,7 @@ import {
   sessionBindingContractChannelIds,
   type SessionBindingContractChannelId,
 } from "./manifest.js";
+import { importBundledChannelContractArtifact } from "./runtime-artifacts.js";
 import "./registry.js";
 
 type SessionBindingContractEntry = {
@@ -35,18 +36,14 @@ const matrixSessionBindingAuth = {
   accessToken: "token",
 } as const;
 
-function buildBundledPluginModuleId(pluginId: string, artifactBasename: string): string {
-  return ["..", "..", "..", "..", "extensions", pluginId, artifactBasename].join("/");
-}
-
 async function getContractApi<T extends Record<string, unknown>>(pluginId: string): Promise<T> {
   const existing = contractApiPromises.get(pluginId);
   if (existing) {
     return (await existing) as T;
   }
-  const next = import(buildBundledPluginModuleId(pluginId, "contract-api.js"));
+  const next = importBundledChannelContractArtifact<T>(pluginId, "contract-api");
   contractApiPromises.set(pluginId, next);
-  return (await next) as T;
+  return await next;
 }
 
 function expectResolvedSessionBinding(params: {
diff --git a/src/channels/plugins/contracts/registry.ts b/src/channels/plugins/contracts/registry.ts
@@ -3,10 +3,10 @@ import type { OpenClawConfig } from "../../../config/config.js";
 import { listBundledChannelPlugins, setBundledChannelRuntime } from "../bundled.js";
 import type { ChannelPlugin } from "../types.js";
 import { channelPluginSurfaceKeys, type ChannelPluginSurface } from "./manifest.js";
-
-function buildBundledPluginModuleId(pluginId: string, artifactBasename: string): string {
-  return ["..", "..", "..", "..", "extensions", pluginId, artifactBasename].join("/");
-}
+import {
+  importBundledChannelContractArtifact,
+  resolveBundledChannelContractArtifactUrl,
+} from "./runtime-artifacts.js";
 
 type SurfaceContractEntry = {
   id: string;
@@ -45,7 +45,11 @@ const sendMessageMatrixMock = vi.hoisted(() =>
   })),
 );
 
-const lineContractApi = await import(buildBundledPluginModuleId("line", "contract-api.js"));
+const lineContractApi = await importBundledChannelContractArtifact<{
+  listLineAccountIds: () => string[];
+  resolveDefaultLineAccountId: (cfg: OpenClawConfig) => string | undefined;
+  resolveLineAccount: (params: { cfg: OpenClawConfig; accountId?: string }) => unknown;
+}>("line", "contract-api");
 
 setBundledChannelRuntime("line", {
   channel: {
@@ -58,8 +62,11 @@ setBundledChannelRuntime("line", {
   },
 } as never);
 
-vi.mock(buildBundledPluginModuleId("matrix", "runtime-api.js"), async () => {
-  const matrixRuntimeApiModuleId = buildBundledPluginModuleId("matrix", "runtime-api.js");
+vi.mock(resolveBundledChannelContractArtifactUrl("matrix", "runtime-api"), async () => {
+  const matrixRuntimeApiModuleId = resolveBundledChannelContractArtifactUrl(
+    "matrix",
+    "runtime-api",
+  );
   const actual = await vi.importActual(matrixRuntimeApiModuleId);
   return {
     ...actual,
diff --git a/src/channels/plugins/contracts/runtime-artifacts.ts b/src/channels/plugins/contracts/runtime-artifacts.ts
@@ -0,0 +1,31 @@
+import { pathToFileURL } from "node:url";
+import {
+  resolvePluginRuntimeModulePath,
+  resolvePluginRuntimeRecord,
+} from "../../../plugins/runtime/runtime-plugin-boundary.js";
+
+export function resolveBundledChannelContractArtifactUrl(
+  pluginId: string,
+  entryBaseName: string,
+): string {
+  const record = resolvePluginRuntimeRecord(pluginId, () => {
+    throw new Error(`missing bundled channel plugin '${pluginId}'`);
+  });
+  if (!record) {
+    throw new Error(`missing bundled channel plugin '${pluginId}'`);
+  }
+  const modulePath = resolvePluginRuntimeModulePath(record, entryBaseName, () => {
+    throw new Error(`missing ${entryBaseName} for bundled channel plugin '${pluginId}'`);
+  });
+  if (!modulePath) {
+    throw new Error(`missing ${entryBaseName} for bundled channel plugin '${pluginId}'`);
+  }
+  return pathToFileURL(modulePath).href;
+}
+
+export async function importBundledChannelContractArtifact<T extends object>(
+  pluginId: string,
+  entryBaseName: string,
+): Promise<T> {
+  return (await import(resolveBundledChannelContractArtifactUrl(pluginId, entryBaseName))) as T;
+}
diff --git a/src/gateway/server.startup-matrix-migration.integration.test.ts b/src/gateway/server.startup-matrix-migration.integration.test.ts
@@ -1,6 +1,5 @@
 import path from "node:path";
 import { describe, expect, it, vi } from "vitest";
-import { clearBundledPluginMetadataCache } from "../plugins/bundled-plugin-metadata.js";
 import { clearPluginDiscoveryCache } from "../plugins/discovery.js";
 import { clearPluginManifestRegistryCache } from "../plugins/manifest-registry.js";
 
@@ -25,7 +24,6 @@ describe("gateway startup channel maintenance wiring", () => {
     const previousSkipChannels = process.env.OPENCLAW_SKIP_CHANNELS;
     process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = path.resolve(process.cwd(), "extensions");
     process.env.OPENCLAW_SKIP_CHANNELS = "0";
-    clearBundledPluginMetadataCache();
     clearPluginDiscoveryCache();
     clearPluginManifestRegistryCache();
     runChannelPluginStartupMaintenanceMock.mockClear();
@@ -70,7 +68,6 @@ describe("gateway startup channel maintenance wiring", () => {
       } else {
         process.env.OPENCLAW_SKIP_CHANNELS = previousSkipChannels;
       }
-      clearBundledPluginMetadataCache();
       clearPluginDiscoveryCache();
       clearPluginManifestRegistryCache();
     }
diff --git a/src/plugin-sdk/facade-runtime.ts b/src/plugin-sdk/facade-runtime.ts
@@ -9,7 +9,6 @@ import { getRuntimeConfigSnapshot } from "../config/runtime-snapshot.js";
 import type { OpenClawConfig } from "../config/types.js";
 import { openBoundaryFileSync } from "../infra/boundary-file-read.js";
 import { resolveBundledPluginsDir } from "../plugins/bundled-dir.js";
-import { resolveBundledPluginPublicSurfacePath } from "../plugins/bundled-plugin-metadata.js";
 import {
   createPluginActivationSource,
   normalizePluginsConfig,
@@ -19,6 +18,7 @@ import {
   loadPluginManifestRegistry,
   type PluginManifestRecord,
 } from "../plugins/manifest-registry.js";
+import { resolveBundledPluginPublicSurfacePath } from "../plugins/public-surface-runtime.js";
 import {
   buildPluginLoaderAliasMap,
   buildPluginLoaderJitiOptions,
diff --git a/src/plugins/bundled-plugin-metadata.ts b/src/plugins/bundled-plugin-metadata.ts
@@ -4,7 +4,6 @@ import { fileURLToPath } from "node:url";
 import { createJiti } from "jiti";
 import { buildChannelConfigSchema } from "../channels/plugins/config-schema.js";
 import type { ChannelConfigRuntimeSchema } from "../channels/plugins/types.plugin.js";
-import { resolveBundledPluginsDir } from "./bundled-dir.js";
 import {
   getPackageManifestMetadata,
   loadPluginManifest,
@@ -521,58 +520,3 @@ export function resolveBundledPluginGeneratedPath(
   }
   return null;
 }
-
-export function resolveBundledPluginPublicSurfacePath(params: {
-  rootDir: string;
-  dirName: string;
-  artifactBasename: string;
-  env?: NodeJS.ProcessEnv;
-  bundledPluginsDir?: string;
-}): string | null {
-  const artifactBasename = params.artifactBasename.replace(/^\.\//u, "");
-  if (!artifactBasename) {
-    return null;
-  }
-
-  const explicitBundledPluginsDir =
-    params.bundledPluginsDir ?? resolveBundledPluginsDir(params.env ?? process.env);
-  if (explicitBundledPluginsDir) {
-    const explicitPluginDir = path.resolve(explicitBundledPluginsDir, params.dirName);
-    const explicitBuiltCandidate = path.join(explicitPluginDir, artifactBasename);
-    if (fs.existsSync(explicitBuiltCandidate)) {
-      return explicitBuiltCandidate;
-    }
-
-    const sourceBaseName = artifactBasename.replace(/\.js$/u, "");
-    for (const ext of PUBLIC_SURFACE_SOURCE_EXTENSIONS) {
-      const sourceCandidate = path.join(explicitPluginDir, `${sourceBaseName}${ext}`);
-      if (fs.existsSync(sourceCandidate)) {
-        return sourceCandidate;
-      }
-    }
-  }
-
-  for (const candidate of [
-    path.resolve(params.rootDir, "dist", "extensions", params.dirName, artifactBasename),
-    path.resolve(params.rootDir, "dist-runtime", "extensions", params.dirName, artifactBasename),
-  ]) {
-    if (fs.existsSync(candidate)) {
-      return candidate;
-    }
-  }
-
-  const sourceBaseName = artifactBasename.replace(/\.js$/u, "");
-  for (const ext of PUBLIC_SURFACE_SOURCE_EXTENSIONS) {
-    const sourceCandidate = path.resolve(
-      params.rootDir,
-      "extensions",
-      params.dirName,
-      `${sourceBaseName}${ext}`,
-    );
-    if (fs.existsSync(sourceCandidate)) {
-      return sourceCandidate;
-    }
-  }
-
-  return null;
-}
diff --git a/src/plugins/contracts/plugin-sdk-index.bundle.test.ts b/src/plugins/contracts/plugin-sdk-index.bundle.test.ts
@@ -3,12 +3,26 @@ import { createRequire } from "node:module";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
 import { describe, expect, it } from "vitest";
-import { bundledPluginFile } from "../../../test/helpers/bundled-plugin-paths.js";
 import { buildPluginSdkEntrySources, pluginSdkEntrypoints } from "../../plugin-sdk/entrypoints.js";
+import { loadPluginManifestRegistry } from "../manifest-registry.js";
 
 const require = createRequire(import.meta.url);
 const tsdownModuleUrl = pathToFileURL(require.resolve("tsdown")).href;
 const bundledRepresentativeEntrypoints = ["matrix-runtime-heavy"] as const;
+const bundledPluginRoots = new Map(
+  loadPluginManifestRegistry({ cache: true, config: {} })
+    .plugins.filter((plugin) => plugin.origin === "bundled")
+    .map((plugin) => [plugin.id, plugin.rootDir] as const),
+);
+
+function bundledPluginFile(pluginId: string, relativePath: string): string {
+  const rootDir = bundledPluginRoots.get(pluginId);
+  if (!rootDir) {
+    throw new Error(`missing bundled plugin root for ${pluginId}`);
+  }
+  return path.join(rootDir, relativePath);
+}
+
 const matrixRuntimeCoverageEntries = {
   "matrix-runtime-sdk": bundledPluginFile("matrix", "src/matrix/sdk.ts"),
 } as const;
diff --git a/src/plugins/contracts/plugin-sdk-runtime-api-guardrails.test.ts b/src/plugins/contracts/plugin-sdk-runtime-api-guardrails.test.ts
diff --git a/src/plugins/public-surface-runtime.ts b/src/plugins/public-surface-runtime.ts
