Merge pull request #1594 from session-foundation/chore-test-debug-crash-with-reporter

feat: add crash reporter + downgrade sharp to 0.33.3

Author: Bilb

package.json

@@ -2,7 +2,7 @@
   "name": "session-desktop",
   "productName": "Session",
   "description": "Private messaging from your desktop",
-  "version": "1.16.8",
+  "version": "1.16.9",
   "license": "GPL-3.0",
   "author": {
     "name": "Session Foundation",
@@ -39,7 +39,7 @@
     "build-release-base": "cross-env NODE_ENV=production electron-builder --config.extraMetadata.environment=production",
     "build-release": "yarn build-release-base --publish=never --config.directories.output=release",
     "build-release-publish": "yarn build-release-base --publish=always",
-    "ready": "yarn dedup --fail && yarn build-everything && yarn lint && yarn test",
+    "ready": "yarn dedup --fail && yarn build && yarn lint && yarn test",
     "postinstall": "yarn patch-package && yarn electron-builder install-app-deps",
     "update-git-info": "node ./build/updateLocalConfig.js",
     "worker:utils": "webpack  --config=./utils.worker.config.js",
@@ -49,7 +49,6 @@
     "prepare": "husky",
     "print-deps": "node -v  && python3 --version",
     "watch": "yarn clean && yarn update-git-info && concurrently -n PBJS,SASS,LOCALES,UTIL,LIBSESSION,IMAGE,TS -c yellow,green,red,blue,blue,blue,green \"yarn protobuf\" \"yarn sass --watch\" \"yarn build:locales-soft\" \"yarn worker:utils --watch\" \"yarn worker:libsession --watch\" \"yarn worker:image_processor --watch\" \"yarn tsc --watch\""
-
   },
   "dependencies": {
     "@emoji-mart/data": "^1.2.1",
@@ -112,7 +111,7 @@
     "rimraf": "6.0.1",
     "sanitize.css": "^12.0.1",
     "semver": "^7.7.1",
-    "sharp": "^0.34.3",
+    "sharp": "0.33.3",
     "styled-components": "^6.1.15",
     "uuid": "11.1.0",
     "viem": "^2.26.0",

ts/mains/main_node.ts

@@ -7,6 +7,7 @@
 import {
   app,
   BrowserWindow,
+  crashReporter,
   protocol as electronProtocol,
   ipcMain as ipc,
   ipcMain,
@@ -152,6 +153,27 @@ if (!process.mas) {
   }
 }
 
+/**
+ * Starts the crash reporter, which saves crashes to disk.
+ * The dumps will be saved in the `userData/CrashPad/pending` directory.
+ *
+ *  The minidumps can be read using the `minidump_stackwalk` tool.
+ * If you do not have cargo installed, you can do those steps:
+ * ```bash
+ * git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
+ * cd depot_tools
+ * mkdir breakpad && cd breakpad
+ * ../fetch breakpad && cd src
+ * ./configure && make
+ * file src/processor/minidump_stackwalk
+ * ./src/processor/minidump_stackwalk <path_to.dmp> <any_symbols_you_have_optional>
+ */
+crashReporter.start({
+  submitURL: '', // leave empty as we don't want to upload them, but only save them locally
+  uploadToServer: false,
+  compress: true,
+});
+
 const windowFromUserConfig = userConfig.get('window');
 const windowFromEphemeral = ephemeralConfig.get('window');
 let windowConfig = windowFromEphemeral || windowFromUserConfig;
@@ -178,6 +200,8 @@ import * as log from '../util/logger/log';
 import { DURATION } from '../session/constants';
 import { tr } from '../localization/localeTools';
 
+import { logCrash } from '../node/crash/log_crash';
+
 function prepareURL(pathSegments: Array<string>, moreKeys?: { theme: any }) {
   const urlObject: url.UrlObject = {
     pathname: join(...pathSegments),
@@ -360,6 +384,12 @@ async function createWindow() {
   mainWindow.on('focus', setWindowFocus);
   mainWindow.on('blur', setWindowFocus);
   mainWindow.once('ready-to-show', setWindowFocus);
+
+  mainWindow.webContents.on('render-process-gone', (_event, details) => {
+    // details.reason can be: 'crashed', 'killed', 'oom', etc.
+    logCrash('renderer', details);
+  });
+
   // This is a fallback in case we drop an event for some reason.
   global.setInterval(setWindowFocus, 5000);
 

ts/node/crash/log_crash.ts

@@ -0,0 +1,13 @@
+import { app } from 'electron';
+import { appendFileSync } from 'fs-extra';
+import path from 'node:path';
+
+/**
+ * Logs a crash of the renderer/main process to the userData directory, file `crash-log.txt`.
+ * Also, see the crashReporter for dumps of the crash itself
+ */
+export function logCrash(type: string, details: any) {
+  const crashLogPath = path.join(app.getPath('userData'), 'crash-log.txt');
+  const logLine = `[${new Date().toISOString()}] ${type} crash: ${JSON.stringify(details)}\n`;
+  appendFileSync(crashLogPath, logLine, 'utf8');
+}

ts/node/global_errors.ts

@@ -3,6 +3,7 @@ import os from 'node:os';
 import { reallyJsonStringify } from '../util/reallyJsonStringify';
 import { Errors } from '../types/Errors';
 import { redactAll } from '../util/privacy';
+import { logCrash } from './crash/log_crash';
 
 // TODO: use localised strings
 const quitText = 'Quit';
@@ -53,10 +54,14 @@ export const addHandler = (): void => {
   // Note: we could maybe add a handler for when the renderer process died here?
   // (but also ignore the valid death like on restart/quit)
   process.on('uncaughtException', (reason: unknown) => {
+    logCrash('main', { reason: 'uncaughtException', error: reason });
+
     handleError('Unhandled Error', _getError(reason));
   });
 
   process.on('unhandledRejection', (reason: unknown) => {
+    logCrash('main', { reason: 'unhandledRejection', error: reason });
+
     handleError('Unhandled Promise Rejection', _getError(reason));
   });
 };

ts/webworker/workers/node/image_processor/image_processor.worker.ts

@@ -63,12 +63,12 @@ function centerCoverOpts(maxSidePx: number) {
 }
 
 function formattedMetadata(metadata: {
-  width: number;
-  height: number;
+  width: number | undefined;
+  height: number | undefined;
   format: keyof sharp.FormatEnum;
   size: number;
 }) {
-  return `(${metadata.width}x${metadata.height} ${metadata.format} of ${metadata.size} bytes)`;
+  return `(${metadata.width}x${metadata.height}, format:${String(metadata.format)}  of ${metadata.size} bytes)`;
 }
 
 function sharpFrom(inputBuffer: ArrayBufferLike | Buffer, options?: sharp.SharpOptions) {
@@ -371,7 +371,13 @@ const workerActions: ImageProcessorWorkerActions = {
     const start = Date.now();
     const metadata = await metadataFromBuffer(inputBuffer);
 
-    if (!metadata || !metadata.format || !sharp.format[metadata.format]?.output) {
+    if (
+      !metadata ||
+      !metadata.format ||
+      !sharp.format[metadata.format]?.output ||
+      !metadata.width ||
+      !metadata.height
+    ) {
       logIfOn(`Unsupported format: ${metadata?.format}`);
       return null;
     }
@@ -480,10 +486,10 @@ const workerActions: ImageProcessorWorkerActions = {
           }ms for}`
         );
         logIfOn(
-          `\t src${formattedMetadata({ width: metadata.width, format: metadata.format, height: metadata.height, size: inputBuffer.byteLength })} `
+          `\t src${formattedMetadata({ width: metadata.width, height: metadata.height, format: metadata.format, size: inputBuffer.byteLength })} `
         );
         logIfOn(
-          `\t dest${formattedMetadata({ width: outputMetadata.width, format: outputMetadata.format, height: outputMetadata.height, size: buffer.buffer.byteLength })} `
+          `\t dest${formattedMetadata({ width: outputMetadata.width, height: outputMetadata.height, format: metadata.format, size: buffer.buffer.byteLength })} `
         );
 
         return {
@@ -501,7 +507,7 @@ const workerActions: ImageProcessorWorkerActions = {
         }ms with quality ${quality}`
       );
       logIfOn(
-        `\t src${formattedMetadata({ width: metadata.width, format: metadata.format, height: metadata.height, size: inputBuffer.byteLength })} `
+        `\t src${formattedMetadata({ width: metadata.width, height: metadata.height, format: metadata.format, size: inputBuffer.byteLength })} `
       );
     }
     qualityRangeIndex++;
@@ -513,7 +519,7 @@ const workerActions: ImageProcessorWorkerActions = {
       `[imageProcessorWorker] processForFileServerUpload: failed after ${Date.now() - start}ms`
     );
     logIfOn(
-      `\t src${formattedMetadata({ width: metadata.width, format: metadata.format, height: metadata.height, size: inputBuffer.byteLength })} `
+      `\t src${formattedMetadata({ width: metadata.width, height: metadata.height, format: metadata.format, size: inputBuffer.byteLength })} `
     );
 
     return null;