@electron-memory/monitor 0.1.0 → 0.2.1

package/dist/index.d.mts

@@ -206,6 +206,8 @@ interface MonitorConfig {
         height: number;
         /** 是否置顶，默认 false */
         alwaysOnTop: boolean;
+        /** 打开看板时是否自动打开 DevTools，默认 false；为 true 或环境变量 LAUNCHER_MEMORY_MONITOR_DEVTOOLS=1 时开启 */
+        openDevToolsOnStart: boolean;
     };
     /** 给窗口进程打标签，方便识别 */
     processLabels: Record<string, string>;
@@ -481,6 +483,12 @@ declare class ElectronMemoryMonitor extends EventEmitter {
     private mergeConfig;
 }
 
+/**
+ * 必须在 app.on('ready') 之前调用（与 new ElectronMemoryMonitor 同文件顶部或更早）。
+ * 由 ElectronMemoryMonitor 在启用时于构造函数内调用。
+ */
+declare function registerDashboardSchemePrivileged(): void;
+
 /**
  * IPC 通道常量定义
  * 所有通道以 'emm:' 为前缀，避免与业务 IPC 冲突
@@ -507,4 +515,4 @@ declare const IPC_CHANNELS: {
     readonly RENDERER_REQUEST: "emm:renderer:request";
 };
 
-export { type AnomalyCategory, type AnomalyEvent, type AnomalyRule, type AnomalySeverity, type CompareReport, ElectronMemoryMonitor, type EventMark, type GCResult, IPC_CHANNELS, type Improvement, type MemorySnapshot, type MetricDiff, type MetricSummary, type MonitorConfig, type ProcessMemoryInfo, type Regression, type RendererV8Detail, type SessionIndex, type SessionReport, type Suggestion, type SystemMemoryInfo, type TestSession, type TrendInfo, type V8HeapDetailStats, type V8HeapSpaceInfo, type V8HeapStats };
+export { type AnomalyCategory, type AnomalyEvent, type AnomalyRule, type AnomalySeverity, type CompareReport, ElectronMemoryMonitor, type EventMark, type GCResult, IPC_CHANNELS, type Improvement, type MemorySnapshot, type MetricDiff, type MetricSummary, type MonitorConfig, type ProcessMemoryInfo, type Regression, type RendererV8Detail, type SessionIndex, type SessionReport, type Suggestion, type SystemMemoryInfo, type TestSession, type TrendInfo, type V8HeapDetailStats, type V8HeapSpaceInfo, type V8HeapStats, registerDashboardSchemePrivileged };

package/dist/index.d.ts

@@ -206,6 +206,8 @@ interface MonitorConfig {
         height: number;
         /** 是否置顶，默认 false */
         alwaysOnTop: boolean;
+        /** 打开看板时是否自动打开 DevTools，默认 false；为 true 或环境变量 LAUNCHER_MEMORY_MONITOR_DEVTOOLS=1 时开启 */
+        openDevToolsOnStart: boolean;
     };
     /** 给窗口进程打标签，方便识别 */
     processLabels: Record<string, string>;
@@ -481,6 +483,12 @@ declare class ElectronMemoryMonitor extends EventEmitter {
     private mergeConfig;
 }
 
+/**
+ * 必须在 app.on('ready') 之前调用（与 new ElectronMemoryMonitor 同文件顶部或更早）。
+ * 由 ElectronMemoryMonitor 在启用时于构造函数内调用。
+ */
+declare function registerDashboardSchemePrivileged(): void;
+
 /**
  * IPC 通道常量定义
  * 所有通道以 'emm:' 为前缀，避免与业务 IPC 冲突
@@ -507,4 +515,4 @@ declare const IPC_CHANNELS: {
     readonly RENDERER_REQUEST: "emm:renderer:request";
 };
 
-export { type AnomalyCategory, type AnomalyEvent, type AnomalyRule, type AnomalySeverity, type CompareReport, ElectronMemoryMonitor, type EventMark, type GCResult, IPC_CHANNELS, type Improvement, type MemorySnapshot, type MetricDiff, type MetricSummary, type MonitorConfig, type ProcessMemoryInfo, type Regression, type RendererV8Detail, type SessionIndex, type SessionReport, type Suggestion, type SystemMemoryInfo, type TestSession, type TrendInfo, type V8HeapDetailStats, type V8HeapSpaceInfo, type V8HeapStats };
+export { type AnomalyCategory, type AnomalyEvent, type AnomalyRule, type AnomalySeverity, type CompareReport, ElectronMemoryMonitor, type EventMark, type GCResult, IPC_CHANNELS, type Improvement, type MemorySnapshot, type MetricDiff, type MetricSummary, type MonitorConfig, type ProcessMemoryInfo, type Regression, type RendererV8Detail, type SessionIndex, type SessionReport, type Suggestion, type SystemMemoryInfo, type TestSession, type TrendInfo, type V8HeapDetailStats, type V8HeapSpaceInfo, type V8HeapStats, registerDashboardSchemePrivileged };

package/dist/index.js

@@ -31,13 +31,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   ElectronMemoryMonitor: () => ElectronMemoryMonitor,
-  IPC_CHANNELS: () => IPC_CHANNELS
+  IPC_CHANNELS: () => IPC_CHANNELS,
+  registerDashboardSchemePrivileged: () => registerDashboardSchemePrivileged
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/core/monitor.ts
-var import_electron4 = require("electron");
-var path3 = __toESM(require("path"));
+var import_electron5 = require("electron");
+var path4 = __toESM(require("path"));
 var v82 = __toESM(require("v8"));
 var import_events3 = require("events");
 
@@ -1106,8 +1107,150 @@ var Analyzer = class {
 };
 
 // src/core/dashboard.ts
+var import_electron3 = require("electron");
+var path3 = __toESM(require("path"));
+
+// src/core/dashboard-protocol.ts
 var import_electron2 = require("electron");
+var import_promises = require("fs/promises");
 var path2 = __toESM(require("path"));
+var SCHEME = "emm-dashboard";
+var privilegedRegistered = false;
+var handlerRegistered = false;
+var MIME_BY_EXT = {
+  ".html": "text/html; charset=utf-8",
+  ".js": "text/javascript; charset=utf-8",
+  ".mjs": "text/javascript; charset=utf-8",
+  ".css": "text/css; charset=utf-8",
+  ".json": "application/json",
+  ".map": "application/json",
+  ".svg": "image/svg+xml",
+  ".png": "image/png",
+  ".jpg": "image/jpeg",
+  ".jpeg": "image/jpeg",
+  ".gif": "image/gif",
+  ".webp": "image/webp",
+  ".ico": "image/x-icon",
+  ".woff": "font/woff",
+  ".woff2": "font/woff2",
+  ".ttf": "font/ttf",
+  ".txt": "text/plain; charset=utf-8"
+};
+function isPathInsideRoot(filePath, root) {
+  const f = path2.resolve(filePath);
+  const r = path2.resolve(root);
+  if (f === r) {
+    return true;
+  }
+  const sep2 = r.endsWith(path2.sep) ? r : `${r}${path2.sep}`;
+  return f.startsWith(sep2);
+}
+function registerDashboardSchemePrivileged() {
+  if (privilegedRegistered) {
+    return;
+  }
+  privilegedRegistered = true;
+  import_electron2.protocol.registerSchemesAsPrivileged([
+    {
+      scheme: SCHEME,
+      privileges: {
+        standard: true,
+        secure: true,
+        supportFetchAPI: true,
+        corsEnabled: true,
+        stream: true
+      }
+    }
+  ]);
+}
+function ensureDashboardProtocolHandler(uiRoot) {
+  if (handlerRegistered) {
+    return;
+  }
+  if (!import_electron2.app.isReady()) {
+    throw new Error(
+      "[@electron-memory/monitor] ensureDashboardProtocolHandler: app must be ready before opening dashboard"
+    );
+  }
+  handlerRegistered = true;
+  const base = path2.resolve(uiRoot);
+  import_electron2.protocol.handle(SCHEME, async (request) => {
+    try {
+      const { pathname } = new URL(request.url);
+      let rel = pathname.startsWith("/") ? pathname.slice(1) : pathname;
+      if (!rel) {
+        rel = "index.html";
+      }
+      const filePath = path2.resolve(path2.join(base, rel));
+      if (!isPathInsideRoot(filePath, base)) {
+        return new Response("Forbidden", { status: 403 });
+      }
+      const body = await (0, import_promises.readFile)(filePath);
+      const ext = path2.extname(filePath).toLowerCase();
+      const mime = MIME_BY_EXT[ext] || "application/octet-stream";
+      return new Response(body, {
+        status: 200,
+        headers: {
+          "Content-Type": mime,
+          "Cache-Control": "no-store"
+        }
+      });
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : String(err);
+      return new Response(msg, { status: 404 });
+    }
+  });
+}
+function getDashboardPageURL() {
+  return `${SCHEME}://electron/index.html`;
+}
+
+// src/core/dashboard-window-hooks.ts
+function shouldOpenDevToolsShortcut(input) {
+  if (input.type !== "keyDown") {
+    return false;
+  }
+  if (input.key === "F12") {
+    return true;
+  }
+  const k = input.key.toLowerCase();
+  if (k !== "i") {
+    return false;
+  }
+  if (input.control && input.shift) {
+    return true;
+  }
+  if (process.platform === "darwin" && input.meta && input.alt) {
+    return true;
+  }
+  return false;
+}
+function attachDashboardWindowHooks(win, options) {
+  const wc = win.webContents;
+  wc.on("before-input-event", (event, input) => {
+    if (!shouldOpenDevToolsShortcut(input)) {
+      return;
+    }
+    event.preventDefault();
+    if (wc.isDevToolsOpened()) {
+      wc.closeDevTools();
+    } else {
+      wc.openDevTools({ mode: "detach" });
+    }
+  });
+  wc.on("did-fail-load", (_e, code, desc, url) => {
+    console.error("[@electron-memory/monitor] dashboard did-fail-load", code, desc, url);
+  });
+  let autoOpened = false;
+  wc.on("did-finish-load", () => {
+    if (options.openDevToolsOnStart && !autoOpened) {
+      autoOpened = true;
+      wc.openDevTools({ mode: "detach" });
+    }
+  });
+}
+
+// src/core/dashboard.ts
 var DashboardManager = class {
   constructor(config) {
     this.window = null;
@@ -1130,8 +1273,8 @@ var DashboardManager = class {
       this.window.focus();
       return;
     }
-    const preloadPath = path2.join(__dirname, "dashboard-preload.js");
-    this.window = new import_electron2.BrowserWindow({
+    const preloadPath = path3.join(__dirname, "dashboard-preload.js");
+    this.window = new import_electron3.BrowserWindow({
       width: this.config.dashboard.width,
       height: this.config.dashboard.height,
       title: "Electron Memory Monitor",
@@ -1139,11 +1282,16 @@ var DashboardManager = class {
       webPreferences: {
         preload: preloadPath,
         contextIsolation: true,
-        nodeIntegration: false
+        nodeIntegration: false,
+        devTools: true
       }
     });
-    const uiPath = path2.join(__dirname, "ui", "index.html");
-    this.window.loadFile(uiPath);
+    attachDashboardWindowHooks(this.window, {
+      openDevToolsOnStart: this.config.dashboard.openDevToolsOnStart
+    });
+    const uiRoot = path3.join(__dirname, "ui");
+    ensureDashboardProtocolHandler(uiRoot);
+    this.window.loadURL(getDashboardPageURL());
     this.window.on("closed", () => {
       this.window = null;
     });
@@ -1165,7 +1313,7 @@ var DashboardManager = class {
 };
 
 // src/ipc/main-handler.ts
-var import_electron3 = require("electron");
+var import_electron4 = require("electron");
 
 // src/ipc/channels.ts
 var IPC_CHANNELS = {
@@ -1203,49 +1351,49 @@ var IPCMainHandler = class {
   }
   /** 注册所有 IPC handlers */
   register() {
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_START, (_event, args) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_START, (_event, args) => {
       return this.monitor.startSession(args.label, args.description);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_STOP, async () => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_STOP, async () => {
       return this.monitor.stopSession();
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_LIST, async () => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_LIST, async () => {
       return this.monitor.getSessions();
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_REPORT, async (_event, sessionId) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_REPORT, async (_event, sessionId) => {
       return this.monitor.getSessionReport(sessionId);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_COMPARE, async (_event, args) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_COMPARE, async (_event, args) => {
       return this.monitor.compareSessions(args.baseId, args.targetId);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_SNAPSHOTS, async (_event, args) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_SNAPSHOTS, async (_event, args) => {
       return this.monitor.getSessionSnapshots(args.sessionId, args.startTime, args.endTime, args.maxPoints);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.TRIGGER_GC, async () => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.TRIGGER_GC, async () => {
       return this.monitor.triggerGC();
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.HEAP_SNAPSHOT, async (_event, filePath) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.HEAP_SNAPSHOT, async (_event, filePath) => {
       return this.monitor.takeHeapSnapshot(filePath);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.MARK, (_event, args) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.MARK, (_event, args) => {
       this.monitor.mark(args.label, args.metadata);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.GET_CONFIG, () => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.GET_CONFIG, () => {
       return this.monitor.getConfig();
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.GET_SESSIONS, async () => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.GET_SESSIONS, async () => {
       return this.monitor.getSessions();
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_EXPORT, async (_event, sessionId) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_EXPORT, async (_event, sessionId) => {
       return this.monitor.exportSession(sessionId);
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_IMPORT, async () => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_IMPORT, async () => {
       return this.monitor.importSession();
     });
-    import_electron3.ipcMain.handle(IPC_CHANNELS.SESSION_DELETE, async (_event, sessionId) => {
+    import_electron4.ipcMain.handle(IPC_CHANNELS.SESSION_DELETE, async (_event, sessionId) => {
       return this.monitor.deleteSession(sessionId);
     });
-    import_electron3.ipcMain.on(IPC_CHANNELS.RENDERER_REPORT, (_event, detail) => {
+    import_electron4.ipcMain.on(IPC_CHANNELS.RENDERER_REPORT, (_event, detail) => {
       this.monitor.updateRendererDetail(detail);
     });
   }
@@ -1265,8 +1413,8 @@ var IPCMainHandler = class {
   unregister() {
     const channels = Object.values(IPC_CHANNELS);
     for (const channel of channels) {
-      import_electron3.ipcMain.removeHandler(channel);
-      import_electron3.ipcMain.removeAllListeners(channel);
+      import_electron4.ipcMain.removeHandler(channel);
+      import_electron4.ipcMain.removeAllListeners(channel);
     }
   }
 };
@@ -1294,7 +1442,8 @@ var DEFAULT_CONFIG = {
   dashboard: {
     width: 1400,
     height: 900,
-    alwaysOnTop: false
+    alwaysOnTop: false,
+    openDevToolsOnStart: false
   },
   processLabels: {}
 };
@@ -1313,6 +1462,7 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
       this.dashboard = null;
       return;
     }
+    registerDashboardSchemePrivileged();
     this.collector = new MemoryCollector(this.config);
     this.anomalyDetector = new AnomalyDetector(this.config);
     this.analyzer = new Analyzer();
@@ -1325,10 +1475,10 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
   /** 启动监控 */
   async start() {
     if (!this.config.enabled || this.started) return;
-    if (!import_electron4.app.isReady()) {
-      await import_electron4.app.whenReady();
+    if (!import_electron5.app.isReady()) {
+      await import_electron5.app.whenReady();
     }
-    const storageDir = this.config.storage.directory || path3.join(import_electron4.app.getPath("userData"), "memory-monitor");
+    const storageDir = this.config.storage.directory || path4.join(import_electron5.app.getPath("userData"), "memory-monitor");
     this.persister = new DataPersister(this.config, storageDir);
     this.sessionManager = new SessionManager(this.persister);
     this.ipcHandler = new IPCMainHandler(this);
@@ -1400,7 +1550,7 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
       anomalies,
       completedSession.dataFile
     );
-    const reportPath = path3.join(this.persister.getStorageDir(), completedSession.id, "report.json");
+    const reportPath = path4.join(this.persister.getStorageDir(), completedSession.id, "report.json");
     const fs2 = await import("fs");
     fs2.writeFileSync(reportPath, JSON.stringify(report, null, 2), "utf-8");
     this.emit("session-end", report);
@@ -1430,7 +1580,7 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
   /** 获取指定会话报告 */
   async getSessionReport(sessionId) {
     const fs2 = await import("fs");
-    const reportPath = path3.join(this.persister.getStorageDir(), sessionId, "report.json");
+    const reportPath = path4.join(this.persister.getStorageDir(), sessionId, "report.json");
     try {
       const content = fs2.readFileSync(reportPath, "utf-8");
       return JSON.parse(content);
@@ -1561,7 +1711,7 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
       } catch {
       }
     }
-    await new Promise((resolve) => setTimeout(resolve, 100));
+    await new Promise((resolve2) => setTimeout(resolve2, 100));
     const afterMem = process.memoryUsage();
     const freed = beforeMem.heapUsed - afterMem.heapUsed;
     return {
@@ -1574,7 +1724,7 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
   }
   /** 导出堆快照 */
   async takeHeapSnapshot(filePath) {
-    const snapshotPath = filePath || path3.join(
+    const snapshotPath = filePath || path4.join(
       this.persister.getStorageDir(),
       `heap-${Date.now()}.heapsnapshot`
     );
@@ -1609,7 +1759,15 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
     this.emit("snapshot", snapshot);
   }
   mergeConfig(userConfig) {
-    if (!userConfig) return { ...DEFAULT_CONFIG };
+    if (!userConfig) {
+      return {
+        ...DEFAULT_CONFIG,
+        dashboard: {
+          ...DEFAULT_CONFIG.dashboard,
+          openDevToolsOnStart: process.env.LAUNCHER_MEMORY_MONITOR_DEVTOOLS === "1"
+        }
+      };
+    }
     return {
       ...DEFAULT_CONFIG,
       ...userConfig,
@@ -1623,7 +1781,8 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
       },
       dashboard: {
         ...DEFAULT_CONFIG.dashboard,
-        ...userConfig.dashboard || {}
+        ...userConfig.dashboard || {},
+        openDevToolsOnStart: userConfig.dashboard?.openDevToolsOnStart !== void 0 ? userConfig.dashboard.openDevToolsOnStart : process.env.LAUNCHER_MEMORY_MONITOR_DEVTOOLS === "1"
       },
       processLabels: {
         ...DEFAULT_CONFIG.processLabels,
@@ -1635,6 +1794,7 @@ var ElectronMemoryMonitor = class extends import_events3.EventEmitter {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ElectronMemoryMonitor,
-  IPC_CHANNELS
+  IPC_CHANNELS,
+  registerDashboardSchemePrivileged
 });
 //# sourceMappingURL=index.js.map