Fix plugin dev watcher and migration snapshot
This commit is contained in:
7899
packages/db/src/migrations/meta/0029_snapshot.json
Normal file
7899
packages/db/src/migrations/meta/0029_snapshot.json
Normal file
File diff suppressed because it is too large
Load Diff
62
server/src/__tests__/plugin-dev-watcher.test.ts
Normal file
62
server/src/__tests__/plugin-dev-watcher.test.ts
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
|
||||||
|
import os from "node:os";
|
||||||
|
import path from "node:path";
|
||||||
|
import { afterEach, describe, expect, it } from "vitest";
|
||||||
|
import { resolvePluginWatchTargets } from "../services/plugin-dev-watcher.js";
|
||||||
|
|
||||||
|
const tempDirs: string[] = [];
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
while (tempDirs.length > 0) {
|
||||||
|
const dir = tempDirs.pop();
|
||||||
|
if (dir) rmSync(dir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
function makeTempPluginDir(): string {
|
||||||
|
const dir = mkdtempSync(path.join(os.tmpdir(), "paperclip-plugin-watch-"));
|
||||||
|
tempDirs.push(dir);
|
||||||
|
return dir;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("resolvePluginWatchTargets", () => {
|
||||||
|
it("watches the package root plus declared build output directories", () => {
|
||||||
|
const pluginDir = makeTempPluginDir();
|
||||||
|
mkdirSync(path.join(pluginDir, "dist", "ui"), { recursive: true });
|
||||||
|
writeFileSync(
|
||||||
|
path.join(pluginDir, "package.json"),
|
||||||
|
JSON.stringify({
|
||||||
|
name: "@acme/example",
|
||||||
|
paperclipPlugin: {
|
||||||
|
manifest: "./dist/manifest.js",
|
||||||
|
worker: "./dist/worker.js",
|
||||||
|
ui: "./dist/ui",
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
writeFileSync(path.join(pluginDir, "dist", "manifest.js"), "export default {};\n");
|
||||||
|
writeFileSync(path.join(pluginDir, "dist", "worker.js"), "export default {};\n");
|
||||||
|
writeFileSync(path.join(pluginDir, "dist", "ui", "index.js"), "export default {};\n");
|
||||||
|
|
||||||
|
const targets = resolvePluginWatchTargets(pluginDir);
|
||||||
|
|
||||||
|
expect(targets).toEqual([
|
||||||
|
{ path: pluginDir, recursive: false },
|
||||||
|
{ path: path.join(pluginDir, "dist"), recursive: true },
|
||||||
|
{ path: path.join(pluginDir, "dist", "ui"), recursive: true },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("falls back to dist when package metadata does not declare entrypoints", () => {
|
||||||
|
const pluginDir = makeTempPluginDir();
|
||||||
|
mkdirSync(path.join(pluginDir, "dist"), { recursive: true });
|
||||||
|
writeFileSync(path.join(pluginDir, "package.json"), JSON.stringify({ name: "@acme/example" }));
|
||||||
|
|
||||||
|
const targets = resolvePluginWatchTargets(pluginDir);
|
||||||
|
|
||||||
|
expect(targets).toEqual([
|
||||||
|
{ path: pluginDir, recursive: false },
|
||||||
|
{ path: path.join(pluginDir, "dist"), recursive: true },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
* @see PLUGIN_SPEC.md §27.2 — Local Development Workflow
|
* @see PLUGIN_SPEC.md §27.2 — Local Development Workflow
|
||||||
*/
|
*/
|
||||||
import { watch, type FSWatcher } from "node:fs";
|
import { watch, type FSWatcher } from "node:fs";
|
||||||
import { existsSync } from "node:fs";
|
import { existsSync, readFileSync, statSync } from "node:fs";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import { logger } from "../middleware/logger.js";
|
import { logger } from "../middleware/logger.js";
|
||||||
import type { PluginLifecycleManager } from "./plugin-lifecycle.js";
|
import type { PluginLifecycleManager } from "./plugin-lifecycle.js";
|
||||||
@@ -36,6 +36,100 @@ export type ResolvePluginPackagePath = (
|
|||||||
export interface PluginDevWatcherFsDeps {
|
export interface PluginDevWatcherFsDeps {
|
||||||
existsSync?: typeof existsSync;
|
existsSync?: typeof existsSync;
|
||||||
watch?: typeof watch;
|
watch?: typeof watch;
|
||||||
|
readFileSync?: typeof readFileSync;
|
||||||
|
statSync?: typeof statSync;
|
||||||
|
}
|
||||||
|
|
||||||
|
type PluginWatchTarget = {
|
||||||
|
path: string;
|
||||||
|
recursive: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
type PluginPackageJson = {
|
||||||
|
paperclipPlugin?: {
|
||||||
|
manifest?: string;
|
||||||
|
worker?: string;
|
||||||
|
ui?: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
function shouldIgnorePath(filename: string | null | undefined): boolean {
|
||||||
|
if (!filename) return false;
|
||||||
|
const normalized = filename.replace(/\\/g, "/");
|
||||||
|
const segments = normalized.split("/").filter(Boolean);
|
||||||
|
return segments.some(
|
||||||
|
(segment) =>
|
||||||
|
segment === "node_modules" ||
|
||||||
|
segment === ".git" ||
|
||||||
|
segment === ".vite" ||
|
||||||
|
segment === ".paperclip-sdk" ||
|
||||||
|
segment.startsWith("."),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function resolvePluginWatchTargets(
|
||||||
|
packagePath: string,
|
||||||
|
fsDeps?: Pick<PluginDevWatcherFsDeps, "existsSync" | "readFileSync" | "statSync">,
|
||||||
|
): PluginWatchTarget[] {
|
||||||
|
const fileExists = fsDeps?.existsSync ?? existsSync;
|
||||||
|
const readFile = fsDeps?.readFileSync ?? readFileSync;
|
||||||
|
const statFile = fsDeps?.statSync ?? statSync;
|
||||||
|
const absPath = path.resolve(packagePath);
|
||||||
|
const targets = new Map<string, PluginWatchTarget>();
|
||||||
|
|
||||||
|
function addWatchTarget(targetPath: string, recursive: boolean): void {
|
||||||
|
const resolved = path.resolve(targetPath);
|
||||||
|
if (!fileExists(resolved)) return;
|
||||||
|
|
||||||
|
const existing = targets.get(resolved);
|
||||||
|
if (existing) {
|
||||||
|
existing.recursive = existing.recursive || recursive;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
targets.set(resolved, { path: resolved, recursive });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Watch the package root non-recursively so top-level files like package.json
|
||||||
|
// can trigger reloads without traversing node_modules or other deep trees.
|
||||||
|
addWatchTarget(absPath, false);
|
||||||
|
|
||||||
|
const packageJsonPath = path.join(absPath, "package.json");
|
||||||
|
if (!fileExists(packageJsonPath)) {
|
||||||
|
return [...targets.values()];
|
||||||
|
}
|
||||||
|
|
||||||
|
let packageJson: PluginPackageJson | null = null;
|
||||||
|
try {
|
||||||
|
packageJson = JSON.parse(readFile(packageJsonPath, "utf8")) as PluginPackageJson;
|
||||||
|
} catch {
|
||||||
|
packageJson = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const entrypointPaths = [
|
||||||
|
packageJson?.paperclipPlugin?.manifest,
|
||||||
|
packageJson?.paperclipPlugin?.worker,
|
||||||
|
packageJson?.paperclipPlugin?.ui,
|
||||||
|
].filter((value): value is string => typeof value === "string" && value.length > 0);
|
||||||
|
|
||||||
|
if (entrypointPaths.length === 0) {
|
||||||
|
addWatchTarget(path.join(absPath, "dist"), true);
|
||||||
|
return [...targets.values()];
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const relativeEntrypoint of entrypointPaths) {
|
||||||
|
const resolvedEntrypoint = path.resolve(absPath, relativeEntrypoint);
|
||||||
|
if (!fileExists(resolvedEntrypoint)) continue;
|
||||||
|
|
||||||
|
const stat = statFile(resolvedEntrypoint);
|
||||||
|
if (stat.isDirectory()) {
|
||||||
|
addWatchTarget(resolvedEntrypoint, true);
|
||||||
|
} else {
|
||||||
|
addWatchTarget(path.dirname(resolvedEntrypoint), true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return [...targets.values()];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -47,7 +141,7 @@ export function createPluginDevWatcher(
|
|||||||
resolvePluginPackagePath?: ResolvePluginPackagePath,
|
resolvePluginPackagePath?: ResolvePluginPackagePath,
|
||||||
fsDeps?: PluginDevWatcherFsDeps,
|
fsDeps?: PluginDevWatcherFsDeps,
|
||||||
): PluginDevWatcher {
|
): PluginDevWatcher {
|
||||||
const watchers = new Map<string, FSWatcher>();
|
const watchers = new Map<string, FSWatcher[]>();
|
||||||
const debounceTimers = new Map<string, ReturnType<typeof setTimeout>>();
|
const debounceTimers = new Map<string, ReturnType<typeof setTimeout>>();
|
||||||
const fileExists = fsDeps?.existsSync ?? existsSync;
|
const fileExists = fsDeps?.existsSync ?? existsSync;
|
||||||
const watchFs = fsDeps?.watch ?? watch;
|
const watchFs = fsDeps?.watch ?? watch;
|
||||||
@@ -66,52 +160,71 @@ export function createPluginDevWatcher(
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const watcher = watchFs(absPath, { recursive: true }, (_event, filename) => {
|
const watcherTargets = resolvePluginWatchTargets(absPath, fsDeps);
|
||||||
// Ignore node_modules and hidden files inside the plugin dir
|
if (watcherTargets.length === 0) {
|
||||||
if (
|
|
||||||
filename &&
|
|
||||||
(filename.includes("node_modules") || filename.startsWith("."))
|
|
||||||
) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Debounce: multiple rapid file changes collapse into one restart
|
|
||||||
const existing = debounceTimers.get(pluginId);
|
|
||||||
if (existing) clearTimeout(existing);
|
|
||||||
|
|
||||||
debounceTimers.set(
|
|
||||||
pluginId,
|
|
||||||
setTimeout(() => {
|
|
||||||
debounceTimers.delete(pluginId);
|
|
||||||
log.info(
|
|
||||||
{ pluginId, changedFile: filename },
|
|
||||||
"plugin-dev-watcher: file change detected, restarting worker",
|
|
||||||
);
|
|
||||||
|
|
||||||
lifecycle.restartWorker(pluginId).catch((err) => {
|
|
||||||
log.warn(
|
|
||||||
{
|
|
||||||
pluginId,
|
|
||||||
err: err instanceof Error ? err.message : String(err),
|
|
||||||
},
|
|
||||||
"plugin-dev-watcher: failed to restart worker after file change",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
}, DEBOUNCE_MS),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
watcher.on("error", (err) => {
|
|
||||||
log.warn(
|
log.warn(
|
||||||
{ pluginId, packagePath: absPath, err: err instanceof Error ? err.message : String(err) },
|
{ pluginId, packagePath: absPath },
|
||||||
"plugin-dev-watcher: watcher error, stopping watch for this plugin",
|
"plugin-dev-watcher: no valid watch targets found, skipping watch",
|
||||||
);
|
);
|
||||||
unwatchPlugin(pluginId);
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const activeWatchers = watcherTargets.map((target) => {
|
||||||
|
const watcher = watchFs(target.path, { recursive: target.recursive }, (_event, filename) => {
|
||||||
|
if (shouldIgnorePath(filename)) return;
|
||||||
|
|
||||||
|
// Debounce: multiple rapid file changes collapse into one restart
|
||||||
|
const existing = debounceTimers.get(pluginId);
|
||||||
|
if (existing) clearTimeout(existing);
|
||||||
|
|
||||||
|
debounceTimers.set(
|
||||||
|
pluginId,
|
||||||
|
setTimeout(() => {
|
||||||
|
debounceTimers.delete(pluginId);
|
||||||
|
log.info(
|
||||||
|
{ pluginId, changedFile: filename, watchTarget: target.path },
|
||||||
|
"plugin-dev-watcher: file change detected, restarting worker",
|
||||||
|
);
|
||||||
|
|
||||||
|
lifecycle.restartWorker(pluginId).catch((err) => {
|
||||||
|
log.warn(
|
||||||
|
{
|
||||||
|
pluginId,
|
||||||
|
err: err instanceof Error ? err.message : String(err),
|
||||||
|
},
|
||||||
|
"plugin-dev-watcher: failed to restart worker after file change",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}, DEBOUNCE_MS),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
watcher.on("error", (err) => {
|
||||||
|
log.warn(
|
||||||
|
{
|
||||||
|
pluginId,
|
||||||
|
packagePath: absPath,
|
||||||
|
watchTarget: target.path,
|
||||||
|
err: err instanceof Error ? err.message : String(err),
|
||||||
|
},
|
||||||
|
"plugin-dev-watcher: watcher error, stopping watch for this plugin",
|
||||||
|
);
|
||||||
|
unwatchPlugin(pluginId);
|
||||||
|
});
|
||||||
|
|
||||||
|
return watcher;
|
||||||
});
|
});
|
||||||
|
|
||||||
watchers.set(pluginId, watcher);
|
watchers.set(pluginId, activeWatchers);
|
||||||
log.info(
|
log.info(
|
||||||
{ pluginId, packagePath: absPath },
|
{
|
||||||
|
pluginId,
|
||||||
|
packagePath: absPath,
|
||||||
|
watchTargets: watcherTargets.map((target) => ({
|
||||||
|
path: target.path,
|
||||||
|
recursive: target.recursive,
|
||||||
|
})),
|
||||||
|
},
|
||||||
"plugin-dev-watcher: watching local plugin for changes",
|
"plugin-dev-watcher: watching local plugin for changes",
|
||||||
);
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -127,9 +240,11 @@ export function createPluginDevWatcher(
|
|||||||
}
|
}
|
||||||
|
|
||||||
function unwatchPlugin(pluginId: string): void {
|
function unwatchPlugin(pluginId: string): void {
|
||||||
const watcher = watchers.get(pluginId);
|
const pluginWatchers = watchers.get(pluginId);
|
||||||
if (watcher) {
|
if (pluginWatchers) {
|
||||||
watcher.close();
|
for (const watcher of pluginWatchers) {
|
||||||
|
watcher.close();
|
||||||
|
}
|
||||||
watchers.delete(pluginId);
|
watchers.delete(pluginId);
|
||||||
}
|
}
|
||||||
const timer = debounceTimers.get(pluginId);
|
const timer = debounceTimers.get(pluginId);
|
||||||
|
|||||||
Reference in New Issue
Block a user