feat(plugin-kit): @punktfunk/plugin-kit 0.1.0 — the Effect plugin framework
ci / rust (push) Has been cancelled
android / android (push) Has been cancelled
apple / swift (push) Has been cancelled
apple / screenshots (push) Has been cancelled
arch / build-publish (push) Has been cancelled
ci / web (push) Has been cancelled
ci / bench (push) Has been cancelled
ci / docs-site (push) Has been cancelled
deb / build-publish-host (push) Has been cancelled
deb / build-publish (push) Has been cancelled
decky / build-publish (push) Has been cancelled
docker / build-push (ci, ci/rust-ci-noble.Dockerfile, punktfunk-rust-ci-noble) (push) Has been cancelled
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Has been cancelled
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Has been cancelled
docker / deploy-docs (push) Has been cancelled
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Has been cancelled
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Has been cancelled
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Has been cancelled
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Has been cancelled
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Has been cancelled
windows-host / package (push) Has been cancelled

The ~80% of every plugin that was copy-pasted (rom-manager ↔ playnite),
extracted as one Effect-v4 package:

- runtime: definePluginKit — async-main boundary hiding a ManagedRuntime
  (two-effect-instances discipline), signal-driven interruption with a
  bounded shutdown grace
- config: Schema-driven raw round-trip (defaults only in the Schema via
  withDecodingDefaultKey + encodingStrategy omit; file stays authored-shape),
  atomic writes, world-writable refusal, changes stream
- cache-store: disposable derived state, corrupt→empty, write-through
- reconcile: kit-owned provider wire schemas + typed client over the
  skew-safe untyped pf.request seam
- sync-engine: generic poll/watch/debounce/single-flight-coalesce/
  fingerprint-skip engine with a status PubSub (the SSE feed)
- ui-server + sse: effect/unstable/httpapi behind servePluginUi with
  core-only env layers (validated by the phase-0 spikes); raw SSE route
  (httpapi has no event-stream media type)
- cli: minimal command dispatcher reusing the plugin layer graph
  (deliberately not effect/unstable/cli — it needs platform packages)
- react subpath: plugin router (path→hash→fallback deep-link restore +
  pf-ui:navigate bridge), ResultGate, sseAtom, resolvePluginBase
- theme.css: the console's violet identity packaged for plugin UIs

18 bun tests incl. the two phase-0 spikes; publish workflow mirrors
sdk-publish (tag plugin-kit-v*; 0.1.0 published manually).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
2026-07-20 18:41:04 +02:00
parent c15c80718a
commit 8d72e1d27e
23 changed files with 1987 additions and 18 deletions
+143
View File
@@ -0,0 +1,143 @@
// ConfigService semantics (the canonical suite — ported from rom-manager's state.test.ts
// obligations): raw round-trip, schema defaults at decode only, atomic writes, missing
// file == defaults, world-writable refusal, changes stream.
import { afterEach, beforeEach, describe, expect, test } from "bun:test";
import * as fs from "node:fs";
import * as os from "node:os";
import * as path from "node:path";
import { Effect, Fiber, Schema, Stream } from "effect";
import {
type ConfigService,
makeConfigService,
pluginInfoLayer,
pluginStateDir,
} from "../src/index.js";
const TestSchema = Schema.Struct({
roots: Schema.Array(Schema.String).pipe(
Schema.withDecodingDefaultKey(Effect.succeed([]), {
encodingStrategy: "omit",
}),
),
sync: Schema.Struct({
pollMinutes: Schema.Number.pipe(
Schema.withDecodingDefaultKey(Effect.succeed(15), {
encodingStrategy: "omit",
}),
),
watch: Schema.Boolean.pipe(
Schema.withDecodingDefaultKey(Effect.succeed(true), {
encodingStrategy: "omit",
}),
),
}).pipe(
Schema.withDecodingDefaultKey(Effect.succeed({}), {
encodingStrategy: "omit",
}),
),
});
const PLUGIN = "kit-config-test";
let tmp: string;
const withService = <A>(
f: (svc: ConfigService<typeof TestSchema>) => Effect.Effect<A, unknown>,
): Promise<A> =>
Effect.runPromise(
makeConfigService({ schema: TestSchema }).pipe(
Effect.flatMap(f),
Effect.provide(pluginInfoLayer({ name: PLUGIN })),
) as Effect.Effect<A, never>,
);
beforeEach(() => {
tmp = fs.mkdtempSync(path.join(os.tmpdir(), "pf-kit-config-"));
process.env.PUNKTFUNK_CONFIG_DIR = tmp;
});
afterEach(() => {
delete process.env.PUNKTFUNK_CONFIG_DIR;
fs.rmSync(tmp, { recursive: true, force: true });
});
describe("ConfigService", () => {
test("missing file decodes to full defaults", async () => {
const loaded = await withService((svc) => svc.load);
expect(loaded).toEqual({
roots: [],
sync: { pollMinutes: 15, watch: true },
});
});
test("saveRaw persists the RAW shape verbatim (no defaults baked in)", async () => {
await withService((svc) => svc.saveRaw({ roots: ["/roms"] }));
const onDisk = JSON.parse(
fs.readFileSync(
path.join(pluginStateDir(PLUGIN), "config.json"),
"utf8",
),
);
expect(onDisk).toEqual({ roots: ["/roms"] }); // no sync block materialized
const loaded = await withService((svc) => svc.load);
expect(loaded.sync.pollMinutes).toBe(15);
});
test("saveRaw rejects an invalid raw config and leaves the file untouched", async () => {
await withService((svc) => svc.saveRaw({ roots: ["/a"] }));
const before = fs.readFileSync(
path.join(pluginStateDir(PLUGIN), "config.json"),
"utf8",
);
const exit = await withService((svc) =>
Effect.exit(svc.saveRaw({ roots: "not-an-array" })),
);
expect(exit._tag).toBe("Failure");
const after = fs.readFileSync(
path.join(pluginStateDir(PLUGIN), "config.json"),
"utf8",
);
expect(after).toBe(before);
});
test("unknown keys in the file are tolerated and survive loadRaw", async () => {
fs.mkdirSync(pluginStateDir(PLUGIN), { recursive: true, mode: 0o700 });
fs.writeFileSync(
path.join(pluginStateDir(PLUGIN), "config.json"),
JSON.stringify({ roots: [], ui: { port: 5885 }, devEntry: true }),
{ mode: 0o600 },
);
const raw = (await withService((svc) => svc.loadRaw)) as Record<
string,
unknown
>;
expect(raw.ui).toEqual({ port: 5885 }); // verbatim — a save decides what survives
});
test("refuses a group/world-writable config file (POSIX)", async () => {
if (process.platform === "win32") return;
fs.mkdirSync(pluginStateDir(PLUGIN), { recursive: true, mode: 0o700 });
const file = path.join(pluginStateDir(PLUGIN), "config.json");
fs.writeFileSync(file, "{}");
fs.chmodSync(file, 0o666); // bypass umask — writeFileSync's mode is masked
const exit = await withService((svc) => Effect.exit(svc.load));
expect(exit._tag).toBe("Failure");
if (exit._tag === "Failure") {
expect(String(exit.cause)).toContain("ConfigPermissionError");
}
});
test("changes stream emits the decoded config after saveRaw", async () => {
const decoded = await withService((svc) =>
Effect.gen(function* () {
const fiber = yield* Effect.forkChild(
svc.changes.pipe(Stream.take(1), Stream.runCollect),
);
yield* Effect.sleep("20 millis"); // let the subscription attach
yield* svc.saveRaw({ roots: ["/x"], sync: { pollMinutes: 5 } });
return yield* Fiber.join(fiber);
}),
);
expect(decoded).toEqual([
{ roots: ["/x"], sync: { pollMinutes: 5, watch: true } },
]);
});
});