Session Replay: support custom User Feedback flows without promoting buffer mode on capture
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 35/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Active
- Domaine
- mobile-dev
Piste de recherche
Commencez par examiner le cycle de vie actuel de la relecture mobile autour de flush(), pause(), stop() et startBuffering(), y compris les chemins Android ReplayCache.persistSegmentValues et BufferCaptureStrategy.stop mentionnés dans les logs. Comparez la coordination intégrée du feedback avec les besoins des flux personnalisés et coordonnez la conception de l’API avec iOS. Le travail est considéré comme terminé lorsque le feedback personnalisé peut préserver, joindre ou supprimer un buffer, exclure la saisie de formulaires et reprendre la mise en buffer sans promotion ni rupture de continuité.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Problem Statement
For custom in-app User Feedback flows on mobile, there is currently no clean way to associate feedback with the pre-feedback replay context without changing replay lifecycle semantics.
Today, the closest workaround in buffer mode is roughly:
- custom feedback UI opens
- call
replay.flush() - call
replay.pause()to avoid recording form entry - on submit, send feedback with that replay id attached
- optionally
replay.stop()+replay.startBuffering()to return to normal buffering
This is not equivalent to the behavior customers want.
What customers want
When a custom feedback form opens, they want to:
- preserve the last ~30 seconds before the form opened
- avoid recording the user filling out the form
- attach that preserved replay to the feedback if the user submits
- avoid sending anything if the user cancels
- return to normal buffer-mode behavior afterward
Why the current API is not enough
flush() is too strong for this use case.
In buffer mode, flush() does not just send the buffered replay. It also promotes the current replay from buffer mode to session mode for the rest of that replay's lifetime.
That creates several problems:
- it changes replay behavior after feedback-open
- cancel / dismiss semantics are awkward
- returning to buffer mode requires stopping and starting a new replay
- stopping and restarting breaks continuity and creates a new replay id / timeline
- the workaround is brittle because it coordinates several async lifecycle operations
pause() and stop() also do not solve the core problem on their own:
pause()prevents further recording but does not create a stable "frozen buffer handle"stop()ends the replay entirely rather than preserving and deferring attachment cleanly
Current behavior
This is especially visible for custom mobile feedback UIs.
If the host app owns the feedback UI lifecycle, the SDK does not have a public API for:
- "feedback opened"
- "freeze current buffer now"
- "attach this preserved replay later on submit"
- "discard it on cancel"
- "resume buffering without promotion"
The built-in feedback UI can coordinate replay behavior internally, but custom flows cannot.
Requested behavior
Expose a supported public API for custom feedback flows that separates:
- freeze/preserve current buffered replay context
from - flush and promote into session mode
In other words, the missing primitive is something like:
- preserve current rolling buffer at feedback-open
- optionally pause/exclude the form interval
- attach/send the preserved replay on submit
- discard it on cancel
- resume normal buffering behavior afterward
The exact API shape is open, but the semantics are the important part.
Example use case
A customer has Replay running in buffer mode and a custom in-app bug report UI.
A user encounters a bug, opens the feedback form, types for 20-30 seconds, and submits.
Expected result:
- the attached replay primarily shows the lead-up to the bug and the moment the user decided to report it
- the form-entry period is excluded or not dominant
- the SDK can return to buffer mode cleanly afterward
Actual result today:
- if replay is captured at submit time, the replay mostly shows the user filling out the form
- if the app uses
flush()as a workaround, replay is promoted from buffer mode to session mode - if the app stops and restarts replay to get back to buffering, continuity is broken
Additional context
This came up from a real customer integration using custom in-app feedback with mobile Session Replay.
We also saw Android logs during workaround testing that may indicate lifecycle/storage brittleness during this flow:
Failed to execute task CaptureStrategy.runInBackground
java.io.IOException: No such file or directory
...
at io.sentry.android.replay.ReplayCache.persistSegmentValues
...
at io.sentry.android.replay.capture.BufferCaptureStrategy.stop
That log may be a separate bug, but it reinforces that the current workaround path is not robust enough to treat as the intended solution.
Cross-platform coordination required
This is a cross-platform issue; we'll want to coordinate any solution with iOS. Writing a develop-docs PR could be a good place to start.
Related
getsentry/sentry-javascript#16541fixed the built-in JS feedback widget behaviorgetsentry/sentry-javascript#10581is adjacent but broader / older- this issue is specifically about custom mobile feedback flows and the lack of a public replay lifecycle primitive for them
Possible acceptance criteria
- A host app can preserve the current buffer at feedback-open without promoting the replay to session mode
- A host app can later attach/send that preserved replay on feedback submit
- A host app can discard the preserved replay on cancel
- A host app can exclude or pause the form-entry interval
- A host app can resume normal buffer-mode recording afterward without forcing a new full-session replay model
- Langage dominant
- Kotlin
- Étoiles
- 1.4k
- Forks
- 478
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 60
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de getsentry/sentry-java
-
Platform: Java
Difficulté 2/5 Une demi-journée Accessibilité débutants 76/100
getsentry/sentry-java#6161 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Bug Java Platform: Android Platform: Java
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
getsentry/sentry-java#6138 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Feature Java Platform: Java Spans
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
getsentry/sentry-java#5984 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Android Task Traces
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
getsentry/sentry-java#5376 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Android Docs Errors
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
getsentry/sentry-java#5375 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de getsentry/sentry-java
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
bug webview
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
home-assistant/android#7524 ·
Les mainteneurs répondent en général sous 1 jour
-
Issue: Bug
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
OpenAPITools/openapi-generator#25021 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
software-mansion/enriched-markdown#897 ·
Les mainteneurs répondent en général sous 1 jour
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
detekt/detekt#9761 · 1 commentaire · 2 réactions ·
Les mainteneurs répondent en général sous 1 jour