feat: Implement offline support through CozyPouchLink #1209
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
Ldoppea
force-pushed
the
feat/open_offline
branch
from
3e2ed92
to
a3828ba
Compare
This was referenced May 31, 2024
Ldoppea
force-pushed
the
feat/open_offline
branch
2 times, most recently
from
21dbcff
to
00fcd7d
Compare
Ldoppea
changed the title
Ldoppea
force-pushed
the
feat/open_offline
branch
2 times, most recently
from
2cbaf5d
to
bcf0320
Compare
Ldoppea
added a commit
to cozy/cozy-libs
that referenced
this pull request
Aug 26, 2024
Since cozy/cozy-flagship-app#1209 the Flagship app can inject the `offline_available` attribute into WebViews metadata in order to tell the cozy-app when offline mode is supported The new `` method can now be used to check this attribute
2 tasks
zatteo
reviewed
Sep 2, 2024
| Boolean(appState.match(/active/) && nextAppState === 'background') | ||
|
|
||
| const isGoingToWakeUp = (nextAppState: AppStateStatus): boolean => | ||
| Boolean(appState.match(/background/) && nextAppState === 'active') |
There was a problem hiding this comment.
Is there a reason to use a regex here ?
There was a problem hiding this comment.
No special reason (as far as i know), this is just a copy from other appState listener in the app (ex)
zatteo
reviewed
Sep 2, 2024
| } | ||
|
|
||
| throw err | ||
| } |
There was a problem hiding this comment.
So this cache has an unlimited lifetime ?
There was a problem hiding this comment.
For now, yes it is. I imagine that opening the app after a very long time AND while being offline is a rare event so this should be acceptable for now. But for sure we may want to add an invalidation mechanism soon.
zatteo
reviewed
Sep 2, 2024
zatteo
reviewed
Sep 2, 2024
| const deviceInfo = `Device info: ${deviceBrand} ${deviceModel} ${os} ${version}` | ||
|
|
||
| return `${appInfo}\n${bundleInfo}\n${deviceInfo}` | ||
| } |
There was a problem hiding this comment.
Same method as src/app/domain/logger/fileLogger.ts ? Need to duplicate ?
There was a problem hiding this comment.
We can yes, for now it is not really important, those are debug methods so it won't be problematic if they differ someday
zatteo
reviewed
Sep 2, 2024
|
Maybe to do in another PR : replace the Line 70 in be4e458 react-native-quick-base64
|
zatteo
reviewed
Sep 2, 2024
| }, | ||
| removeItem: async (key: string): Promise<void> => { | ||
| return AsyncStorage.removeItem(key) | ||
| } |
There was a problem hiding this comment.
A prefix is added to the key by PouchDB ?
There was a problem hiding this comment.
No, the keys will be:
cozy-client-pouch-link-lastreplicateddocidcozy-client-pouch-link-lastreplicationsequencecozy-client-pouch-link-synced
|
No real changes requested, just a lot of question. As always, very easy to read 👍 |
Ldoppea
added a commit
to cozy/cozy-libs
that referenced
this pull request
Sep 9, 2024
Since cozy/cozy-flagship-app#1209 the Flagship app can inject the `offline_available` attribute into WebViews metadata in order to tell the cozy-app when offline mode is supported The new `` method can now be used to check this attribute
Ldoppea
force-pushed
the
feat/open_offline
branch
2 times, most recently
from
289a7b9
to
27ed108
Compare
`react-native-quick-sqlite` is enforced to version `8.0.6` in order to be compatible with RN0.72 Related article: https://dev.to/craftzdog/a-performant-way-to-use-pouchdb7-on-react-native-in-2022-24ej
We want the Flagship app to work when offline To make this possible we configure cozy-client with CozyPouchLink which role will be to synchronize necessary doctypes into a local PouchDB and serve them from it instead of from the cozy-stack when the device is offline For now the list of synchronized doctypes is hardcoded but in the future we expect to implement a dynamic list based on cozy-apps' manifests Related PR: cozy/cozy-client#1507
In previous commit we configured cozy-client to use CozyPouchLink for its queries This commit also adds StackLink as the first Link so by default it will do its queries through the remote cozy-stack CozyClient has been modified to handle offline mode and redirect to the next link when it is detected Related PR: cozy/cozy-client#1507
This plugin is required by cozy-client to process `find` queries Related PR: cozy/cozy-client#1507
PouchDB can handle only `client.query()` requests For all other requests, like `client.fetchJSON()` we want to be able to store the request result in the device's AsyncStorage so we can re-use this result when the device is offline Data is stored using the client's url and the request content as key (it can be a string or a full request object)
`/apps/:slug/open` request is based on `client.fetchJSON()` and is on the critical execution path for the application to boot So we want to use the new caching mechanism from previous commit in order to retrieve this request's cached result if the application is booted while the device is offline
`cozy-intent` has been upgraded to `2.23.0` to retrieve new interfaces for FlagshipLink and files downloading Related PR: cozy/cozy-libs#2562
In previous commits we configured the application's cozy-client to use CozyPouchLink This link is configured for all react-native side queries, but not for cozy-app queries as they are served inside of WebViews and use a different cozy-client instance We want cozy-apps to benefits from the CozyPouchLink by redirecting their queries to the react-native side using the new FlagshipLink interface With this interface, all cozy-apps queries can be redirected to the react-native side using cozy-intent/post-me In order to intercept them, then we should declare `FlagshipLinkRequest()` method `localMethods` Related PR: cozy/cozy-client#1505
When a cozy-app's WebView is served offline, then the cozy-app bundle is served from local folder using the CozyProxyWebview, and since previous commits, the cozy-client's queries are served through `FlagshipLink` With those mechanisms, nearly all data are available offline except two things: - cozy-stack static assets (i.e. some css files, avatar, partners logos etc) - `fetchJSON()` requests This commit tries to handle the static assets part Those assets are often served with HTTP cache activated, and so the WebView should be able to load them correctly when the device is offline. However on Android, the WebView's cache seems not to persist after the application is closed Activating the `cacheMode=LOAD_CACHE_ELSE_NETWORK` seems to fix this behavior. But it prioritizes too much the cache over fresh data, so we want to activate it only when strictly necessary, which is when the application is offline This also allows to load partners logos that are not cached by the cozy-stack (as of today). But we expect to modify the cozy-stack to enable cache on them
With previous changes, we now expect the CozyPouchLink to be the last link of the chain, so forwarding the query would result to an exception thrown This mean we cannot forward the query when warmup queries are not finished yet So we want to allow CozyPouchLink to ignore the verification step and process the query independently of the warmup queries status To allow this we introduce the `ignoreWarmup` parameter. When set to `true` the CozyPouchLink will process the query even if warmup is not finished yet Related PR: cozy/cozy-client#1506
Some cozy-apps declare a data `schema` into cozy-client instance This schema is then used for processing queries As we now process cozy-app queries on the react-native side through FlagshipLinkRequest, we want to declared this schema in the Flagship app's cozy-client For now we only need to implement the one from cozy-home The ideal implementation would be to extract it from the cozy-app's bundle, but we did not implement anything to support this (we should first investigate how to do this). So for now it is hardcoded
By adding offline support through PouchDB, we expect database related bugs to happens in the future In order to ease debugging them, we want to allow exploring the local PouchDB files The easier way is to add the ability to extract them from the device and send them through email to cozy's support team
For now we don't want to replicate local changes into remote PouchDB as we first want to ensure everything works as expected locally before activating two-way replication in the future
Ldoppea
force-pushed
the
feat/meta_offline
branch
from
a2a1b6a
to
d0ae666
Compare
Ldoppea
force-pushed
the
feat/open_offline
branch
from
27ed108
to
749ef40
Compare
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.
We want to make the application work when offline.
To make this happens we want to configure a local PouchDB in order to replicated remote CouchDB data and then we want to serve them to the cozy-client instances in both the react-native side and the cozy-apps side (in WebViews)
This PR implement offline support first for cozy-home and mespapiers, other cozy-apps will come later when the new mechanism is proved to work
Related PR:
TODO: