feat: Expose withScope (#1536)

HazAT · web-flow · commit 2249c2eca724 · 2018-09-17T13:34:20.000+02:00
* feat: Expose push/pop/withScope in minimal, Add level to scope

* feat: Remove minimal and hub dep from browser

* feat: Remove reexport of push and pop in minimal

* fix: Remove node 5/7/9
diff --git a/.gitignore b/.gitignore
@@ -24,3 +24,5 @@ lerna-debug.log
 .Trashes
 
 .rpt2_cache
+
+docs
diff --git a/.travis.yml b/.travis.yml
@@ -15,60 +15,45 @@ cache:
 
 matrix:
   include:
-    - name: "@sentry/packages - lint"
-      node_js: "8"
+    - name: '@sentry/packages - lint'
+      node_js: '8'
       script: .travis/lint.sh
-    - name: "@sentry/packages - build and test [node v6]"
-      node_js: "6"
+    - name: '@sentry/packages - build and test [node v6]'
+      node_js: '6'
       script: .travis/test.sh
-    - name: "@sentry/packages - build and test [node v7]"
-      node_js: "7"
+    - name: '@sentry/packages - build and test [node v8]'
+      node_js: '8'
       script: .travis/test.sh
-    - name: "@sentry/packages - build and test [node v8]"
-      node_js: "8"
+    - name: '@sentry/packages - build and test [node v10]'
+      node_js: '10'
       script: .travis/test.sh
-    - name: "@sentry/packages - build and test [node v9]"
-      node_js: "9"
-      script: .travis/test.sh
-    - name: "@sentry/packages - build and test [node v10]"
-      node_js: "10"
-      script: .travis/test.sh
-    - name: "@sentry/browser - integration tests"
-      node_js: "8"
+    - name: '@sentry/browser - integration tests'
+      node_js: '8'
       addons:
         chrome: stable
         firefox: latest
         sauce_connect: true
       script: .travis/integration.sh
-    - name: "raven-js - unit and integration tests"
-      node_js: "8"
+    - name: 'raven-js - unit and integration tests'
+      node_js: '8'
       addons:
         chrome: stable
         firefox: latest
       script: .travis/raven-js.sh
-    - name: "raven-js - saucelabs tests"
-      node_js: "8"
+    - name: 'raven-js - saucelabs tests'
+      node_js: '8'
       addons:
         sauce_connect: true
       script: .travis/raven-js-saucelabs.sh
-    - name: "raven-node [node v4]"
-      node_js: "4"
-      script: .travis/raven-node.sh
-    - name: "raven-node [node v5]"
-      node_js: "5"
-      script: .travis/raven-node.sh
-    - name: "raven-node [node v6]"
-      node_js: "6"
-      script: .travis/raven-node.sh
-    - name: "raven-node [node v7]"
-      node_js: "7"
+    - name: 'raven-node [node v4]'
+      node_js: '4'
       script: .travis/raven-node.sh
-    - name: "raven-node [node v8]"
-      node_js: "8"
+    - name: 'raven-node [node v6]'
+      node_js: '6'
       script: .travis/raven-node.sh
-    - name: "raven-node [node v9]"
-      node_js: "9"
+    - name: 'raven-node [node v8]'
+      node_js: '8'
       script: .travis/raven-node.sh
-    - name: "raven-node [node v10]"
-      node_js: "10"
+    - name: 'raven-node [node v10]'
+      node_js: '10'
       script: .travis/raven-node.sh
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -16,8 +16,6 @@
   },
   "dependencies": {
     "@sentry/core": "4.0.0-rc.2",
-    "@sentry/hub": "4.0.0-rc.2",
-    "@sentry/minimal": "4.0.0-rc.2",
     "@sentry/types": "4.0.0-rc.2",
     "@sentry/utils": "4.0.0-rc.2",
     "md5": "2.2.1"
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -13,9 +13,18 @@ export {
   User,
 } from '@sentry/types';
 
-export { addBreadcrumb, captureMessage, captureException, captureEvent, configureScope } from '@sentry/minimal';
-
-export { getHubFromCarrier, getCurrentHub, Hub, Scope } from '@sentry/hub';
+export {
+  addBreadcrumb,
+  captureException,
+  captureEvent,
+  captureMessage,
+  configureScope,
+  withScope,
+  getHubFromCarrier,
+  getCurrentHub,
+  Hub,
+  Scope,
+} from '@sentry/core';
 
 export { BrowserBackend, BrowserOptions } from './backend';
 export { BrowserClient } from './client';
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -1,5 +1,4 @@
-import { API, logger } from '@sentry/core';
-import { getCurrentHub } from '@sentry/hub';
+import { API, getCurrentHub, logger } from '@sentry/core';
 import { Integration, Severity } from '@sentry/types';
 import { isFunction, isString } from '@sentry/utils/is';
 import { getGlobalObject, parseUrl } from '@sentry/utils/misc';
diff --git a/packages/browser/src/integrations/dedupe.ts b/packages/browser/src/integrations/dedupe.ts
@@ -1,5 +1,4 @@
-import { logger } from '@sentry/core';
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { configureScope, logger } from '@sentry/core';
 import { Integration, SentryEvent, SentryException, StackFrame } from '@sentry/types';
 
 /** Deduplication filter */
@@ -18,7 +17,7 @@ export class Dedupe implements Integration {
    * @inheritDoc
    */
   public install(): void {
-    getCurrentHub().configureScope((scope: Scope) => {
+    configureScope(scope => {
       scope.addEventProcessor(async (currentEvent: SentryEvent) => {
         // Juuust in case something goes wrong
         try {
diff --git a/packages/browser/src/integrations/globalhandlers.ts b/packages/browser/src/integrations/globalhandlers.ts
@@ -1,5 +1,4 @@
-import { logger } from '@sentry/core';
-import { getCurrentHub } from '@sentry/hub';
+import { getCurrentHub, logger } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
 import { eventFromStacktrace } from '../parsers';
 import {
diff --git a/packages/browser/src/integrations/helpers.ts b/packages/browser/src/integrations/helpers.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { getCurrentHub, withScope } from '@sentry/core';
 import { Mechanism, SentryEvent, SentryWrappedFunction } from '@sentry/types';
 import { isFunction } from '@sentry/utils/is';
 import { htmlTreeAsString } from '@sentry/utils/misc';
@@ -65,18 +65,16 @@ export function wrap(
     } catch (ex) {
       ignoreNextOnError();
 
-      getCurrentHub().withScope(async () => {
-        getCurrentHub().configureScope((scope: Scope) => {
-          scope.addEventProcessor(async (event: SentryEvent) => {
-            const processedEvent = { ...event };
+      withScope(async scope => {
+        scope.addEventProcessor(async (event: SentryEvent) => {
+          const processedEvent = { ...event };
 
-            if (options.mechanism) {
-              processedEvent.exception = processedEvent.exception || {};
-              processedEvent.exception.mechanism = options.mechanism;
-            }
+          if (options.mechanism) {
+            processedEvent.exception = processedEvent.exception || {};
+            processedEvent.exception.mechanism = options.mechanism;
+          }
 
-            return processedEvent;
-          });
+          return processedEvent;
         });
 
         getCurrentHub().captureException(ex, { originalException: ex });
diff --git a/packages/browser/src/integrations/inboundfilters.ts b/packages/browser/src/integrations/inboundfilters.ts
@@ -1,5 +1,4 @@
-import { logger } from '@sentry/core';
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { configureScope, logger } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
 import { isRegExp } from '@sentry/utils/is';
 import { BrowserOptions } from '../backend';
@@ -27,7 +26,7 @@ export class InboundFilters implements Integration {
   public install(options: BrowserOptions = {}): void {
     this.configureOptions(options);
 
-    getCurrentHub().configureScope((scope: Scope) => {
+    configureScope(scope => {
       scope.addEventProcessor(async (event: SentryEvent) => {
         if (this.shouldDropEvent(event)) {
           return null;
diff --git a/packages/browser/src/integrations/linkederrors.ts b/packages/browser/src/integrations/linkederrors.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub } from '@sentry/hub';
+import { configureScope } from '@sentry/core';
 import { Integration, SentryEvent, SentryEventHint, SentryException } from '@sentry/types';
 import { exceptionFromStacktrace } from '../parsers';
 import { computeStackTrace } from '../tracekit';
@@ -42,9 +42,7 @@ export class LinkedErrors implements Integration {
    * @inheritDoc
    */
   public install(): void {
-    getCurrentHub().configureScope(scope => {
-      scope.addEventProcessor(this.handler.bind(this));
-    });
+    configureScope(scope => scope.addEventProcessor(this.handler.bind(this)));
   }
 
   /**
diff --git a/packages/browser/src/integrations/pluggable/ember.ts b/packages/browser/src/integrations/pluggable/ember.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { captureMessage, getCurrentHub, Scope, withScope } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils/misc';
 
@@ -36,10 +36,8 @@ export class Ember implements Integration {
     const oldOnError = this.Ember.onerror;
 
     this.Ember.onerror = (error: Error): void => {
-      getCurrentHub().withScope(() => {
-        getCurrentHub().configureScope((scope: Scope) => {
-          this.addIntegrationToSdkInfo(scope);
-        });
+      withScope(scope => {
+        this.addIntegrationToSdkInfo(scope);
         getCurrentHub().captureException(error, { originalException: error });
       });
 
@@ -51,24 +49,16 @@ export class Ember implements Integration {
     this.Ember.RSVP.on(
       'error',
       (reason: any): void => {
-        getCurrentHub().pushScope();
-
+        const scope = getCurrentHub().pushScope();
         if (reason instanceof Error) {
-          getCurrentHub().configureScope((scope: Scope) => {
-            scope.setExtra('context', 'Unhandled Promise error detected');
-            this.addIntegrationToSdkInfo(scope);
-          });
-
+          scope.setExtra('context', 'Unhandled Promise error detected');
+          this.addIntegrationToSdkInfo(scope);
           getCurrentHub().captureException(reason, { originalException: reason });
         } else {
-          getCurrentHub().configureScope((scope: Scope) => {
-            scope.setExtra('reason', reason);
-            this.addIntegrationToSdkInfo(scope);
-          });
-
-          getCurrentHub().captureMessage('Unhandled Promise error detected');
+          scope.setExtra('reason', reason);
+          this.addIntegrationToSdkInfo(scope);
+          captureMessage('Unhandled Promise error detected');
         }
-
         getCurrentHub().popScope();
       },
     );
diff --git a/packages/browser/src/integrations/pluggable/vue.ts b/packages/browser/src/integrations/pluggable/vue.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { getCurrentHub, withScope } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
 import { isPlainObject, isUndefined } from '@sentry/utils/is';
 import { getGlobalObject } from '@sentry/utils/misc';
@@ -70,22 +70,20 @@ export class Vue implements Integration {
         metadata.lifecycleHook = info;
       }
 
-      getCurrentHub().withScope(() => {
-        getCurrentHub().configureScope((scope: Scope) => {
-          Object.keys(metadata).forEach(key => {
-            scope.setExtra(key, metadata[key]);
-          });
+      withScope(scope => {
+        Object.keys(metadata).forEach(key => {
+          scope.setExtra(key, metadata[key]);
+        });
 
-          scope.addEventProcessor(async (event: SentryEvent) => {
-            if (event.sdk) {
-              const integrations = event.sdk.integrations || [];
-              event.sdk = {
-                ...event.sdk,
-                integrations: [...integrations, 'vue'],
-              };
-            }
-            return event;
-          });
+        scope.addEventProcessor(async (event: SentryEvent) => {
+          if (event.sdk) {
+            const integrations = event.sdk.integrations || [];
+            event.sdk = {
+              ...event.sdk,
+              integrations: [...integrations, 'vue'],
+            };
+          }
+          return event;
         });
 
         getCurrentHub().captureException(error, { originalException: error });
diff --git a/packages/browser/src/integrations/reportingobserver.ts b/packages/browser/src/integrations/reportingobserver.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { captureMessage, withScope } from '@sentry/core';
 import { Integration } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils/misc';
 import { supportsReportingObserver } from '@sentry/utils/supports';
@@ -93,10 +93,8 @@ export class ReportingObserver implements Integration {
    */
   public handler(reports: Report[]): void {
     for (const report of reports) {
-      getCurrentHub().withScope(() => {
-        getCurrentHub().configureScope((scope: Scope) => {
-          scope.setExtra('url', report.url);
-        });
+      withScope(scope => {
+        scope.setExtra('url', report.url);
 
         const label = `ReportingObserver [${report.type}]`;
         let details = 'No details available';
@@ -112,9 +110,7 @@ export class ReportingObserver implements Integration {
             plainBody[prop] = report.body[prop];
           }
 
-          getCurrentHub().configureScope((scope: Scope) => {
-            scope.setExtra('body', plainBody);
-          });
+          scope.setExtra('body', plainBody);
 
           if (report.type === ReportTypes.Crash) {
             const body = report.body as CrashReportBody;
@@ -125,7 +121,7 @@ export class ReportingObserver implements Integration {
           }
         }
 
-        getCurrentHub().captureMessage(`${label}: ${details}`);
+        captureMessage(`${label}: ${details}`);
       });
     }
   }
diff --git a/packages/browser/src/integrations/sdkinformation.ts b/packages/browser/src/integrations/sdkinformation.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub, Scope } from '@sentry/hub';
+import { configureScope } from '@sentry/core';
 import { Integration, SentryEvent } from '@sentry/types';
 import { SDK_NAME, SDK_VERSION } from '../version';
 
@@ -13,7 +13,7 @@ export class SDKInformation implements Integration {
    * @inheritDoc
    */
   public install(): void {
-    getCurrentHub().configureScope((scope: Scope) => {
+    configureScope(scope => {
       scope.addEventProcessor(async (event: SentryEvent) => ({
         ...event,
         sdk: {
diff --git a/packages/browser/src/sdk.ts b/packages/browser/src/sdk.ts
@@ -1,5 +1,4 @@
-import { initAndBind } from '@sentry/core';
-import { getCurrentHub } from '@sentry/hub';
+import { getCurrentHub, initAndBind } from '@sentry/core';
 import { DsnLike } from '@sentry/types';
 import { BrowserOptions } from './backend';
 import { BrowserClient } from './client';
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,6 +1,13 @@
 export { logger } from './logger';
-export { captureException, captureMessage, configureScope } from '@sentry/minimal';
-export { Hub, Scope } from '@sentry/hub';
+export {
+  addBreadcrumb,
+  captureException,
+  captureEvent,
+  captureMessage,
+  configureScope,
+  withScope,
+} from '@sentry/minimal';
+export { getCurrentHub, Hub, getHubFromCarrier, 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
diff --git a/packages/hub/src/scope.ts b/packages/hub/src/scope.ts
diff --git a/packages/hub/test/lib/hub.test.ts b/packages/hub/test/lib/hub.test.ts
diff --git a/packages/hub/test/lib/scope.test.ts b/packages/hub/test/lib/scope.test.ts
diff --git a/packages/minimal/src/index.ts b/packages/minimal/src/index.ts
diff --git a/packages/minimal/test/lib/minimal.test.ts b/packages/minimal/test/lib/minimal.test.ts
diff --git a/packages/node/package.json b/packages/node/package.json
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
