-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(browser): Add
captureUserFeedback
(#7729)
Add new API `captureUserFeedback` to Browser SDKs, allowing Sentry users to send feedback programmatically without opening and using the feedback dialog. Co-authored-by: Luca Forstner <luca.forstner@sentry.io>
- Loading branch information
1 parent
367f779
commit c90a60f
Showing
8 changed files
with
183 additions
and
1 deletion.
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
packages/browser-integration-tests/suites/public-api/captureUserFeedback/init.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import * as Sentry from '@sentry/browser'; | ||
|
||
window.Sentry = Sentry; | ||
|
||
Sentry.init({ | ||
dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
}); |
6 changes: 6 additions & 0 deletions
6
...rowser-integration-tests/suites/public-api/captureUserFeedback/simple_feedback/subject.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Sentry.captureUserFeedback({ | ||
eventId: 'test_event_id', | ||
email: 'test_email', | ||
comments: 'test_comments', | ||
name: 'test_name', | ||
}); |
18 changes: 18 additions & 0 deletions
18
...s/browser-integration-tests/suites/public-api/captureUserFeedback/simple_feedback/test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
import { expect } from '@playwright/test'; | ||
import type { UserFeedback } from '@sentry/types'; | ||
|
||
import { sentryTest } from '../../../../utils/fixtures'; | ||
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers'; | ||
|
||
sentryTest('should capture simple user feedback', async ({ getLocalTestPath, page }) => { | ||
const url = await getLocalTestPath({ testDir: __dirname }); | ||
|
||
const eventData = await getFirstSentryEnvelopeRequest<UserFeedback>(page, url); | ||
|
||
expect(eventData).toMatchObject({ | ||
eventId: 'test_event_id', | ||
email: 'test_email', | ||
comments: 'test_comments', | ||
name: 'test_name', | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
import type { DsnComponents, EventEnvelope, SdkMetadata, UserFeedback, UserFeedbackItem } from '@sentry/types'; | ||
import { createEnvelope, dsnToString } from '@sentry/utils'; | ||
|
||
/** | ||
* Creates an envelope from a user feedback. | ||
*/ | ||
export function createUserFeedbackEnvelope( | ||
feedback: UserFeedback, | ||
{ | ||
metadata, | ||
tunnel, | ||
dsn, | ||
}: { | ||
metadata: SdkMetadata | undefined; | ||
tunnel: string | undefined; | ||
dsn: DsnComponents | undefined; | ||
}, | ||
): EventEnvelope { | ||
const headers: EventEnvelope[0] = { | ||
event_id: feedback.event_id, | ||
sent_at: new Date().toISOString(), | ||
...(metadata && | ||
metadata.sdk && { | ||
sdk: { | ||
name: metadata.sdk.name, | ||
version: metadata.sdk.version, | ||
}, | ||
}), | ||
...(!!tunnel && !!dsn && { dsn: dsnToString(dsn) }), | ||
}; | ||
const item = createUserFeedbackEnvelopeItem(feedback); | ||
|
||
return createEnvelope(headers, [item]); | ||
} | ||
|
||
function createUserFeedbackEnvelopeItem(feedback: UserFeedback): UserFeedbackItem { | ||
const feedbackHeaders: UserFeedbackItem[0] = { | ||
type: 'user_report', | ||
}; | ||
return [feedbackHeaders, feedback]; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
import { createUserFeedbackEnvelope } from '../../src/userfeedback'; | ||
|
||
describe('userFeedback', () => { | ||
test('creates user feedback envelope header', () => { | ||
const envelope = createUserFeedbackEnvelope( | ||
{ | ||
comments: 'Test Comments', | ||
email: 'test@email.com', | ||
name: 'Test User', | ||
event_id: 'testEvent123', | ||
}, | ||
{ | ||
metadata: { | ||
sdk: { | ||
name: 'testSdkName', | ||
version: 'testSdkVersion', | ||
}, | ||
}, | ||
tunnel: 'testTunnel', | ||
dsn: { | ||
host: 'testHost', | ||
projectId: 'testProjectId', | ||
protocol: 'http', | ||
}, | ||
}, | ||
); | ||
|
||
expect(envelope[0]).toEqual({ | ||
dsn: 'http://undefined@testHost/undefinedtestProjectId', | ||
event_id: 'testEvent123', | ||
sdk: { | ||
name: 'testSdkName', | ||
version: 'testSdkVersion', | ||
}, | ||
sent_at: expect.any(String), | ||
}); | ||
}); | ||
|
||
test('creates user feedback envelope item', () => { | ||
const envelope = createUserFeedbackEnvelope( | ||
{ | ||
comments: 'Test Comments', | ||
email: 'test@email.com', | ||
name: 'Test User', | ||
event_id: 'testEvent123', | ||
}, | ||
{ | ||
metadata: undefined, | ||
tunnel: undefined, | ||
dsn: undefined, | ||
}, | ||
); | ||
|
||
expect(envelope[1]).toEqual([ | ||
[ | ||
{ | ||
type: 'user_report', | ||
}, | ||
{ | ||
comments: 'Test Comments', | ||
email: 'test@email.com', | ||
name: 'Test User', | ||
event_id: 'testEvent123', | ||
}, | ||
], | ||
]); | ||
}); | ||
}); |