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
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:
@@ -0,0 +1,128 @@
|
||||
// SyncEngine semantics: fingerprint skip, single-flight coalescing, status feed.
|
||||
import { describe, expect, test } from "bun:test";
|
||||
import { Duration, Effect, Fiber, Ref, Scope, Stream } from "effect";
|
||||
import {
|
||||
type LastSync,
|
||||
makeSyncEngine,
|
||||
type SyncOutcome,
|
||||
} from "../src/index.js";
|
||||
|
||||
interface Report {
|
||||
readonly included: number;
|
||||
}
|
||||
|
||||
const harness = (opts?: {
|
||||
computeDelayMs?: number;
|
||||
entries?: () => ReadonlyArray<string>;
|
||||
}) =>
|
||||
Effect.gen(function* () {
|
||||
const applied = yield* Ref.make(0);
|
||||
const last = yield* Ref.make<LastSync | undefined>(undefined);
|
||||
const entries = opts?.entries ?? (() => ["a", "b"]);
|
||||
const engine = yield* makeSyncEngine<Report, ReadonlyArray<string>, never>(
|
||||
{
|
||||
compute: () =>
|
||||
Effect.suspend(() => {
|
||||
const e = entries();
|
||||
return Effect.succeed({
|
||||
entries: e,
|
||||
report: { included: e.length },
|
||||
});
|
||||
}).pipe(
|
||||
opts?.computeDelayMs
|
||||
? Effect.delay(Duration.millis(opts.computeDelayMs))
|
||||
: (x) => x,
|
||||
),
|
||||
apply: () => Ref.update(applied, (n) => n + 1),
|
||||
lastSync: {
|
||||
get: Ref.get(last),
|
||||
set: (l) => Ref.set(last, l),
|
||||
},
|
||||
settings: Effect.succeed({
|
||||
pollInterval: Duration.minutes(60),
|
||||
watch: false,
|
||||
debounce: Duration.millis(10),
|
||||
watchDirs: [],
|
||||
}),
|
||||
},
|
||||
);
|
||||
return { engine, applied, last };
|
||||
});
|
||||
|
||||
const run = <A>(eff: Effect.Effect<A, unknown, Scope.Scope>): Promise<A> =>
|
||||
Effect.runPromise(Effect.scoped(eff) as Effect.Effect<A>);
|
||||
|
||||
describe("SyncEngine", () => {
|
||||
test("first sync applies; unchanged content skips the apply", async () => {
|
||||
const { first, second, count } = await run(
|
||||
Effect.gen(function* () {
|
||||
const h = yield* harness();
|
||||
const first = yield* h.engine.sync("manual");
|
||||
const second = yield* h.engine.sync("manual");
|
||||
return {
|
||||
first,
|
||||
second,
|
||||
count: yield* Ref.get(h.applied),
|
||||
};
|
||||
}),
|
||||
);
|
||||
expect(first._tag).toBe("Applied");
|
||||
if (first._tag === "Applied") expect(first.count).toBe(2);
|
||||
expect(second._tag).toBe("Unchanged");
|
||||
expect(count).toBe(1);
|
||||
});
|
||||
|
||||
test("changed content re-applies", async () => {
|
||||
let call = 0;
|
||||
const { outcomes, count } = await run(
|
||||
Effect.gen(function* () {
|
||||
const h = yield* harness({
|
||||
entries: () => (call++ === 0 ? ["a"] : ["a", "b"]),
|
||||
});
|
||||
const o1 = yield* h.engine.sync("manual");
|
||||
const o2 = yield* h.engine.sync("manual");
|
||||
return { outcomes: [o1, o2], count: yield* Ref.get(h.applied) };
|
||||
}),
|
||||
);
|
||||
expect(outcomes.map((o: SyncOutcome<Report>) => o._tag)).toEqual([
|
||||
"Applied",
|
||||
"Applied",
|
||||
]);
|
||||
expect(count).toBe(2);
|
||||
});
|
||||
|
||||
test("concurrent trigger returns AlreadyRunning and coalesces into a follow-up", async () => {
|
||||
const { during, count } = await run(
|
||||
Effect.gen(function* () {
|
||||
const h = yield* harness({ computeDelayMs: 50 });
|
||||
const fiber = yield* Effect.forkChild(h.engine.sync("manual"));
|
||||
yield* Effect.sleep("10 millis");
|
||||
const during = yield* h.engine.sync("manual");
|
||||
yield* Fiber.join(fiber);
|
||||
// the coalesced re-run is forked detached — give it a beat
|
||||
yield* Effect.sleep("120 millis");
|
||||
return { during, count: yield* Ref.get(h.applied) };
|
||||
}),
|
||||
);
|
||||
expect(during._tag).toBe("AlreadyRunning");
|
||||
// first sync applied; the coalesced pass found identical content → skipped
|
||||
expect(count).toBe(1);
|
||||
});
|
||||
|
||||
test("status feed publishes syncing transitions", async () => {
|
||||
const statuses = await run(
|
||||
Effect.gen(function* () {
|
||||
const h = yield* harness();
|
||||
const fiber = yield* Effect.forkChild(
|
||||
h.engine.changes.pipe(Stream.take(2), Stream.runCollect),
|
||||
);
|
||||
yield* Effect.sleep("20 millis");
|
||||
yield* h.engine.sync("manual");
|
||||
return yield* Fiber.join(fiber);
|
||||
}),
|
||||
);
|
||||
expect(statuses[0]?.syncing).toBe(true);
|
||||
expect(statuses[1]?.syncing).toBe(false);
|
||||
expect(statuses[1]?.lastSync?.count).toBe(2);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user