adonisjs-server-stats 1.10.0 → 1.10.3

package/dist/src/data/data_access.js

@@ -1,58 +1,4 @@
-import { readFile, stat } from 'node:fs/promises';
-import { parseAndEnrich } from '../log_stream/log_stream_service.js';
-// ---------------------------------------------------------------------------
-// Helpers
-// ---------------------------------------------------------------------------
-/**
- * Wrap a plain array in the standard {@link PaginatedResult} envelope.
- *
- * Applies optional client-side search filtering and pagination so that
- * ring-buffer results match the same shape returned by the dashboard store.
- */
-function wrapArray(items, opts, searchFn) {
-    let filtered = items;
-    // Client-side search
-    if (opts.search && searchFn) {
-        const term = opts.search.toLowerCase();
-        filtered = filtered.filter((item) => searchFn(item, term));
-    }
-    const total = filtered.length;
-    const page = opts.page ?? 1;
-    // When perPage is not specified, return all items (backward compat for debug panel)
-    const perPage = opts.perPage ?? (total || 1);
-    const lastPage = Math.max(1, Math.ceil(total / perPage));
-    const start = (page - 1) * perPage;
-    const data = filtered.slice(start, start + perPage);
-    return {
-        data,
-        meta: { total, page, perPage, lastPage },
-    };
-}
-/**
- * Convert a flat {@link DashboardStore.PaginatedResult} to the nested
- * `{ data, meta }` shape used by the unified API.
- */
-function fromDashboardResult(result) {
-    return {
-        data: result.data,
-        meta: {
-            total: result.total,
-            page: result.page,
-            perPage: result.perPage,
-            lastPage: result.lastPage,
-        },
-    };
-}
-function mapTraceListRow(row) {
-    return {
-        ...row,
-        requestId: row.request_id ?? row.requestId,
-        statusCode: row.status_code ?? row.statusCode,
-        totalDuration: row.total_duration ?? row.totalDuration,
-        spanCount: row.span_count ?? row.spanCount,
-        createdAt: row.created_at ?? row.createdAt,
-    };
-}
+import { wrapArray, fromDashboardResult, mapTraceListRow, normalizeEmailRow, buildPaginationArgs, buildQueryFilters, buildEventFilters, buildEmailFilters, buildTraceFilters, buildLogFilters, stripEmailForList, stripTraceForList, filterRoutes, readLogFile, } from './data_access_helpers.js';
 // ---------------------------------------------------------------------------
 // DataAccess
 // ---------------------------------------------------------------------------
@@ -87,13 +33,8 @@ export class DataAccess {
     // =========================================================================
     async getQueries(opts = {}) {
         if (this.hasPersistence && opts.source !== 'memory') {
-            const page = opts.page ?? 1;
-            const perPage = opts.perPage ?? 50;
-            const filters = {
-                search: opts.search,
-                ...opts.filters,
-            };
-            const result = await this.dashboardStore.getQueries(page, perPage, filters);
+            const { page, perPage } = buildPaginationArgs(opts);
+            const result = await this.dashboardStore.getQueries(page, perPage, buildQueryFilters(opts));
             return fromDashboardResult(result);
         }
         const queries = this.debugStore.queries.getQueries();
@@ -111,13 +52,8 @@ export class DataAccess {
     // =========================================================================
     async getEvents(opts = {}) {
         if (this.hasPersistence && opts.source !== 'memory') {
-            const page = opts.page ?? 1;
-            const perPage = opts.perPage ?? 50;
-            const filters = {
-                search: opts.search,
-                ...opts.filters,
-            };
-            const result = await this.dashboardStore.getEvents(page, perPage, filters);
+            const { page, perPage } = buildPaginationArgs(opts);
+            const result = await this.dashboardStore.getEvents(page, perPage, buildEventFilters(opts));
             return fromDashboardResult(result);
         }
         const events = this.debugStore.events.getEvents();
@@ -136,42 +72,14 @@ export class DataAccess {
      */
     async getEmails(opts = {}) {
         if (this.hasPersistence && opts.source !== 'memory') {
-            const page = opts.page ?? 1;
-            const perPage = opts.perPage ?? 50;
-            const filters = {
-                search: opts.search,
-                ...opts.filters,
-            };
-            const result = await this.dashboardStore.getEmails(page, perPage, filters, true);
+            const { page, perPage } = buildPaginationArgs(opts);
+            const result = await this.dashboardStore.getEmails(page, perPage, buildEmailFilters(opts), true);
             const normalized = fromDashboardResult(result);
-            // Normalize SQLite column names to match the EmailRecord shape
-            // so both memory and SQLite paths return consistent field names
-            normalized.data = normalized.data.map((row) => ({
-                ...row,
-                from: row.from_addr ?? row.from ?? '',
-                to: row.to_addr ?? row.to ?? '',
-                messageId: row.message_id ?? row.messageId ?? null,
-                attachmentCount: row.attachment_count ?? row.attachmentCount ?? 0,
-                timestamp: row.created_at ?? row.timestamp ?? null,
-            }));
+            normalized.data = normalized.data.map(normalizeEmailRow);
             return normalized;
         }
         const emails = this.debugStore.emails.getEmails();
-        // Strip html/text from list response — build lightweight objects
-        // without object-spread to avoid copying large HTML bodies
-        const stripped = emails.map((e) => ({
-            id: e.id,
-            from: e.from,
-            to: e.to,
-            cc: e.cc,
-            bcc: e.bcc,
-            subject: e.subject,
-            mailer: e.mailer,
-            status: e.status,
-            messageId: e.messageId,
-            attachmentCount: e.attachmentCount,
-            timestamp: e.timestamp,
-        }));
+        const stripped = emails.map(stripEmailForList);
         return wrapArray(stripped, opts, (e, term) => {
             return (e.from.toLowerCase().includes(term) ||
                 e.to.toLowerCase().includes(term) ||
@@ -201,13 +109,8 @@ export class DataAccess {
      */
     async getTraces(opts = {}) {
         if (this.hasPersistence && opts.source !== 'memory') {
-            const page = opts.page ?? 1;
-            const perPage = opts.perPage ?? 50;
-            const filters = {
-                search: opts.search,
-                ...opts.filters,
-            };
-            const result = await this.dashboardStore.getTraces(page, perPage, filters);
+            const { page, perPage } = buildPaginationArgs(opts);
+            const result = await this.dashboardStore.getTraces(page, perPage, buildTraceFilters(opts));
             return {
                 ...fromDashboardResult(result),
                 data: result.data.map(mapTraceListRow),
@@ -217,18 +120,7 @@ export class DataAccess {
             return { data: [], meta: { total: 0, page: 1, perPage: opts.perPage ?? 50, lastPage: 1 } };
         }
         const traces = this.debugStore.traces.getTraces();
-        // Strip spans from list view, add warningCount — build lightweight
-        // objects without spread to avoid copying large span arrays
-        const list = traces.map((t) => ({
-            id: t.id,
-            method: t.method,
-            url: t.url,
-            statusCode: t.statusCode,
-            totalDuration: t.totalDuration,
-            spanCount: t.spanCount,
-            warningCount: t.warnings.length,
-            timestamp: t.timestamp,
-        }));
+        const list = traces.map(stripTraceForList);
         return wrapArray(list, opts, (t, term) => {
             return t.method.toLowerCase().includes(term) || t.url.toLowerCase().includes(term);
         });
@@ -258,12 +150,8 @@ export class DataAccess {
     }
     /**
      * Find log entries matching a specific request ID.
-     *
-     * Checks SQLite first (if available), then falls back to scanning
-     * the log file for entries with a matching `request_id` field.
      */
     async getRelatedLogsByRequestId(requestId) {
-        // Try SQLite first
         if (this.hasPersistence) {
             try {
                 const result = await this.dashboardStore.getLogs(1, 50, { requestId });
@@ -273,8 +161,7 @@ export class DataAccess {
                 // Fall through to log file
             }
         }
-        // Fallback: scan log file
-        const entries = await this.readLogFile();
+        const entries = this.logPath ? await readLogFile(this.logPath) : [];
         return entries.filter((e) => e.request_id === requestId || e.requestId === requestId);
     }
     // =========================================================================
@@ -289,17 +176,7 @@ export class DataAccess {
     getRoutes(search) {
         let routes = this.debugStore.routes.getRoutes();
         if (search) {
-            const term = search.toLowerCase();
-            routes = routes.filter((r) => {
-                const pattern = (r.pattern || '').toLowerCase();
-                const handler = (r.handler || '').toLowerCase();
-                const name = (r.name || '').toLowerCase();
-                const method = (r.method || '').toLowerCase();
-                return (pattern.includes(term) ||
-                    handler.includes(term) ||
-                    name.includes(term) ||
-                    method.includes(term));
-            });
+            routes = filterRoutes(routes, search);
         }
         const total = routes.length;
         return {
@@ -319,68 +196,15 @@ export class DataAccess {
      */
     async getLogs(opts = {}) {
         if (this.hasPersistence && opts.source !== 'memory') {
-            const page = opts.page ?? 1;
-            const perPage = opts.perPage ?? 50;
-            const filters = {
-                search: opts.search,
-                ...opts.filters,
-            };
-            const result = await this.dashboardStore.getLogs(page, perPage, filters);
+            const { page, perPage } = buildPaginationArgs(opts);
+            const result = await this.dashboardStore.getLogs(page, perPage, buildLogFilters(opts));
             return fromDashboardResult(result);
         }
-        // Fallback: read from log file on disk (same approach as DebugController)
-        const entries = await this.readLogFile();
+        const entries = this.logPath ? await readLogFile(this.logPath) : [];
         return wrapArray(entries, opts, (e, term) => {
             const msg = String(e.msg ?? e.message ?? '').toLowerCase();
             const levelName = String(e.levelName ?? '').toLowerCase();
             return msg.includes(term) || levelName.includes(term);
         });
     }
-    // =========================================================================
-    // Private helpers
-    // =========================================================================
-    /**
-     * Read and parse the last 256 KB of the application log file.
-     *
-     * Returns an array of enriched log entry objects. If the log file
-     * does not exist or cannot be read, returns an empty array.
-     */
-    async readLogFile() {
-        if (!this.logPath)
-            return [];
-        try {
-            const stats = await stat(this.logPath);
-            const maxBytes = 256 * 1024;
-            let content;
-            if (stats.size > maxBytes) {
-                const { createReadStream } = await import('node:fs');
-                const stream = createReadStream(this.logPath, {
-                    start: stats.size - maxBytes,
-                    encoding: 'utf-8',
-                });
-                const chunks = [];
-                for await (const chunk of stream) {
-                    chunks.push(chunk);
-                }
-                content = chunks.join('');
-                // Skip first potentially incomplete line
-                const firstNewline = content.indexOf('\n');
-                if (firstNewline !== -1)
-                    content = content.slice(firstNewline + 1);
-            }
-            else {
-                content = await readFile(this.logPath, 'utf-8');
-            }
-            return content
-                .trim()
-                .split('\n')
-                .filter(Boolean)
-                .map((line) => parseAndEnrich(line))
-                .filter((entry) => entry !== null)
-                .reverse();
-        }
-        catch {
-            return [];
-        }
-    }
 }

package/dist/src/data/data_access_helpers.d.ts

@@ -0,0 +1,130 @@
+import type { DashboardStore, QueryFilters, EventFilters, EmailFilters, TraceFilters, LogFilters } from '../dashboard/dashboard_store.js';
+import type { DebugStore } from '../debug/debug_store.js';
+import type { QueryRecord, EventRecord, TraceRecord, RouteRecord } from '../debug/types.js';
+export interface ListOptions {
+    page?: number;
+    perPage?: number;
+    search?: string;
+    sort?: string;
+    sortDir?: 'asc' | 'desc';
+    filters?: Record<string, unknown>;
+    /**
+     * Force the data source for this read.
+     *
+     * - `'memory'` — always read from ring buffers ({@link DebugStore}).
+     *   Use this for the debug panel, which expects camelCase field names
+     *   matching the {@link QueryRecord}/{@link EventRecord}/etc. interfaces.
+     * - `'auto'` (default) — use SQLite when available, fall back to memory.
+     */
+    source?: 'memory' | 'auto';
+}
+export interface PaginatedResult<T = Record<string, unknown>> {
+    data: T[];
+    meta: {
+        total: number;
+        page: number;
+        perPage: number;
+        lastPage: number;
+    };
+}
+/**
+ * Wrap a plain array in the standard {@link PaginatedResult} envelope.
+ *
+ * Applies optional client-side search filtering and pagination so that
+ * ring-buffer results match the same shape returned by the dashboard store.
+ */
+export declare function wrapArray<T>(items: T[], opts: ListOptions, searchFn?: (item: T, term: string) => boolean): PaginatedResult<T>;
+/**
+ * Convert a flat {@link DashboardStore.PaginatedResult} to the nested
+ * `{ data, meta }` shape used by the unified API.
+ */
+export declare function fromDashboardResult<T>(result: {
+    data: T[];
+    total: number;
+    page: number;
+    perPage: number;
+    lastPage: number;
+}): PaginatedResult<T>;
+export declare function mapTraceListRow<T extends Record<string, unknown>>(row: T): T & {
+    requestId: unknown;
+    statusCode: unknown;
+    totalDuration: unknown;
+    spanCount: unknown;
+    createdAt: unknown;
+};
+/** Normalize SQLite email column names to match the EmailRecord shape. */
+export declare function normalizeEmailRow(row: Record<string, unknown>): {
+    from: unknown;
+    to: unknown;
+    messageId: unknown;
+    attachmentCount: unknown;
+    timestamp: unknown;
+};
+/** Build dashboard store query/event/email/trace pagination args. */
+export declare function buildPaginationArgs(opts: ListOptions): {
+    page: number;
+    perPage: number;
+};
+export declare function buildQueryFilters(opts: ListOptions): QueryFilters;
+export declare function buildEventFilters(opts: ListOptions): EventFilters;
+export declare function buildEmailFilters(opts: ListOptions): EmailFilters;
+export declare function buildTraceFilters(opts: ListOptions): TraceFilters;
+export declare function buildLogFilters(opts: ListOptions): LogFilters;
+/** Strip heavy html/text bodies from email records for list view. */
+export declare function stripEmailForList(e: {
+    id: number;
+    from: string;
+    to: string;
+    cc?: string | null;
+    bcc?: string | null;
+    subject: string;
+    mailer: string;
+    status: string;
+    messageId?: string | null;
+    attachmentCount?: number;
+    timestamp?: string | number | null;
+}): {
+    id: number;
+    from: string;
+    to: string;
+    cc: string | null | undefined;
+    bcc: string | null | undefined;
+    subject: string;
+    mailer: string;
+    status: string;
+    messageId: string | null | undefined;
+    attachmentCount: number | undefined;
+    timestamp: string | number | null | undefined;
+};
+/** Strip spans from trace records for list view. */
+export declare function stripTraceForList(t: {
+    id: number;
+    method: string;
+    url: string;
+    statusCode: number;
+    totalDuration: number;
+    spanCount: number;
+    warnings: readonly unknown[];
+    timestamp?: string | number | null;
+}): {
+    id: number;
+    method: string;
+    url: string;
+    statusCode: number;
+    totalDuration: number;
+    spanCount: number;
+    warningCount: number;
+    timestamp: string | number | null | undefined;
+};
+/** Filter routes by search term across pattern, handler, name, and method. */
+export declare function filterRoutes(routes: RouteRecord[], search: string): RouteRecord[];
+/**
+ * Read and parse the last 256 KB of a log file.
+ *
+ * Returns an array of enriched log entry objects. If the log file
+ * does not exist or cannot be read, returns an empty array.
+ */
+export declare function readLogFile(logPath: string): Promise<Record<string, unknown>[]>;
+export type { DashboardStore, QueryFilters, EventFilters, EmailFilters, TraceFilters, LogFilters };
+export type { DebugStore };
+export type { QueryRecord, EventRecord, TraceRecord, RouteRecord };

package/dist/src/data/data_access_helpers.js

@@ -0,0 +1,212 @@
+import { readFile, stat } from 'node:fs/promises';
+import { parseAndEnrich } from '../log_stream/log_stream_service.js';
+// ---------------------------------------------------------------------------
+// Pagination helpers
+// ---------------------------------------------------------------------------
+/**
+ * Wrap a plain array in the standard {@link PaginatedResult} envelope.
+ *
+ * Applies optional client-side search filtering and pagination so that
+ * ring-buffer results match the same shape returned by the dashboard store.
+ */
+export function wrapArray(items, opts, searchFn) {
+    let filtered = items;
+    // Client-side search
+    if (opts.search && searchFn) {
+        const term = opts.search.toLowerCase();
+        filtered = filtered.filter((item) => searchFn(item, term));
+    }
+    const total = filtered.length;
+    const page = opts.page ?? 1;
+    // When perPage is not specified, return all items (backward compat for debug panel)
+    const perPage = opts.perPage ?? (total || 1);
+    const lastPage = Math.max(1, Math.ceil(total / perPage));
+    const start = (page - 1) * perPage;
+    const data = filtered.slice(start, start + perPage);
+    return {
+        data,
+        meta: { total, page, perPage, lastPage },
+    };
+}
+/**
+ * Convert a flat {@link DashboardStore.PaginatedResult} to the nested
+ * `{ data, meta }` shape used by the unified API.
+ */
+export function fromDashboardResult(result) {
+    return {
+        data: result.data,
+        meta: {
+            total: result.total,
+            page: result.page,
+            perPage: result.perPage,
+            lastPage: result.lastPage,
+        },
+    };
+}
+// ---------------------------------------------------------------------------
+// Row mapping helpers
+// ---------------------------------------------------------------------------
+export function mapTraceListRow(row) {
+    return {
+        ...row,
+        requestId: row.request_id ?? row.requestId,
+        statusCode: row.status_code ?? row.statusCode,
+        totalDuration: row.total_duration ?? row.totalDuration,
+        spanCount: row.span_count ?? row.spanCount,
+        createdAt: row.created_at ?? row.createdAt,
+    };
+}
+/** Pick the first defined value from a row, trying snake_case then camelCase. */
+function pick(row, snake, camel, fallback = null) {
+    return row[snake] ?? row[camel] ?? fallback;
+}
+/** Normalize SQLite email column names to match the EmailRecord shape. */
+export function normalizeEmailRow(row) {
+    return {
+        ...row,
+        from: pick(row, 'from_addr', 'from', ''),
+        to: pick(row, 'to_addr', 'to', ''),
+        messageId: pick(row, 'message_id', 'messageId'),
+        attachmentCount: pick(row, 'attachment_count', 'attachmentCount', 0),
+        timestamp: pick(row, 'created_at', 'timestamp'),
+    };
+}
+// ---------------------------------------------------------------------------
+// Store delegate helpers
+// ---------------------------------------------------------------------------
+/** Build dashboard store query/event/email/trace pagination args. */
+export function buildPaginationArgs(opts) {
+    return {
+        page: opts.page ?? 1,
+        perPage: opts.perPage ?? 50,
+    };
+}
+export function buildQueryFilters(opts) {
+    return {
+        search: opts.search,
+        ...opts.filters,
+    };
+}
+export function buildEventFilters(opts) {
+    return {
+        search: opts.search,
+        ...opts.filters,
+    };
+}
+export function buildEmailFilters(opts) {
+    return {
+        search: opts.search,
+        ...opts.filters,
+    };
+}
+export function buildTraceFilters(opts) {
+    return {
+        search: opts.search,
+        ...opts.filters,
+    };
+}
+export function buildLogFilters(opts) {
+    return {
+        search: opts.search,
+        ...opts.filters,
+    };
+}
+// ---------------------------------------------------------------------------
+// Email stripping
+// ---------------------------------------------------------------------------
+/** Strip heavy html/text bodies from email records for list view. */
+export function stripEmailForList(e) {
+    return {
+        id: e.id,
+        from: e.from,
+        to: e.to,
+        cc: e.cc,
+        bcc: e.bcc,
+        subject: e.subject,
+        mailer: e.mailer,
+        status: e.status,
+        messageId: e.messageId,
+        attachmentCount: e.attachmentCount,
+        timestamp: e.timestamp,
+    };
+}
+// ---------------------------------------------------------------------------
+// Trace list stripping
+// ---------------------------------------------------------------------------
+/** Strip spans from trace records for list view. */
+export function stripTraceForList(t) {
+    return {
+        id: t.id,
+        method: t.method,
+        url: t.url,
+        statusCode: t.statusCode,
+        totalDuration: t.totalDuration,
+        spanCount: t.spanCount,
+        warningCount: t.warnings.length,
+        timestamp: t.timestamp,
+    };
+}
+// ---------------------------------------------------------------------------
+// Route search
+// ---------------------------------------------------------------------------
+/** Filter routes by search term across pattern, handler, name, and method. */
+export function filterRoutes(routes, search) {
+    const term = search.toLowerCase();
+    return routes.filter((r) => {
+        const pattern = (r.pattern || '').toLowerCase();
+        const handler = (r.handler || '').toLowerCase();
+        const name = (r.name || '').toLowerCase();
+        const method = (r.method || '').toLowerCase();
+        return (pattern.includes(term) ||
+            handler.includes(term) ||
+            name.includes(term) ||
+            method.includes(term));
+    });
+}
+// ---------------------------------------------------------------------------
+// Log file reader
+// ---------------------------------------------------------------------------
+/**
+ * Read and parse the last 256 KB of a log file.
+ *
+ * Returns an array of enriched log entry objects. If the log file
+ * does not exist or cannot be read, returns an empty array.
+ */
+export async function readLogFile(logPath) {
+    try {
+        const stats = await stat(logPath);
+        const content = await readLogContent(logPath, stats.size);
+        return content
+            .trim()
+            .split('\n')
+            .filter(Boolean)
+            .map((line) => parseAndEnrich(line))
+            .filter((entry) => entry !== null)
+            .reverse();
+    }
+    catch {
+        return [];
+    }
+}
+/** Read the last maxBytes of a file, skipping partial first line if truncated. */
+async function readLogContent(logPath, fileSize) {
+    const maxBytes = 256 * 1024;
+    if (fileSize <= maxBytes) {
+        return readFile(logPath, 'utf-8');
+    }
+    const { createReadStream } = await import('node:fs');
+    const stream = createReadStream(logPath, {
+        start: fileSize - maxBytes,
+        encoding: 'utf-8',
+    });
+    const chunks = [];
+    for await (const chunk of stream) {
+        chunks.push(chunk);
+    }
+    let content = chunks.join('');
+    // Skip first potentially incomplete line
+    const firstNewline = content.indexOf('\n');
+    if (firstNewline !== -1)
+        content = content.slice(firstNewline + 1);
+    return content;
+}