feat: Offline Support

.github/workflows/build.yml

@@ -17,12 +17,7 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '14'
-      - uses: actions/cache@v2
-        with:
-          path: |
-            .cache/**
-            **/node_modules
-          key: ${{ runner.os }}
+          cache: 'yarn'
       - name: Install
         run: yarn install
       - name: Build
@@ -48,12 +43,7 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '14'
-      - uses: actions/cache@v2
-        with:
-          path: |
-            .cache/**
-            **/node_modules
-          key: ${{ runner.os }}
+          cache: 'yarn'
       - run: yarn install
       - name: Run Linter
         run: yarn lint
@@ -72,12 +62,7 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '14'
-      - uses: actions/cache@v2
-        with:
-          path: |
-            .cache/**
-            **/node_modules
-          key: ${{ runner.os }}
+          cache: 'yarn'
       - run: yarn install
       - name: Run Unit Tests
         run: yarn test
@@ -98,12 +83,12 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '14'
+          cache: 'yarn'
       - uses: actions/cache@v2
         with:
           path: |
-            .cache/**
-            **/node_modules
-          key: ${{ runner.os }}
+            **/.cache/**/*.zip
+          key: ${{ runner.os }}-${{ matrix.electron }}
       - run: yarn install
       - name: Run E2E Tests
         run: yarn e2e

package.json

@@ -77,6 +77,7 @@
     "@types/koa": "^2.0.52",
     "@types/koa-bodyparser": "^4.3.0",
     "@types/mocha": "^9.0.0",
+    "@types/tmp": "^0.2.2",
     "busboy": "^0.3.1",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
@@ -95,6 +96,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
+    "tmp": "^0.2.1",
     "ts-node": "^10.4.0",
     "typescript": "^4.4.4",
     "xvfb-maybe": "^0.2.1",

src/main/fs.ts

@@ -1,5 +1,8 @@
-import { mkdir, mkdirSync, readdir, readFile, rename, stat, Stats, statSync, unlink } from 'fs';
-import { dirname, resolve } from 'path';
+import { app } from 'electron';
+import { mkdir, mkdirSync, readdir, readFile, rename, stat, Stats, statSync, unlink, writeFile } from 'fs';
+import { dirname, join, resolve } from 'path';
+
+export const sentryCachePath = join(app.getPath('userData'), 'sentry');
 
 /**
  * Asynchronously reads given files content.
@@ -24,6 +27,30 @@ export async function readFileAsync(
   });
 }
 
+/**
+ * Asynchronously reads given files content.
+ *
+ * @param path A relative or absolute path to the file
+ * @returns A Promise that resolves when the file has been read.
+ */
+export async function writeFileAsync(
+  path: string,
+  data: Buffer | string,
+  options?: { encoding?: string; flag?: string },
+): Promise<void> {
+  // We cannot use util.promisify here because that was only introduced in Node
+  // 8 and we need to support older Node versions.
+  return new Promise((res, reject) => {
+    writeFile(path, data, options as any, (err: any) => {
+      if (err) {
+        reject(err);
+      } else {
+        res();
+      }
+    });
+  });
+}
+
 /**
  * Asynchronously creates the given directory.
  *

src/main/index.ts

@@ -43,6 +43,7 @@ export {
 export { NodeOptions, NodeBackend, NodeClient, lastEventId } from '@sentry/node';
 
 export { ElectronNetTransport } from './transports/electron-net';
+export { ElectronOfflineNetTransport } from './transports/electron-offline-net';
 export const Integrations = { ...ElectronMainIntegrations, ...NodeIntegrations };
 
 export { init, ElectronMainOptions, defaultIntegrations } from './sdk';

src/main/integrations/sentry-minidump/base-uploader.ts

@@ -1,19 +1,15 @@
 import { API } from '@sentry/core';
 import { NodeOptions } from '@sentry/node';
-import { Event, Status, Transport } from '@sentry/types';
+import { Event, Transport } from '@sentry/types';
 import { isThenable, logger, SentryError, timestampWithMs } from '@sentry/utils';
-import { basename, join } from 'path';
+import { basename } from 'path';
 
-import { mkdirp, readFileAsync, renameAsync, statAsync, unlinkAsync } from '../../fs';
-import { Store } from '../../store';
+import { readFileAsync, statAsync, unlinkAsync } from '../../fs';
 import { ElectronNetTransport, SentryElectronRequest } from '../../transports/electron-net';
 
 /** Maximum number of days to keep a minidump before deleting it. */
 const MAX_AGE = 30;
 
-/** Maximum number of requests that we store/queue if something goes wrong. */
-const MAX_REQUESTS_COUNT = 10;
-
 /**
  * Payload for a minidump request comprising a persistent file system path and
  * event metadata.
@@ -32,31 +28,20 @@ export abstract class BaseUploader {
   /** List of minidumps that have been found already. */
   private readonly _knownPaths: string[];
 
-  /**
-   * Store to persist queued Minidumps beyond application crashes or lost
-   * internet connection.
-   */
-  private readonly _queue: Store<MinidumpRequest[]>;
-
   /** API object */
   private readonly _api: API;
 
   /**
    * Creates a new uploader instance.
    */
-  public constructor(
-    private readonly _options: NodeOptions,
-    private readonly _cacheDirectory: string,
-    private readonly _transport: Transport,
-  ) {
+  public constructor(private readonly _options: NodeOptions, private readonly _transport: Transport) {
     this._knownPaths = [];
 
     if (!_options.dsn) {
       throw new SentryError('Attempted to enable Electron native crash reporter but no DSN was supplied');
     }
 
     this._api = new API(_options.dsn);
-    this._queue = new Store(this._cacheDirectory, 'queue', []);
   }
 
   /**
@@ -90,14 +75,10 @@ export abstract class BaseUploader {
 
     const transport = this._transport as ElectronNetTransport;
     try {
-      let response;
-
       if (request.event && !transport.isRateLimited('event')) {
         logger.log('Sending minidump', request.path);
-
         const requestForTransport = await this._toMinidumpRequest(transport, request.event, request.path);
-        response = await transport.sendRequest(requestForTransport);
-        logger.log('Minidump sent');
+        await transport.sendRequest(requestForTransport);
       }
 
       // We either succeeded, something went wrong or the send was aborted. Either way, we can remove the minidump file.
@@ -109,22 +90,10 @@ export abstract class BaseUploader {
       }
 
       // Forget this minidump in all caches
-      this._queue.update((queued) => queued.filter((stored) => stored !== request));
       this._knownPaths.splice(this._knownPaths.indexOf(request.path), 1);
-
-      // If we were successful, we can try to flush the remaining queue
-      if (response && response.status === Status.Success) {
-        await this.flushQueue();
-      }
     } catch (err) {
       // TODO: Test this
       logger.warn('Failed to upload minidump', err);
-
-      // User's internet connection was down so we queue it as well
-      const error = err ? (err as { code: string }) : { code: '' };
-      if (error.code === 'ENOTFOUND') {
-        await this._queueMinidump(request);
-      }
     }
   }
 
@@ -164,11 +133,6 @@ export abstract class BaseUploader {
     });
   }
 
-  /** Flushes locally cached minidumps from the queue. */
-  public async flushQueue(): Promise<void> {
-    await Promise.all(this._queue.get().map(async (request) => this.uploadMinidump(request)));
-  }
-
   /**
    * Helper to filter an array with asynchronous callbacks.
    *
@@ -186,46 +150,6 @@ export abstract class BaseUploader {
     return array.filter((_, index) => verdicts[index]);
   }
 
-  /**
-   * Enqueues a minidump with event information for later upload.
-   * @param request The request containing a minidump and event info.
-   */
-  private async _queueMinidump(request: MinidumpRequest): Promise<void> {
-    const filename = basename(request.path);
-
-    // Only enqueue if this minidump hasn't been enqueued before. Compare the
-    // filename instead of the full path, because we will move the file to a
-    // temporary location later on.
-    if (this._queue.get().some((req) => basename(req.path) === filename)) {
-      return;
-    }
-
-    // Move the minidump file to a separate cache directory and enqueue it. Even
-    // if the Electron CrashReporter's cache directory gets wiped or changes,
-    // this will allow us to retry uploading the file later.
-    const queuePath = join(this._cacheDirectory, filename);
-    await mkdirp(this._cacheDirectory);
-    await renameAsync(request.path, queuePath);
-
-    // Remove stale minidumps in case we go over limit. Note that we have to
-    // re-fetch the queue as it might have changed in the meanwhile. It is
-    // important to store the queue value again immediately to avoid phantom
-    // reads.
-    const requests = [...this._queue.get(), { ...request, path: queuePath }];
-    const stale = requests.splice(-MAX_REQUESTS_COUNT);
-    this._queue.set(requests);
-
-    await Promise.all(
-      stale.map(async (req) => {
-        try {
-          await unlinkAsync(req.path);
-        } catch (e) {
-          logger.warn('Could not delete', req.path);
-        }
-      }),
-    );
-  }
-
   /**
    * Create minidump request to dispatch to the transport
    */

src/main/integrations/sentry-minidump/breakpad-uploader.ts

@@ -11,8 +11,8 @@ import { BaseUploader } from './base-uploader';
 export class BreakpadUploader extends BaseUploader {
   private readonly _crashesDirectory: string = getCrashesDirectory();
 
-  public constructor(options: NodeOptions, cacheDirectory: string, transport: Transport) {
-    super(options, cacheDirectory, transport);
+  public constructor(options: NodeOptions, transport: Transport) {
+    super(options, transport);
   }
 
   /** @inheritdoc */

src/main/integrations/sentry-minidump/crashpad-uploader.ts

@@ -14,8 +14,8 @@ export class CrashpadUploader extends BaseUploader {
   /** The sub-directory where crashpad dumps can be found */
   private readonly _crashpadSubDirectory: string;
 
-  public constructor(options: NodeOptions, cacheDirectory: string, transport: Transport) {
-    super(options, cacheDirectory, transport);
+  public constructor(options: NodeOptions, transport: Transport) {
+    super(options, transport);
     this._crashpadSubDirectory = process.platform === 'win32' ? 'reports' : 'completed';
   }
 

src/main/integrations/sentry-minidump/index.ts

@@ -3,7 +3,6 @@ import { NodeClient } from '@sentry/node';
 import { Event, Integration, Severity } from '@sentry/types';
 import { forget, isPlainObject, isThenable, logger, SentryError } from '@sentry/utils';
 import { app, crashReporter } from 'electron';
-import { join } from 'path';
 
 import { onRendererProcessGone, usesCrashpad } from '../../electron-normalize';
 import { mergeEvents, normalizeUrl } from '../../../common';
@@ -15,6 +14,7 @@ import { CrashpadUploader } from './crashpad-uploader';
 import { Store } from '../../store';
 import { getEventDefaults } from '../../context';
 import { checkPreviousSession, sessionCrashed } from '../../sessions';
+import { sentryCachePath } from '../../fs';
 
 /** Sends minidumps via the Sentry uploader */
 export class SentryMinidump implements Integration {
@@ -33,9 +33,6 @@ export class SentryMinidump implements Integration {
   /** Uploader for minidump files. */
   private _uploader?: BaseUploader;
 
-  /** The path to the Sentry cache directory. */
-  private readonly _cachePath: string = join(app.getPath('userData'), 'sentry');
-
   /** @inheritDoc */
   public setupOnce(): void {
     // Mac AppStore builds cannot run the crash reporter due to the sandboxing
@@ -47,7 +44,7 @@ export class SentryMinidump implements Integration {
 
     this._startCrashReporter();
 
-    this._scopeStore = new Store<Scope>(this._cachePath, 'scope_v2', new Scope());
+    this._scopeStore = new Store<Scope>(sentryCachePath, 'scope_v2', new Scope());
     // We need to store the scope in a variable here so it can be attached to minidumps
     this._scopeLastRun = this._scopeStore.get();
 
@@ -64,15 +61,12 @@ export class SentryMinidump implements Integration {
     const transport = (client as any)._getBackend().getTransport() as ElectronNetTransport;
 
     this._uploader = usesCrashpad()
-      ? new CrashpadUploader(options, this._cachePath, transport)
-      : new BreakpadUploader(options, this._cachePath, transport);
+      ? new CrashpadUploader(options, transport)
+      : new BreakpadUploader(options, transport);
 
     // Every time a subprocess or renderer crashes, send a minidump right away.
     onRendererProcessGone((contents, details) => this._sendRendererCrash(options, contents, details));
 
-    // Flush already cached minidumps from the queue.
-    forget(this._uploader.flushQueue());
-
     // Start to submit recent minidump crashes. This will load breadcrumbs and
     // context information that was cached on disk prior to the crash.
     forget(

src/main/sdk.ts

@@ -14,7 +14,7 @@ import {
   SentryMinidump,
 } from './integrations';
 import { configureIPC } from './ipc';
-import { ElectronNetTransport } from './transports/electron-net';
+import { ElectronOfflineNetTransport } from './transports/electron-offline-net';
 
 export const defaultIntegrations: Integration[] = [
   new SentryMinidump(),
@@ -88,7 +88,7 @@ export function init(partialOptions: Partial<ElectronMainOptions>): void {
   setDefaultIntegrations(defaults, options);
 
   if (options.dsn && options.transport === undefined) {
-    options.transport = ElectronNetTransport;
+    options.transport = ElectronOfflineNetTransport;
   }
 
   configureIPC(options);

src/main/sessions.ts

@@ -2,20 +2,15 @@ import { getCurrentHub } from '@sentry/core';
 import { flush, NodeClient } from '@sentry/node';
 import { SessionContext, SessionStatus } from '@sentry/types';
 import { logger } from '@sentry/utils';
-import { app } from 'electron';
-import { join } from 'path';
 
+import { sentryCachePath } from './fs';
 import { Store } from './store';
 import { ElectronNetTransport } from './transports/electron-net';
 
 const PERSIST_INTERVAL_MS = 60_000;
 
 /** Stores the app session in case of termination due to main process crash or app killed */
-const sessionStore = new Store<SessionContext | undefined>(
-  join(app.getPath('userData'), 'sentry'),
-  'session',
-  undefined,
-);
+const sessionStore = new Store<SessionContext | undefined>(sentryCachePath, 'session', undefined);
 
 /** Previous session that did not exit cleanly */
 let previousSession = sessionStore.get();