enricobuehler
10a0ef3283
The kit had NO biome config and no lint script, while every plugin repo that
consumes it has both. So its source quietly drifted — unused imports, unsorted
imports, formatting — with nothing to catch any of it. Running biome here for
the first time reported 20 findings across 8 files.
Adds `plugin-kit/biome.json` mirroring the plugin repos' (tab indent, double
quotes, recommended lint preset, organizeImports), a `check` script, and
`@biomejs/biome` pinned to the same `^2.5.2` the plugins pin — without that pin
`bunx biome` resolved 2.4.6, which rejects the 2.5 `rules.preset` key.
Two deliberate differences from the plugin repos' copy:
* no `vcs.useIgnoreFile` — those are standalone repos with a .gitignore beside
the config; plugin-kit is a directory inside this one, and biome errors with
"couldn't find an ignore file". The `files.includes` exclusions cover it.
* `!examples/**/dist` instead of `!ui/dist` — the kit has examples, not a UI.
`css.parser.tailwindDirectives` is carried over and is load-bearing: without it
biome cannot parse `@theme` in src/theme.css and reports three parse errors on
CSS that is perfectly valid Tailwind v4.
Everything here is formatter/import churn except two real findings, both fixed:
* `Layer` (library/define.ts) and `Cause` (sync-engine.ts) were imported and
never used;
* test/spike-httpapi.test.ts read `(reg?.body as …).ui.secret` one line after
`expect(reg).toBeDefined()`. The optional chain undoes the assertion: had
`reg` been undefined the `.ui` access would throw a TypeError instead of
failing the test readably. Now asserted to the type system too.
Wired into plugin-kit-publish.yml as a `Lint & format` step ahead of Typecheck,
so this cannot rot again.
Gates after: biome clean (42 files), tsc clean, 67/67 tests, build clean.
65 lines
2.1 KiB
TypeScript
65 lines
2.1 KiB
TypeScript
// SSE support. `effect/unstable/httpapi` has no event-stream media type (verified at
|
|
// beta.99), so the status feed is a raw HttpRouter route beside the HttpApi contract —
|
|
// same wire shape the first-generation plugins used (`event: <name>` frames + comment
|
|
// pings), which is already proven through the console's reverse proxy.
|
|
import { Effect, type Layer, Schedule, Stream } from "effect";
|
|
import { HttpRouter, HttpServerResponse } from "effect/unstable/http";
|
|
|
|
const encoder = new TextEncoder();
|
|
|
|
export interface SseRouteOptions<A> {
|
|
/** SSE `event:` name (default "message"). */
|
|
readonly event?: string;
|
|
/** Serialize one item (default JSON.stringify). */
|
|
readonly encode?: (a: A) => string;
|
|
/**
|
|
* Keepalive comment cadence in seconds (0 disables). Default 5 — deliberately below
|
|
* Bun's 10 s default `idleTimeout`, which `servePluginUi`'s server does not raise:
|
|
* a slower ping never arrives, because the idle connection is closed first.
|
|
*/
|
|
readonly pingSeconds?: number;
|
|
}
|
|
|
|
/**
|
|
* Register `GET <path>` streaming `stream` as server-sent events. Each subscriber gets
|
|
* an independent subscription; disconnects tear the stream down via scope closure.
|
|
*/
|
|
export const sseRoute = <A>(
|
|
path: `/${string}`,
|
|
stream: Stream.Stream<A>,
|
|
opts?: SseRouteOptions<A>,
|
|
): Layer.Layer<never, never, HttpRouter.HttpRouter> => {
|
|
const event = opts?.event ?? "message";
|
|
const encode = opts?.encode ?? ((a: A) => JSON.stringify(a));
|
|
const pingSeconds = opts?.pingSeconds ?? 5;
|
|
|
|
const frames = stream.pipe(
|
|
Stream.map((a) => `event: ${event}\ndata: ${encode(a)}\n\n`),
|
|
);
|
|
const pings =
|
|
pingSeconds > 0
|
|
? Stream.fromSchedule(Schedule.spaced(`${pingSeconds} seconds`)).pipe(
|
|
Stream.map(() => `: ping\n\n`),
|
|
)
|
|
: Stream.empty;
|
|
|
|
const body = Stream.merge(frames, pings).pipe(
|
|
Stream.map((s) => encoder.encode(s)),
|
|
);
|
|
|
|
return HttpRouter.add(
|
|
"GET",
|
|
path,
|
|
Effect.succeed(
|
|
HttpServerResponse.stream(body, {
|
|
contentType: "text/event-stream",
|
|
headers: {
|
|
"cache-control": "no-cache",
|
|
connection: "keep-alive",
|
|
"x-accel-buffering": "no",
|
|
},
|
|
}),
|
|
),
|
|
);
|
|
};
|