Merged in release/1.0.7 (pull request #5)

Release/1.0.7
This commit is contained in:
Patrick Fic
2025-10-30 18:11:21 +00:00
13 changed files with 2906 additions and 2648 deletions

View File

@@ -22,6 +22,7 @@ win:
endpoint: https://eus.codesigning.azure.net endpoint: https://eus.codesigning.azure.net
certificateProfileName: ImEXRPS certificateProfileName: ImEXRPS
codeSigningAccountName: ImEX codeSigningAccountName: ImEX
publisherName: ImEX Systems Inc.
nsis: nsis:
artifactName: imex-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext} artifactName: imex-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext}
shortcutName: ${productName} shortcutName: ${productName}
@@ -50,14 +51,6 @@ mac:
- x64 - x64
dmg: dmg:
artifactName: imex-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext} artifactName: imex-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext}
linux:
target:
- AppImage
- snap
- deb
maintainer: electronjs.org
category: Utility
desktop: scripts/imex-shop-partner.desktop
appImage: appImage:
artifactName: imex-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext} artifactName: imex-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext}
npmRebuild: false npmRebuild: false

View File

@@ -22,6 +22,7 @@ win:
endpoint: https://eus.codesigning.azure.net endpoint: https://eus.codesigning.azure.net
certificateProfileName: ImEXRPS certificateProfileName: ImEXRPS
codeSigningAccountName: ImEX codeSigningAccountName: ImEX
publisherName: ImEX Systems Inc.
nsis: nsis:
artifactName: rome-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext} artifactName: rome-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext}
shortcutName: ${productName} shortcutName: ${productName}
@@ -51,14 +52,6 @@ mac:
- x64 - x64
dmg: dmg:
artifactName: rome-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext} artifactName: rome-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext}
linux:
target:
- AppImage
- snap
- deb
maintainer: electronjs.org
category: Utility
desktop: scripts/rome-shop-partner.desktop
appImage: appImage:
artifactName: rome-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext} artifactName: rome-partner-${env.ARTIFACT_SUFFIX}${arch}.${ext}
npmRebuild: false npmRebuild: false

View File

@@ -6,10 +6,18 @@ import react from "@vitejs/plugin-react";
export default defineConfig({ export default defineConfig({
main: { main: {
plugins: [ plugins: [
externalizeDepsPlugin(), externalizeDepsPlugin({
exclude: ["electron-store"],
}),
sentryVitePlugin({ sentryVitePlugin({
org: "imex", org: "imex",
project: "imex-partner", project: "imex-partner",
sourcemaps: {
filesToDeleteAfterUpload: ["**.js.map"],
},
release: {
name: `bodyshop-desktop@${process.env.npm_package_version}`,
},
}), }),
], ],
build: { build: {
@@ -32,6 +40,12 @@ export default defineConfig({
sentryVitePlugin({ sentryVitePlugin({
org: "imex", org: "imex",
project: "imex-partner", project: "imex-partner",
sourcemaps: {
filesToDeleteAfterUpload: ["**.js.map"],
},
release: {
name: `bodyshop-desktop@${process.env.npm_package_version}`,
},
}), }),
], ],
build: { build: {

4934
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{ {
"name": "bodyshop-desktop", "name": "bodyshop-desktop",
"version": "1.0.6", "version": "1.0.7",
"description": "Shop Management System Partner", "description": "Shop Management System Partner",
"main": "./out/main/index.js", "main": "./out/main/index.js",
"author": "Convenient Brands, LLC", "author": "Convenient Brands, LLC",
@@ -27,66 +27,65 @@
}, },
"dependencies": { "dependencies": {
"@apollo/client": "^3.13.6", "@apollo/client": "^3.13.6",
"@electron-toolkit/preload": "^3.0.1", "@electron-toolkit/preload": "^3.0.2",
"@electron-toolkit/utils": "^4.0.0", "@electron-toolkit/utils": "^4.0.0",
"@sentry/electron": "^6.5.0", "@sentry/electron": "^7.2.0",
"@sentry/vite-plugin": "^3.3.1", "@sentry/vite-plugin": "^4.5.0",
"axios": "^1.9.0", "axios": "^1.12.2",
"dayjs": "^1.11.13", "dayjs": "^1.11.18",
"electron-log": "^5.3.3", "electron-log": "^5.4.3",
"electron-store": "^8.2.0",
"electron-updater": "^6.6.2", "electron-updater": "^6.6.2",
"winax": "^3.6.2" "winax": "^3.6.2"
}, },
"devDependencies": { "devDependencies": {
"@ant-design/v5-patch-for-react-19": "^1.0.3", "@ant-design/v5-patch-for-react-19": "^1.0.3",
"@electron-toolkit/eslint-config-prettier": "^3.0.0", "@electron-toolkit/eslint-config-prettier": "^3.0.0",
"@electron-toolkit/eslint-config-ts": "^3.0.0", "@electron-toolkit/eslint-config-ts": "^3.1.0",
"@electron-toolkit/tsconfig": "^1.0.1", "@electron-toolkit/tsconfig": "^2.0.0",
"@playwright/test": "^1.51.1", "@playwright/test": "^1.56.1",
"@reduxjs/toolkit": "^2.6.1", "@reduxjs/toolkit": "^2.9.1",
"@types/cors": "^2.8.17", "@types/cors": "^2.8.19",
"@types/express": "^5.0.1", "@types/express": "^5.0.3",
"@types/lodash": "^4.17.16", "@types/lodash": "^4.17.20",
"@types/node": "^22.14.0", "@types/node": "^24.9.1",
"@types/node-cron": "^3.0.11", "@types/node-cron": "^3.0.11",
"@types/react": "^19.1.0", "@types/react": "^19.2.2",
"@types/react-dom": "^19.1.2", "@types/react-dom": "^19.2.2",
"@types/xml2js": "^0.4.14", "@types/xml2js": "^0.4.14",
"@vitejs/plugin-react": "^4.3.4", "@vitejs/plugin-react": "^5.0.4",
"antd": "^5.24.6", "antd": "^5.27.6",
"archiver": "^7.0.1", "archiver": "^7.0.1",
"chokidar": "^4.0.3", "chokidar": "^4.0.3",
"cors": "^2.8.5", "cors": "^2.8.5",
"cross-env": "^10.0.0", "cross-env": "^10.1.0",
"dbffile": "^1.12.0", "dbffile": "^1.12.0",
"electron": "^35.1.5", "electron": "^38.3.0",
"electron-builder": "^25.1.8", "electron-builder": "^26.0.12",
"electron-store": "^8.2.0", "electron-store": "^11.0.2",
"electron-vite": "^3.1.0", "electron-vite": "^4.0.1",
"eslint": "^9.24.0", "eslint": "^9.38.0",
"eslint-plugin-react": "^7.37.5", "eslint-plugin-react": "^7.37.5",
"eslint-plugin-react-hooks": "^5.2.0", "eslint-plugin-react-hooks": "^7.0.0",
"eslint-plugin-react-refresh": "^0.4.19", "eslint-plugin-react-refresh": "^0.4.24",
"express": "^5.1.0", "express": "^5.1.0",
"firebase": "^11.6.0", "firebase": "^12.4.0",
"graphql": "^16.10.0", "graphql": "^16.11.0",
"graphql-request": "^7.1.2", "graphql-request": "^7.3.1",
"i18next": "^24.2.3", "i18next": "^25.6.0",
"lodash": "^4.17.21", "lodash": "^4.17.21",
"node-cron": "^3.0.3", "node-cron": "^4.2.1",
"playwright": "^1.51.1", "playwright": "^1.56.1",
"prettier": "^3.5.3", "prettier": "^3.6.2",
"react": "^19.1.0", "react": "^19.2.0",
"react-dom": "^19.1.0", "react-dom": "^19.2.0",
"react-error-boundary": "^5.0.0", "react-error-boundary": "^6.0.0",
"react-i18next": "^15.4.1", "react-i18next": "^16.1.4",
"react-redux": "^9.2.0", "react-redux": "^9.2.0",
"react-router": "^7.5.0", "react-router": "^7.9.4",
"redux-logger": "^3.0.6", "redux-logger": "^3.0.6",
"typescript": "^5.8.3", "typescript": "^5.9.3",
"vite": "6.2.6", "vite": "7.1.11",
"xml2js": "^0.6.2", "xml2js": "^0.6.2",
"xmlbuilder2": "^3.1.1" "xmlbuilder2": "^4.0.0"
} }
} }

View File

@@ -4,6 +4,7 @@ import { GraphQLClient, RequestMiddleware } from "graphql-request";
import errorTypeCheck from "../../util/errorTypeCheck.js"; import errorTypeCheck from "../../util/errorTypeCheck.js";
import ipcTypes from "../../util/ipcTypes.json"; import ipcTypes from "../../util/ipcTypes.json";
import store from "../store/store.js"; import store from "../store/store.js";
import getMainWindow from "../../util/getMainWindow.js";
const requestMiddleware: RequestMiddleware = async (request) => { const requestMiddleware: RequestMiddleware = async (request) => {
const token = await getTokenFromRenderer(); const token = await getTokenFromRenderer();
@@ -32,9 +33,9 @@ const client: GraphQLClient = new GraphQLClient(
export async function getTokenFromRenderer(): Promise<string> { export async function getTokenFromRenderer(): Promise<string> {
return new Promise((resolve) => { return new Promise((resolve) => {
try { try {
const mainWindow = BrowserWindow.getAllWindows()[0]; //TODO: Filter to only main window once a proper key has been set. const mainWindow = getMainWindow();
//TODO: Verify that this will work if the app is minimized/closed. //TODO: Verify that this will work if the app is minimized/closed.
mainWindow.webContents.send(ipcTypes.toRenderer.user.getToken); mainWindow?.webContents.send(ipcTypes.toRenderer.user.getToken);
} catch (error) { } catch (error) {
log.error( log.error(
"Unable to send request to renderer process for token", "Unable to send request to renderer process for token",

View File

@@ -36,6 +36,7 @@ import {
setupKeepAliveTask, setupKeepAliveTask,
} from "./setup-keep-alive-task"; } from "./setup-keep-alive-task";
import ensureWindowOnScreen from "./util/ensureWindowOnScreen"; import ensureWindowOnScreen from "./util/ensureWindowOnScreen";
import ongoingMemoryDump, { dumpMemoryStatsToFile } from "../util/memUsage";
const appIconToUse = const appIconToUse =
import.meta.env.VITE_COMPANY === "IMEX" ? imexAppIcon : romeAppIcon; import.meta.env.VITE_COMPANY === "IMEX" ? imexAppIcon : romeAppIcon;
@@ -45,6 +46,13 @@ Sentry.init({
}); });
log.initialize(); log.initialize();
// Configure log format to include process ID
log.transports.file.format =
"[{y}-{m}-{d} {h}:{i}:{s}.{ms}] [{level}] [PID:{processId}] {text}";
log.transports.console.format =
"[{y}-{m}-{d} {h}:{i}:{s}.{ms}] [{level}] [PID:{processId}] {text}";
log.transports.file.maxSize = 50 * 1024 * 1024; // 50 MB
const isMac: boolean = process.platform === "darwin"; const isMac: boolean = process.platform === "darwin";
const protocol: string = "imexmedia"; const protocol: string = "imexmedia";
let isAppQuitting = false; //Needed on Mac as an override to allow us to fully quit the app. let isAppQuitting = false; //Needed on Mac as an override to allow us to fully quit the app.
@@ -53,6 +61,14 @@ let isKeepAliveLaunch = false; // Track if launched via keep-alive
const localServer = new LocalServer(); const localServer = new LocalServer();
const gotTheLock = app.requestSingleInstanceLock(); const gotTheLock = app.requestSingleInstanceLock();
if (!gotTheLock) {
log.warn(
"Another instance is already running and could not obtain mutex lock. Exiting this instance.",
);
isAppQuitting = true;
app.quit(); // Quit the app if another instance is already running
}
function createWindow(): void { function createWindow(): void {
// Create the browser window. // Create the browser window.
const { width, height, x, y } = store.get("app.windowBounds") as { const { width, height, x, y } = store.get("app.windowBounds") as {
@@ -252,6 +268,27 @@ function createWindow(): void {
{ {
type: "separator", type: "separator",
}, },
{
label: "Enable Memory Logging",
checked: store.get("settings.enableMemDebug") as boolean,
type: "checkbox",
click: (): void => {
const currentSetting = store.get(
"settings.enableMemDebug",
) as boolean;
store.set("settings.enableMemDebug", !currentSetting);
log.info("Enable Memory Logging set to", !currentSetting);
},
},
{
label: "Dump Memory Stats Now",
click: (): void => {
dumpMemoryStatsToFile();
},
},
{
type: "separator",
},
// { // {
// label: "Decode Hardcoded Estimate", // label: "Decode Hardcoded Estimate",
// click: (): void => { // click: (): void => {
@@ -429,9 +466,6 @@ function createWindow(): void {
} }
} }
if (!gotTheLock) {
app.quit(); // Quit the app if another instance is already running
}
// This method will be called when Electron has finished // This method will be called when Electron has finished
// initialization and is ready to create browser windows. // initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs. // Some APIs can only be used after this event occurs.
@@ -439,6 +473,8 @@ app.whenReady().then(async () => {
// Default open or close DevTools by F12 in development // Default open or close DevTools by F12 in development
// and ignore CommandOrControl + R in production. // and ignore CommandOrControl + R in production.
// see https://github.com/alex8088/electron-toolkit/tree/master/packages/utils // see https://github.com/alex8088/electron-toolkit/tree/master/packages/utils
log.debug("App is ready, initializing shortcuts and protocol handlers.");
if (platform.isWindows) { if (platform.isWindows) {
app.setAppUserModelId("Shop Partner"); app.setAppUserModelId("Shop Partner");
} }
@@ -470,21 +506,6 @@ app.whenReady().then(async () => {
log.warn("Failed to register protocol handler."); log.warn("Failed to register protocol handler.");
} }
// Add this event handler for second instance
app.on("second-instance", (_event: Electron.Event, argv: string[]) => {
const url = argv.find((arg) => arg.startsWith(`${protocol}://`));
if (url) {
if (url.startsWith(`${protocol}://keep-alive`)) {
log.info("Keep-alive protocol received, app is already running.");
// Do nothing if already running
return;
} else {
openInExplorer(url);
}
}
// No action taken if no URL is provided
});
//Dynamically load ipcMain handlers once ready. //Dynamically load ipcMain handlers once ready.
try { try {
const { initializeCronTasks } = await import("./ipc/ipcMainConfig"); const { initializeCronTasks } = await import("./ipc/ipcMainConfig");
@@ -546,19 +567,19 @@ app.whenReady().then(async () => {
autoUpdater.on("checking-for-update", () => { autoUpdater.on("checking-for-update", () => {
log.info("Checking for update..."); log.info("Checking for update...");
const mainWindow = BrowserWindow.getAllWindows()[0]; const mainWindow = getMainWindow();
mainWindow?.webContents.send(ipcTypes.toRenderer.updates.checking); mainWindow?.webContents.send(ipcTypes.toRenderer.updates.checking);
}); });
autoUpdater.on("update-available", (info) => { autoUpdater.on("update-available", (info) => {
log.info("Update available.", info); log.info("Update available.", info);
const mainWindow = BrowserWindow.getAllWindows()[0]; const mainWindow = getMainWindow();
mainWindow?.webContents.send(ipcTypes.toRenderer.updates.available, info); mainWindow?.webContents.send(ipcTypes.toRenderer.updates.available, info);
}); });
autoUpdater.on("download-progress", (progress) => { autoUpdater.on("download-progress", (progress) => {
log.info(`Download speed: ${progress.bytesPerSecond}`); log.info(`Download speed: ${progress.bytesPerSecond}`);
log.info(`Downloaded ${progress.percent}%`); log.info(`Downloaded ${progress.percent}%`);
log.info(`Total downloaded ${progress.transferred}/${progress.total}`); log.info(`Total downloaded ${progress.transferred}/${progress.total}`);
const mainWindow = BrowserWindow.getAllWindows()[0]; const mainWindow = getMainWindow();
mainWindow?.webContents.send( mainWindow?.webContents.send(
ipcTypes.toRenderer.updates.downloading, ipcTypes.toRenderer.updates.downloading,
progress, progress,
@@ -566,7 +587,7 @@ app.whenReady().then(async () => {
}); });
autoUpdater.on("update-downloaded", (info) => { autoUpdater.on("update-downloaded", (info) => {
log.info("Update downloaded", info); log.info("Update downloaded", info);
const mainWindow = BrowserWindow.getAllWindows()[0]; const mainWindow = getMainWindow();
mainWindow?.webContents.send(ipcTypes.toRenderer.updates.downloaded, info); mainWindow?.webContents.send(ipcTypes.toRenderer.updates.downloaded, info);
}); });
@@ -577,7 +598,8 @@ app.whenReady().then(async () => {
} }
//The update itself will run when the bodyshop record is queried to know what release channel to use. //The update itself will run when the bodyshop record is queried to know what release channel to use.
createWindow(); openMainWindow();
ongoingMemoryDump();
app.on("activate", function () { app.on("activate", function () {
openMainWindow(); openMainWindow();
@@ -595,6 +617,24 @@ app.on("open-url", (event: Electron.Event, url: string) => {
} }
}); });
// Add this event handler for second instance
app.on("second-instance", (_event: Electron.Event, argv: string[]) => {
const url = argv.find((arg) => arg.startsWith(`${protocol}://`));
if (url) {
if (url.startsWith(`${protocol}://keep-alive`)) {
log.info(
"Keep-alive protocol received, app is already running. Nothing to do.",
);
// Do nothing if already running
return;
} else {
log.info("Received Media URL: ", url);
openInExplorer(url);
}
}
// No action taken if no URL is provided
});
// Quit when all windows are closed, except on macOS. There, it's common // Quit when all windows are closed, except on macOS. There, it's common
// for applications and their menu bar to stay active until the user quits // for applications and their menu bar to stay active until the user quits
// explicitly with Cmd + Q. // explicitly with Cmd + Q.
@@ -604,8 +644,7 @@ app.on("window-all-closed", () => {
} }
}); });
app.on("before-quit", (props) => { app.on("before-quit", () => {
console.log(props);
preQuitMethods(); preQuitMethods();
}); });
@@ -635,7 +674,7 @@ function preQuitMethods(): void {
} }
function openMainWindow(): void { function openMainWindow(): void {
const mainWindow = BrowserWindow.getAllWindows()[0]; const mainWindow = getMainWindow();
if (mainWindow) { if (mainWindow) {
mainWindow.show(); mainWindow.show();
} else { } else {

View File

@@ -9,6 +9,7 @@ const store = new Store({
emsOutFilePath: null, emsOutFilePath: null,
qbFilePath: "", qbFilePath: "",
runWatcherOnStartup: true, runWatcherOnStartup: true,
enableMemDebug: false,
polling: { polling: {
enabled: false, enabled: false,
interval: 30000, interval: 30000,

View File

@@ -1,14 +1,19 @@
import { autoUpdater } from "electron-updater"; import { autoUpdater } from "electron-updater";
import { setReleaseChannel } from "../ipc/ipcMainHandler.user"; import { setReleaseChannel } from "../ipc/ipcMainHandler.user";
let continuousUpdatesTriggered = false;
async function checkForAppUpdatesContinuously(): Promise<void> { async function checkForAppUpdatesContinuously(): Promise<void> {
checkForAppUpdates(); if (!continuousUpdatesTriggered) {
setInterval( continuousUpdatesTriggered = true;
() => { checkForAppUpdates();
checkForAppUpdatesContinuously(); setInterval(
}, () => {
1000 * 60 * 30, checkForAppUpdates();
); },
1000 * 60 * 30,
);
}
} }
async function checkForAppUpdates(): Promise<void> { async function checkForAppUpdates(): Promise<void> {
await setReleaseChannel(); await setReleaseChannel();

View File

@@ -7,6 +7,7 @@ import errorTypeCheck from "../../util/errorTypeCheck";
import ipcTypes from "../../util/ipcTypes.json"; import ipcTypes from "../../util/ipcTypes.json";
import ImportJob from "../decoder/decoder"; import ImportJob from "../decoder/decoder";
import store from "../store/store"; import store from "../store/store";
import getMainWindow from "../../util/getMainWindow";
let watcher: FSWatcher | null; let watcher: FSWatcher | null;
async function StartWatcher(): Promise<boolean> { async function StartWatcher(): Promise<boolean> {
@@ -107,23 +108,23 @@ function addWatcherPath(path: string | string[]): void {
function onWatcherReady(): void { function onWatcherReady(): void {
if (watcher) { if (watcher) {
const mainWindow = BrowserWindow.getAllWindows()[0]; //TODO: Filter to only main window once a proper key has been set. const mainWindow = getMainWindow();
new Notification({ new Notification({
title: "Watcher Started", title: "Watcher Started",
body: "Newly exported estimates will be automatically uploaded.", body: "Newly exported estimates will be automatically uploaded.",
}).show(); }).show();
log.info("Confirmed watched paths:", watcher.getWatched()); log.info("Confirmed watched paths:", watcher.getWatched());
mainWindow.webContents.send(ipcTypes.toRenderer.watcher.started); mainWindow?.webContents.send(ipcTypes.toRenderer.watcher.started);
} }
} }
async function StopWatcher(): Promise<boolean> { async function StopWatcher(): Promise<boolean> {
const mainWindow = BrowserWindow.getAllWindows()[0]; //TODO: Filter to only main window once a proper key has been set. const mainWindow = getMainWindow();
if (watcher) { if (watcher) {
await watcher.close(); await watcher.close();
log.info("Watcher stopped."); log.info("Watcher stopped.");
mainWindow.webContents.send(ipcTypes.toRenderer.watcher.stopped); mainWindow?.webContents.send(ipcTypes.toRenderer.watcher.stopped);
new Notification({ new Notification({
title: "Watcher Stopped", title: "Watcher Stopped",

View File

@@ -0,0 +1,5 @@
import { BrowserWindow } from "electron";
export default function getMainWindow(): BrowserWindow | null {
return BrowserWindow.getAllWindows()[0] || null;
}

309
src/util/memUsage.ts Normal file
View File

@@ -0,0 +1,309 @@
import { BrowserWindow } from "electron";
import log from "electron-log/main";
import fs from "fs";
import os from "os";
import path from "path";
import Store from "../main/store/store";
/**
* Human-readable memory/cpu/resource snapshot.
*/
export type MemoryUsageStats = {
timestamp: string;
label?: string;
uptimeSeconds: number;
pid: number;
memory: {
rss: number;
heapTotal: number;
heapUsed: number;
external: number;
arrayBuffers?: number;
};
memoryPretty: {
rss: string;
heapTotal: string;
heapUsed: string;
external: string;
arrayBuffers?: string;
};
os: {
totalMem: number;
freeMem: number;
freeMemPercent: number;
};
cpuUsage?: NodeJS.CpuUsage;
resourceUsage?: NodeJS.ResourceUsage;
heapSpaces?: Array<import("v8").HeapSpaceInfo>;
heapSnapshotFile?: string;
custom?: Record<string, unknown>;
};
// (merged into top import)
/**
* Options for dumpMemoryStats.
*/
export type DumpOptions = {
/**
* Call global.gc() before sampling if available (requires node run with --expose-gc).
*/
runGc?: boolean;
/**
* Optional label to include in the returned snapshot.
*/
label?: string;
includeHeapSpaces?: boolean;
writeHeapSnapshot?: boolean;
heapSnapshotDir?: string;
};
/**
* Convert bytes to a compact human readable string.
*/
function formatBytes(bytes: number): string {
if (!isFinite(bytes)) return String(bytes);
const units = ["B", "KB", "MB", "GB", "TB"];
let i = 0;
let val = bytes;
while (val >= 1024 && i < units.length - 1) {
val /= 1024;
i++;
}
return `${val.toFixed(2)} ${units[i]}`;
}
/**
* Asynchronously produce a memory / cpu / os snapshot.
*
* Example:
* const stats = await dumpMemoryStats({ runGc: true, label: 'before-heavy-task' });
*/
export async function dumpMemoryStats(
options: DumpOptions = {},
): Promise<MemoryUsageStats> {
const {
runGc = false,
label,
includeHeapSpaces = true,
writeHeapSnapshot = true,
heapSnapshotDir,
} = options;
// Allow GC if requested and available to get a cleaner snapshot
if (runGc && typeof (global as any).gc === "function") {
try {
(global as any).gc();
} catch {
// ignore GC errors
}
}
// Let the event loop settle a tick so GC can complete if run
await new Promise((resolve) => setImmediate(resolve));
const mem = process.memoryUsage();
const totalMem = os.totalmem();
const freeMem = os.freemem();
const stats: MemoryUsageStats = {
timestamp: new Date().toISOString(),
label,
uptimeSeconds: Math.floor(process.uptime()),
pid: process.pid,
memory: {
rss: mem.rss,
heapTotal: mem.heapTotal,
heapUsed: mem.heapUsed,
external: mem.external,
arrayBuffers: mem.arrayBuffers,
},
memoryPretty: {
rss: formatBytes(mem.rss),
heapTotal: formatBytes(mem.heapTotal),
heapUsed: formatBytes(mem.heapUsed),
external: formatBytes(mem.external),
arrayBuffers:
mem.arrayBuffers !== undefined
? formatBytes(mem.arrayBuffers)
: undefined,
},
os: {
totalMem,
freeMem,
freeMemPercent: Math.round((freeMem / totalMem) * 10000) / 100,
},
cpuUsage: process.cpuUsage ? process.cpuUsage() : undefined,
resourceUsage:
typeof process.resourceUsage === "function"
? process.resourceUsage()
: undefined,
custom: {
numBrowserWindows: BrowserWindow.getAllWindows().length,
},
};
if (includeHeapSpaces) {
try {
// eslint-disable-next-line @typescript-eslint/no-var-requires
const v8: typeof import("v8") = require("v8");
if (typeof v8.getHeapSpaceStatistics === "function") {
stats.heapSpaces = v8.getHeapSpaceStatistics();
}
} catch (err) {
log.warn("Failed to get heap space stats", err);
}
}
if (writeHeapSnapshot) {
try {
if (!runGc && typeof (global as any).gc === "function") {
try {
(global as any).gc();
} catch {
/* ignore */
}
}
// eslint-disable-next-line @typescript-eslint/no-var-requires
const v8: typeof import("v8") = require("v8");
if (typeof v8.writeHeapSnapshot === "function") {
const baseDir =
heapSnapshotDir || path.dirname(log.transports.file.getFile().path);
const dir = path.join(baseDir, "heap-snapshots");
fs.mkdirSync(dir, { recursive: true });
const fileName = `heap-${Date.now()}-${process.pid}.heapsnapshot`;
const filePath = path.join(dir, fileName);
const snapshotPath = v8.writeHeapSnapshot(filePath);
stats.heapSnapshotFile = snapshotPath;
} else {
log.warn("v8.writeHeapSnapshot not available");
}
} catch (err) {
log.warn("Failed to write heap snapshot", err);
}
}
return stats;
}
const memLogger = log.create({ logId: "mem-stat" });
memLogger.transports.file.resolvePathFn = () => {
const filePath = path.join(
path.dirname(log.transports.file.getFile().path),
"memory-stats.log",
);
return filePath;
};
// Configure memory logger format to include process ID
memLogger.transports.file.format =
"[{y}-{m}-{d} {h}:{i}:{s}.{ms}] [{level}] [PID:{processId}] {text}";
memLogger.transports.console.format =
"[{y}-{m}-{d} {h}:{i}:{s}.{ms}] [{level}] [PID:{processId}] {text}";
export async function dumpMemoryStatsToFile() {
try {
const stats = await dumpMemoryStats({ includeHeapSpaces: false });
memLogger.debug("[MemStat]:", stats);
} catch (error) {
log.warn("Unexpected error while writing memory stats log", error);
}
}
function ongoingMemoryDump() {
console.log(
`Memory logging set to ${Store.get("settings.enableMemDebug")}. Log file at ${memLogger.transports.file.getFile().path}`,
);
setInterval(
async () => {
// Also write each snapshot to a dedicated memory stats log file as JSON lines.
try {
const loggingEnabled = Store.get("settings.enableMemDebug");
log.debug(
"Checking if memory stats logging is enabled.",
loggingEnabled,
);
if (loggingEnabled) {
// Enforce heap snapshot folder size limit (< 1GB) before writing a new snapshot.
const MAX_DIR_BYTES = 5 * 1024 * 1024 * 1024; // 5GB
const TARGET_REDUCED_BYTES = Math.floor(MAX_DIR_BYTES * 0.9); // prune down to 90%
const baseDir = path.dirname(log.transports.file.getFile().path);
const heapDir = path.join(baseDir, "heap-snapshots");
try {
fs.mkdirSync(heapDir, { recursive: true });
const files = fs
.readdirSync(heapDir)
.filter((f) => f.endsWith(".heapsnapshot"));
let totalSize = 0;
const fileStats: Array<{
file: string;
size: number;
mtimeMs: number;
}> = [];
for (const file of files) {
try {
const stat = fs.statSync(path.join(heapDir, file));
if (stat.isFile()) {
totalSize += stat.size;
fileStats.push({
file,
size: stat.size,
mtimeMs: stat.mtimeMs,
});
}
} catch (e) {
log.warn("Failed to stat heap snapshot file", file, e);
}
}
if (totalSize > MAX_DIR_BYTES) {
// Sort oldest first and delete until below TARGET_REDUCED_BYTES.
fileStats.sort((a, b) => a.mtimeMs - b.mtimeMs);
let bytesAfter = totalSize;
for (const info of fileStats) {
if (bytesAfter <= TARGET_REDUCED_BYTES) break;
try {
fs.unlinkSync(path.join(heapDir, info.file));
bytesAfter -= info.size;
log.warn(
`Pruned heap snapshot '${info.file}' (${formatBytes(info.size)}) to reduce directory size. New size: ${formatBytes(bytesAfter)}.`,
);
} catch (errDel) {
log.warn(
"Failed to delete heap snapshot file",
info.file,
errDel,
);
}
}
if (bytesAfter > MAX_DIR_BYTES) {
// Still above hard cap; skip writing a new snapshot this cycle.
log.warn(
`Heap snapshot directory still above hard cap (${formatBytes(bytesAfter)} > ${formatBytes(MAX_DIR_BYTES)}). Skipping new heap snapshot this cycle.`,
);
const stats = await dumpMemoryStats({
includeHeapSpaces: false,
writeHeapSnapshot: false,
});
memLogger.debug("[MemStat]:", stats);
return; // skip remainder; we already logged stats without snapshot.
}
}
} catch (dirErr) {
log.warn(
"Unexpected error while enforcing heap snapshot directory size limit",
dirErr,
);
// Continue; failure to enforce limit should not stop memory stats.
}
// Directory is within allowed bounds (or pruning succeeded); proceed normally.
const stats = await dumpMemoryStats({ includeHeapSpaces: false });
memLogger.debug("[MemStat]:", stats);
}
} catch (err) {
log.warn("Unexpected error while writing memory stats log", err);
}
},
15 * 60 * 1000,
); // every 15 minutes
}
export default ongoingMemoryDump;

62
tests/heapPrune.test.ts Normal file
View File

@@ -0,0 +1,62 @@
import { test, expect } from "@playwright/test";
import fs from "fs";
import path from "path";
// We import the module after setting up a temporary log path by monkey patching electron-log.
// Since the project primarily uses Playwright for tests, we leverage its expect assertion library.
// NOTE: This is a lightweight test that simulates the pruning logic indirectly by invoking the exported ongoingMemoryDump
// function and creating artificial heap snapshot files exceeding the threshold.
// Because ongoingMemoryDump sets an interval, we invoke its internal logic by importing the file and manually calling dumpMemoryStats.
// For simplicity and to avoid altering production code for testability, we replicate the size enforcement logic here and assert behavior.
function createDummySnapshots(dir: string, count: number, sizeBytes: number) {
fs.mkdirSync(dir, { recursive: true });
for (let i = 0; i < count; i++) {
const file = path.join(dir, `dummy-${i}.heapsnapshot`);
const fd = fs.openSync(file, "w");
// Write sizeBytes of zeros
const buf = Buffer.alloc(1024 * 1024, 0); // 1MB chunk
let written = 0;
while (written < sizeBytes) {
fs.writeSync(fd, buf, 0, Math.min(buf.length, sizeBytes - written));
written += Math.min(buf.length, sizeBytes - written);
}
fs.closeSync(fd);
// Stagger mtime for deterministic pruning ordering
const mtime = new Date(Date.now() - (count - i) * 1000);
fs.utimesSync(file, mtime, mtime);
}
}
test("heap snapshot directory pruning reduces size below simulated hard cap", async () => {
const baseDir = fs.mkdtempSync(path.join(process.cwd(), "heap-test-"));
const heapDir = path.join(baseDir, "heap-snapshots");
// Simulate oversize: 15 files of 5MB each = 75MB
createDummySnapshots(heapDir, 15, 5 * 1024 * 1024);
// Use smaller cap to keep test resource usage low.
const MAX_DIR_BYTES = 50 * 1024 * 1024; // 50MB simulated cap
const TARGET_REDUCED_BYTES = Math.floor(MAX_DIR_BYTES * 0.9);
const files = fs
.readdirSync(heapDir)
.filter((f) => f.endsWith(".heapsnapshot"));
let totalSize = 0;
const fileStats: Array<{ file: string; size: number; mtimeMs: number }> = [];
for (const file of files) {
const stat = fs.statSync(path.join(heapDir, file));
totalSize += stat.size;
fileStats.push({ file, size: stat.size, mtimeMs: stat.mtimeMs });
}
expect(totalSize).toBeGreaterThan(MAX_DIR_BYTES);
fileStats.sort((a, b) => a.mtimeMs - b.mtimeMs);
let bytesAfter = totalSize;
for (const info of fileStats) {
if (bytesAfter <= TARGET_REDUCED_BYTES) break;
fs.unlinkSync(path.join(heapDir, info.file));
bytesAfter -= info.size;
}
expect(bytesAfter).toBeLessThanOrEqual(TARGET_REDUCED_BYTES);
// Cleanup
fs.rmSync(baseDir, { recursive: true, force: true });
});