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,68 @@
|
||||
// Disposable derived state (cache.json): corrupt or absent falls back to `empty` and
|
||||
// never fails a read; every `modify` is write-through with the same atomic-write
|
||||
// discipline as config. Held in a Ref so reads are cheap and mutations are ordered.
|
||||
import * as fs from "node:fs";
|
||||
import { Effect, Ref, Schema } from "effect";
|
||||
import type { ConfigWriteError } from "./errors.js";
|
||||
import { atomicWriteFile, ensureStateDir, statePath } from "./paths.js";
|
||||
import { PluginInfo } from "./host-client.js";
|
||||
|
||||
export interface CacheStore<S extends Schema.Top> {
|
||||
readonly get: Effect.Effect<S["Type"]>;
|
||||
/** Atomically update the cache (Ref + write-through). Returns the `modify` result. */
|
||||
readonly modify: <A>(
|
||||
f: (current: S["Type"]) => readonly [A, S["Type"]],
|
||||
) => Effect.Effect<A, ConfigWriteError>;
|
||||
/** `modify` without a result. */
|
||||
readonly update: (
|
||||
f: (current: S["Type"]) => S["Type"],
|
||||
) => Effect.Effect<void, ConfigWriteError>;
|
||||
/** Absolute path of the cache file (status views). */
|
||||
readonly path: string;
|
||||
}
|
||||
|
||||
export const makeCacheStore = <S extends Schema.Top>(opts: {
|
||||
readonly schema: S;
|
||||
readonly empty: S["Type"];
|
||||
readonly fileName?: string;
|
||||
}): Effect.Effect<CacheStore<S>, never, PluginInfo> =>
|
||||
Effect.gen(function* () {
|
||||
const info = yield* PluginInfo;
|
||||
const file = statePath(info.name, opts.fileName ?? "cache.json");
|
||||
|
||||
const initial = yield* Effect.suspend(() => {
|
||||
try {
|
||||
const parsed = JSON.parse(fs.readFileSync(file, "utf8")) as unknown;
|
||||
return Schema.decodeUnknownEffect(opts.schema)(parsed).pipe(
|
||||
Effect.orElseSucceed(() => opts.empty),
|
||||
) as Effect.Effect<S["Type"]>;
|
||||
} catch {
|
||||
return Effect.succeed(opts.empty);
|
||||
}
|
||||
});
|
||||
const ref = yield* Ref.make<S["Type"]>(initial);
|
||||
|
||||
const persist = (value: S["Type"]) =>
|
||||
ensureStateDir(info.name).pipe(
|
||||
Effect.flatMap(() =>
|
||||
atomicWriteFile(file, JSON.stringify(value)),
|
||||
),
|
||||
);
|
||||
|
||||
const modify = <A>(f: (current: S["Type"]) => readonly [A, S["Type"]]) =>
|
||||
Ref.modify(ref, (current) => {
|
||||
const [a, next] = f(current);
|
||||
return [[a, next] as const, next] as const;
|
||||
}).pipe(
|
||||
Effect.flatMap(([a, next]) =>
|
||||
persist(next).pipe(Effect.as(a)),
|
||||
),
|
||||
);
|
||||
|
||||
return {
|
||||
get: Ref.get(ref),
|
||||
modify,
|
||||
update: (f) => modify((c) => [undefined, f(c)] as const),
|
||||
path: file,
|
||||
} satisfies CacheStore<S>;
|
||||
});
|
||||
Reference in New Issue
Block a user