Spaces:
Paused
Paused
File size: 9,185 Bytes
b152fd5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 | /**
* External adapter plugin loader.
*
* Loads external adapter packages from the adapter-plugin-store and returns
* their ServerAdapterModule instances. The caller (registry.ts) is
* responsible for registering them.
*
* This avoids circular initialization: plugin-loader imports only
* adapter-utils, never registry.ts.
*/
import fs from "node:fs";
import path from "node:path";
import type { ServerAdapterModule } from "./types.js";
import { logger } from "../middleware/logger.js";
import {
listAdapterPlugins,
getAdapterPluginsDir,
getAdapterPluginByType,
} from "../services/adapter-plugin-store.js";
import type { AdapterPluginRecord } from "../services/adapter-plugin-store.js";
// ---------------------------------------------------------------------------
// In-memory UI parser cache
// ---------------------------------------------------------------------------
const uiParserCache = new Map<string, string>();
export function getUiParserSource(adapterType: string): string | undefined {
return uiParserCache.get(adapterType);
}
/**
* On cache miss, attempt on-demand extraction from the plugin store.
* Makes the ui-parser.js endpoint self-healing.
*/
export function getOrExtractUiParserSource(adapterType: string): string | undefined {
const cached = uiParserCache.get(adapterType);
if (cached) return cached;
const record = getAdapterPluginByType(adapterType);
if (!record) return undefined;
const packageDir = resolvePackageDir(record);
const source = extractUiParserSource(packageDir, record.packageName);
if (source) {
uiParserCache.set(adapterType, source);
logger.info(
{ type: adapterType, packageName: record.packageName, origin: "lazy" },
"UI parser extracted on-demand (cache miss)",
);
}
return source;
}
// ---------------------------------------------------------------------------
// Shared helpers
// ---------------------------------------------------------------------------
function resolvePackageDir(record: Pick<AdapterPluginRecord, "localPath" | "packageName">): string {
return record.localPath
? path.resolve(record.localPath)
: path.resolve(getAdapterPluginsDir(), "node_modules", record.packageName);
}
function resolvePackageEntryPoint(packageDir: string): string {
const pkgJsonPath = path.join(packageDir, "package.json");
const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
if (pkg.exports && typeof pkg.exports === "object" && pkg.exports["."]) {
const exp = pkg.exports["."];
return typeof exp === "string" ? exp : (exp.import ?? exp.default ?? "index.js");
}
return pkg.main ?? "index.js";
}
// ---------------------------------------------------------------------------
// UI parser extraction
// ---------------------------------------------------------------------------
const SUPPORTED_PARSER_CONTRACT = "1";
function extractUiParserSource(
packageDir: string,
packageName: string,
): string | undefined {
const pkgJsonPath = path.join(packageDir, "package.json");
const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
if (!pkg.exports || typeof pkg.exports !== "object" || !pkg.exports["./ui-parser"]) {
return undefined;
}
const contractVersion = pkg.paperclip?.adapterUiParser;
if (contractVersion) {
const major = contractVersion.split(".")[0];
if (major !== SUPPORTED_PARSER_CONTRACT) {
logger.warn(
{ packageName, contractVersion, supported: `${SUPPORTED_PARSER_CONTRACT}.x` },
"Adapter declares unsupported UI parser contract version — skipping UI parser",
);
return undefined;
}
} else {
logger.info(
{ packageName },
"Adapter has ./ui-parser export but no paperclip.adapterUiParser version — loading anyway (future versions may require it)",
);
}
const uiParserExp = pkg.exports["./ui-parser"];
const uiParserFile = typeof uiParserExp === "string"
? uiParserExp
: (uiParserExp.import ?? uiParserExp.default);
const uiParserPath = path.resolve(packageDir, uiParserFile);
if (!uiParserPath.startsWith(packageDir + path.sep) && uiParserPath !== packageDir) {
logger.warn(
{ packageName, uiParserFile },
"UI parser path escapes package directory — skipping",
);
return undefined;
}
if (!fs.existsSync(uiParserPath)) {
return undefined;
}
try {
const source = fs.readFileSync(uiParserPath, "utf-8");
logger.info(
{ packageName, uiParserFile, size: source.length },
`Loaded UI parser from adapter package${contractVersion ? "" : " (no version declared)"}`,
);
return source;
} catch (err) {
logger.warn({ err, packageName, uiParserFile }, "Failed to read UI parser from adapter package");
return undefined;
}
}
// ---------------------------------------------------------------------------
// Load / reload
// ---------------------------------------------------------------------------
function validateAdapterModule(mod: unknown, packageName: string): ServerAdapterModule {
const m = mod as Record<string, unknown>;
const createServerAdapter = m.createServerAdapter;
if (typeof createServerAdapter !== "function") {
throw new Error(
`Package "${packageName}" does not export createServerAdapter(). ` +
`Ensure the package's main entry exports a createServerAdapter function.`,
);
}
const adapterModule = createServerAdapter() as ServerAdapterModule;
if (!adapterModule || !adapterModule.type) {
throw new Error(
`createServerAdapter() from "${packageName}" returned an invalid module (missing "type").`,
);
}
return adapterModule;
}
export async function loadExternalAdapterPackage(
packageName: string,
localPath?: string,
): Promise<ServerAdapterModule> {
const packageDir = localPath
? path.resolve(localPath)
: path.resolve(getAdapterPluginsDir(), "node_modules", packageName);
const entryPoint = resolvePackageEntryPoint(packageDir);
const modulePath = path.resolve(packageDir, entryPoint);
const uiParserSource = extractUiParserSource(packageDir, packageName);
logger.info({ packageName, packageDir, entryPoint, modulePath, hasUiParser: !!uiParserSource }, "Loading external adapter package");
const mod = await import(modulePath);
const adapterModule = validateAdapterModule(mod, packageName);
if (uiParserSource) {
uiParserCache.set(adapterModule.type, uiParserSource);
}
return adapterModule;
}
async function loadFromRecord(record: AdapterPluginRecord): Promise<ServerAdapterModule | null> {
try {
return await loadExternalAdapterPackage(record.packageName, record.localPath);
} catch (err) {
logger.warn(
{ err, packageName: record.packageName, type: record.type },
"Failed to dynamically load external adapter; skipping",
);
return null;
}
}
/**
* Reload an external adapter at runtime (dev iteration without server restart).
* Busts the ESM module cache via a cache-busting query string.
*/
export async function reloadExternalAdapter(
type: string,
): Promise<ServerAdapterModule | null> {
const record = getAdapterPluginByType(type);
if (!record) return null;
const packageDir = resolvePackageDir(record);
const entryPoint = resolvePackageEntryPoint(packageDir);
const modulePath = path.resolve(packageDir, entryPoint);
const fileUrl = `file://${modulePath}`;
// Bust ESM module cache so re-import loads fresh code from disk.
// Query-string trick (?t=...) works in Node; Bun may need the file:// URL
// to be evicted from its internal registry first.
try {
// @ts-expect-error -- Bun internal module cache
const bunCache = globalThis.Bun?.__moduleCache as Map<string, unknown> | undefined;
if (bunCache) {
bunCache.delete(fileUrl);
bunCache.delete(modulePath);
}
} catch {
// Ignore — query-string fallback still works in Node
}
const cacheBustUrl = `${fileUrl}?t=${Date.now()}`;
logger.info(
{ type, packageName: record.packageName, modulePath, cacheBustUrl },
"Reloading external adapter (cache bust)",
);
const mod = await import(cacheBustUrl);
const adapterModule = validateAdapterModule(mod, record.packageName);
uiParserCache.delete(type);
const uiParserSource = extractUiParserSource(packageDir, record.packageName);
if (uiParserSource) {
uiParserCache.set(adapterModule.type, uiParserSource);
}
logger.info(
{ type, packageName: record.packageName, hasUiParser: !!uiParserSource },
"Successfully reloaded external adapter",
);
return adapterModule;
}
/**
* Build all external adapter modules from the plugin store.
*/
export async function buildExternalAdapters(): Promise<ServerAdapterModule[]> {
const results: ServerAdapterModule[] = [];
const storeRecords = listAdapterPlugins();
for (const record of storeRecords) {
const adapter = await loadFromRecord(record);
if (adapter) {
results.push(adapter);
}
}
if (results.length > 0) {
logger.info(
{ count: results.length, adapters: results.map((a) => a.type) },
"Loaded external adapters from plugin store",
);
}
return results;
}
|