Skip to content
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

Jump to bottom

feat(overlay): Allow to directly add sentry envelopes via trigger #498

Closed
wants to merge 5 commits into from
Closed

feat(overlay): Allow to directly add sentry envelopes via trigger #498

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
87ba9ff
feat(overlay): Allow to directly add sentry envelopes via trigger
mydea Aug 20, 2024
28007e3
Use predefined const for content type
BYK Aug 20, 2024
34b641c
directly pass envelope
mydea Aug 21, 2024
b2fafea
fix it
mydea Aug 21, 2024
3d775b8
Merge branch 'main' into fn/trigger-add-event
BYK Aug 27, 2024
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
5 changes: 5 additions & 0 deletions .changeset/blue-trees-repeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@spotlightjs/overlay': minor
---

feat: Allow to directly add sentry envelopes via trigger
11 changes: 11 additions & 0 deletions packages/overlay/src/integrations/sentry/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,19 @@ export default function sentryIntegration(options: SentryIntegrationOptions = {}

on('sentry:showError', onRenderError as EventListener);

const onAddEnvelope = (e: CustomEvent) => {
if (!e.detail.envelope) return;
processEnvelope({
contentType: HEADER,
data: e.detail.envelope,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious, why not just e.detail and pass the envelope as the event payload?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I basically just copied this from the showError scenario - but actually you are right, I think this is incorrect, will adjust it!

});
};

on('sentry:addEnvelope', onAddEnvelope as EventListener);

return () => {
off('sentry:showError', onRenderError as EventListener);
off('sentry:addEnvelope', onAddEnvelope as EventListener);
};
},

Expand Down
10 changes: 9 additions & 1 deletion packages/website/src/content/docs/reference/sentry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,18 @@ init({
Additionally it includes an event to trigger synchronously rendering an error:

```js
import { trigger } as Spotlight from '@spotlightjs/spotlight';
import { trigger } from '@spotlightjs/spotlight';

trigger("sentry:showError", {
eventId: string,
event?: Event,
});
```

You can also directly add envelopes to the Sentry integration:

```js
import { trigger } from '@spotlightjs/spotlight';

trigger("sentry:addEnvelope", sentryEnvelope);
```
Loading