Merge branch 'master' of https://github.com/getsentry/sentry-javascript into onur/node-integration-tests

onurtemizkan · onurtemizkan · commit efd9f73d67dd · 2022-03-08T13:35:09.000Z
diff --git a/.size-limit.js b/.size-limit.js
@@ -57,4 +57,10 @@ module.exports = [
     gzip: true,
     limit: '100 KB',
   },
+  {
+    name: '@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified)',
+    path: 'packages/tracing/build/bundle.tracing.es6.min.js',
+    gzip: true,
+    limit: '100 KB',
+  },
 ];
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,22 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+## 6.18.2
+
+If you are using `@sentry-internal/eslint-config-sdk`, please note that this release turns on the [quotes rule](https://eslint.org/docs/rules/quotes) to enforce usage of single quotes.
+
+This release also removes `@sentry/tracing` as a dependency of `@sentry/node`. Please explicitly install and import `@sentry/tracing` if you want to use performance monitoring capabilities. For more details, [see our docs on setting up Node Performance Monitoring](https://docs.sentry.io/platforms/node/performance/).
+
+We also now produce an ES6 version of our [CDN tracing bundle](https://docs.sentry.io/platforms/javascript/install/cdn/#performance-bundle), which can be accessed with `bundle.tracing.es6.min.js`.
+
+- chore(eslint): Turn on quotes rules ([#4671](https://github.com/getsentry/sentry-javascript/pull/4671))
+- fix(node): prevent errors thrown on flush from breaking response ([#4667](https://github.com/getsentry/sentry-javascript/pull/4667))
+- ref(node): Remove dependency on @sentry/tracing ([#4647](https://github.com/getsentry/sentry-javascript/pull/4647))
+- fix(tracing): Make method required in transactionSampling type ([#4657](https://github.com/getsentry/sentry-javascript/pull/4657))
+- feat(tracing): Add ES6 tracing bundle ([#4674](https://github.com/getsentry/sentry-javascript/pull/4674))
+
+Work in this release contributed by @Ignigena. Thank you for your contribution!
+
 ## 6.18.1
 
 - fix(ember): use _backburner if it exists ([#4603](https://github.com/getsentry/sentry-javascript/pull/4603))
diff --git a/packages/browser/rollup.config.js b/packages/browser/rollup.config.js
@@ -1,37 +1,17 @@
-import { makeBaseBundleConfig, makeLicensePlugin, terserPlugin } from '../../rollup.config';
+import { makeBaseBundleConfig, makeMinificationVariants } from '../../rollup.config';
 
 const builds = [];
 
-const licensePlugin = makeLicensePlugin();
-
 ['es5', 'es6'].forEach(jsVersion => {
   const baseBundleConfig = makeBaseBundleConfig({
     input: 'src/index.ts',
     isAddOn: false,
     jsVersion,
+    licenseTitle: '@sentry/browser',
     outputFileBase: `build/bundle${jsVersion === 'es6' ? '.es6' : ''}`,
   });
 
-  builds.push(
-    ...[
-      {
-        ...baseBundleConfig,
-        output: {
-          ...baseBundleConfig.output,
-          file: `${baseBundleConfig.output.file}.js`,
-        },
-        plugins: [...baseBundleConfig.plugins, licensePlugin],
-      },
-      {
-        ...baseBundleConfig,
-        output: {
-          ...baseBundleConfig.output,
-          file: `${baseBundleConfig.output.file}.min.js`,
-        },
-        plugins: [...baseBundleConfig.plugins, terserPlugin, licensePlugin],
-      },
-    ],
-  );
+  builds.push(...makeMinificationVariants(baseBundleConfig));
 });
 
 export default builds;
diff --git a/packages/browser/src/transports/base.ts b/packages/browser/src/transports/base.ts
@@ -226,7 +226,7 @@ export abstract class BaseTransport implements Transport {
       }
       return true;
     } else if (raHeader) {
-      this._rateLimits.all = new Date(now + parseRetryAfterHeader(now, raHeader));
+      this._rateLimits.all = new Date(now + parseRetryAfterHeader(raHeader, now));
       return true;
     }
     return false;
diff --git a/packages/integration-tests/utils/generatePlugin.ts b/packages/integration-tests/utils/generatePlugin.ts
@@ -29,9 +29,8 @@ const BUNDLE_PATHS: Record<string, Record<string, string>> = {
     esm: 'esm/index.js',
     bundle_es5: 'build/bundle.tracing.js',
     bundle_es5_min: 'build/bundle.tracing.min.js',
-    // `tracing` doesn't have an es6 build yet
-    bundle_es6: 'build/bundle.tracing.js',
-    bundle_es6_min: 'build/bundle.tracing.min.js',
+    bundle_es6: 'build/bundle.tracing.es6.js',
+    bundle_es6_min: 'build/bundle.tracing.es6.min.js',
   },
 };
 
diff --git a/packages/integrations/rollup.config.js b/packages/integrations/rollup.config.js
@@ -2,45 +2,25 @@ import * as fs from 'fs';
 
 import commonjs from '@rollup/plugin-commonjs';
 
-import { makeBaseBundleConfig, terserPlugin } from '../../rollup.config';
-
-function allIntegrations() {
-  return fs.readdirSync('./src').filter(file => file != 'index.ts');
-}
-
-function loadAllIntegrations() {
-  const builds = [];
-
-  allIntegrations().forEach(file => {
-    const baseBundleConfig = makeBaseBundleConfig({
-      input: `src/${file}`,
-      isAddOn: true,
-      jsVersion: 'es5',
-      outputFileBase: `build/${file.replace('.ts', '')}`,
-    });
-
-    [
-      {
-        extension: '.js',
-        plugins: [...baseBundleConfig.plugins, commonjs()],
-      },
-      {
-        extension: '.min.js',
-        plugins: [...baseBundleConfig.plugins, commonjs(), terserPlugin],
-      },
-    ].forEach(build => {
-      builds.push({
-        ...baseBundleConfig,
-        output: {
-          ...baseBundleConfig.output,
-          file: `${baseBundleConfig.output.file}${build.extension}`,
-        },
-        plugins: build.plugins,
-      });
-    });
+import { insertAt, makeBaseBundleConfig, makeMinificationVariants } from '../../rollup.config';
+
+const builds = [];
+
+const integrationSourceFiles = fs.readdirSync('./src').filter(file => file != 'index.ts');
+
+integrationSourceFiles.forEach(file => {
+  const baseBundleConfig = makeBaseBundleConfig({
+    input: `src/${file}`,
+    isAddOn: true,
+    jsVersion: 'es5',
+    licenseTitle: '@sentry/integrations',
+    outputFileBase: `build/${file.replace('.ts', '')}`,
   });
 
-  return builds;
-}
+  // TODO We only need `commonjs` for localforage (used in the offline plugin). Once that's fixed, this can come out.
+  baseBundleConfig.plugins = insertAt(baseBundleConfig.plugins, -2, commonjs());
+
+  builds.push(...makeMinificationVariants(baseBundleConfig));
+});
 
-export default loadAllIntegrations();
+export default builds;
diff --git a/packages/node/src/transports/base/index.ts b/packages/node/src/transports/base/index.ts
@@ -181,7 +181,7 @@ export abstract class BaseTransport implements Transport {
       }
       return true;
     } else if (raHeader) {
-      this._rateLimits.all = new Date(now + parseRetryAfterHeader(now, raHeader));
+      this._rateLimits.all = new Date(now + parseRetryAfterHeader(raHeader, now));
       return true;
     }
     return false;
diff --git a/packages/tracing/rollup.config.js b/packages/tracing/rollup.config.js
@@ -1,30 +1,17 @@
-import { makeBaseBundleConfig, makeLicensePlugin, terserPlugin } from '../../rollup.config';
+import { makeBaseBundleConfig, makeMinificationVariants } from '../../rollup.config';
 
-const licensePlugin = makeLicensePlugin('@sentry/tracing & @sentry/browser');
+const builds = [];
 
-const baseBundleConfig = makeBaseBundleConfig({
-  input: 'src/index.bundle.ts',
-  isAddOn: false,
-  jsVersion: 'es5',
-  outputFileBase: 'build/bundle.tracing',
+['es5', 'es6'].forEach(jsVersion => {
+  const baseBundleConfig = makeBaseBundleConfig({
+    input: 'src/index.bundle.ts',
+    isAddOn: false,
+    jsVersion,
+    licenseTitle: '@sentry/tracing & @sentry/browser',
+    outputFileBase: `build/bundle.tracing${jsVersion === 'es6' ? '.es6' : ''}`,
+  });
+
+  builds.push(...makeMinificationVariants(baseBundleConfig));
 });
 
-export default [
-  // ES5 Browser Tracing Bundle
-  {
-    ...baseBundleConfig,
-    output: {
-      ...baseBundleConfig.output,
-      file: `${baseBundleConfig.output.file}.js`,
-    },
-    plugins: [...baseBundleConfig.plugins, licensePlugin],
-  },
-  {
-    ...baseBundleConfig,
-    output: {
-      ...baseBundleConfig.output,
-      file: `${baseBundleConfig.output.file}.min.js`,
-    },
-    plugins: [...baseBundleConfig.plugins, terserPlugin, licensePlugin],
-  },
-];
+export default builds;
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -24,3 +24,4 @@ export * from './tracing';
 export * from './env';
 export * from './envelope';
 export * from './clientreport';
+export * from './ratelimit';
diff --git a/packages/utils/src/misc.ts b/packages/utils/src/misc.ts
@@ -188,31 +188,6 @@ export function parseSemver(input: string): SemVer {
   };
 }
 
-const defaultRetryAfter = 60 * 1000; // 60 seconds
-
-/**
- * Extracts Retry-After value from the request header or returns default value
- * @param now current unix timestamp
- * @param header string representation of 'Retry-After' header
- */
-export function parseRetryAfterHeader(now: number, header?: string | number | null): number {
-  if (!header) {
-    return defaultRetryAfter;
-  }
-
-  const headerDelay = parseInt(`${header}`, 10);
-  if (!isNaN(headerDelay)) {
-    return headerDelay * 1000;
-  }
-
-  const headerDate = Date.parse(`${header}`);
-  if (!isNaN(headerDate)) {
-    return headerDate - now;
-  }
-
-  return defaultRetryAfter;
-}
-
 /**
  * This function adds context (pre/post/line) lines to the provided frame
  *
diff --git a/packages/utils/src/ratelimit.ts b/packages/utils/src/ratelimit.ts
@@ -0,0 +1,88 @@
+// Keeping the key broad until we add the new transports
+export type RateLimits = Record<string, number>;
+
+export const DEFAULT_RETRY_AFTER = 60 * 1000; // 60 seconds
+
+/**
+ * Extracts Retry-After value from the request header or returns default value
+ * @param header string representation of 'Retry-After' header
+ * @param now current unix timestamp
+ *
+ */
+export function parseRetryAfterHeader(header: string, now: number = Date.now()): number {
+  const headerDelay = parseInt(`${header}`, 10);
+  if (!isNaN(headerDelay)) {
+    return headerDelay * 1000;
+  }
+
+  const headerDate = Date.parse(`${header}`);
+  if (!isNaN(headerDate)) {
+    return headerDate - now;
+  }
+
+  return DEFAULT_RETRY_AFTER;
+}
+
+/**
+ * Gets the time that given category is disabled until for rate limiting
+ */
+export function disabledUntil(limits: RateLimits, category: string): number {
+  return limits[category] || limits.all || 0;
+}
+
+/**
+ * Checks if a category is rate limited
+ */
+export function isRateLimited(limits: RateLimits, category: string, now: number = Date.now()): boolean {
+  return disabledUntil(limits, category) > now;
+}
+
+/**
+ * Update ratelimits from incoming headers.
+ * Returns true if headers contains a non-empty rate limiting header.
+ */
+export function updateRateLimits(
+  limits: RateLimits,
+  headers: Record<string, string | null | undefined>,
+  now: number = Date.now(),
+): RateLimits {
+  const updatedRateLimits: RateLimits = {
+    ...limits,
+  };
+
+  // "The name is case-insensitive."
+  // https://developer.mozilla.org/en-US/docs/Web/API/Headers/get
+  const rateLimitHeader = headers['x-sentry-rate-limits'];
+  const retryAfterHeader = headers['retry-after'];
+
+  if (rateLimitHeader) {
+    /**
+     * rate limit headers are of the form
+     *     <header>,<header>,..
+     * where each <header> is of the form
+     *     <retry_after>: <categories>: <scope>: <reason_code>
+     * where
+     *     <retry_after> is a delay in seconds
+     *     <categories> is the event type(s) (error, transaction, etc) being rate limited and is of the form
+     *         <category>;<category>;...
+     *     <scope> is what's being limited (org, project, or key) - ignored by SDK
+     *     <reason_code> is an arbitrary string like "org_quota" - ignored by SDK
+     */
+    for (const limit of rateLimitHeader.trim().split(',')) {
+      const parameters = limit.split(':', 2);
+      const headerDelay = parseInt(parameters[0], 10);
+      const delay = (!isNaN(headerDelay) ? headerDelay : 60) * 1000; // 60sec default
+      if (!parameters[1]) {
+        updatedRateLimits.all = now + delay;
+      } else {
+        for (const category of parameters[1].split(';')) {
+          updatedRateLimits[category] = now + delay;
+        }
+      }
+    }
+  } else if (retryAfterHeader) {
+    updatedRateLimits.all = now + parseRetryAfterHeader(retryAfterHeader, now);
+  }
+
+  return updatedRateLimits;
+}
diff --git a/packages/utils/test/misc.test.ts b/packages/utils/test/misc.test.ts
@@ -5,7 +5,6 @@ import {
   addExceptionMechanism,
   checkOrSetAlreadyCaught,
   getEventDescription,
-  parseRetryAfterHeader,
   stripUrlQueryAndFragment,
 } from '../src/misc';
 
@@ -118,26 +117,6 @@ describe('getEventDescription()', () => {
   });
 });
 
-describe('parseRetryAfterHeader', () => {
-  test('no header', () => {
-    expect(parseRetryAfterHeader(Date.now())).toEqual(60 * 1000);
-  });
-
-  test('incorrect header', () => {
-    expect(parseRetryAfterHeader(Date.now(), 'x')).toEqual(60 * 1000);
-  });
-
-  test('delay header', () => {
-    expect(parseRetryAfterHeader(Date.now(), '1337')).toEqual(1337 * 1000);
-  });
-
-  test('date header', () => {
-    expect(
-      parseRetryAfterHeader(new Date('Wed, 21 Oct 2015 07:28:00 GMT').getTime(), 'Wed, 21 Oct 2015 07:28:13 GMT'),
-    ).toEqual(13 * 1000);
-  });
-});
-
 describe('addContextToFrame', () => {
   const lines = [
     '1: a',
diff --git a/packages/utils/test/ratelimit.test.ts b/packages/utils/test/ratelimit.test.ts
diff --git a/packages/vue/rollup.config.js b/packages/vue/rollup.config.js
diff --git a/packages/wasm/rollup.config.js b/packages/wasm/rollup.config.js
diff --git a/rollup.config.js b/rollup.config.js

Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ export abstract class BaseTransport implements Transport {`
`226`	`226`	`}`
`227`	`227`	`return true;`
`228`	`228`	`} else if (raHeader) {`
`229`		`- this._rateLimits.all = new Date(now + parseRetryAfterHeader(now, raHeader));`
	`229`	`+ this._rateLimits.all = new Date(now + parseRetryAfterHeader(raHeader, now));`
`230`	`230`	`return true;`
`231`	`231`	`}`
`232`	`232`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ export abstract class BaseTransport implements Transport {`
`181`	`181`	`}`
`182`	`182`	`return true;`
`183`	`183`	`} else if (raHeader) {`
`184`		`- this._rateLimits.all = new Date(now + parseRetryAfterHeader(now, raHeader));`
	`184`	`+ this._rateLimits.all = new Date(now + parseRetryAfterHeader(raHeader, now));`
`185`	`185`	`return true;`
`186`	`186`	`}`
`187`	`187`	`return false;`