Skip to content

fix(hub): keep hint event id if it's provided #4577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 16, 2022
Merged

fix(hub): keep hint event id if it's provided #4577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
080efff
feat: keep hint id if it's provided
Feb 15, 2022
29ba760
fix: add tests for hub (keep event id if provided)
Feb 16, 2022
66456d5
fix: tests pattern
Feb 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/hub/src/hub.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ export class Hub implements HubInterface {
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
public captureException(exception: any, hint?: EventHint): string {
const eventId = (this._lastEventId = uuid4());
const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4());
let finalHint = hint;

// If there's no explicit hint provided, mimic the same thing that would happen
Expand Down Expand Up @@ -216,7 +216,7 @@ export class Hub implements HubInterface {
* @inheritDoc
*/
public captureMessage(message: string, level?: Severity, hint?: EventHint): string {
const eventId = (this._lastEventId = uuid4());
const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4());
let finalHint = hint;

// If there's no explicit hint provided, mimic the same thing that would happen
Expand Down Expand Up @@ -247,7 +247,7 @@ export class Hub implements HubInterface {
* @inheritDoc
*/
public captureEvent(event: Event, hint?: EventHint): string {
const eventId = uuid4();
const eventId = hint && hint.event_id ? hint.event_id : uuid4();
if (event.type !== 'transaction') {
this._lastEventId = eventId;
}
Expand Down
27 changes: 27 additions & 0 deletions packages/hub/test/hub.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,14 @@ describe('Hub', () => {
expect(testClient.captureException.mock.calls[0][1].event_id).toBeTruthy();
});

test('should keep event_id from hint', () => {
const testClient = makeClient();
const hub = new Hub(testClient);
const id = Math.random().toString();
hub.captureException('a', { event_id: id });
expect(testClient.captureException.mock.calls[0][1].event_id).toBe(id);
});

test('should generate hint if not provided in the call', () => {
const testClient = makeClient();
const hub = new Hub(testClient);
Expand All @@ -248,6 +256,14 @@ describe('Hub', () => {
expect(testClient.captureMessage.mock.calls[0][2].event_id).toBeTruthy();
});

test('should keep event_id from hint', () => {
const testClient = makeClient();
const hub = new Hub(testClient);
const id = Math.random().toString();
hub.captureMessage('a', undefined, { event_id: id });
expect(testClient.captureMessage.mock.calls[0][2].event_id).toBe(id);
});

test('should generate hint if not provided in the call', () => {
const testClient = makeClient();
const hub = new Hub(testClient);
Expand Down Expand Up @@ -279,6 +295,17 @@ describe('Hub', () => {
expect(testClient.captureEvent.mock.calls[0][1].event_id).toBeTruthy();
});

test('should keep event_id from hint', () => {
const event: Event = {
extra: { b: 3 },
};
const testClient = makeClient();
const hub = new Hub(testClient);
const id = Math.random().toString();
hub.captureEvent(event, { event_id: id });
expect(testClient.captureEvent.mock.calls[0][1].event_id).toBe(id);
});

test('sets lastEventId', () => {
const event: Event = {
extra: { b: 3 },
Expand Down