Merge branch 'master' into feat/gatsby

dcramer · web-flow · commit a146fdc6eeba · 2020-06-10T13:32:16.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@
 - [react] feat: Add @sentry/react package (#2631)
 - [react] feat: Add Error Boundary component (#2647)
 - [react] feat: Add useProfiler hook (#2659)
+- [core] feat: Export `makeMain` (#2665)
+- [core] fix: Call `bindClient` when creating new `Hub` to make integrations work automatically (#2665)
 - [gatsby] feat: Add @sentry/gatsby package (#2652)
 
 ## 5.17.0
diff --git a/packages/browser/src/exports.ts b/packages/browser/src/exports.ts
@@ -25,6 +25,7 @@ export {
   getHubFromCarrier,
   getCurrentHub,
   Hub,
+  makeMain,
   Scope,
   startTransaction,
   setContext,
diff --git a/packages/browser/test/integration/suites/builtins.js b/packages/browser/test/integration/suites/builtins.js
@@ -64,17 +64,72 @@ describe("wrapped built-ins", function() {
     });
   });
 
-  it("should capture exceptions inside requestAnimationFrame", function() {
-    // needs to be visible or requestAnimationFrame won't ever fire
-    sandbox.style.display = "block";
+  describe("requestAnimationFrame", function() {
+    it("should capture exceptions inside callback", function() {
+      // needs to be visible or requestAnimationFrame won't ever fire
+      sandbox.style.display = "block";
 
-    return runInSandbox(sandbox, { manual: true }, function() {
-      requestAnimationFrame(function() {
-        window.finalizeManualTest();
-        foo();
+      return runInSandbox(sandbox, { manual: true }, function() {
+        requestAnimationFrame(function() {
+          window.finalizeManualTest();
+          foo();
+        });
+      }).then(function(summary) {
+        assert.match(summary.events[0].exception.values[0].value, /baz/);
+      });
+    });
+
+    it("wrapped callback should preserve correct context - window (not-bound)", function() {
+      // needs to be visible or requestAnimationFrame won't ever fire
+      sandbox.style.display = "block";
+      return runInSandbox(sandbox, { manual: true }, function() {
+        requestAnimationFrame(function() {
+          window.capturedCtx = this;
+          window.finalizeManualTest();
+        });
+      }).then(function(summary) {
+        assert.strictEqual(summary.window.capturedCtx, summary.window);
+        delete summary.window.capturedCtx;
+      });
+    });
+
+    it("wrapped callback should preserve correct context - class bound method", function() {
+      // needs to be visible or requestAnimationFrame won't ever fire
+      sandbox.style.display = "block";
+      return runInSandbox(sandbox, { manual: true }, function() {
+        // TypeScript-transpiled class syntax
+        var Foo = (function() {
+          function Foo() {
+            var _this = this;
+            this.magicNumber = 42;
+            this.getThis = function() {
+              window.capturedCtx = _this;
+              window.finalizeManualTest();
+            };
+          }
+          return Foo;
+        })();
+        var foo = new Foo();
+        requestAnimationFrame(foo.getThis);
+      }).then(function(summary) {
+        assert.strictEqual(summary.window.capturedCtx.magicNumber, 42);
+        delete summary.window.capturedCtx;
+      });
+    });
+
+    it("wrapped callback should preserve correct context - `bind` bound method", function() {
+      // needs to be visible or requestAnimationFrame won't ever fire
+      sandbox.style.display = "block";
+      return runInSandbox(sandbox, { manual: true }, function() {
+        function foo() {
+          window.capturedCtx = this;
+          window.finalizeManualTest();
+        }
+        requestAnimationFrame(foo.bind({ magicNumber: 42 }));
+      }).then(function(summary) {
+        assert.strictEqual(summary.window.capturedCtx.magicNumber, 42);
+        delete summary.window.capturedCtx;
       });
-    }).then(function(summary) {
-      assert.match(summary.events[0].exception.values[0].value, /baz/);
     });
   });
 
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -13,7 +13,7 @@ export {
   setUser,
   withScope,
 } from '@sentry/minimal';
-export { addGlobalEventProcessor, getCurrentHub, getHubFromCarrier, Hub, Scope } from '@sentry/hub';
+export { addGlobalEventProcessor, getCurrentHub, getHubFromCarrier, Hub, makeMain, Scope } from '@sentry/hub';
 export { API } from './api';
 export { BaseClient } from './baseclient';
 export { BackendClass, BaseBackend } from './basebackend';
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -61,6 +61,7 @@ export class Hub implements HubInterface {
    */
   public constructor(client?: Client, scope: Scope = new Scope(), private readonly _version: number = API_VERSION) {
     this._stack.push({ client, scope });
+    this.bindClient(client);
   }
 
   /**
diff --git a/packages/hub/test/hub.test.ts b/packages/hub/test/hub.test.ts
@@ -6,10 +6,18 @@ const clientFn: any = jest.fn();
 
 describe('Hub', () => {
   afterEach(() => {
-    jest.resetAllMocks();
+    jest.restoreAllMocks();
     jest.useRealTimers();
   });
 
+  test('call bindClient with provided client when constructing new instance', () => {
+    const testClient: any = { setupIntegrations: jest.fn() };
+    const spy = jest.spyOn(Hub.prototype, 'bindClient');
+    // tslint:disable-next-line:no-unused-expression
+    new Hub(testClient);
+    expect(spy).toHaveBeenCalledWith(testClient);
+  });
+
   test('push process into stack', () => {
     const hub = new Hub();
     expect(hub.getStack()).toHaveLength(1);
@@ -51,15 +59,35 @@ describe('Hub', () => {
       expect(hub.getStack()[1].client).toBe(testClient);
     });
 
-    test('bindClient', () => {
-      const testClient: any = { bla: 'a' };
-      const hub = new Hub(testClient);
-      const ndClient: any = { foo: 'bar' };
-      hub.pushScope();
-      hub.bindClient(ndClient);
-      expect(hub.getStack()).toHaveLength(2);
-      expect(hub.getStack()[0].client).toBe(testClient);
-      expect(hub.getStack()[1].client).toBe(ndClient);
+    describe('bindClient', () => {
+      test('should override curent client', () => {
+        const testClient: any = { setupIntegrations: jest.fn() };
+        const nextClient: any = { setupIntegrations: jest.fn() };
+        const hub = new Hub(testClient);
+        hub.bindClient(nextClient);
+        expect(hub.getStack()).toHaveLength(1);
+        expect(hub.getStack()[0].client).toBe(nextClient);
+      });
+
+      test('should bind client to the top-most layer', () => {
+        const testClient: any = { bla: 'a' };
+        const nextClient: any = { foo: 'bar' };
+        const hub = new Hub(testClient);
+        hub.pushScope();
+        hub.bindClient(nextClient);
+        expect(hub.getStack()).toHaveLength(2);
+        expect(hub.getStack()[0].client).toBe(testClient);
+        expect(hub.getStack()[1].client).toBe(nextClient);
+      });
+
+      test('should call setupIntegration method of passed client', () => {
+        const testClient: any = { setupIntegrations: jest.fn() };
+        const nextClient: any = { setupIntegrations: jest.fn() };
+        const hub = new Hub(testClient);
+        hub.bindClient(nextClient);
+        expect(testClient.setupIntegrations).toHaveBeenCalled();
+        expect(nextClient.setupIntegrations).toHaveBeenCalled();
+      });
     });
 
     test('inherit processors', () => {
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -25,6 +25,7 @@ export {
   getHubFromCarrier,
   getCurrentHub,
   Hub,
+  makeMain,
   Scope,
   startTransaction,
   setContext,
diff --git a/packages/utils/src/misc.ts b/packages/utils/src/misc.ts
@@ -382,22 +382,26 @@ export const crossPlatformPerformance: CrossPlatformPerformance = (() => {
     }
   }
 
-  if (getGlobalObject<Window>().performance) {
-    // Polyfill for performance.timeOrigin.
-    //
-    // While performance.timing.navigationStart is deprecated in favor of performance.timeOrigin, performance.timeOrigin
-    // is not as widely supported. Namely, performance.timeOrigin is undefined in Safari as of writing.
-    // tslint:disable-next-line:strict-type-predicates
-    if (performance.timeOrigin === undefined) {
-      // As of writing, performance.timing is not available in Web Workers in mainstream browsers, so it is not always a
-      // valid fallback. In the absence of a initial time provided by the browser, fallback to INITIAL_TIME.
-      // @ts-ignore
-      // tslint:disable-next-line:deprecation
-      performance.timeOrigin = (performance.timing && performance.timing.navigationStart) || INITIAL_TIME;
-    }
+  const { performance } = getGlobalObject<Window>();
+
+  if (!performance || !performance.now) {
+    return performanceFallback;
+  }
+
+  // Polyfill for performance.timeOrigin.
+  //
+  // While performance.timing.navigationStart is deprecated in favor of performance.timeOrigin, performance.timeOrigin
+  // is not as widely supported. Namely, performance.timeOrigin is undefined in Safari as of writing.
+  // tslint:disable-next-line:strict-type-predicates
+  if (performance.timeOrigin === undefined) {
+    // As of writing, performance.timing is not available in Web Workers in mainstream browsers, so it is not always a
+    // valid fallback. In the absence of a initial time provided by the browser, fallback to INITIAL_TIME.
+    // @ts-ignore
+    // tslint:disable-next-line:deprecation
+    performance.timeOrigin = (performance.timing && performance.timing.navigationStart) || INITIAL_TIME;
   }
 
-  return getGlobalObject<Window>().performance || performanceFallback;
+  return performance;
 })();
 
 /**
diff --git a/yarn.lock b/yarn.lock
@@ -1810,32 +1810,11 @@ after@0.8.2:
   version "0.8.2"
   resolved "https://registry.yarnpkg.com/after/-/after-0.8.2.tgz#fedb394f9f0e02aa9768e702bda23b505fae7e1f"
 
-agent-base@4, agent-base@^4.3.0:
-  version "4.3.0"
-  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-4.3.0.tgz#8165f01c436009bccad0b1d122f05ed770efc6ee"
-  integrity sha512-salcGninV0nPrwpGNn4VTXBb1SOuXQBiqbrNXoeizJsHrsL6ERFM2Ne3JUSBWRE6aeNJI2ROP/WEEIDUiDe3cg==
-  dependencies:
-    es6-promisify "^5.0.0"
-
-agent-base@5:
+agent-base@4, agent-base@5, agent-base@6, agent-base@^4.3.0, agent-base@~4.2.0:
   version "5.1.1"
   resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-5.1.1.tgz#e8fb3f242959db44d63be665db7a8e739537a32c"
   integrity sha512-TMeqbNl2fMW0nMjTEPOwe3J/PRFP4vqeoNuQMG0HlMrtm5QxKqdvAkZ1pRBQ/ulIyDD5Yq0nJ7YbdD8ey0TO3g==
 
-agent-base@6:
-  version "6.0.0"
-  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-6.0.0.tgz#5d0101f19bbfaed39980b22ae866de153b93f09a"
-  integrity sha512-j1Q7cSCqN+AwrmDd+pzgqc0/NpC655x2bUf5ZjRIO77DcNBFmh+OgRNzF6OKdCC9RSCb19fGd99+bhXFdkRNqw==
-  dependencies:
-    debug "4"
-
-agent-base@~4.2.0:
-  version "4.2.1"
-  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-4.2.1.tgz#d89e5999f797875674c07d87f260fc41e83e8ca9"
-  integrity sha512-JVwXMr9nHYTUXsBFKUqhJwvlcYU/blreOEUkhNR2eXZIvwd+c+o5V4MgDPKWnMS/56awN3TRzIP+KoPn+roQtg==
-  dependencies:
-    es6-promisify "^5.0.0"
-
 agentkeepalive@^3.4.1:
   version "3.5.2"
   resolved "https://registry.yarnpkg.com/agentkeepalive/-/agentkeepalive-3.5.2.tgz#a113924dd3fa24a0bc3b78108c450c2abee00f67"
@@ -4553,18 +4532,6 @@ es-to-primitive@^1.1.1, es-to-primitive@^1.2.0:
     is-date-object "^1.0.1"
     is-symbol "^1.0.2"
 
-es6-promise@^4.0.3:
-  version "4.2.8"
-  resolved "https://registry.yarnpkg.com/es6-promise/-/es6-promise-4.2.8.tgz#4eb21594c972bc40553d276e510539143db53e0a"
-  integrity sha512-HJDGx5daxeIvxdBxvG2cb9g4tEvwIk3i8+nhX0yGrYmZUzbkdg8QbDevheDB8gd0//uPj4c1EQua8Q+MViT0/w==
-
-es6-promisify@^5.0.0:
-  version "5.0.0"
-  resolved "https://registry.yarnpkg.com/es6-promisify/-/es6-promisify-5.0.0.tgz#5109d62f3e56ea967c4b63505aef08291c8a5203"
-  integrity sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=
-  dependencies:
-    es6-promise "^4.0.3"
-
 escape-html@~1.0.3:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ export class Hub implements HubInterface {`
`61`	`61`	`*/`
`62`	`62`	`public constructor(client?: Client, scope: Scope = new Scope(), private readonly _version: number = API_VERSION) {`
`63`	`63`	`this._stack.push({ client, scope });`
	`64`	`+ this.bindClient(client);`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`/**`