feat(feedback): Flush replays when feedback form opens #10567
Merged
Conversation
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
size-limit report 📦
|
billyvg
commented
Feb 8, 2024
billyvg
force-pushed
the
feat-feedback-flush-replay-on-form-open
branch
2 times, most recently
from
3f23a50
to
4069cf5
Compare
billyvg
commented
Feb 21, 2024
billyvg
force-pushed
the
feat-feedback-flush-replay-on-form-open
branch
from
3094032
to
bc31cf3
Compare
…form open * By default (can be disabled), if replay integration exists, start buffering * Flush replay when the feedback form is first opened instead of at submit time We are making this change because we have noticed a lot of feedback replays only consist of the user submitting the feedback and not what they did prior to submitting feedback. This may result in false positives if users open but do not submit feedback, but this should make replays from feedback more useful.
billyvg
force-pushed
the
feat-feedback-flush-replay-on-form-open
branch
from
bc31cf3
to
c45d03f
Compare
mydea
reviewed
Feb 28, 2024
packages/feedback/src/integration.ts
Outdated
| @@ -1,4 +1,5 @@ | |||
| import type { Integration, IntegrationFn } from '@sentry/types'; | |||
| import { type replayIntegration } from '@sentry/replay'; | |||
There was a problem hiding this comment.
let's not use this syntax, but import type {} - I've read that this is better/easier to treeshake!
Also, generally, I'd say maybe we should avoid this - we have this as devDependency only for the type here, which is not really correct from a bundling perspective 😬 I'd rather we just inline the relevant type here (or if really needed put some interface type in @sentry/types that both packages can use)?
There was a problem hiding this comment.
Wouldn't inlining defeat the purpose of typechecking against replay interface? (in this case, it probably wouldn't matter too much, but just trying to think of a good general solution).
I guess the best solution here is to extract it into types, but it's still a bit annoying having to duplicate the type
There was a problem hiding this comment.
yeah, that's always the problem with the types stuff and the circular dependency stuff 😬
So I'd go with one of these approaches - no strong feelings:
- We add a minimal interface to types - IMHO that may be OK to do for the integration itself, as the surface is quite small and can be considered the public contract. then in replay we can do
class Replay implements ReplayIntegrationInterfaceor something like this 🤔 - We inline the styles, which is obv. not super secure but probably OK/fine here (as tests would fail anyhow hopefully if that would change), and we only use a single method right now?
mydea
reviewed
Feb 28, 2024
billyvg
changed the title
AbhiPrasad
approved these changes
Feb 29, 2024
mydea
approved these changes
Feb 29, 2024
Closed
AbhiPrasad
pushed a commit
that referenced
this pull request
Feb 29, 2024
Flush replay when the feedback form is first opened instead of at submit time We are making this change because we have noticed a lot of feedback replays only consist of the user submitting the feedback and not what they did prior to submitting feedback. This may result in false positives if users open but do not submit feedback, but this should make replays from feedback more useful.
AbhiPrasad
pushed a commit
that referenced
this pull request
Feb 29, 2024
Flush replay when the feedback form is first opened instead of at submit time We are making this change because we have noticed a lot of feedback replays only consist of the user submitting the feedback and not what they did prior to submitting feedback. This may result in false positives if users open but do not submit feedback, but this should make replays from feedback more useful.
This was referenced Mar 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Flush replay when the feedback form is first opened instead of at submit time
We are making this change because we have noticed a lot of feedback replays only consist of the user submitting the feedback and not what they did prior to submitting feedback. This may result in false positives if users open but do not submit feedback, but this should make replays from feedback more useful.