adonisjs-server-stats 1.10.0 → 1.10.3

package/dist/src/define_config.js

@@ -1,41 +1,32 @@
-import { bold, dim, setVerbose } from './utils/logger.js';
-/**
- * Resolve `toolbar`, `dashboard`, and `advanced` aliases into a
- * {@link DevToolbarOptions} object, merging with any existing
- * `devToolbar` settings the user provided.
- */
-function resolveToolbarAliases(config, existing) {
-    const toolbar = config.toolbar;
-    const dashboard = config.dashboard;
-    const advanced = config.advanced;
-    // Start from existing devToolbar or a new object
-    const result = { ...existing, enabled: existing?.enabled ?? false };
-    // toolbar: true | ToolbarConfig enables the toolbar
-    if (toolbar === true) {
-        result.enabled = true;
-    }
-    else if (toolbar && typeof toolbar === 'object') {
-        result.enabled = true;
-        if (toolbar.slowQueryThreshold !== undefined)
-            result.slowQueryThresholdMs = toolbar.slowQueryThreshold;
-        if (toolbar.tracing !== undefined)
-            result.tracing = toolbar.tracing;
-        if (toolbar.persist !== undefined)
-            result.persistDebugData = toolbar.persist;
-        if (toolbar.panes !== undefined)
-            result.panes = toolbar.panes;
-        if (toolbar.excludeFromTracing !== undefined)
-            result.excludeFromTracing = toolbar.excludeFromTracing;
-    }
-    else if (toolbar === false) {
-        result.enabled = false;
+import { logDeprecationWarnings } from './config/deprecation_migration.js';
+import { setVerbose } from './utils/logger.js';
+// ---------------------------------------------------------------------------
+// Toolbar alias resolution helpers
+// ---------------------------------------------------------------------------
+/** Apply toolbar config object fields onto the result. */
+function applyToolbarConfig(toolbar, result) {
+    result.enabled = true;
+    const fields = [
+        ['slowQueryThreshold', 'slowQueryThresholdMs'],
+        ['tracing', 'tracing'],
+        ['persist', 'persistDebugData'],
+        ['panes', 'panes'],
+        ['excludeFromTracing', 'excludeFromTracing'],
+    ];
+    for (const [src, dst] of fields) {
+        const v = toolbar[src];
+        if (v !== undefined)
+            result[dst] = v;
     }
-    // dashboard: true | DashboardConfig
+}
+/** Apply dashboard config onto the result. */
+function applyDashboardConfig(dashboard, result) {
     if (dashboard === true) {
-        result.enabled = true; // dashboard implies toolbar enabled
+        result.enabled = true;
         result.dashboard = true;
+        return;
     }
-    else if (dashboard && typeof dashboard === 'object') {
+    if (dashboard && typeof dashboard === 'object') {
         result.enabled = true;
         result.dashboard = true;
         if (dashboard.path !== undefined)
@@ -43,343 +34,112 @@ function resolveToolbarAliases(config, existing) {
         if (dashboard.retentionDays !== undefined)
             result.retentionDays = dashboard.retentionDays;
     }
-    // advanced options
-    if (advanced) {
-        if (advanced.debugEndpoint !== undefined)
-            result.debugEndpoint = advanced.debugEndpoint;
-        if (advanced.renderer !== undefined)
-            result.renderer = advanced.renderer;
-        if (advanced.dbPath !== undefined)
-            result.dbPath = advanced.dbPath;
-        if (advanced.persistPath !== undefined) {
-            result.persistDebugData = advanced.persistPath;
-        }
-        if (advanced.maxQueries !== undefined)
-            result.maxQueries = advanced.maxQueries;
-        if (advanced.maxEvents !== undefined)
-            result.maxEvents = advanced.maxEvents;
-        if (advanced.maxEmails !== undefined)
-            result.maxEmails = advanced.maxEmails;
-        if (advanced.maxTraces !== undefined)
-            result.maxTraces = advanced.maxTraces;
-    }
-    return result;
 }
-/**
- * Build a concrete migration hint for `devToolbar` based on which sub-fields
- * the user actually configured. The result splits `devToolbar` into the new
- * `toolbar`, `dashboard`, and `advanced` config sections.
- */
-function buildDevToolbarMigration(dt) {
-    const beforeParts = [];
-    const afterParts = [];
-    // Reconstruct a readable "before" snapshot
-    beforeParts.push('devToolbar: {');
-    if (dt.enabled !== undefined)
-        beforeParts.push(`  enabled: ${dt.enabled},`);
-    if (dt.dashboard !== undefined)
-        beforeParts.push(`  dashboard: ${dt.dashboard},`);
-    if (dt.dashboardPath !== undefined)
-        beforeParts.push(`  dashboardPath: '${dt.dashboardPath}',`);
-    if (dt.retentionDays !== undefined)
-        beforeParts.push(`  retentionDays: ${dt.retentionDays},`);
-    if (dt.slowQueryThresholdMs !== undefined)
-        beforeParts.push(`  slowQueryThresholdMs: ${dt.slowQueryThresholdMs},`);
-    if (dt.tracing !== undefined)
-        beforeParts.push(`  tracing: ${dt.tracing},`);
-    if (dt.persistDebugData !== undefined)
-        beforeParts.push(`  persistDebugData: ${JSON.stringify(dt.persistDebugData)},`);
-    if (dt.maxQueries !== undefined)
-        beforeParts.push(`  maxQueries: ${dt.maxQueries},`);
-    if (dt.maxEvents !== undefined)
-        beforeParts.push(`  maxEvents: ${dt.maxEvents},`);
-    if (dt.maxEmails !== undefined)
-        beforeParts.push(`  maxEmails: ${dt.maxEmails},`);
-    if (dt.maxTraces !== undefined)
-        beforeParts.push(`  maxTraces: ${dt.maxTraces},`);
-    if (dt.renderer !== undefined)
-        beforeParts.push(`  renderer: '${dt.renderer}',`);
-    if (dt.panes !== undefined)
-        beforeParts.push(`  panes: [...],`);
-    if (dt.excludeFromTracing !== undefined)
-        beforeParts.push(`  excludeFromTracing: [...],`);
-    if (dt.debugEndpoint !== undefined)
-        beforeParts.push(`  debugEndpoint: '${dt.debugEndpoint}',`);
-    if (dt.dbPath !== undefined)
-        beforeParts.push(`  dbPath: '${dt.dbPath}',`);
-    beforeParts.push('}');
-    // -- toolbar --
-    const hasSlowQuery = dt.slowQueryThresholdMs !== undefined;
-    const hasTracing = dt.tracing !== undefined;
-    const hasPersist = dt.persistDebugData !== undefined;
-    const hasPanes = dt.panes !== undefined;
-    const hasExclude = dt.excludeFromTracing !== undefined;
-    const hasToolbarDetails = hasSlowQuery || hasTracing || hasPersist || hasPanes || hasExclude;
-    if (dt.enabled && hasToolbarDetails) {
-        const parts = [];
-        if (hasSlowQuery)
-            parts.push(`  slowQueryThreshold: ${dt.slowQueryThresholdMs},`);
-        if (hasTracing)
-            parts.push(`  tracing: ${dt.tracing},`);
-        if (hasPersist)
-            parts.push(`  persist: ${JSON.stringify(dt.persistDebugData)},`);
-        if (hasPanes)
-            parts.push(`  panes: [...],`);
-        if (hasExclude)
-            parts.push(`  excludeFromTracing: [...],`);
-        afterParts.push('toolbar: {');
-        afterParts.push(...parts);
-        afterParts.push('}');
-    }
-    else if (dt.enabled) {
-        afterParts.push('toolbar: true');
-    }
-    // -- dashboard --
-    const hasCustomPath = dt.dashboardPath !== undefined;
-    const hasRetention = dt.retentionDays !== undefined;
-    const hasDashboardDetails = hasCustomPath || hasRetention;
-    if (dt.dashboard && hasDashboardDetails) {
-        const parts = [];
-        if (hasCustomPath)
-            parts.push(`  path: '${dt.dashboardPath}',`);
-        if (hasRetention)
-            parts.push(`  retentionDays: ${dt.retentionDays},`);
-        afterParts.push('dashboard: {');
-        afterParts.push(...parts);
-        afterParts.push('}');
-    }
-    else if (dt.dashboard) {
-        afterParts.push('dashboard: true');
+/** Advanced config field mappings. */
+const ADVANCED_FIELDS = [
+    ['debugEndpoint', 'debugEndpoint'],
+    ['renderer', 'renderer'],
+    ['dbPath', 'dbPath'],
+    ['maxQueries', 'maxQueries'],
+    ['maxEvents', 'maxEvents'],
+    ['maxEmails', 'maxEmails'],
+    ['maxTraces', 'maxTraces'],
+];
+/** Apply advanced config onto the result. */
+function applyAdvancedConfig(advanced, result) {
+    if (!advanced)
+        return;
+    for (const [src, dst] of ADVANCED_FIELDS) {
+        const v = advanced[src];
+        if (v !== undefined)
+            result[dst] = v;
     }
-    // -- advanced --
-    const advancedParts = [];
-    if (dt.maxQueries !== undefined)
-        advancedParts.push(`  maxQueries: ${dt.maxQueries},`);
-    if (dt.maxEvents !== undefined)
-        advancedParts.push(`  maxEvents: ${dt.maxEvents},`);
-    if (dt.maxEmails !== undefined)
-        advancedParts.push(`  maxEmails: ${dt.maxEmails},`);
-    if (dt.maxTraces !== undefined)
-        advancedParts.push(`  maxTraces: ${dt.maxTraces},`);
-    if (dt.renderer !== undefined)
-        advancedParts.push(`  renderer: '${dt.renderer}',`);
-    if (dt.debugEndpoint !== undefined)
-        advancedParts.push(`  debugEndpoint: '${dt.debugEndpoint}',`);
-    if (dt.dbPath !== undefined)
-        advancedParts.push(`  dbPath: '${dt.dbPath}',`);
-    if (advancedParts.length > 0) {
-        afterParts.push('advanced: {');
-        afterParts.push(...advancedParts);
-        afterParts.push('}');
+    if (advanced.persistPath !== undefined) {
+        result.persistDebugData = advanced.persistPath;
     }
-    return {
-        old: 'devToolbar',
-        new: [
-            dt.enabled !== undefined ? 'toolbar' : '',
-            dt.dashboard ? 'dashboard' : '',
-            advancedParts.length > 0 ? 'advanced' : '',
-        ]
-            .filter(Boolean)
-            .join(' + ') || 'toolbar + dashboard + advanced',
-        before: beforeParts,
-        after: afterParts,
-    };
 }
 /**
- * Detect deprecated config names and log a single grouped warning block.
- *
- * Only warns for fields the user **actually set** (not undefined).
- * The output is designed to be immediately actionable: each deprecated
- * field gets a before/after code snippet so users can copy-paste.
+ * Resolve `toolbar`, `dashboard`, and `advanced` aliases into a
+ * {@link DevToolbarOptions} object.
  */
-function logDeprecationWarnings(config) {
-    const entries = [];
-    // intervalMs -> pollInterval
-    if (config.intervalMs !== undefined) {
-        entries.push({
-            old: 'intervalMs',
-            new: 'pollInterval',
-            before: [`intervalMs: ${config.intervalMs}`],
-            after: [`pollInterval: ${config.intervalMs}`],
-        });
-    }
-    // transport -> realtime
-    if (config.transport !== undefined) {
-        const realtimeValue = config.transport === 'transmit';
-        entries.push({
-            old: 'transport',
-            new: 'realtime',
-            before: [`transport: '${config.transport}'`],
-            after: [`realtime: ${realtimeValue}`],
-        });
-    }
-    // endpoint -> statsEndpoint
-    if (config.endpoint !== undefined) {
-        const endpointDisplay = config.endpoint === false ? 'false' : `'${config.endpoint}'`;
-        entries.push({
-            old: 'endpoint',
-            new: 'statsEndpoint',
-            before: [`endpoint: ${endpointDisplay}`],
-            after: [`statsEndpoint: ${endpointDisplay}`],
-        });
-    }
-    // shouldShow -> authorize
-    if (config.shouldShow !== undefined) {
-        entries.push({
-            old: 'shouldShow',
-            new: 'authorize',
-            before: ['shouldShow: (ctx) => ...'],
-            after: ['authorize: (ctx) => ...'],
-        });
-    }
-    // channelName -> advanced.channelName
-    if (config.channelName !== undefined) {
-        entries.push({
-            old: 'channelName',
-            new: 'advanced.channelName',
-            before: [`channelName: '${config.channelName}'`],
-            after: [`advanced: { channelName: '${config.channelName}' }`],
-        });
+function resolveToolbarAliases(config, existing) {
+    const result = { ...existing, enabled: existing?.enabled ?? false };
+    if (config.toolbar === true) {
+        result.enabled = true;
     }
-    // skipInTest -> advanced.skipInTest
-    if (config.skipInTest !== undefined) {
-        entries.push({
-            old: 'skipInTest',
-            new: 'advanced.skipInTest',
-            before: [`skipInTest: ${config.skipInTest}`],
-            after: [`advanced: { skipInTest: ${config.skipInTest} }`],
-        });
+    else if (config.toolbar && typeof config.toolbar === 'object') {
+        applyToolbarConfig(config.toolbar, result);
     }
-    // devToolbar -> toolbar + dashboard + advanced
-    if (config.devToolbar !== undefined) {
-        entries.push(buildDevToolbarMigration(config.devToolbar));
+    else if (config.toolbar === false) {
+        result.enabled = false;
     }
-    if (entries.length === 0)
-        return;
-    // Build the warning block
-    const TAG = '\x1b[36m[ \x1b[1m\uD83D\uDD0D server-stats\x1b[0m\x1b[36m ]\x1b[0m';
-    const lines = [];
-    lines.push('');
-    lines.push(`${TAG} Some config options have been renamed — here's how to update:`);
-    lines.push('');
-    for (const entry of entries) {
-        lines.push(`    ${dim(entry.old)} ${dim('\u2192')} ${bold(entry.new)}`);
-        lines.push('');
-        for (const line of entry.before) {
-            lines.push(`      ${dim('before:')}  ${dim(line)}`);
-        }
-        for (const line of entry.after) {
-            lines.push(`      ${dim('after:')}   ${line}`);
-        }
-        lines.push('');
+    applyDashboardConfig(config.dashboard, result);
+    applyAdvancedConfig(config.advanced, result);
+    return result;
+}
+// ---------------------------------------------------------------------------
+// Config resolution helpers
+// ---------------------------------------------------------------------------
+/** Resolve transport from new and deprecated config options. */
+function resolveTransport(config) {
+    if (config.realtime !== undefined) {
+        return config.realtime ? 'transmit' : 'none';
     }
-    lines.push(`    ${dim('No rush — the old names still work. They will be removed in the next major version.')}`);
-    lines.push(`    ${dim('Update')} ${bold('config/server_stats.ts')} ${dim('when you get a chance.')}`);
-    lines.push('');
-    console.log(lines.join('\n'));
+    return config.transport ?? 'transmit';
 }
+/** Resolve devToolbar from aliases. */
+function resolveDevToolbar(config) {
+    const hasAliases = config.toolbar !== undefined || config.dashboard !== undefined || config.advanced !== undefined;
+    if (hasAliases)
+        return resolveToolbarAliases(config, config.devToolbar);
+    return config.devToolbar;
+}
+// ---------------------------------------------------------------------------
+// Main defineConfig
+// ---------------------------------------------------------------------------
 /**
  * Define the server stats configuration with full type safety.
  *
- * All top-level fields are optional. Sensible defaults are applied
- * for any omitted fields:
- *
- * | Field         | Default                        |
- * |---------------|--------------------------------|
- * | `intervalMs`  | `3000`                         |
- * | `transport`   | `'transmit'`                   |
- * | `channelName` | `'admin/server-stats'`         |
- * | `endpoint`    | `'/admin/api/server-stats'`    |
- * | `collectors`  | `'auto'`                       |
- * | `skipInTest`  | `true`                         |
- *
- * New simplified aliases (Phase 1) are also supported. When both the
- * old name and its alias are provided, the **new name takes precedence**.
- *
- * | Alias            | Resolves to      |
- * |------------------|------------------|
- * | `pollInterval`   | `intervalMs`     |
- * | `realtime`       | `transport`      |
- * | `statsEndpoint`  | `endpoint`       |
- * | `authorize`      | `shouldShow`     |
- * | `toolbar`        | `devToolbar`     |
- * | `dashboard`      | `devToolbar`     |
- * | `advanced`       | various          |
- *
- * This is the main entry point for configuring `adonisjs-server-stats`.
- * Call it in `config/server_stats.ts` and export the result as default.
+ * All fields are optional. Sensible defaults are applied for anything
+ * you omit -- `defineConfig({})` works out of the box with zero config.
  *
  * @example
  * ```ts
- * // config/server_stats.ts — minimal (all defaults)
+ * // Zero config -- auto-detects everything
  * import { defineConfig } from 'adonisjs-server-stats'
- *
  * export default defineConfig({})
  * ```
  *
  * @example
  * ```ts
- * // config/server_stats.ts — explicit collectors
- * import { defineConfig } from 'adonisjs-server-stats'
- * import { processCollector, httpCollector } from 'adonisjs-server-stats/collectors'
- *
- * export default defineConfig({
- *   intervalMs: 3000,
- *   transport: 'transmit',
- *   collectors: [processCollector(), httpCollector()],
- * })
- * ```
- *
- * @example
- * ```ts
- * // config/server_stats.ts — new simplified aliases
+ * // Common setup with auth and all features
  * import { defineConfig } from 'adonisjs-server-stats'
  *
  * export default defineConfig({
- *   pollInterval: 3000,
- *   realtime: true,
+ *   authorize: (ctx) => ctx.auth?.user?.role === 'admin',
  *   toolbar: true,
  *   dashboard: true,
  * })
  * ```
  */
+/** Resolve a value from primary, fallback, then default. */
+function first(primary, fallback, defaultVal) {
+    return primary ?? fallback ?? defaultVal;
+}
 export function defineConfig(config) {
-    // Apply verbose setting early so all subsequent log.info calls respect it
     const verbose = config.verbose ?? false;
     setVerbose(verbose);
-    // Resolve aliases (new names take precedence over old)
-    const intervalMs = config.pollInterval ?? config.intervalMs ?? 3000;
-    let transport;
-    if (config.realtime !== undefined) {
-        transport = config.realtime ? 'transmit' : 'none';
-    }
-    else {
-        transport = config.transport ?? 'transmit';
-    }
-    const endpoint = config.statsEndpoint ?? config.endpoint ?? '/admin/api/server-stats';
-    const shouldShow = config.authorize ?? config.shouldShow;
-    // Resolve toolbar/dashboard aliases into devToolbar
-    let devToolbar = config.devToolbar;
-    if (config.toolbar !== undefined ||
-        config.dashboard !== undefined ||
-        config.advanced !== undefined) {
-        devToolbar = resolveToolbarAliases(config, devToolbar);
-    }
-    // Resolve advanced.channelName, advanced.skipInTest etc
-    const channelName = config.advanced?.channelName ?? config.channelName ?? 'admin/server-stats';
-    const skipInTest = config.advanced?.skipInTest ?? config.skipInTest ?? true;
-    // Log friendly deprecation warnings for any old config names the user set
     logDeprecationWarnings(config);
     return {
-        intervalMs,
-        transport,
-        channelName,
-        endpoint,
+        intervalMs: first(config.pollInterval, config.intervalMs, 3000),
+        transport: resolveTransport(config),
+        channelName: first(config.advanced?.channelName, config.channelName, 'admin/server-stats'),
+        endpoint: first(config.statsEndpoint, config.endpoint, '/admin/api/server-stats'),
         collectors: config.collectors ?? 'auto',
-        skipInTest,
+        skipInTest: first(config.advanced?.skipInTest, config.skipInTest, true),
         onStats: config.onStats,
-        devToolbar,
-        shouldShow,
+        devToolbar: resolveDevToolbar(config),
+        shouldShow: config.authorize ?? config.shouldShow,
         verbose,
     };
 }