feat: Add flush & close and read dsn of process.env for node (#1892)

* feat: Add flush close and dsn from process for node

* feat: Expose flush and close also on browser

* fix: Lint error and add changelog

Author: HazAT

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+- [node] feat: If `options.dsn` is undefined when calling `init` we try to load it from `process.env.SENTRY_DSN`
+- [node] feat: Expose `flush` and `close` on `Sentry.*`
+- [node] feat: Add `sentry` to express error handler response which contains the `event_id` of the error
+- [core] feat: Introduce `flush` method which currently is an alias for `close`
+
 ## 4.5.4
 
 - [browser] fix: `DOMError` and `DOMException` should be error level events
@@ -14,10 +19,10 @@
 ## 4.5.3
 
 - [browser]: fix: Fix UnhandledPromise: [object Object]
-- [core]: fix: Error in extraErrorData integration where event would not be send in case of non assignable object property.
+- [core]: fix: Error in extraErrorData integration where event would not be send in case of non assignable object
+  property.
 - [hub]: feat: Support non async event processors
 
-
 ## 4.5.2
 
 - [utils] fix: Decycling for objects to no produce an endless loop

packages/browser/src/index.ts

@@ -29,7 +29,7 @@ export {
 
 export { BrowserBackend, BrowserOptions } from './backend';
 export { BrowserClient, ReportDialogOptions } from './client';
-export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog } from './sdk';
+export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog, flush, close } from './sdk';
 export { SDK_NAME, SDK_VERSION } from './version';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';

packages/browser/src/sdk.ts

@@ -103,3 +103,23 @@ export function forceLoad(): void {
 export function onLoad(callback: () => void): void {
   callback();
 }
+
+/**
+ * A promise that resolves when all current events have been sent.
+ * If you provide a timeout and the queue takes longer to drain the promise returns false.
+ *
+ * @param timeout Maximum time in ms the client should wait.
+ */
+export async function flush(timeout?: number): Promise<boolean> {
+  return (getCurrentHub().getClient() as BrowserClient).flush(timeout);
+}
+
+/**
+ * A promise that resolves when all current events have been sent.
+ * If you provide a timeout and the queue takes longer to drain the promise returns false.
+ *
+ * @param timeout Maximum time in ms the client should wait.
+ */
+export async function close(timeout?: number): Promise<boolean> {
+  return (getCurrentHub().getClient() as BrowserClient).close(timeout);
+}

packages/core/src/baseclient.ts

@@ -386,7 +386,7 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
   /**
    * @inheritDoc
    */
-  public async close(timeout?: number): Promise<boolean> {
+  public async flush(timeout?: number): Promise<boolean> {
     return (await Promise.all([
       this.getBackend()
         .getTransport()
@@ -395,6 +395,13 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
     ])).reduce((prev, current) => prev && current);
   }
 
+  /**
+   * @inheritDoc
+   */
+  public async close(timeout?: number): Promise<boolean> {
+    return this.flush(timeout);
+  }
+
   /**
    * @inheritDoc
    */

packages/core/src/interfaces.ts

@@ -207,13 +207,21 @@ export interface Client<O extends Options = Options> {
   getOptions(): O;
 
   /**
-   * A promise that resolves whenever the request buffer is empty.
-   * If you provide a timeout and the buffer takes longer to drain the promise returns false.
+   * A promise that resolves when all current events have been sent.
+   * If you provide a timeout and the queue takes longer to drain the promise returns false.
    *
    * @param timeout Maximum time in ms the client should wait.
    */
   close(timeout?: number): Promise<boolean>;
 
+  /**
+   * A promise that resolves when all current events have been sent.
+   * If you provide a timeout and the queue takes longer to drain the promise returns false.
+   *
+   * @param timeout Maximum time in ms the client should wait.
+   */
+  flush(timeout?: number): Promise<boolean>;
+
   /** Returns an array of installed integrations on the client. */
   getIntegration<T extends Integration>(integartion: IntegrationClass<T>): T | null;
 }

packages/node/src/handlers.ts

@@ -272,7 +272,7 @@ export function errorHandler(): (
       return;
     }
     const eventId = captureException(error);
-    _res.sentry = eventId;
+    (_res as any).sentry = eventId;
     next(error);
   };
 }

packages/node/src/index.ts

@@ -29,7 +29,7 @@ export {
 
 export { NodeBackend, NodeOptions } from './backend';
 export { NodeClient } from './client';
-export { defaultIntegrations, init } from './sdk';
+export { defaultIntegrations, init, flush, close } from './sdk';
 export { SDK_NAME, SDK_VERSION } from './version';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';

packages/node/src/sdk.ts

@@ -70,6 +70,10 @@ export function init(options: NodeOptions = {}): void {
     options.defaultIntegrations = defaultIntegrations;
   }
 
+  if (options.dsn === undefined && process.env.SENTRY_DSN) {
+    options.dsn = process.env.SENTRY_DSN;
+  }
+
   if (domain.active) {
     setHubOnCarrier(getMainCarrier(), getCurrentHub());
   }
@@ -85,3 +89,23 @@ export function init(options: NodeOptions = {}): void {
 export function lastEventId(): string | undefined {
   return getCurrentHub().lastEventId();
 }
+
+/**
+ * A promise that resolves when all current events have been sent.
+ * If you provide a timeout and the queue takes longer to drain the promise returns false.
+ *
+ * @param timeout Maximum time in ms the client should wait.
+ */
+export async function flush(timeout?: number): Promise<boolean> {
+  return (getCurrentHub().getClient() as NodeClient).flush(timeout);
+}
+
+/**
+ * A promise that resolves when all current events have been sent.
+ * If you provide a timeout and the queue takes longer to drain the promise returns false.
+ *
+ * @param timeout Maximum time in ms the client should wait.
+ */
+export async function close(timeout?: number): Promise<boolean> {
+  return (getCurrentHub().getClient() as NodeClient).close(timeout);
+}