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.

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

Rename sendFeedback to captureFeedback & enhance it #10953

Closed
2 tasks done
Tracked by #64671
billyvg opened this issue Mar 6, 2024 · 3 comments · Fixed by getsentry/sentry-docs#10172
Closed
2 tasks done
Tracked by #64671

Rename sendFeedback to captureFeedback & enhance it #10953

billyvg opened this issue Mar 6, 2024 · 3 comments · Fixed by getsentry/sentry-docs#10172

Comments

@billyvg
Copy link
Member

billyvg commented Mar 6, 2024

We want to deprecate captureUserFeedback, and instead have a new API captureFeedback that users can use instead.

This will send to the new feedback API, and allow to optionally define an event id that should be assigned to the feedback. This API will also apply scope etc. to the feedback event.

We will keep the old captureUserFeedback API for v8, as the new API will require a newer self-hosted version. Eventually, only captureFeedback will remain (~in v9 or beyond).

@bruno-garcia
Copy link
Member

Worth noting whatever we're doing here makes sense to become part of the protocol extending our current one. That's going to be eventually be built in many SDKs (in particular those with a UI like mobile and desktop).

This means updating this document: https://develop.sentry.dev/sdk/features/#user-feedback

@mydea
Copy link
Member

mydea commented Mar 7, 2024

Is there any reason to still use captureUserFeedback, I wonder? 🤔

@ryan953 ryan953 self-assigned this Mar 8, 2024
@billyvg billyvg assigned mydea and unassigned ryan953 Mar 11, 2024
@ryan953 ryan953 self-assigned this Mar 18, 2024
@mydea mydea changed the title Combine new sendFeedback API into existing captureUserFeedback Rename sendFeedback to captureFeedback & enhance it Mar 25, 2024
@bruno-garcia
Copy link
Member

From @lforst

Why is name a required property in captureUserFeedback()?
It is also not clear what name is supposed to be. Is it the name of the feature that someone gives feedback on, or is it the user name? I know now that it is the latter but maybe we can come up with a better identifier (or at least add JSDoc).
Having to provide and event_id is a bit annoying. We are getting rid of that right?
Why is it comments and not comment ? Alternatively I think we could call this feedback maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants