Skip to content

Clarify offline caching behavior of Flutter SDK #6069

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 3 commits into from
Feb 11, 2023

Conversation

cstavitsky
Copy link
Contributor

Offline caching functionality for iOS and Android behave differently; reports are retried under slightly different conditions. This is already clear in the respective iOS and Android docs:

  • iOS: "Offline caching when a device is unable to connect; we send a report once we receive another event"
  • Android: "Offline caching when a device is offline; we send a report once the application is restarted"

However, the Flutter docs are vague about how offline caching works in a way that has confused at least one customer. This change clarifies how offline caching works for Flutter.

The iOS and Android offline caching functionality behaves slightly differently. This is currently clear in the respective iOS and Android docs:

- [iOS](https://docs.sentry.io/platforms/apple/guides/ios/): "Offline caching when a device is unable to connect; we send a report once we receive another event"
- [Android](https://docs.sentry.io/platforms/android/): "Offline caching when a device is offline; we send a report once the application is restarted"

But, the docs are not clear about how offline caching works in the Flutter SDK, so I've suggested a clarification.
@vercel
Copy link

vercel bot commented Jan 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Jan 19, 2023 at 10:07PM (UTC)

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines 14 to 15
- Android: Offline caching when a device is offline; we send a report once the application is restarted
- iOS: Offline caching when a device is unable to connect; we send a report once we receive another event
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe worth that to RN, Capacitor, and on Android/iOS as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea, I'll add those to this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • Added clarification for handling of mobile offline storage to React Native and Cordova ✔️

It looks like Capacitor has solid coverage for how it handles offline storage, so do iOS and Android

@github-actions
Copy link
Contributor

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@marandaneto marandaneto merged commit 38a36e0 into master Feb 11, 2023
@marandaneto marandaneto deleted the clarify-flutter-offline-caching-behavior branch February 11, 2023 01:51
@github-actions github-actions bot locked and limited conversation to collaborators Feb 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants