feat: setExtra + tests

HazAT · HazAT · commit 74f44f9be2ef · 2019-05-29T21:18:26.000+02:00
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -25,7 +25,7 @@ export {
   Hub,
   Scope,
   setContext,
-  setExtras,
+  setExtra,
   setTags,
   setUser,
   withScope,
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -5,7 +5,7 @@ export {
   captureMessage,
   configureScope,
   setContext,
-  setExtras,
+  setExtra,
   setTags,
   setUser,
   withScope,
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -251,12 +251,12 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public setExtras(extras: { [key: string]: any }): void {
+  public setExtra(extra: { [key: string]: any }): void {
     const top = this.getStackTop();
     if (!top.scope) {
       return;
     }
-    top.scope.setExtras(extras);
+    top.scope.setExtras(extra);
   }
 
   /**
diff --git a/packages/minimal/src/index.ts b/packages/minimal/src/index.ts
@@ -95,10 +95,10 @@ export function setContext(name: string, context: { [key: string]: any } | null)
 
 /**
  * Set an object that will be merged sent as extra data with the event.
- * @param extras Extras object to merge into current context.
+ * @param extra Extra object to merge into current context.
  */
-export function setExtras(extras: { [key: string]: any }): void {
-  callOnHub<void>('setExtras', extras);
+export function setExtra(extra: { [key: string]: any }): void {
+  callOnHub<void>('setExtra', extra);
 }
 
 /**
diff --git a/packages/minimal/test/lib/minimal.test.ts b/packages/minimal/test/lib/minimal.test.ts
@@ -1,6 +1,17 @@
 import { getCurrentHub, getHubFromCarrier, Scope } from '@sentry/hub';
 import { Severity } from '@sentry/types';
-import { _callOnClient, captureEvent, captureException, captureMessage, configureScope, withScope } from '../../src';
+import {
+  _callOnClient,
+  captureEvent,
+  captureException,
+  captureMessage,
+  configureScope,
+  setContext,
+  setExtras,
+  setTags,
+  setUser,
+  withScope,
+} from '../../src';
 import { init, TestClient, TestClient2 } from '../mocks/client';
 
 declare var global: any;
@@ -208,4 +219,28 @@ describe('Minimal', () => {
     });
     expect(global.__SENTRY__.hub._stack).toHaveLength(1);
   });
+
+  test('setExtra', () => {
+    init({});
+    setExtras({ a: 'b' });
+    expect(global.__SENTRY__.hub._stack[0].scope._extra).toEqual({ a: 'b' });
+  });
+
+  test('setTags', () => {
+    init({});
+    setTags({ a: 'b' });
+    expect(global.__SENTRY__.hub._stack[0].scope._tags).toEqual({ a: 'b' });
+  });
+
+  test('setUser', () => {
+    init({});
+    setUser({ id: 'b' });
+    expect(global.__SENTRY__.hub._stack[0].scope._user).toEqual({ id: 'b' });
+  });
+
+  test('setContext', () => {
+    init({});
+    setContext('test', { id: 'b' });
+    expect(global.__SENTRY__.hub._stack[0].scope._context).toEqual({ test: { id: 'b' } });
+  });
 });
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -25,7 +25,7 @@ export {
   Hub,
   Scope,
   setContext,
-  setExtras,
+  setExtra,
   setTags,
   setUser,
   withScope,
diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -126,9 +126,9 @@ export interface Hub {
 
   /**
    * Set an object that will be merged sent as extra data with the event.
-   * @param extras Extras object to merge into current context.
+   * @param extra Extra object to merge into current context.
    */
-  setExtras(extras: { [key: string]: any }): void;
+  setExtra(extra: { [key: string]: any }): void;
 
   /**
    * Sets context data with the given name.

Original file line number	Diff line number	Diff line change
`@@ -251,12 +251,12 @@ export class Hub implements HubInterface {`
`251`	`251`	`/**`
`252`	`252`	`* @inheritDoc`
`253`	`253`	`*/`
`254`		`- public setExtras(extras: { [key: string]: any }): void {`
	`254`	`+ public setExtra(extra: { [key: string]: any }): void {`
`255`	`255`	`const top = this.getStackTop();`
`256`	`256`	`if (!top.scope) {`
`257`	`257`	`return;`
`258`	`258`	`}`
`259`		`- top.scope.setExtras(extras);`
	`259`	`+ top.scope.setExtras(extra);`
`260`	`260`	`}`
`261`	`261`
`262`	`262`	`/**`