@checkstack/queue-memory-backend 0.3.18 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,132 @@
 # @checkstack/queue-memory-backend
 
+## 0.4.0
+
+### Minor 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.
+
+### Patch Changes
+
+- Updated dependencies [42abfff]
+- Updated dependencies [aa89bc5]
+  - @checkstack/common@0.9.0
+  - @checkstack/queue-api@0.3.0
+  - @checkstack/backend-api@0.15.1
+  - @checkstack/queue-memory-common@0.1.12
+
 ## 0.3.18
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/queue-memory-backend",
-  "version": "0.3.18",
+  "version": "0.4.0",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -27,7 +27,7 @@
   "devDependencies": {
     "@types/bun": "latest",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/scripts": "0.2.0"
+    "@checkstack/scripts": "0.3.0"
   },
   "description": "Checkstack queue-memory-backend plugin",
   "author": {

package/src/memory-queue.test.ts

@@ -505,4 +505,192 @@ describe("InMemoryQueue Consumer Groups", () => {
   });
 
   // NOTE: Recurring job tests are in recurring-jobs.test.ts
+
+  describe("listJobs + getStats scope", () => {
+    it("getStats reports scope=instance", async () => {
+      const stats = await queue.getStats();
+      expect(stats.scope).toBe("instance");
+    });
+
+    it("lists waiting jobs in FIFO order", async () => {
+      await queue.enqueue("a", { jobId: "j-a" });
+      await queue.enqueue("b", { jobId: "j-b" });
+      await queue.enqueue("c", { jobId: "j-c" });
+
+      const waiting = await queue.listJobs({
+        state: "waiting",
+        offset: 0,
+        limit: 10,
+      });
+      expect(waiting.items.map((j) => j.id)).toEqual(["j-a", "j-b", "j-c"]);
+      expect(waiting.items.every((j) => j.state === "waiting")).toBe(true);
+      expect(waiting.total).toBe(3);
+      expect(waiting.hasMore).toBe(false);
+    });
+
+    it("classifies delayed jobs separately from waiting", async () => {
+      // delayMultiplier=0.01 means startDelay=10s becomes 100ms; list before it elapses.
+      await queue.enqueue("now");
+      await queue.enqueue("later", { startDelay: 10 });
+
+      const waiting = await queue.listJobs({
+        state: "waiting",
+        offset: 0,
+        limit: 10,
+      });
+      const delayed = await queue.listJobs({
+        state: "delayed",
+        offset: 0,
+        limit: 10,
+      });
+      expect(waiting.items).toHaveLength(1);
+      expect(delayed.items).toHaveLength(1);
+    });
+
+    it("surfaces recurring (cron) schedules under pending with nextRunAt", async () => {
+      // Use cron pattern: every minute
+      await queue.scheduleRecurring("payload", {
+        jobId: "cron-job",
+        cronPattern: "*/1 * * * *",
+      });
+
+      const pending = await queue.listJobs({
+        state: "pending",
+        offset: 0,
+        limit: 10,
+      });
+      const cronRow = pending.items.find((j) => j.id === "cron-job");
+      expect(cronRow).toBeDefined();
+      expect(cronRow!.recurring).toBe(true);
+      expect(cronRow!.state).toBe("delayed");
+      expect(cronRow!.nextRunAt).toBeInstanceOf(Date);
+      expect(cronRow!.nextRunAt!.getTime()).toBeGreaterThan(Date.now());
+    });
+
+    it("surfaces recurring (interval) schedules under delayed with nextRunAt", async () => {
+      await queue.scheduleRecurring("payload", {
+        jobId: "interval-job",
+        intervalSeconds: 60,
+      });
+
+      const delayed = await queue.listJobs({
+        state: "delayed",
+        offset: 0,
+        limit: 10,
+      });
+      const row = delayed.items.find((j) => j.id === "interval-job");
+      expect(row).toBeDefined();
+      expect(row!.recurring).toBe(true);
+      expect(row!.nextRunAt).toBeInstanceOf(Date);
+    });
+
+    it("'pending' is the union of waiting and delayed, FIFO", async () => {
+      await queue.enqueue("now1", { jobId: "p-now-1" });
+      await queue.enqueue("later", { jobId: "p-later", startDelay: 10 });
+      await queue.enqueue("now2", { jobId: "p-now-2" });
+
+      const pending = await queue.listJobs({
+        state: "pending",
+        offset: 0,
+        limit: 10,
+      });
+      expect(pending.items.map((j) => j.id)).toEqual([
+        "p-now-1",
+        "p-later",
+        "p-now-2",
+      ]);
+      expect(pending.total).toBe(3);
+      // Per-job state classification preserved.
+      const states = Object.fromEntries(
+        pending.items.map((j) => [j.id, j.state]),
+      );
+      expect(states["p-now-1"]).toBe("waiting");
+      expect(states["p-later"]).toBe("delayed");
+      expect(states["p-now-2"]).toBe("waiting");
+    });
+
+    it("records completed jobs in history (most-recent first)", async () => {
+      await queue.consume(async () => {}, {
+        consumerGroup: "g1",
+        maxRetries: 0,
+      });
+
+      await queue.enqueue("x", { jobId: "ok-1" });
+      await queue.enqueue("y", { jobId: "ok-2" });
+      await new Promise((resolve) => setTimeout(resolve, 60));
+
+      const completed = await queue.listJobs({
+        state: "completed",
+        offset: 0,
+        limit: 10,
+      });
+      expect(completed.items.length).toBe(2);
+      expect(completed.total).toBe(2);
+      // Newest first
+      expect(
+        completed.items[0].finishedAt!.getTime(),
+      ).toBeGreaterThanOrEqual(completed.items[1].finishedAt!.getTime());
+      expect(completed.items[0].state).toBe("completed");
+    });
+
+    it("records failed jobs with the error message", async () => {
+      await queue.consume(
+        async () => {
+          throw new Error("boom");
+        },
+        { consumerGroup: "g1", maxRetries: 0 },
+      );
+
+      await queue.enqueue("z", { jobId: "bad-1" });
+      await new Promise((resolve) => setTimeout(resolve, 60));
+
+      const failed = await queue.listJobs({
+        state: "failed",
+        offset: 0,
+        limit: 10,
+      });
+      expect(failed.items.length).toBe(1);
+      expect(failed.items[0].state).toBe("failed");
+      expect(failed.items[0].failedReason).toBe("boom");
+    });
+
+    it("paginates with offset/limit", async () => {
+      await queue.consume(async () => {}, {
+        consumerGroup: "g1",
+        maxRetries: 0,
+      });
+      for (let i = 0; i < 10; i++) {
+        await queue.enqueue("v", { jobId: `id-${i}` });
+      }
+      await new Promise((resolve) => setTimeout(resolve, 80));
+
+      const page1 = await queue.listJobs({
+        state: "completed",
+        offset: 0,
+        limit: 3,
+      });
+      expect(page1.items).toHaveLength(3);
+      expect(page1.total).toBe(10);
+      expect(page1.hasMore).toBe(true);
+
+      const page2 = await queue.listJobs({
+        state: "completed",
+        offset: 3,
+        limit: 3,
+      });
+      expect(page2.items).toHaveLength(3);
+      // Different page should yield different ids
+      expect(page2.items.map((j) => j.id)).not.toEqual(
+        page1.items.map((j) => j.id),
+      );
+
+      const lastPage = await queue.listJobs({
+        state: "completed",
+        offset: 9,
+        limit: 3,
+      });
+      expect(lastPage.items).toHaveLength(1);
+      expect(lastPage.hasMore).toBe(false);
+    });
+  });
 });

package/src/memory-queue.ts

@@ -6,8 +6,13 @@ import {
   ConsumeOptions,
   RecurringJobDetails,
   RecurringSchedule,
+  JobSummary,
+  ListJobsOptions,
+  ListJobsResult,
+  JobState,
 } from "@checkstack/queue-api";
 import type { Logger } from "@checkstack/backend-api";
+import { extractErrorMessage } from "@checkstack/common";
 import { InMemoryQueueConfig } from "./plugin";
 import parser from "cron-parser";
 
@@ -79,6 +84,26 @@ type RecurringJobMetadata<T> = {
   timerId?: ReturnType<typeof setTimeout> | ReturnType<typeof setInterval>;
 } & RecurringSchedule;
 
+/** Maximum history entries kept per terminal state (completed/failed). */
+const HISTORY_CAP = 200;
+
+interface ActiveJobInfo {
+  id: string;
+  enqueuedAt: Date;
+  startedAt: Date;
+  attempts: number;
+}
+
+interface TerminalJobInfo {
+  id: string;
+  state: "completed" | "failed";
+  enqueuedAt: Date;
+  startedAt: Date;
+  finishedAt: Date;
+  attempts: number;
+  failedReason?: string;
+}
+
 /**
  * In-memory queue implementation with consumer group support
  */
@@ -94,6 +119,13 @@ export class InMemoryQueue<T> implements Queue<T> {
     failed: 0,
   };
 
+  /** Currently-processing jobs, keyed by job id. */
+  private activeJobs = new Map<string, ActiveJobInfo>();
+  /** Most-recent-first ring buffer of completed jobs (capped at {@link HISTORY_CAP}). */
+  private completedHistory: TerminalJobInfo[] = [];
+  /** Most-recent-first ring buffer of failed jobs (capped at {@link HISTORY_CAP}). */
+  private failedHistory: TerminalJobInfo[] = [];
+
   private logger: Logger;
   private heartbeatInterval: ReturnType<typeof setInterval> | undefined;
 
@@ -440,6 +472,13 @@ export class InMemoryQueue<T> implements Queue<T> {
     });
   }
 
+  private pushHistory(buf: TerminalJobInfo[], info: TerminalJobInfo): void {
+    buf.unshift(info);
+    if (buf.length > HISTORY_CAP) {
+      buf.length = HISTORY_CAP;
+    }
+  }
+
   private async processJob(
     job: InternalQueueJob<T>,
     consumer: ConsumerGroupState<T>["consumers"][0],
@@ -448,12 +487,27 @@ export class InMemoryQueue<T> implements Queue<T> {
   ): Promise<void> {
     await this.semaphore.acquire();
     this.processing++;
+    const startedAt = new Date();
+    this.activeJobs.set(job.id, {
+      id: job.id,
+      enqueuedAt: job.timestamp,
+      startedAt,
+      attempts: (job.attempts ?? 0) + 1,
+    });
 
     let isRetrying = false;
 
     try {
       await consumer.handler(job);
       this.stats.completed++;
+      this.pushHistory(this.completedHistory, {
+        id: job.id,
+        state: "completed",
+        enqueuedAt: job.timestamp,
+        startedAt,
+        finishedAt: new Date(),
+        attempts: (job.attempts ?? 0) + 1,
+      });
     } catch (error) {
       this.logger.error(
         `Job ${job.id} failed in group ${groupId} (attempt ${job.attempts}):`,
@@ -488,8 +542,18 @@ export class InMemoryQueue<T> implements Queue<T> {
         });
       } else {
         this.stats.failed++;
+        this.pushHistory(this.failedHistory, {
+          id: job.id,
+          state: "failed",
+          enqueuedAt: job.timestamp,
+          startedAt,
+          finishedAt: new Date(),
+          attempts: (job.attempts ?? 0) + 1,
+          failedReason: extractErrorMessage(error),
+        });
       }
     } finally {
+      this.activeJobs.delete(job.id);
       this.processing--;
       this.semaphore.release();
 
@@ -535,6 +599,149 @@ export class InMemoryQueue<T> implements Queue<T> {
       completed: this.stats.completed,
       failed: this.stats.failed,
       consumerGroups: this.consumerGroups.size,
+      scope: "instance",
+    };
+  }
+
+  /**
+   * Synthesise `JobSummary` rows for recurring schedules so the UI can
+   * surface them under Pending (and Delayed) between actual fires.
+   *
+   * The in-memory queue runs cron via `setTimeout` and intervals via
+   * `setInterval`; neither materialises the next execution as an entry
+   * in `this.jobs` until the timer fires. Without these synthetic rows,
+   * cron-scheduled work like healthchecks would be invisible to operators
+   * looking at the runtime panel.
+   */
+  private synthesizeRecurringSummaries(): JobSummary[] {
+    const out: JobSummary[] = [];
+    for (const meta of this.recurringJobs.values()) {
+      if (!meta.enabled) continue;
+      let nextRunAt: Date | undefined;
+      if ("cronPattern" in meta && meta.cronPattern) {
+        try {
+          nextRunAt = parser
+            .parseExpression(meta.cronPattern)
+            .next()
+            .toDate();
+        } catch {
+          nextRunAt = undefined;
+        }
+      } else if (meta.intervalSeconds) {
+        // Best-effort: assume "now + intervalMs". The exact next-tick of
+        // an active setInterval isn't observable from outside; this gives
+        // operators an upper bound on the wait.
+        const intervalMs =
+          meta.intervalSeconds * 1000 * (this.config.delayMultiplier ?? 1);
+        nextRunAt = new Date(Date.now() + intervalMs);
+      }
+      // For synthesised recurring rows, `enqueuedAt` represents "this
+      // schedule is currently active as of now" — not a future fire time.
+      // The future fire time goes in `nextRunAt`. Using a future date
+      // here would make the UI's "x ago" relative formatting report
+      // negative seconds.
+      out.push({
+        id: meta.jobId,
+        name: this.name,
+        state: "delayed",
+        enqueuedAt: new Date(),
+        attempts: 0,
+        nextRunAt,
+        recurring: true,
+      });
+    }
+    return out;
+  }
+
+  async listJobs(opts: ListJobsOptions): Promise<ListJobsResult> {
+    const limit = Math.max(0, opts.limit);
+    const offset = Math.max(0, opts.offset);
+    const state: JobState = opts.state;
+    const now = Date.now();
+
+    const slice = <X>(all: X[]): { items: X[]; total: number } => ({
+      items: all.slice(offset, offset + limit),
+      total: all.length,
+    });
+
+    let result: { items: JobSummary[]; total: number };
+
+    if (state === "completed" || state === "failed") {
+      const src =
+        state === "completed" ? this.completedHistory : this.failedHistory;
+      const { items, total } = slice(src);
+      result = {
+        total,
+        items: items.map((j) => ({
+          id: j.id,
+          name: this.name,
+          state,
+          enqueuedAt: j.enqueuedAt,
+          startedAt: j.startedAt,
+          finishedAt: j.finishedAt,
+          attempts: j.attempts,
+          failedReason: j.failedReason,
+        })),
+      };
+    } else if (state === "active") {
+      const sorted = [...this.activeJobs.values()].toSorted(
+        (a, b) => a.startedAt.getTime() - b.startedAt.getTime(),
+      );
+      const { items, total } = slice(sorted);
+      result = {
+        total,
+        items: items.map((j) => ({
+          id: j.id,
+          name: this.name,
+          state: "active",
+          enqueuedAt: j.enqueuedAt,
+          startedAt: j.startedAt,
+          attempts: j.attempts,
+        })),
+      };
+    } else {
+      // pending / waiting / delayed: derived from this.jobs PLUS synthetic
+      // entries for active recurring schedules (so cron jobs are visible
+      // between fires).
+      // - waiting: availableAt <= now
+      // - delayed: availableAt > now (real jobs) + recurring schedules
+      // - pending: union, sorted by enqueuedAt (FIFO)
+      const isDelayed = (job: InternalQueueJob<T>) =>
+        job.availableAt.getTime() > now;
+
+      const baseSummaries: JobSummary[] = this.jobs
+        .filter((j) =>
+          state === "pending"
+            ? true
+            : state === "delayed"
+              ? isDelayed(j)
+              : !isDelayed(j),
+        )
+        .map((j) => ({
+          id: j.id,
+          name: this.name,
+          state:
+            state === "pending"
+              ? isDelayed(j)
+                ? ("delayed" as const)
+                : ("waiting" as const)
+              : state,
+          enqueuedAt: j.timestamp,
+          attempts: j.attempts ?? 0,
+        }));
+
+      const recurringSummaries =
+        state === "waiting" ? [] : this.synthesizeRecurringSummaries();
+
+      const all = [...baseSummaries, ...recurringSummaries];
+      const { items, total } = slice(all);
+      result = { items, total };
+    }
+
+    return {
+      items: result.items,
+      total: result.total,
+      hasMore: offset + result.items.length < result.total,
     };
   }