bee-ladybug 0.5.3 → 0.6.0

package/src/adapters/python/PythonBridge.js

@@ -10,6 +10,7 @@
  *
  * ingest() is the same parser used by the socket, so tests and the mock
  * demo do not need a live Python process.
+ * `snapshot()` lists the latest metric received for each name.
  */
 
 export const PYTHON_BRIDGE_DEFAULTS = Object.freeze({
@@ -35,16 +36,27 @@ export class PythonBridge {
 
         this.#socket = null;
         this.#wanted = false;
+        this.#live = true;
         this.#timer = 0;
         this.#packets = 0;
         this.#retries = 0;
+        this.#metrics = new Map();
+        this.core?.registerAdapter('python', {
+            label: 'PYTHON',
+            enabled: true,
+            enable: () => this.#enable(),
+            disable: () => this.#disable(),
+            snapshot: () => this.snapshot()
+        });
     }
 
     #socket;
     #wanted;
+    #live;
     #timer;
     #packets;
     #retries;
+    #metrics;
 
     get connected() {
         return this.status === 'open';
@@ -53,6 +65,7 @@ export class PythonBridge {
     connect(url) {
         if (url) this.url = url;
         this.#wanted = true;
+        this.#live = true;
         this.#retries = 0;
         this.#open();
         return this;
@@ -77,6 +90,25 @@ export class PythonBridge {
         return this;
     }
 
+    /**
+     * Latest metric value for each name received through ingest().
+     * @returns {{ name: string, items: Array<{ severity: string, selector: string, rule: string, value: string, source: string }> }}
+     */
+    snapshot() {
+        const items = [];
+        for (const [name, metric] of this.#metrics) {
+            const unit = metric.unit ? ` ${metric.unit}` : '';
+            items.push({
+                severity: 'ok',
+                selector: name,
+                rule: 'metric',
+                value: `${metricText(metric.value)}${unit}`,
+                source: this.source
+            });
+        }
+        return { name: 'python', items };
+    }
+
     /**
      * Parse one wire message (object, JSON string, or array) into sendData().
      * @param {unknown} raw
@@ -117,6 +149,7 @@ export class PythonBridge {
         }
 
         const payload = unpackPayload(data, this.source);
+        if (type === 'metric') this.#rememberMetric(payload);
         this.#packets += 1;
         this.core.sendData(type, payload);
         this.core.sendData('state', {
@@ -128,7 +161,7 @@ export class PythonBridge {
     }
 
     #open() {
-        if (!this.#wanted) return;
+        if (!this.#wanted || !this.#live) return;
         if (typeof WebSocket === 'undefined') {
             this.core?.sendData('error', {
                 source: this.source,
@@ -205,7 +238,7 @@ export class PythonBridge {
     }
 
     #scheduleReconnect() {
-        if (!this.#wanted || !this.autoReconnect) return;
+        if (!this.#wanted || !this.#live || !this.autoReconnect) return;
         this.#clearTimer();
         this.#timer = setTimeout(() => this.#open(), this.reconnectMs);
     }
@@ -215,6 +248,39 @@ export class PythonBridge {
         this.#timer = 0;
     }
 
+    #enable() {
+        this.#live = true;
+        if (this.#wanted) this.#open();
+    }
+
+    #disable() {
+        this.#live = false;
+        this.#clearTimer();
+        const socket = this.#socket;
+        this.#socket = null;
+        if (socket) {
+            try {
+                socket.close();
+            } catch {
+                /* already closing */
+            }
+        }
+        if (this.status !== 'idle') this.#setStatus('closed');
+    }
+
+    #rememberMetric(payload) {
+        const name = typeof payload.name === 'string' && payload.name ? payload.name : 'metric';
+        if (this.#metrics.has(name)) this.#metrics.delete(name);
+        this.#metrics.set(name, {
+            value: payload.value,
+            unit: typeof payload.unit === 'string' ? payload.unit : ''
+        });
+        while (this.#metrics.size > 40) {
+            const oldest = this.#metrics.keys().next().value;
+            this.#metrics.delete(oldest);
+        }
+    }
+
     #setStatus(status) {
         this.status = status;
         this.core?.sendData('state', {
@@ -225,6 +291,12 @@ export class PythonBridge {
     }
 }
 
+function metricText(value) {
+    if (value == null) return '';
+    if (typeof value === 'object') return JSON.stringify(value);
+    return String(value);
+}
+
 function unpackPayload(data, source) {
     const body = data.payload != null && typeof data.payload === 'object' && !Array.isArray(data.payload)
         ? { ...data.payload }

package/src/core/BeeLadybugCore.js

@@ -8,13 +8,15 @@
 
 import { UIOverlay } from './UIOverlay.js';
 import { buildAssistantSnapshot, normalizeAssistant } from './AiAssistant.js';
+import { exportReport as writeReport } from './ReportExporter.js';
 
-export const BEE_LADYBUG_VERSION = '0.5.3';
+export const BEE_LADYBUG_VERSION = '0.6.0';
 
 export const CORE_DEFAULTS = Object.freeze({
     toggleKey: 'F2',
     slowKey: 'F3',
     freezeKey: 'F4',
+    exportKey: 'F8',
     slowScale: 0.25,
     maxLogs: 250,
     historySize: 120,
@@ -61,6 +63,7 @@ export class BeeLadybugCore {
         this.toggleKey = cfg.toggleKey;
         this.slowKey = cfg.slowKey;
         this.freezeKey = cfg.freezeKey;
+        this.exportKey = cfg.exportKey;
         this.slowScale = cfg.slowScale;
         this.maxLogs = cfg.maxLogs;
         this.historySize = cfg.historySize;
@@ -138,7 +141,7 @@ export class BeeLadybugCore {
     #detail;
     /** @type {Array<{ text: string, level?: string, onSelect?: () => void }>} */
     #issues;
-    /** @type {Map<string, { name: string, label: string, enabled: boolean, enable: Function, disable: Function }>} */
+    /** @type {Map<string, { name: string, label: string, hotkey: string, enabled: boolean, enable: Function, disable: Function, snapshot: Function | null }>} */
     #adapters;
 
     /**
@@ -295,7 +298,7 @@ export class BeeLadybugCore {
      * Register a toggleable diagnostic adapter. The core stores hooks only —
      * it does not import or special-case adapter modules.
      * @param {string} name
-     * @param {{ enable: () => void, disable: () => void, label?: string, hotkey?: string, enabled?: boolean }} hooks
+     * @param {{ enable: () => void, disable: () => void, label?: string, hotkey?: string, enabled?: boolean, snapshot?: () => { name?: string, items?: object[] } | null }} hooks
      */
     registerAdapter(name, hooks = {}) {
         const key = String(name || '').trim();
@@ -315,7 +318,8 @@ export class BeeLadybugCore {
             hotkey,
             enabled,
             enable: hooks.enable,
-            disable: hooks.disable
+            disable: hooks.disable,
+            snapshot: typeof hooks.snapshot === 'function' ? hooks.snapshot : null
         });
         this.sendData('sys', {
             op: 'adapter',
@@ -349,6 +353,30 @@ export class BeeLadybugCore {
         }));
     }
 
+    /**
+     * Ask every registered adapter for a report snapshot.
+     * Modules without a snapshot hook are skipped. The core does not read the rows.
+     * A thrown snapshot becomes `{ name, error }` so one module cannot abort the report.
+     * @returns {Array<{ name: string, result?: unknown, error?: string }>}
+     */
+    collectSnapshots() {
+        const out = [];
+        for (const entry of this.#adapters.values()) {
+            if (typeof entry.snapshot !== 'function') continue;
+            try {
+                const result = entry.snapshot();
+                if (result == null) continue;
+                out.push({ name: entry.name, result });
+            } catch (err) {
+                out.push({
+                    name: entry.name,
+                    error: err instanceof Error ? err.message : String(err)
+                });
+            }
+        }
+        return out;
+    }
+
     /**
      * Clickable rows inside the overlay. The core does not interpret them.
      * @param {Array<{ text: string, level?: string, onSelect?: () => void }>} items
@@ -535,6 +563,16 @@ export class BeeLadybugCore {
         return this;
     }
 
+    /**
+     * Build a telemetry report. HTML and CSV return a string; JSON returns
+     * the plain object. A mounted overlay downloads the file.
+     * @param {'html' | 'json' | 'csv'} [format]
+     * @returns {object | string}
+     */
+    exportReport(format = 'html') {
+        return writeReport(this, { format });
+    }
+
     applySlowMo() {
         if (this.frozen) this.unfreeze();
         const next = this.timeScale === this.slowScale ? 1 : this.slowScale;
@@ -749,6 +787,12 @@ export class BeeLadybugCore {
             return;
         }
 
+        if (code === this.exportKey) {
+            event.preventDefault();
+            this.exportReport('html');
+            return;
+        }
+
         if (!this.visible) return;
 
         if (code === this.slowKey) {