feat(node): Application mode sessions

ahmedetefy · ahmedetefy · commit 9aacf379d18f · 2021-05-04T16:18:10.000+02:00
Add API to capture application mode sessions associated with a specific
release, and send them to Sentry as part of the Release Health functionality.
diff --git a/packages/browser/src/backend.ts b/packages/browser/src/backend.ts
@@ -29,12 +29,6 @@ export interface BrowserOptions extends Options {
 
   /** @deprecated use {@link Options.denyUrls} instead. */
   blacklistUrls?: Array<string | RegExp>;
-
-  /**
-   * A flag enabling Sessions Tracking feature.
-   * By default, Sessions Tracking is enabled.
-   */
-  autoSessionTracking?: boolean;
 }
 
 /**
diff --git a/packages/node/package.json b/packages/node/package.json
@@ -56,11 +56,12 @@
     "fix": "run-s fix:eslint fix:prettier",
     "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
     "fix:eslint": "eslint . --format stylish --fix",
-    "test": "run-s test:jest test:express test:webpack",
+    "test": "run-s test:jest test:express test:webpack test:release-health",
     "test:jest": "jest",
     "test:watch": "jest --watch",
     "test:express": "node test/manual/express-scope-separation/start.js",
     "test:webpack": "cd test/manual/webpack-domain/ && yarn && node npm-build.js",
+    "test:release-health": "node test/manual/release-health/single-session/healthy-session.js && node test/manual/release-health/single-session/caught-exception-errored-session.js && node test/manual/release-health/single-session/uncaught-exception-crashed-session.js && node test/manual/release-health/single-session/unhandled-rejection-crashed-session.js",
     "pack": "npm pack"
   },
   "volta": {
diff --git a/packages/node/src/sdk.ts b/packages/node/src/sdk.ts
@@ -1,5 +1,6 @@
 import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
 import { getMainCarrier, setHubOnCarrier } from '@sentry/hub';
+import { SessionStatus } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils';
 import * as domain from 'domain';
 
@@ -96,9 +97,16 @@ export function init(options: NodeOptions = {}): void {
     const detectedRelease = getSentryRelease();
     if (detectedRelease !== undefined) {
       options.release = detectedRelease;
+    } else {
+      // If release is not provided, then we should disable autoSessionTracking
+      options.autoSessionTracking = false;
     }
   }
 
+  if (options.autoSessionTracking === undefined) {
+    options.autoSessionTracking = true;
+  }
+
   if (options.environment === undefined && process.env.SENTRY_ENVIRONMENT) {
     options.environment = process.env.SENTRY_ENVIRONMENT;
   }
@@ -109,6 +117,10 @@ export function init(options: NodeOptions = {}): void {
   }
 
   initAndBind(NodeClient, options);
+
+  if (options.autoSessionTracking) {
+    startSessionTracking();
+  }
 }
 
 /**
@@ -148,6 +160,20 @@ export async function close(timeout?: number): Promise<boolean> {
   return Promise.reject(false);
 }
 
+/**
+ * Function that takes an instance of NodeClient and checks if autoSessionTracking option is enabled for that client
+ */
+export function isAutoSessionTrackingEnabled(client?: NodeClient): boolean {
+  if (client === undefined) {
+    return false;
+  }
+  const clientOptions: NodeOptions = client && client.getOptions();
+  if (clientOptions && clientOptions.autoSessionTracking !== undefined) {
+    return clientOptions.autoSessionTracking;
+  }
+  return false;
+}
+
 /**
  * Returns a release dynamically from environment variables.
  */
@@ -180,3 +206,22 @@ export function getSentryRelease(fallback?: string): string | undefined {
     fallback
   );
 }
+
+/**
+ * Enable automatic Session Tracking for the node process.
+ */
+function startSessionTracking(): void {
+  const hub = getCurrentHub();
+  hub.startSession();
+  // Emitted in the case of healthy sessions, error of `mechanism.handled: true` and unhandledrejections because
+  // The 'beforeExit' event is not emitted for conditions causing explicit termination,
+  // such as calling process.exit() or uncaught exceptions.
+  // Ref: https://nodejs.org/api/process.html#process_event_beforeexit
+  process.on('beforeExit', () => {
+    const session = hub.getScope()?.getSession();
+    const terminalStates = [SessionStatus.Exited, SessionStatus.Crashed];
+    // Only call endSession, if the Session exists on Scope and SessionStatus is not a
+    // Terminal Status i.e. Exited or Crashed
+    if (session && !terminalStates.includes(session.status)) hub.endSession();
+  });
+}
diff --git a/packages/node/src/transports/base.ts b/packages/node/src/transports/base.ts
@@ -1,5 +1,5 @@
-import { API, eventToSentryRequest, SDK_VERSION } from '@sentry/core';
-import { DsnProtocol, Event, Response, Status, Transport, TransportOptions } from '@sentry/types';
+import { API, SDK_VERSION } from '@sentry/core';
+import { DsnProtocol, Event, Response, SentryRequest, Status, Transport, TransportOptions } from '@sentry/types';
 import { logger, parseRetryAfterHeader, PromiseBuffer, SentryError } from '@sentry/utils';
 import * as fs from 'fs';
 import * as http from 'http';
@@ -124,7 +124,10 @@ export abstract class BaseTransport implements Transport {
   }
 
   /** JSDoc */
-  protected async _sendWithModule(httpModule: HTTPModule, event: Event): Promise<Response> {
+  protected async _send(sentryReq: SentryRequest): Promise<Response> {
+    if (!this.module) {
+      throw new SentryError('No module available');
+    }
     if (new Date(Date.now()) < this._disabledUntil) {
       return Promise.reject(new SentryError(`Transport locked till ${this._disabledUntil} due to too many requests.`));
     }
@@ -134,10 +137,11 @@ export abstract class BaseTransport implements Transport {
     }
     return this._buffer.add(
       new Promise<Response>((resolve, reject) => {
-        const sentryReq = eventToSentryRequest(event, this._api);
+        if (!this.module) {
+          throw new SentryError('No module available');
+        }
         const options = this._getRequestOptions(new url.URL(sentryReq.url));
-
-        const req = httpModule.request(options, (res: http.IncomingMessage) => {
+        const req = this.module.request(options, (res: http.IncomingMessage) => {
           const statusCode = res.statusCode || 500;
           const status = Status.fromHttpCode(statusCode);
 
diff --git a/packages/node/src/transports/http.ts b/packages/node/src/transports/http.ts
@@ -1,5 +1,5 @@
-import { Event, Response, TransportOptions } from '@sentry/types';
-import { SentryError } from '@sentry/utils';
+import { eventToSentryRequest, sessionToSentryRequest } from '@sentry/core';
+import { Event, Response, Session, TransportOptions } from '@sentry/types';
 import * as http from 'http';
 
 import { BaseTransport } from './base';
@@ -20,9 +20,13 @@ export class HTTPTransport extends BaseTransport {
    * @inheritDoc
    */
   public sendEvent(event: Event): Promise<Response> {
-    if (!this.module) {
-      throw new SentryError('No module available in HTTPTransport');
-    }
-    return this._sendWithModule(this.module, event);
+    return this._send(eventToSentryRequest(event, this._api));
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public sendSession(session: Session): PromiseLike<Response> {
+    return this._send(sessionToSentryRequest(session, this._api));
   }
 }
diff --git a/packages/node/src/transports/https.ts b/packages/node/src/transports/https.ts
@@ -1,5 +1,5 @@
-import { Event, Response, TransportOptions } from '@sentry/types';
-import { SentryError } from '@sentry/utils';
+import { eventToSentryRequest, sessionToSentryRequest } from '@sentry/core';
+import { Event, Response, Session, TransportOptions } from '@sentry/types';
 import * as https from 'https';
 
 import { BaseTransport } from './base';
@@ -20,9 +20,13 @@ export class HTTPSTransport extends BaseTransport {
    * @inheritDoc
    */
   public sendEvent(event: Event): Promise<Response> {
-    if (!this.module) {
-      throw new SentryError('No module available in HTTPSTransport');
-    }
-    return this._sendWithModule(this.module, event);
+    return this._send(eventToSentryRequest(event, this._api));
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public sendSession(session: Session): PromiseLike<Response> {
+    return this._send(sessionToSentryRequest(session, this._api));
   }
 }
diff --git a/packages/node/test/manual/release-health/single-session/caught-exception-errored-session.js b/packages/node/test/manual/release-health/single-session/caught-exception-errored-session.js
@@ -0,0 +1,60 @@
+const Sentry = require('../../../../dist');
+const { assertSessions, constructStrippedSessionObject, BaseDummyTransport } = require('./test-utils');
+
+let sessionCounter = 0;
+process.on('exit', ()=> {
+  if (process.exitCode !== 1) {
+    console.log('SUCCESS: All application mode sessions were sent to node transport as expected');
+  }
+})
+
+class DummyTransport extends BaseDummyTransport {
+  sendSession(session) {
+    sessionCounter++;
+    if (sessionCounter === 1) {
+      assertSessions(constructStrippedSessionObject(session),
+        {
+          init: true,
+          status: 'ok',
+          errors: 1,
+          release: '1.1'
+        }
+      )
+    }
+    else if (sessionCounter === 2) {
+      assertSessions(constructStrippedSessionObject(session),
+        {
+          init: false,
+          status: 'exited',
+          errors: 1,
+          release: '1.1'
+        }
+      )
+    }
+    else {
+      console.log('FAIL: Received way too many Sessions!');
+      process.exit(1);
+    }
+    return super.sendSession(session);
+  }
+}
+
+Sentry.init({
+  dsn: 'http://test@example.com/1337',
+  release: '1.1',
+  transport: DummyTransport,
+});
+
+/**
+ * The following code snippet will capture exceptions of `mechanism.handled` equal to `true`, and so these sessions
+ * are treated as Errored Sessions.
+ * In this case, we have two session updates sent; First Session sent is due to the call to CaptureException that
+ * extracts event data and uses it to update the Session and sends it. The second session update is sent on the
+ * `beforeExit` event which happens right before the process exits.
+ */
+try {
+  throw new Error('hey there')
+}
+catch(e) {
+  Sentry.captureException(e);
+}
diff --git a/packages/node/test/manual/release-health/single-session/healthy-session.js b/packages/node/test/manual/release-health/single-session/healthy-session.js
@@ -0,0 +1,41 @@
+const Sentry = require('../../../../dist');
+const { assertSessions, constructStrippedSessionObject, BaseDummyTransport } = require('./test-utils');
+
+let sessionCounter = 0;
+process.on('exit', ()=> {
+  if (process.exitCode !== 1) {
+    console.log('SUCCESS: All application mode sessions were sent to node transport as expected');
+  }
+})
+
+class DummyTransport extends BaseDummyTransport {
+  sendSession(session) {
+    sessionCounter++;
+    if (sessionCounter === 1) {
+      assertSessions(constructStrippedSessionObject(session),
+        {
+          init: true,
+          status: 'exited',
+          errors: 0,
+          release: '1.1'
+        }
+      )
+    }
+    else {
+      console.log('FAIL: Received way too many Sessions!');
+      process.exit(1);
+    }
+    return super.sendSession(session);
+  }
+}
+
+Sentry.init({
+  dsn: 'http://test@example.com/1337',
+  release: '1.1',
+  transport: DummyTransport
+});
+
+/**
+ * This script or process, start a Session on init object, and calls endSession on `beforeExit` of the process, which
+ * sends a healthy session to the Server.
+ */
diff --git a/packages/node/test/manual/release-health/single-session/test-utils.js b/packages/node/test/manual/release-health/single-session/test-utils.js
@@ -0,0 +1,29 @@
+function assertSessions(actual, expected) {
+  if (JSON.stringify(actual) !== JSON.stringify(expected)) {
+    console.error('FAILED: Sessions do not match');
+    process.exit(1);
+  }
+}
+
+function constructStrippedSessionObject(actual) {
+  const { init, status, errors, release, did } = actual;
+  return { init, status, errors, release, did };
+}
+
+class BaseDummyTransport {
+  sendEvent(event) {
+    return Promise.resolve({
+      status: 'success',
+    });
+  }
+  sendSession(session) {
+    return Promise.resolve({
+      status: 'success',
+    });
+  }
+  close(timeout) {
+    return Promise.resolve(true);
+  }
+}
+
+module.exports = { assertSessions, constructStrippedSessionObject, BaseDummyTransport };
diff --git a/packages/node/test/manual/release-health/single-session/uncaught-exception-crashed-session.js b/packages/node/test/manual/release-health/single-session/uncaught-exception-crashed-session.js
@@ -0,0 +1,36 @@
+const Sentry = require('../../../../dist');
+const { assertSessions, constructStrippedSessionObject, BaseDummyTransport } = require('./test-utils');
+
+process.on('exit', ()=> {
+  if (process.exitCode !== 1) {
+    console.log('SUCCESS: All application mode sessions were sent to node transport as expected');
+  }
+})
+
+class DummyTransport extends BaseDummyTransport {
+  sendSession(session) {
+    assertSessions(constructStrippedSessionObject(session),
+      {
+        init: true,
+        status: 'crashed',
+        errors: 1,
+        release: '1.1'
+      }
+    )
+    process.exit(0);
+  }
+}
+
+Sentry.init({
+  dsn: 'http://test@example.com/1337',
+  release: '1.1',
+  transport: DummyTransport
+});
+/**
+ * The following code snippet will throw an exception of `mechanism.handled` equal to `false`, and so this session
+ * is considered a Crashed Session.
+ * In this case, we have only session update that is sent, which is sent due to the call to CaptureException that
+ * extracts event data and uses it to update the Session and send it. No secondary session update in this case because
+ * we explicitly exit the process in the onUncaughtException handler and so the `beforeExit` event is not fired.
+ */
+throw new Error('test error')
diff --git a/packages/node/test/manual/release-health/single-session/unhandled-rejection-crashed-session.js b/packages/node/test/manual/release-health/single-session/unhandled-rejection-crashed-session.js
diff --git a/packages/node/test/transports/http.test.ts b/packages/node/test/transports/http.test.ts
diff --git a/packages/node/test/transports/https.test.ts b/packages/node/test/transports/https.test.ts
diff --git a/packages/types/src/options.ts b/packages/types/src/options.ts
