adonisjs-server-stats 1.12.3 → 1.13.0

package/dist/src/dashboard/integrations/queue_inspector.d.ts

@@ -1,4 +1,8 @@
 import type { ApplicationService } from '@adonisjs/core/types';
+import type { QueueInspectorContract } from './queue_inspector_contract.js';
+export type { QueueOverview, QueueJobSummary, QueueJobDetail, QueueJobListResult, JobStatus, } from './queue_inspector_contract.js';
+export { ALL_STATUSES } from './queue_inspector_contract.js';
+import type { QueueOverview, QueueJobDetail, QueueJobListResult, JobStatus } from './queue_inspector_contract.js';
 /** Minimal interface for a BullMQ Job as accessed by the inspector. */
 interface BullMQJob {
     id: string | number;
@@ -29,65 +33,6 @@ interface QueueManager {
     getOrSet?(name: string): BullMQQueue;
     getJobCounts?(...statuses: string[]): Promise<Record<string, number>>;
 }
-export interface QueueOverview {
-    /** Total jobs currently being processed. */
-    active: number;
-    /** Jobs waiting to be picked up by a worker. */
-    waiting: number;
-    /** Jobs scheduled for future execution. */
-    delayed: number;
-    /** Jobs that completed successfully. */
-    completed: number;
-    /** Jobs that permanently failed. */
-    failed: number;
-    /** Jobs paused in the queue. */
-    paused: number;
-}
-export interface QueueJobSummary {
-    /** Bull job ID. */
-    id: string;
-    /** Human-readable job name (cleaned from file URLs). */
-    name: string;
-    /** Current job status. */
-    status: 'active' | 'waiting' | 'delayed' | 'completed' | 'failed' | 'paused';
-    /** Job payload (data). */
-    data: Record<string, unknown> | null;
-    /** Alias for `data` — used by some frontends. */
-    payload: Record<string, unknown> | null;
-    /** Number of attempts so far. */
-    attempts: number;
-    /** Maximum allowed attempts. */
-    maxAttempts: number;
-    /** Job progress (0-100 or custom). */
-    progress: number | object;
-    /** Error message if the job failed, or null. */
-    failedReason: string | null;
-    /** When the job was added (Unix timestamp ms). */
-    createdAt: number;
-    /** Alias for `createdAt` — BullMQ compat. */
-    timestamp: number;
-    /** When processing started (Unix timestamp ms), or null. */
-    processedAt: number | null;
-    /** When the job finished (Unix timestamp ms), or null. */
-    finishedAt: number | null;
-    /** Processing duration in ms, or null if not finished. */
-    duration: number | null;
-}
-export interface QueueJobDetail extends QueueJobSummary {
-    /** Full stack trace if the job failed. */
-    stackTrace: string[];
-    /** Return value from the job handler, if any. */
-    returnValue: unknown;
-    /** Job options (delay, priority, repeat, etc.). */
-    opts: Record<string, unknown>;
-}
-export interface QueueJobListResult {
-    /** Jobs for the requested page. */
-    jobs: QueueJobSummary[];
-    /** Total number of jobs matching the status filter. */
-    total: number;
-}
-type JobStatus = 'active' | 'waiting' | 'delayed' | 'completed' | 'failed' | 'paused';
 /**
  * Inspects Bull Queue jobs, counts, and allows retrying failed jobs.
  *
@@ -95,7 +40,7 @@ type JobStatus = 'active' | 'waiting' | 'delayed' | 'completed' | 'failed' | 'pa
  * Only functional when `@rlanz/bull-queue` is installed.
  * All methods catch errors and return safe defaults.
  */
-export declare class QueueInspector {
+export declare class QueueInspector implements QueueInspectorContract {
     private queueManager;
     constructor(queueManager: QueueManager);
     /**
@@ -147,4 +92,3 @@ export declare class QueueInspector {
     /** Format a Bull job into our summary shape. */
     private formatJobSummary;
 }
-export {};

package/dist/src/dashboard/integrations/queue_inspector.js

@@ -1,4 +1,8 @@
-const ALL_STATUSES = ['active', 'waiting', 'delayed', 'completed', 'failed', 'paused'];
+export { ALL_STATUSES } from './queue_inspector_contract.js';
+import { ALL_STATUSES } from './queue_inspector_contract.js';
+// ---------------------------------------------------------------------------
+// QueueInspector
+// ---------------------------------------------------------------------------
 /**
  * Inspects Bull Queue jobs, counts, and allows retrying failed jobs.
  *

package/dist/src/dashboard/integrations/queue_inspector_contract.d.ts

@@ -0,0 +1,73 @@
+export interface QueueOverview {
+    /** Total jobs currently being processed. */
+    active: number;
+    /** Jobs waiting to be picked up by a worker. */
+    waiting: number;
+    /** Jobs scheduled for future execution. */
+    delayed: number;
+    /** Jobs that completed successfully. */
+    completed: number;
+    /** Jobs that permanently failed. */
+    failed: number;
+    /** Jobs paused in the queue. */
+    paused: number;
+}
+export interface QueueJobSummary {
+    /** Bull / @boringnode job ID. */
+    id: string;
+    /** Human-readable job name (cleaned from file URLs). */
+    name: string;
+    /** Current job status. */
+    status: 'active' | 'waiting' | 'delayed' | 'completed' | 'failed' | 'paused';
+    /** Job payload (data). */
+    data: Record<string, unknown> | null;
+    /** Alias for `data` — used by some frontends. */
+    payload: Record<string, unknown> | null;
+    /** Number of attempts so far. */
+    attempts: number;
+    /** Maximum allowed attempts. */
+    maxAttempts: number;
+    /** Job progress (0-100 or custom). */
+    progress: number | object;
+    /** Error message if the job failed, or null. */
+    failedReason: string | null;
+    /** When the job was added (Unix timestamp ms). */
+    createdAt: number;
+    /** Alias for `createdAt` — BullMQ compat. */
+    timestamp: number;
+    /** When processing started (Unix timestamp ms), or null. */
+    processedAt: number | null;
+    /** When the job finished (Unix timestamp ms), or null. */
+    finishedAt: number | null;
+    /** Processing duration in ms, or null if not finished. */
+    duration: number | null;
+}
+export interface QueueJobDetail extends QueueJobSummary {
+    /** Full stack trace if the job failed. */
+    stackTrace: string[];
+    /** Return value from the job handler, if any. */
+    returnValue: unknown;
+    /** Job options (delay, priority, repeat, etc.). */
+    opts: Record<string, unknown>;
+}
+export interface QueueJobListResult {
+    /** Jobs for the requested page. */
+    jobs: QueueJobSummary[];
+    /** Total number of jobs matching the status filter. */
+    total: number;
+}
+/** The statuses understood by the dashboard UI. */
+export type JobStatus = 'active' | 'waiting' | 'delayed' | 'completed' | 'failed' | 'paused';
+/** All dashboard-level job statuses. */
+export declare const ALL_STATUSES: JobStatus[];
+/**
+ * Common interface implemented by both BullMQ and @adonisjs/queue inspectors.
+ *
+ * All methods catch errors internally and return safe defaults.
+ */
+export interface QueueInspectorContract {
+    getOverview(): Promise<QueueOverview>;
+    listJobs(status: JobStatus | 'all', page?: number, perPage?: number): Promise<QueueJobListResult>;
+    getJob(id: string): Promise<QueueJobDetail | null>;
+    retryJob(id: string): Promise<boolean>;
+}

package/dist/src/dashboard/integrations/queue_inspector_contract.js

@@ -0,0 +1,15 @@
+// ---------------------------------------------------------------------------
+// Shared response types and contract interface for queue inspection.
+//
+// Both QueueInspector (BullMQ / @rlanz/bull-queue) and
+// AdonisQueueInspector (@adonisjs/queue) implement QueueInspectorContract.
+// ---------------------------------------------------------------------------
+/** All dashboard-level job statuses. */
+export const ALL_STATUSES = [
+    'active',
+    'waiting',
+    'delayed',
+    'completed',
+    'failed',
+    'paused',
+];

package/dist/src/provider/email_bridge.d.ts

@@ -13,14 +13,25 @@ interface RedisPublisher {
 interface RedisSubscriber extends RedisPublisher {
     subscribe(channel: string, handler: (message: string) => void): unknown;
 }
+/** Sink that persists an ingested email (the SQLite dashboard store). */
+interface DashboardEmailSink {
+    recordEmail(record: Record<string, unknown>): void;
+}
 /** Targets for ingesting remote emails. */
 export interface EmailBridgeTargets {
     debugEmails: {
         ingest(record: Record<string, unknown>): void;
     } | null;
-    dashboardStore: {
-        recordEmail(record: Record<string, unknown>): void;
-    } | null;
+    /**
+     * The persistent dashboard store, or a (possibly async) getter for it.
+     *
+     * A getter is used because the bridge subscribes during early boot —
+     * before the SQLite dashboard store exists — yet remote emails arrive
+     * later, by which time the store is available. Resolving lazily lets
+     * cross-process (queue-worker) emails land in SQLite, where the
+     * dashboard/debug APIs read from when persistence is enabled.
+     */
+    dashboardStore: DashboardEmailSink | (() => DashboardEmailSink | null | Promise<DashboardEmailSink | null>) | null;
 }
 /**
  * Ingest a remote email message from Redis pub/sub.

package/dist/src/provider/email_bridge.js

@@ -3,6 +3,20 @@
  */
 import { log } from '../utils/logger.js';
 import { buildEmailPayload, MAIL_STATUS_MAP } from './email_helpers.js';
+/** Resolve the dashboard sink whether it's a direct object, a getter, or null. */
+async function resolveDashboardSink(store) {
+    if (!store)
+        return null;
+    if (typeof store === 'function') {
+        try {
+            return (await store()) ?? null;
+        }
+        catch {
+            return null;
+        }
+    }
+    return store;
+}
 /**
  * Ingest a remote email message from Redis pub/sub.
  * Skips messages from the same process.
@@ -19,7 +33,11 @@ export function ingestRemoteEmail(message, processTag, targets) {
             text: fields.text || null,
         };
         targets.debugEmails?.ingest(record);
-        targets.dashboardStore?.recordEmail({ id: 0, ...record });
+        // Persist to SQLite too (where the APIs read from). The store may be
+        // resolved lazily, so fire-and-forget without blocking ingestion.
+        void resolveDashboardSink(targets.dashboardStore).then((sink) => {
+            sink?.recordEmail({ id: 0, ...record });
+        });
     }
     catch {
         // Ignore malformed messages

package/dist/src/provider/toolbar_setup.js

@@ -18,7 +18,7 @@ export async function setupDevToolbarCore(opts) {
     if (!em)
         log.warn('emitter not available — query/event collection disabled');
     await debugStore.start(em, await resolve('router'));
-    const emailBridgeRedis = await setupBridgeInternal(em, debugStore);
+    const emailBridgeRedis = await setupBridgeInternal(em, debugStore, app);
     const debugController = await createDebugController(debugStore, config, getDiagnostics, app);
     if (debugStore.traces)
         setTraceCollector(debugStore.traces);
@@ -66,14 +66,26 @@ function createFlushTimer(debugStore, persistPath) {
         catch { }
     }, 30_000);
 }
-async function setupBridgeInternal(emitter, debugStore) {
+async function setupBridgeInternal(emitter, debugStore, app) {
     if (!emitter)
         return null;
     try {
         const { appImport } = await import('../utils/app_import.js');
         const mod = await appImport('@adonisjs/redis/services/main');
         const redis = mod.default;
-        return await setupFullEmailBridge(emitter, redis, 'adonisjs-server-stats:emails', { debugEmails: debugStore.emails ?? null, dashboardStore: null });
+        // Lazily resolve the SQLite dashboard store: it's registered as a
+        // container singleton later in boot, but remote emails only arrive
+        // post-boot, so cross-process (queue-worker) emails get persisted
+        // where the dashboard/debug APIs read from.
+        const getDashboardStore = async () => {
+            try {
+                return (await app.container.make('dashboard.store'));
+            }
+            catch {
+                return null;
+            }
+        };
+        return await setupFullEmailBridge(emitter, redis, 'adonisjs-server-stats:emails', { debugEmails: debugStore.emails ?? null, dashboardStore: getDashboardStore });
     }
     catch {
         return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adonisjs-server-stats",
-  "version": "1.12.3",
+  "version": "1.13.0",
   "description": "Real-time server monitoring for AdonisJS v6 applications",
   "keywords": [
     "adonisjs",
@@ -138,6 +138,8 @@
     "@vitejs/plugin-react": "^5.1.4",
     "@vitejs/plugin-vue": "^6.0.4",
     "better-sqlite3": "^11.10.0",
+    "@adonisjs/queue": "^0.6.1",
+    "@boringnode/queue": "^0.5.2",
     "bullmq": "^5.0.0",
     "edge.js": "^6.0.0",
     "oxfmt": "^0.35.0",
@@ -159,6 +161,8 @@
     "@adonisjs/transmit-client": "^1.0.0",
     "@julr/adonisjs-prometheus": "^1.4.0 || ^2.0.0",
     "better-sqlite3": "^7.0.0 || ^11.0.0 || ^12.0.0",
+    "@adonisjs/queue": "^0.6.0",
+    "@boringnode/queue": "^0.5.0",
     "bullmq": "^5.0.0",
     "edge.js": "^6.0.0",
     "knex": "^3.0.0",
@@ -179,6 +183,12 @@
     "@julr/adonisjs-prometheus": {
       "optional": true
     },
+    "@adonisjs/queue": {
+      "optional": true
+    },
+    "@boringnode/queue": {
+      "optional": true
+    },
     "bullmq": {
       "optional": true
     },