Skip to content

feat(feedback): Report a Bug button #4378

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

Merged
merged 154 commits into from
Apr 7, 2025

Conversation

antonis
Copy link
Collaborator

@antonis antonis commented Dec 16, 2024

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

Targeting feedback-ui-2 branch

PR Chain:

📜 Description

Implements feedback button that launches the feedback widget using the auto-injected feedback widget

The button is shown with Sentry.showFeedbackButton() and hidden with Sentry.hideFeedbackButton() provided that the app is wrapped (Sentry.wrap(RootComponent)). The button can be styled like:

Sentry.feedbackIntegration({
  buttonOptions: {
    styles: {
      triggerButton: {
        marginBottom: 75,
      },
    },
  },
})

💡 Motivation and Context

Part of #4302

💚 How did you test it?

Manual testing with the sample app

📝 Checklist

  • I added tests to verify changes
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • All tests passing
  • No breaking changes

🔮 Next steps

@antonis
Copy link
Collaborator Author

antonis commented Mar 26, 2025

Thank you for reviewing and your feedback @krystofwoldrich 🙇

I noticed that the button is above the shadow when dismissing the form.

Good catch 👍 Should be fixed after 04f1a8d

Let's also add a dummy button integration to track the usage of the button.

Good point! Added with 7473c58

The web version has a border similar to the form buttons.

Good catch 👍 Added the border with 24b3df0

@antonis antonis requested a review from krystofwoldrich March 26, 2025 17:04
@antonis antonis changed the title feat(feedback): Implements Report a Bug button feat(feedback): Report a Bug button Apr 3, 2025

const showFeedbackWidget = (): void => {
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { showFeedbackWidget } = require('./FeedbackWidgetManager');
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The cyclic dependency is properly fixed with a small refactoring in a followup PR #4718

Copy link
Contributor

@krystofwoldrich krystofwoldrich left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you! 🚀

Can you also add the button to the Expo Sample?

@antonis
Copy link
Collaborator Author

antonis commented Apr 7, 2025

Thank you for reviewing and all the feedback Krystof 🙇

Can you also add the button to the Expo Sample?

Added with 722114d

@antonis antonis merged commit 1bb4e34 into feedback-ui-2 Apr 7, 2025
60 checks passed
@antonis antonis deleted the antonis/4358-Feedback-Form-Autoinject-Button branch April 7, 2025 10:01
antonis added a commit to getsentry/sentry-docs that referenced this pull request Jun 4, 2025
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

⚠️ PR Chain:
- 👉  #13512
- #13513
- #13515

## DESCRIBE YOUR PR
*Tell us what you're changing and why. If your PR **resolves an issue**,
please link it so it closes automatically.*

Adds feedback button documentation.


Part of getsentry/sentry-react-native#4302

Implementation PR:
getsentry/sentry-react-native#4378

## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+

Should be merged after
getsentry/sentry-react-native#4726 is released

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section.
-->

Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: LucasZF <[email protected]>
Co-authored-by: Krystof Woldrich <[email protected]>
antonpirker pushed a commit to getsentry/sentry-docs that referenced this pull request Jun 6, 2025
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

⚠️ PR Chain:
- 👉  #13512
- #13513
- #13515

## DESCRIBE YOUR PR
*Tell us what you're changing and why. If your PR **resolves an issue**,
please link it so it closes automatically.*

Adds feedback button documentation.


Part of getsentry/sentry-react-native#4302

Implementation PR:
getsentry/sentry-react-native#4378

## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+

Should be merged after
getsentry/sentry-react-native#4726 is released

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section.
-->

Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: LucasZF <[email protected]>
Co-authored-by: Krystof Woldrich <[email protected]>
bitsandfoxes pushed a commit to getsentry/sentry-docs that referenced this pull request Jul 3, 2025
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

⚠️ PR Chain:
- 👉  #13512
- #13513
- #13515

## DESCRIBE YOUR PR
*Tell us what you're changing and why. If your PR **resolves an issue**,
please link it so it closes automatically.*

Adds feedback button documentation.


Part of getsentry/sentry-react-native#4302

Implementation PR:
getsentry/sentry-react-native#4378

## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+

Should be merged after
getsentry/sentry-react-native#4726 is released

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section.
-->

Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: LucasZF <[email protected]>
Co-authored-by: Krystof Woldrich <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feedback Form: Implement Report a Bug button
3 participants