Merge remote-tracking branch 'origin/master' into lforst-validate-test-app-setup

Author: lforst

CHANGELOG.md

@@ -4,6 +4,30 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+## 7.14.0
+
+- feat(nextjs): Add status to data-fetcher spans (#5777)
+- feat(nextjs): Auto-wrap API routes (#5778)
+- feat(nextjs): Promote option to automatically wrap data fetchers and API routes to non-experimental (#5793)
+- feat(utils): Modern implementation of `getGlobalObject` (#5809)
+- fix(gatsby): Include app-* entrypoints as they may include user source code (#5685)
+- fix(nextjs): Handle `pathname` being passed in object in `instrumentServer` (#5782)
+- fix(nextjs): Pass request in sampling context of data fetchers wrapper transaction (#5784)
+- fix(nextjs): Reverse order of checks for instrumenting server (#5828)
+- fix(nextjs): Rename `nextjs.data.server` ops (#5830) 
+- fix(remix): Do not skip error handling if tracing is not enabled. (#5811)
+- fix(remix): Use import() to get `react-router-dom` in Express wrapper. (#5810)
+- fix(tracing): Remove `connection.downlink` measurement (#5794)
+- ref(browser): Use configured transport as fallback for client reports (#5797)
+- ref(nextjs): Use flush code from `withSentry` in all backend wrappers (#5814)
+- ref(nextjs): Use integration to add request data to transaction events (#5703)
+- ref(nextjs): Use`RequestData` integration for errors (#5729)
+- ref(node): Move request data functions back to `@sentry/node` (#5759)
+- ref(tracing): Don't track transaction sampling method (#5775)
+- ref(types): Use intersections instead of extend in envelope types (#5788)
+
+Work in this release contributed by @Auspicus and @dagroe. Thank you for your contributions!
+
 ## 7.13.0
 
 - feat(browser): Use fetch `keepalive` flag (#5697)

lerna.json

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

packages/angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/angular",
-  "version": "7.13.0",
+  "version": "7.14.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.13.0",
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/browser": "7.14.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "tslib": "^2.0.0"
   },
   "devDependencies": {

packages/browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/browser",
-  "version": "7.13.0",
+  "version": "7.14.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,9 +16,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/core": "7.13.0",
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/core": "7.14.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "tslib": "^1.9.3"
   },
   "devDependencies": {

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/core",
-  "version": "7.13.0",
+  "version": "7.14.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,9 +16,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/hub": "7.13.0",
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/hub": "7.14.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "tslib": "^1.9.3"
   },
   "scripts": {

packages/core/src/version.ts

@@ -1 +1 @@
-export const SDK_VERSION = '7.13.0';
+export const SDK_VERSION = '7.14.0';

packages/e2e-tests/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry-internal/e2e-tests",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "license": "MIT",
   "engines": {
     "node": ">=10"

packages/ember/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/ember",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Official Sentry SDK for Ember.js",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/ember",
@@ -30,10 +30,10 @@
   },
   "dependencies": {
     "@embroider/macros": "1.8.3",
-    "@sentry/browser": "7.13.0",
-    "@sentry/tracing": "7.13.0",
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/browser": "7.14.0",
+    "@sentry/tracing": "7.14.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "ember-auto-import": "~1.12.1 || ~2.2.0",
     "ember-cli-babel": "~7.26.6",
     "ember-cli-htmlbars": "^6.0.1",

packages/eslint-config-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry-internal/eslint-config-sdk",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Official Sentry SDK eslint config",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/eslint-config-sdk",
@@ -19,8 +19,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry-internal/eslint-plugin-sdk": "7.13.0",
-    "@sentry-internal/typescript": "7.13.0",
+    "@sentry-internal/eslint-plugin-sdk": "7.14.0",
+    "@sentry-internal/typescript": "7.14.0",
     "@typescript-eslint/eslint-plugin": "^3.9.0",
     "@typescript-eslint/parser": "^3.9.0",
     "eslint-config-prettier": "^6.11.0",

packages/eslint-plugin-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry-internal/eslint-plugin-sdk",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Official Sentry SDK eslint plugin",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/eslint-plugin-sdk",

packages/gatsby/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/gatsby",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Official Sentry SDK for Gatsby.js",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/gatsby",
@@ -20,10 +20,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/react": "7.13.0",
-    "@sentry/tracing": "7.13.0",
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/react": "7.14.0",
+    "@sentry/tracing": "7.14.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "@sentry/webpack-plugin": "1.19.0"
   },
   "peerDependencies": {

packages/hub/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/hub",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Sentry hub which handles global state managment.",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/hub",
@@ -16,8 +16,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "tslib": "^1.9.3"
   },
   "scripts": {

packages/integration-tests/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry-internal/browser-integration-tests",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "main": "index.js",
   "license": "MIT",
   "engines": {

packages/integrations/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/integrations",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Pluggable integrations that can be used to enhance JS SDKs",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/integrations",
@@ -16,8 +16,8 @@
   "module": "build/npm/esm/index.js",
   "types": "build/npm/types/index.d.ts",
   "dependencies": {
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "localforage": "^1.8.1",
     "tslib": "^1.9.3"
   },

packages/nextjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/nextjs",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "Official Sentry SDK for Next.js",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs",
@@ -18,21 +18,21 @@
   },
   "dependencies": {
     "@rollup/plugin-sucrase": "4.0.4",
-    "@sentry/core": "7.13.0",
-    "@sentry/hub": "7.13.0",
-    "@sentry/integrations": "7.13.0",
-    "@sentry/node": "7.13.0",
-    "@sentry/react": "7.13.0",
-    "@sentry/tracing": "7.13.0",
-    "@sentry/types": "7.13.0",
-    "@sentry/utils": "7.13.0",
+    "@sentry/core": "7.14.0",
+    "@sentry/hub": "7.14.0",
+    "@sentry/integrations": "7.14.0",
+    "@sentry/node": "7.14.0",
+    "@sentry/react": "7.14.0",
+    "@sentry/tracing": "7.14.0",
+    "@sentry/types": "7.14.0",
+    "@sentry/utils": "7.14.0",
     "@sentry/webpack-plugin": "1.19.0",
     "chalk": "3.0.0",
     "rollup": "2.78.0",
     "tslib": "^1.9.3"
   },
   "devDependencies": {
-    "@sentry/nextjs": "7.13.0",
+    "@sentry/nextjs": "7.14.0",
     "@types/webpack": "^4.41.31",
     "next": "10.1.3"
   },

packages/nextjs/src/config/wrappers/types.ts

@@ -1,4 +1,4 @@
-import type { Transaction } from '@sentry/types';
+import type { Transaction, WrappedFunction } from '@sentry/types';
 import type { NextApiRequest, NextApiResponse } from 'next';
 
 // The `NextApiHandler` and `WrappedNextApiHandler` types are the same as the official `NextApiHandler` type, except:
@@ -42,4 +42,4 @@ export type AugmentedNextApiResponse = NextApiResponse & {
 };
 
 export type ResponseEndMethod = AugmentedNextApiResponse['end'];
-export type WrappedResponseEndMethod = AugmentedNextApiResponse['end'];
+export type WrappedResponseEndMethod = AugmentedNextApiResponse['end'] & WrappedFunction;

packages/nextjs/src/config/wrappers/utils/responseEnd.ts

@@ -0,0 +1,69 @@
+import { flush } from '@sentry/node';
+import { Transaction } from '@sentry/types';
+import { fill, logger } from '@sentry/utils';
+import { ServerResponse } from 'http';
+
+import { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
+
+/**
+ * Wrap `res.end()` so that it closes the transaction and flushes events before letting the request finish.
+ *
+ * Note: This wraps a sync method with an async method. While in general that's not a great idea in terms of keeping
+ * things in the right order, in this case it's safe, because the native `.end()` actually *is* (effectively) async, and
+ * its run actually *is* (literally) awaited, just manually so (which reflects the fact that the core of the
+ * request/response code in Node by far predates the introduction of `async`/`await`). When `.end()` is done, it emits
+ * the `prefinish` event, and only once that fires does request processing continue. See
+ * https://github.com/nodejs/node/commit/7c9b607048f13741173d397795bac37707405ba7.
+ *
+ * Also note: `res.end()` isn't called until *after* all response data and headers have been sent, so blocking inside of
+ * `end` doesn't delay data getting to the end user. See
+ * https://nodejs.org/api/http.html#responseenddata-encoding-callback.
+ *
+ * @param transaction The transaction tracing request handling
+ * @param res: The request's corresponding response
+ */
+export function autoEndTransactionOnResponseEnd(transaction: Transaction, res: ServerResponse): void {
+  const wrapEndMethod = (origEnd: ResponseEndMethod): WrappedResponseEndMethod => {
+    return async function sentryWrappedEnd(this: ServerResponse, ...args: unknown[]) {
+      await finishTransaction(transaction, this);
+      await flushQueue();
+
+      return origEnd.call(this, ...args);
+    };
+  };
+
+  // Prevent double-wrapping
+  if (!(res.end as WrappedResponseEndMethod).__sentry_original__) {
+    fill(res, 'end', wrapEndMethod);
+  }
+}
+
+/** Finish the given response's transaction and set HTTP status data */
+export async function finishTransaction(transaction: Transaction | undefined, res: ServerResponse): Promise<void> {
+  if (transaction) {
+    transaction.setHttpStatus(res.statusCode);
+
+    // If any open spans are set to finish when the response ends, it sets up a race condition between their `finish`
+    // calls and the transaction's `finish` call - and any spans which lose the race will get dropped from the
+    // transaction. To prevent this, push `transaction.finish` to the next event loop so that it's guaranteed to lose
+    // the race, and wait for it to be done before flushing events.
+    const transactionFinished: Promise<void> = new Promise(resolve => {
+      setImmediate(() => {
+        transaction.finish();
+        resolve();
+      });
+    });
+    await transactionFinished;
+  }
+}
+
+/** Flush the event queue to ensure that events get sent to Sentry before the response is finished and the lambda ends */
+export async function flushQueue(): Promise<void> {
+  try {
+    __DEBUG_BUILD__ && logger.log('Flushing events...');
+    await flush(2000);
+    __DEBUG_BUILD__ && logger.log('Done flushing events');
+  } catch (e) {
+    __DEBUG_BUILD__ && logger.log('Error while flushing events:\n', e);
+  }
+}