@checkstack/backend 0.8.2 → 0.9.1

package/CHANGELOG.md

@@ -1,5 +1,338 @@
 # @checkstack/backend
 
+## 0.9.1
+
+### Patch Changes
+
+- aa89bc5: Replace the bespoke `registerInfrastructureTab()` registry with a standard
+  slot-extension contract (`InfrastructureTabsSlot` from
+  `@checkstack/infrastructure-common`). Plugins now contribute infrastructure
+  tabs via `createSlotExtension`, depending only on the slot owner.
+
+  The slot system in `@checkstack/frontend-api` gains a second type parameter
+  on `createSlot<TContext, TMetadata>` so extensions can declare typed static
+  metadata at registration time (label, icon, access rules, ordering for the
+  infrastructure tab bar). A new `useSlotExtensions(slot)` hook returns typed
+  extensions and subscribes to plugin lifecycle changes.
+
+  Each tab body now stacks a **Runtime** sub-section (live state, read-only)
+  on top of a **Configuration** sub-section (settings, gated by `canUpdate`).
+
+  **Queue runtime panel.** Surfaces aggregated counts (pending / processing /
+  completed / failed) plus three sub-tabs of recent jobs: **Active**, **Recent
+  failed** (with the failure message), and **Recent completed** (with
+  duration). Job payloads are deliberately not surfaced — they may carry
+  secrets and need a separate manage-access gate to be shown.
+
+  To support this, `Queue<T>` gains a required `listJobs(opts)` method
+  returning `JobSummary[]` (no payloads), and `QueueStats` gains a
+  `scope: "instance" | "cluster"` field. The in-memory queue keeps rolling
+  ring buffers (200 entries) for completed/failed history and tracks active
+  jobs by id; BullMQ uses native `getJobs`. `QueueManager.listJobs` aggregates
+  across queues and sorts (most-recent-first for terminal states, FIFO for
+  active/waiting/delayed).
+
+  **Cache runtime panel.** Lists the top N entries by size (or by recency) so
+  operators can debug a cache filling up. Values are deliberately omitted —
+  PII / secret risk. Backends opt in via an optional `listEntries?` method on
+  `CacheProvider`; non-supporting backends return `{ supported: false }` and
+  the UI renders a "not supported by this backend" hint. The in-memory cache
+  implements it using its existing per-entry byte tracking.
+
+  `CacheStats` also gains `scope: "instance" | "cluster"`.
+
+  **Multi-instance scope warning.** A new `<InstanceScopeBanner>` component in
+  `@checkstack/ui` renders a yellow banner above any runtime panel whose
+  backend reports `scope: "instance"` — i.e. in-memory queue or cache running
+  in a horizontally scaled deployment. The banner explains the metrics are
+  local to the responding replica and recommends switching to a clustered
+  backend (Redis-backed queue / cache) for cluster-wide visibility.
+
+  **Bug fix — stable cache provider proxy.** `CacheManagerImpl.getProvider()`
+  now returns a single stable proxy that delegates to whatever provider is
+  currently active. Previously, consumers of `createCachedScope` (and any
+  direct `cacheManager.getProvider()` caller) captured the active provider
+  reference at plugin-init time. After any `setActiveBackend` call — including
+  saving the same memory config in the new Cache tab, which reconstructs the
+  in-memory cache — those scopes wrote to an orphaned old provider while the
+  runtime panel read stats from the new (empty) one, making the runtime panel
+  appear to report 0 keys. With the proxy, all consumers share a single stable
+  identity and writes always land in the active provider.
+
+  **Bytes tracking on the in-memory cache.** `InMemoryCache.getStats().sizeBytes`
+  now returns a running approximation (UTF-8 bytes of the key plus
+  `v8.serialize(value).byteLength`, with a JSON fallback) that's kept in sync
+  across all eviction paths. Treat the number as a sanity gauge; it doesn't
+  include `Map` per-entry overhead.
+
+  **Pagination.** Both `Queue<T>.listJobs` and `CacheProvider.listEntries?`
+  are offset-paginated. Inputs gain an `offset: number`; outputs change to
+  `{ items, total: number | null, hasMore: boolean }`. `total` is nullable
+  so backends that can't compute it cheaply still paginate via `hasMore`.
+  The UI uses the existing `<Pagination>` component with a 25-row default
+  page size. `QueueManager.listJobs` aggregates by over-fetching
+  `[0, offset+limit)` per queue, merge-sorting, then slicing the window —
+  optimal for the single-queue case, acceptable for the multi-queue case
+  within the UI's reasonable page-depth bounds. BullMQ uses native offset
+  ranges via `getJobs(types, start, end)` plus `getJobCounts` for `total`.
+
+  **Pending tab.** The Queue runtime panel exposes a virtual `"pending"`
+  state (waiting ∪ delayed, FIFO). It's now the default sub-tab, since
+  "what's queued up?" is the most common question. Per-row state is shown
+  when viewing the combined list.
+
+  **Recurring schedules visible under Pending.** Cron- and interval-based
+  recurring jobs (e.g. healthchecks) are surfaced under Pending/Delayed
+  between fires, with a `nextRunAt` countdown column and a "(recurring)"
+  label. `JobSummary` gains optional `nextRunAt: Date` and `recurring:
+boolean` fields. The in-memory queue synthesises these rows from its
+  `recurringJobs` registry; BullMQ already materialises the next fire of
+  each scheduler as a delayed job and we now surface its trigger time and
+  the `repeatJobKey`-derived `recurring` flag.
+
+  **Bug fix — drop hook emits with no listeners.** `EventBus.emit` no
+  longer enqueues a job when zero listeners (distributed or instance-local)
+  are registered for the hook. Previously, hooks like
+  `core.plugin.initialized` — emitted on every plugin init but subscribed
+  to by nothing in the core repo — accumulated one waiting job per emit
+  forever. The in-memory queue's `processNext` short-circuits when there
+  are zero consumer groups, so its post-loop cleanup never ran for these
+  orphaned jobs. The fix drops the emit at the source and logs a debug
+  line. Note: in distributed deployments using a Redis-backed queue, this
+  means a subscriber on another replica won't receive an event if no
+  replica that emits it has a local listener. Plugins needing cross-process
+  delivery must register their listener on every replica that should
+  receive the hook.
+
+  **Breaking notes (treated as minor under beta semantics)**:
+
+  - `@checkstack/infrastructure-common` removes `registerInfrastructureTab`
+    and `getInfrastructureTabs`; former callers must register an extension
+    into `InfrastructureTabsSlot`.
+  - `@checkstack/queue-api`'s `Queue<T>` interface requires the new
+    `listJobs(opts)` method returning `ListJobsResult` (paginated). Both
+    bundled queue backends (memory, BullMQ) are updated; out-of-tree
+    implementations will need to add it.
+  - `QueueStats` and `CacheStats` add a required `scope` field.
+  - `CacheProvider.listEntries?` (when implemented) now returns
+    `ListEntriesResult` instead of `CacheEntrySummary[]`.
+  - `JobState` adds a `"pending"` variant.
+
+- Updated dependencies [42abfff]
+- Updated dependencies [aa89bc5]
+  - @checkstack/common@0.9.0
+  - @checkstack/queue-api@0.3.0
+  - @checkstack/cache-api@0.3.0
+  - @checkstack/api-docs-common@0.1.12
+  - @checkstack/auth-common@0.6.6
+  - @checkstack/backend-api@0.15.1
+  - @checkstack/pluginmanager-common@0.2.1
+  - @checkstack/signal-backend@0.2.4
+  - @checkstack/signal-common@0.2.2
+
+## 0.9.0
+
+### Minor Changes
+
+- 50e5f5f: Add `bunx @checkstack/scripts dev` — a local Checkstack dev server for
+  plugin authors that runs from the plugin's own repo without a monorepo
+  checkout.
+
+  Mechanics:
+
+  - The dev command spawns `core/backend`'s production entry as a child
+    process with three env vars wired in:
+    - `CHECKSTACK_DEV_PLUGIN_PATH=<cwd>` — backend skips filesystem
+      discovery and imports the plugin at this path as a manual plugin.
+    - `CHECKSTACK_DEV_EXTRA_PLUGIN_PATHS=<JSON array>` — additional
+      backend plugins co-loaded as manual plugins. The dev command walks
+      the plugin under dev's `package.json#dependencies` recursively to
+      discover every `@checkstack/*-backend` package and pass their
+      module paths through. Auto-includes
+      `@checkstack/queue-memory-backend` +
+      `@checkstack/cache-memory-backend` when no other queue/cache
+      provider is in the dep graph, so `coreServices.queueManager` /
+      `coreServices.cacheManager` always have a registered strategy on
+      boot. Without this co-loading, plugins that depend on
+      `healthcheck-backend`, `notification-backend`, etc. would hit
+      unregistered services and the boot would deadlock.
+    - `CHECKSTACK_DEV_AUTH=true` — backend registers a synthetic
+      `AuthService` that auto-grants every registered access rule.
+      Refused when `NODE_ENV=production` so accidental misuse is loud.
+  - A file watcher under the plugin's `./src` triggers a full backend
+    restart (debounced) on save. Bun's startup is sub-second for a single
+    plugin, so the loop stays tight.
+  - For frontend plugins (or bundle primaries with a `-frontend`
+    sibling), the dev command additionally spawns a Vite dev server on
+    port 5173 (configurable via `--frontend-port`). Vite serves
+    `core/frontend`'s new `dev-main.tsx` shell — the same App.tsx,
+    loadPlugins(), ThemeProvider, etc. that ship in production. The
+    plugin module is mounted via a `virtual:checkstack-dev-plugin` alias
+    Vite resolves at config time. React Fast Refresh works for component
+    edits.
+  - On boot, the dev command validates the plugin's `package.json`
+    against the same `installPackageMetadataSchema` the runtime install
+    pipeline uses, so missing required fields fail fast.
+
+  Reuses 100% of the production boot code path — no parallel dev backend
+  to drift from. New code surfaces:
+
+  - `core/backend/src/services/dev-auth.ts` — the synthetic auth service.
+    Inert unless `CHECKSTACK_DEV_AUTH=true`.
+  - `core/scripts/src/commands/dev-server.ts` — the CLI command.
+  - `core/scripts/src/commands/dev-deps-resolver.ts` — pure function that
+    walks the plugin's deps and resolves the co-load set; covered by 8
+    unit tests.
+  - `core/scripts/src/commands/dev-frontend.ts` — Vite spawn helper.
+  - `core/frontend/src/dev-main.tsx` — frontend dev-shell entry.
+
+  `@checkstack/scripts` now depends on `@checkstack/backend`,
+  `@checkstack/frontend`, `@checkstack/frontend-api`, `@checkstack/ui`,
+  `vite`, and `@vitejs/plugin-react` so a `bunx` invocation pulls in
+  everything needed for the dev server in one shot.
+
+  Replaces the previous "three patterns" plugin-development guide with a
+  single `bun run dev` workflow.
+
+  A new ESLint rule branch in `no-extraneous-runtime-deps` ignores
+  `virtual:` module specifiers (resolved by bundler aliases at runtime,
+  not installed from npm).
+
+  Scaffold templates updated for one-click compatibility — `bun run create`
+  now produces plugin packages that pass the dev-server's
+  `installPackageMetadataSchema` gate and ship `dev` / `pack` scripts plus
+  `@checkstack/scripts` in devDependencies, so a freshly scaffolded plugin
+  runs `bun run dev` without any further file edits. Required metadata
+  (`description`, `author`, `license: "Elastic-2.0"`, `checkstack.pluginId`)
+  is filled in by the scaffold; `@checkstack/scripts plugin-pack
+--validate-only` accepts the rendered package.json directly. Templates
+  also reformatted from one-line JSON-in-handlebars to readable
+  multi-line.
+
+  New scaffold tests in `core/scripts/src/templates.test.ts` render each
+  template type and assert: dev-server validation passes, `dev` script
+  present (backend/frontend), `pack` script present, `@checkstack/scripts`
+  in devDependencies.
+
+  In addition, the new `dev-internals.ts`, `dev-lifecycle.ts`,
+  `dev-deps-resolver.ts`, and refactored `dev-frontend.ts` ship 58
+  unit tests covering arg parsing, package.json validation, backend
+  entry resolution, frontend-spawn decision, child env construction,
+  the debounce watcher, the spawn → restart → shutdown lifecycle (with
+  hard-kill SIGKILL fallback), the dev-auth service, and the bundle
+  sibling resolver — all driven through injectable seams so no real
+  process / Postgres / Vite is needed at test time.
+
+- 50e5f5f: Runtime plugin system: install + uninstall plugins from npm, GitHub releases
+  (including private GitHub Enterprise instances), or tarball uploads at
+  runtime, with multi-package bundles, dependency-derived compatibility checks,
+  multi-instance coordination via a Postgres artifact store, and
+  single-coordinator destructive cleanup.
+
+  Highlights:
+
+  - New `PluginSource` discriminated union and `PluginInstaller` /
+    `PluginInstallerRegistry` interfaces in `@checkstack/backend-api`. The
+    GitHub variant accepts an optional `apiBaseUrl` so deployments backed by
+    GitHub Enterprise can install from `https://ghe.example.com/api/v3`
+    instead of `api.github.com`.
+  - New `installPackageMetadataSchema` (Zod) in `@checkstack/common` validates
+    every plugin's `package.json` at install time. Required fields: `name`,
+    `version`, `description`, `author`, `license`, `checkstack.type`,
+    `checkstack.pluginId`. Optional: `checkstack.bundle`,
+    `checkstack.usageInstructions`, `checkstack.allowInstallScripts`.
+  - New `pluginManagerContract` in `@checkstack/pluginmanager-common` with
+    `list`, `previewInstall`, `install`, `previewUninstall`, `uninstall`, and
+    `events` procedures.
+  - New `@checkstack/pluginmanager-frontend` admin UI: installed-plugins list
+    with per-row uninstall (typed-confirmation modal, schema/configs/cascade
+    toggles), install page with NPM / Tarball Upload / GitHub Release tabs
+    (Catalog tab disabled — coming soon), and an events page surfacing the
+    install/uninstall audit log.
+  - New `bunx @checkstack/scripts plugin-pack` CLI for plugin authors —
+    per-package mode produces an npm-shaped tarball; `--bundle` mode produces
+    an outer tarball containing every sibling declared in
+    `package.json#checkstack.bundle`. Published to npm so external authors
+    can `bunx` it directly without a workspace checkout.
+  - Compatibility derived from `package.json#dependencies` ranges
+    (`semver.satisfies` against the platform's loaded `@checkstack/*`
+    versions) — no separate `compatibility` field.
+  - Multi-instance: originator persists artifacts + `plugins` rows + broadcasts
+    install/uninstall; receiving instances do in-process register/unregister
+    only. Destructive ops (drop schema, delete plugin_configs, delete
+    artifacts, delete `plugins` rows) run exactly once on the originator.
+  - Fresh-instance bootstrap: `loadPlugins()` hydrates any
+    `is_uninstallable=true` plugin missing from `node_modules` from the
+    artifact store before normal Phase 1 register.
+  - New schema: `plugin_artifacts` (tarball storage), `plugin_install_events`
+    (audit/error log). `plugins` extended with `version`, `metadata`,
+    `source`, `bundle_id`, `is_primary`. Local plugin sync now writes
+    `version` from each plugin's `package.json` so the admin UI shows real
+    versions instead of `—`.
+  - Tarball-upload endpoint (`POST /api/pluginmanager/upload-tarball`) for
+    the install UI; access-gated by `pluginmanager.plugin.manage`.
+  - Plugin Manager menu link added to the user menu (main grid, alongside
+    Profile / Notification Settings / etc.).
+
+  Cross-cutting changes:
+
+  - Backend request/response logging now flows through `rootLogger` (winston)
+    instead of `hono/logger`. 5xx responses include the response body inline
+    so swallowed early-return errors are visible in the log.
+  - The `/api/:pluginId/*` dispatcher now logs which core service is missing
+    or which `pluginId` had no metadata when it 500s.
+  - New `registerCorePluginMetadata` on `PluginManager` for core routers
+    (like the plugin manager itself) that need their metadata visible to the
+    RPC dispatcher without going through the full plugin lifecycle.
+  - ESLint: `unicorn/no-null` is now disabled globally. Drizzle distinguishes
+    between `null` (writes a real SQL NULL) and `undefined` (skip the column
+    on insert), so treating them as interchangeable produced latent bugs at
+    the persistence boundary. The bulk of the patch-bumped packages above
+    reflect lint-fix touches that landed when this rule was relaxed.
+  - Workspace-wide license normalization to `Elastic-2.0` (matches
+    `LICENSE.md`). Every `package.json` in the workspace now declares the
+    same SPDX identifier; the patch bumps capture this.
+
+  Plugin packages (every `plugins/*`): added a `pack` npm script
+  (`bunx @checkstack/scripts plugin-pack`), mirrored each plugin's
+  `pluginId` from `plugin-metadata.ts` into `package.json#checkstack.pluginId`
+  so install-time validation passes, stubbed any missing required metadata
+  fields (`description`, `author`, `license`), and added
+  `checkstack.bundle` to multi-package plugin primaries (telegram, rcon, ssh,
+  jira, queue-bullmq, queue-memory, cache-memory).
+
+  Breaking changes:
+
+  - The legacy single-method `PluginInstaller` interface (`install(packageName)`)
+    is removed. Callers must use `coreServices.pluginInstallerRegistry`.
+  - The old `pluginAdminContract` and `createPluginAdminRouter` are removed.
+    Replaced by `pluginManagerContract` in `@checkstack/pluginmanager-common`
+    and `createPluginManagerRouter` in `core/backend`.
+  - `@checkstack/test-utils-backend` no longer exports
+    `createMockPluginInstaller` / `MockPluginInstaller` (the legacy interface
+    it shimmed is gone).
+
+  Note: bumps are limited to `minor` (for packages with new public API
+  surface) and `patch` (for downstream consumers, license normalization,
+  and lint fixes). No `major` bumps despite the `PluginInstaller` removal —
+  the legacy interface had no third-party consumers in the wild before this
+  runtime plugin system landed, and the contract surface is the same shape
+  modulo the rename.
+
+### Patch Changes
+
+- Updated dependencies [50e5f5f]
+  - @checkstack/auth-common@0.6.5
+  - @checkstack/backend-api@0.15.0
+  - @checkstack/common@0.8.0
+  - @checkstack/drizzle-helper@0.0.5
+  - @checkstack/pluginmanager-common@0.2.0
+  - @checkstack/queue-api@0.2.18
+  - @checkstack/signal-backend@0.2.3
+  - @checkstack/api-docs-common@0.1.11
+  - @checkstack/cache-api@0.2.4
+  - @checkstack/signal-common@0.2.1
+
 ## 0.8.2
 
 ### Patch Changes

package/drizzle/0001_slim_mordo.sql

@@ -0,0 +1,34 @@
+CREATE TABLE "plugin_artifacts" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	"plugin_name" text NOT NULL,
+	"version" text NOT NULL,
+	"bundle_id" uuid,
+	"tarball" text NOT NULL,
+	"content_hash" text NOT NULL,
+	"size_bytes" integer NOT NULL,
+	"created_at" timestamp DEFAULT now() NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE "plugin_install_events" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	"plugin_name" text,
+	"bundle_id" uuid,
+	"action" text NOT NULL,
+	"phase" text NOT NULL,
+	"status" text NOT NULL,
+	"source" jsonb,
+	"error" text,
+	"instance_id" text NOT NULL,
+	"user_id" text,
+	"created_at" timestamp DEFAULT now() NOT NULL
+);
+--> statement-breakpoint
+ALTER TABLE "plugins" ADD COLUMN "version" text DEFAULT '' NOT NULL;--> statement-breakpoint
+ALTER TABLE "plugins" ADD COLUMN "metadata" jsonb DEFAULT '{}'::jsonb NOT NULL;--> statement-breakpoint
+ALTER TABLE "plugins" ADD COLUMN "source" jsonb;--> statement-breakpoint
+ALTER TABLE "plugins" ADD COLUMN "bundle_id" uuid;--> statement-breakpoint
+ALTER TABLE "plugins" ADD COLUMN "is_primary" boolean DEFAULT false NOT NULL;--> statement-breakpoint
+CREATE UNIQUE INDEX "plugin_artifacts_name_version_idx" ON "plugin_artifacts" USING btree ("plugin_name","version");--> statement-breakpoint
+CREATE INDEX "plugin_artifacts_content_hash_idx" ON "plugin_artifacts" USING btree ("content_hash");--> statement-breakpoint
+CREATE INDEX "plugin_install_events_name_created_idx" ON "plugin_install_events" USING btree ("plugin_name","created_at");--> statement-breakpoint
+CREATE INDEX "plugin_install_events_status_created_idx" ON "plugin_install_events" USING btree ("status","created_at");