Merge branch 'master' into feat-replays-add-mask-and-unmask-options

Author: billyvg

CHANGELOG.md

@@ -4,6 +4,41 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+## 7.30.0
+
+- feat(core): Add `addIntegration` method to client (#6651)
+- feat(core): Add `replay_event` type for events (#6481)
+- feat(gatsby): Support Gatsby v5 (#6635)
+- feat(integrations): Add HTTPClient integration (#6500)
+- feat(node): Add `LocalVariables` integration to capture local variables to stack frames (#6478)
+- feat(node): Check for invalid url in node transport (#6623)
+- feat(replay): Remove `replayType` from tags and into `replay_event` (#6658)
+- feat(transport): Return result through Transport send (#6626)
+- fix(nextjs): Don't wrap `res.json` and `res.send` (#6674)
+- fix(nextjs): Don't write to `res.end` to fix `next export` (#6682)
+- fix(nextjs): Exclude SDK from Edge runtime bundles (#6683)
+- fix(replay): Allow Replay to be used in Electron renderers with nodeIntegration enabled (#6644)
+- fix(utils): Ignore stack frames over 1kb (#6627)
+- ref(angular) Add error-like objects handling (#6446)
+- ref(nextjs): Remove `instrumentSever` (#6592)
+
+Work in this release contributed by @rjoonas, @Naddiseo, and @theofidry. Thank you for your contributions!
+
+## 7.29.0
+
+This update includes a change to the `@sentry/nextjs` SDK that may increase response times of requests in applications
+deployed to Vercel or AWS lambdas to ensure that error events are sent consistently.
+Additionally, Next.js applications deployed to Vercel or AWS lambdas may also see an uptick in sent transactions. (for
+more information see #6578)
+
+- feat(core): Add `getSdkMetadata` to `Client` (#6643)
+- feat(nextjs): Send events consistently on platforms that don't support streaming (#6578)
+- feat(replay): Use new `prepareEvent` util & ensure dropping replays works (#6522)
+- feat(types): Upstream some replay types (#6506)
+- fix(replay): Envelope send should be awaited in try/catch (#6625)
+- fix(replay): Improve handling of `maskAllText` selector (#6637)
+- fix(tracing): Don't finish React Router 6 `pageload` transactions early (#6609)
+
 ## 7.28.1
 
 - fix(replay): Do not mangle `_metadata` in client options (#6600)

docs/event-sending.md

@@ -77,8 +77,8 @@ This document gives an outline for how event sending works, and which which plac
 ## Replay (WIP)
 
 * `replay.sendReplayRequest()`
-  * `createPayload()`
-  * `getReplayEvent()`
+  * `createRecordingData()`
+  * `prepareReplayEvent()`
     * `client._prepareEvent()` (see baseclient)
       * `baseclient._applyClientOptions()`
       * `baseclient._applyIntegrationsMetadata()`

lerna.json

@@ -1,6 +1,6 @@
 {
   "lerna": "3.4.0",
-  "version": "7.28.1",
+  "version": "7.29.0",
   "packages": "packages/*",
   "npmClient": "yarn",
   "useWorkspaces": true

packages/angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/angular",
-  "version": "7.28.1",
+  "version": "7.29.0",
   "description": "Official Sentry SDK for Angular",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/angular",
@@ -21,9 +21,9 @@
     "rxjs": "^6.5.5 || ^7.x"
   },
   "dependencies": {
-    "@sentry/browser": "7.28.1",
-    "@sentry/types": "7.28.1",
-    "@sentry/utils": "7.28.1",
+    "@sentry/browser": "7.29.0",
+    "@sentry/types": "7.29.0",
+    "@sentry/utils": "7.29.0",
     "tslib": "^2.0.0"
   },
   "devDependencies": {

packages/angular/src/errorhandler.ts

@@ -2,7 +2,7 @@ import { HttpErrorResponse } from '@angular/common/http';
 import { ErrorHandler as AngularErrorHandler, Inject, Injectable } from '@angular/core';
 import * as Sentry from '@sentry/browser';
 import { captureException } from '@sentry/browser';
-import { addExceptionMechanism } from '@sentry/utils';
+import { addExceptionMechanism, isString } from '@sentry/utils';
 
 import { runOutsideAngular } from './zone';
 
@@ -32,7 +32,7 @@ function tryToUnwrapZonejsError(error: unknown): unknown | Error {
 
 function extractHttpModuleError(error: HttpErrorResponse): string | Error {
   // The `error` property of http exception can be either an `Error` object, which we can use directly...
-  if (error.error instanceof Error) {
+  if (isErrorOrErrorLikeObject(error.error)) {
     return error.error;
   }
 
@@ -50,6 +50,31 @@ function extractHttpModuleError(error: HttpErrorResponse): string | Error {
   return error.message;
 }
 
+type ErrorCandidate = {
+  name?: unknown;
+  message?: unknown;
+  stack?: unknown;
+};
+
+function isErrorOrErrorLikeObject(value: unknown): value is Error {
+  if (value instanceof Error) {
+    return true;
+  }
+
+  if (value === null || typeof value !== 'object') {
+    return false;
+  }
+
+  const candidate = value as ErrorCandidate;
+
+  return (
+    isString(candidate.name) &&
+    isString(candidate.name) &&
+    isString(candidate.message) &&
+    (undefined === candidate.stack || isString(candidate.stack))
+  );
+}
+
 /**
  * Implementation of Angular's ErrorHandler provider that can be used as a drop-in replacement for the stock one.
  */
@@ -117,16 +142,16 @@ class SentryErrorHandler implements AngularErrorHandler {
   protected _defaultExtractor(errorCandidate: unknown): unknown {
     const error = tryToUnwrapZonejsError(errorCandidate);
 
-    // We can handle messages and Error objects directly.
-    if (typeof error === 'string' || error instanceof Error) {
-      return error;
-    }
-
     // If it's http module error, extract as much information from it as we can.
     if (error instanceof HttpErrorResponse) {
       return extractHttpModuleError(error);
     }
 
+    // We can handle messages and Error objects directly.
+    if (typeof error === 'string' || isErrorOrErrorLikeObject(error)) {
+      return error;
+    }
+
     // Nothing was extracted, fallback to default error message.
     return null;
   }

packages/angular/test/errorhandler.test.ts

@@ -33,7 +33,7 @@ class CustomError extends Error {
 }
 
 class ErrorLikeShapedClass implements Partial<Error> {
-  constructor(public message: string) {}
+  constructor(public name: string, public message: string) {}
 }
 
 function createErrorEvent(message: string, innerError: any): ErrorEvent {
@@ -118,8 +118,7 @@ describe('SentryErrorHandler', () => {
       createErrorHandler().handleError(errorLikeWithoutStack);
 
       expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-      // TODO: to be changed; see https://github.com/getsentry/sentry-javascript/issues/6332
-      expect(captureExceptionSpy).toHaveBeenCalledWith('Handled unknown error', expect.any(Function));
+      expect(captureExceptionSpy).toHaveBeenCalledWith(errorLikeWithoutStack, expect.any(Function));
     });
 
     it('extracts an error-like object with a stack', () => {
@@ -132,8 +131,7 @@ describe('SentryErrorHandler', () => {
       createErrorHandler().handleError(errorLikeWithStack);
 
       expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-      // TODO: to be changed; see https://github.com/getsentry/sentry-javascript/issues/6332
-      expect(captureExceptionSpy).toHaveBeenCalledWith('Handled unknown error', expect.any(Function));
+      expect(captureExceptionSpy).toHaveBeenCalledWith(errorLikeWithStack, expect.any(Function));
     });
 
     it('extracts an object that could look like an error but is not (does not have a message)', () => {
@@ -150,7 +148,6 @@ describe('SentryErrorHandler', () => {
 
     it('extracts an object that could look like an error but is not (does not have an explicit name)', () => {
       const notErr: Partial<Error> = {
-        // missing name; but actually is always there as part of the Object prototype
         message: 'something failed.',
       };
 
@@ -194,12 +191,12 @@ describe('SentryErrorHandler', () => {
     });
 
     it('extracts an instance of class not extending Error but that has an error-like shape', () => {
-      const err = new ErrorLikeShapedClass('something happened');
+      const err = new ErrorLikeShapedClass('sentry-error', 'something happened');
 
       createErrorHandler().handleError(err);
 
       expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-      expect(captureExceptionSpy).toHaveBeenCalledWith('Handled unknown error', expect.any(Function));
+      expect(captureExceptionSpy).toHaveBeenCalledWith(err, expect.any(Function));
     });
 
     it('extracts an instance of a class that does not extend Error and does not have an error-like shape', () => {
@@ -304,11 +301,7 @@ describe('SentryErrorHandler', () => {
       createErrorHandler().handleError(err);
 
       expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-      // TODO: to be changed; see https://github.com/getsentry/sentry-javascript/issues/6332
-      expect(captureExceptionSpy).toHaveBeenCalledWith(
-        'Http failure response for (unknown url): undefined undefined',
-        expect.any(Function),
-      );
+      expect(captureExceptionSpy).toHaveBeenCalledWith(errorLikeWithoutStack, expect.any(Function));
     });
 
     it('extracts an `HttpErrorResponse` with error-like object with a stack', () => {
@@ -322,11 +315,7 @@ describe('SentryErrorHandler', () => {
       createErrorHandler().handleError(err);
 
       expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-      // TODO: to be changed; see https://github.com/getsentry/sentry-javascript/issues/6332
-      expect(captureExceptionSpy).toHaveBeenCalledWith(
-        'Http failure response for (unknown url): undefined undefined',
-        expect.any(Function),
-      );
+      expect(captureExceptionSpy).toHaveBeenCalledWith(errorLikeWithStack, expect.any(Function));
     });
 
     it('extracts an `HttpErrorResponse` with an object that could look like an error but is not (does not have a message)', () => {
@@ -347,7 +336,6 @@ describe('SentryErrorHandler', () => {
 
     it('extracts an `HttpErrorResponse` with an object that could look like an error but is not (does not have an explicit name)', () => {
       const notErr: Partial<Error> = {
-        // missing name; but actually is always there as part of the Object prototype
         message: 'something failed.',
       };
       const err = new HttpErrorResponse({ error: notErr });
@@ -453,16 +441,13 @@ describe('SentryErrorHandler', () => {
     });
 
     it('extracts an `HttpErrorResponse` with an instance of class not extending Error but that has an error-like shape', () => {
-      const innerErr = new ErrorLikeShapedClass('something happened');
+      const innerErr = new ErrorLikeShapedClass('sentry-error', 'something happened');
       const err = new HttpErrorResponse({ error: innerErr });
 
       createErrorHandler().handleError(err);
 
       expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-      expect(captureExceptionSpy).toHaveBeenCalledWith(
-        'Http failure response for (unknown url): undefined undefined',
-        expect.any(Function),
-      );
+      expect(captureExceptionSpy).toHaveBeenCalledWith(innerErr, expect.any(Function));
     });
 
     it('extracts an `HttpErrorResponse` with an instance of a class that does not extend Error and does not have an error-like shape', () => {

packages/browser/.eslintignore

@@ -0,0 +1 @@
+tmp.js

packages/browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/browser",
-  "version": "7.28.1",
+  "version": "7.29.0",
   "description": "Official Sentry SDK for browsers",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/browser",
@@ -16,10 +16,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/core": "7.28.1",
-    "@sentry/replay": "7.28.1",
-    "@sentry/types": "7.28.1",
-    "@sentry/utils": "7.28.1",
+    "@sentry/core": "7.29.0",
+    "@sentry/replay": "7.29.0",
+    "@sentry/types": "7.29.0",
+    "@sentry/utils": "7.29.0",
     "tslib": "^1.9.3"
   },
   "devDependencies": {

packages/browser/src/client.ts

@@ -1,13 +1,6 @@
 import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, Scope, SDK_VERSION } from '@sentry/core';
-import {
-  BrowserClientReplayOptions,
-  ClientOptions,
-  Event,
-  EventHint,
-  Options,
-  Severity,
-  SeverityLevel,
-} from '@sentry/types';
+import type { BrowserClientReplayOptions } from '@sentry/types';
+import { ClientOptions, Event, EventHint, Options, Severity, SeverityLevel } from '@sentry/types';
 import { createClientReportEnvelope, dsnToString, logger, serializeEnvelope } from '@sentry/utils';
 
 import { eventFromException, eventFromMessage } from './eventbuilder';

packages/browser/src/helpers.ts

@@ -179,5 +179,5 @@ export interface ReportDialogOptions {
   errorFormEntry?: string;
   successMessage?: string;
   /** Callback after reportDialog showed up */
-  onLoad?(): void;
+  onLoad?(this: void): void;
 }

packages/browser/src/integrations/httpcontext.ts

@@ -36,7 +36,7 @@ export class HttpContext implements Integration {
           ...(referrer && { Referer: referrer }),
           ...(userAgent && { 'User-Agent': userAgent }),
         };
-        const request = { ...(url && { url }), headers };
+        const request = { ...event.request, ...(url && { url }), headers };
 
         return { ...event, request };
       }

packages/browser/src/sdk.ts

@@ -164,7 +164,6 @@ export function showReportDialog(options: ReportDialogOptions = {}, hub: Hub = g
   script.src = getReportDialogEndpoint(dsn, options);
 
   if (options.onLoad) {
-    // eslint-disable-next-line @typescript-eslint/unbound-method
     script.onload = options.onLoad;
   }
 

packages/browser/test/unit/sdk.test.ts

@@ -1,14 +1,11 @@
 /* eslint-disable @typescript-eslint/unbound-method */
-import { Scope } from '@sentry/core';
-import { createTransport } from '@sentry/core';
+import { createTransport, Scope } from '@sentry/core';
 import { MockIntegration } from '@sentry/core/test/lib/sdk.test';
 import { Client, Integration } from '@sentry/types';
 import { resolvedSyncPromise } from '@sentry/utils';
 
 import { BrowserOptions } from '../../src';
 import { init } from '../../src/sdk';
-// eslint-disable-next-line no-var
-declare var global: any;
 
 const PUBLIC_DSN = 'https://username@domain/123';
 

packages/browser/test/unit/tracekit/chromium.test.ts

@@ -547,4 +547,30 @@ describe('Tracekit - Chrome Tests', () => {
       },
     });
   });
+
+  it('should drop frames that are over 1kb', () => {
+    const LONG_STR = 'A'.repeat(1040);
+
+    const LONG_FRAME = {
+      message: 'bad',
+      name: 'Error',
+      stack: `Error: bad
+          at aha (http://localhost:5000/:39:5)
+          at Foo.testMethod (http://localhost:5000/${LONG_STR}:44:7)
+          at http://localhost:5000/:50:19`,
+    };
+
+    const ex = exceptionFromError(parser, LONG_FRAME);
+
+    expect(ex).toEqual({
+      value: 'bad',
+      type: 'Error',
+      stacktrace: {
+        frames: [
+          { filename: 'http://localhost:5000/', function: '?', lineno: 50, colno: 19, in_app: true },
+          { filename: 'http://localhost:5000/', function: 'aha', lineno: 39, colno: 5, in_app: true },
+        ],
+      },
+    });
+  });
 });

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/core",
-  "version": "7.28.1",
+  "version": "7.29.0",
   "description": "Base implementation for all Sentry JavaScript SDKs",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/core",
@@ -16,8 +16,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/types": "7.28.1",
-    "@sentry/utils": "7.28.1",
+    "@sentry/types": "7.29.0",
+    "@sentry/utils": "7.29.0",
     "tslib": "^1.9.3"
   },
   "scripts": {