feat(cozy-pouch-link): Add startReplicationWithDebounce() method
#1553
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
We want to be able to debounce calls to `startReplication()` This commit adds the `startReplicationWithDebounce()` method that is responsible to debounce the call of `startReplication()` by a specific delay The debounce delay can be configured using the CozyPouchLink constructor's `syncDebounceDelayInMs` option Calling the `startReplication()` will cancel debounced calls and immediately execute the replication
Ldoppea
requested review from
Merkur39,
paultranvan and
cballevre
as code owners
4 tasks
zatteo
approved these changes
Nov 5, 2024
paultranvan
reviewed
Nov 5, 2024
| @@ -11,6 +11,7 @@ import defaults from 'lodash/defaults' | |||
| import mapValues from 'lodash/mapValues' | |||
| import zipWith from 'lodash/zipWith' | |||
| import get from 'lodash/get' | |||
| import debounce from 'lodash/debounce' | |||
There was a problem hiding this comment.
Is it really worth the import compared to a simple setTimeout ? Is it because of the .cancel feature?
There was a problem hiding this comment.
I made this choice mainly because I have more trust in a widely used utility library than in our code 😄 (but also because we already includes lodash in all our projects, my choice would have been different otherwise)
| @@ -285,15 +311,26 @@ class PouchLink extends CozyLink { | |||
| * @returns {void} | |||
| */ | |||
| startReplication() { | |||
| this.client.emit('pouchlink:sync:start') | |||
| this.startReplicationDebounced.cancel() | |||
There was a problem hiding this comment.
It means each new replication call will reset the debounce timer, right?
I wonder if we should rather have a mechanism where the timer is not reset, and new function calls are simply ignored.
In the current implementation, we might never replicate (or greatly delay) if we receive continuous realtime events
There was a problem hiding this comment.
I fixed this by adding a maxdelay parameter here: 0c9557c
In previous commit we added the possibility to debounce the `startReplication()` method and to configure the debounce delay with `syncDebounceDelayInMs` parameter This may be problematic as we expect to call this from realtime events that may, in some rare scenario, occur too often to trigger a single replication due to the debounce To prevent this we add the `syncDebounceMaxDelayInMs` parameter that will ensure that `startReplication()` is called when the max delay is reached even if realtime events trigger the debounce for too long
paultranvan
approved these changes
Nov 5, 2024
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 5, 2024
In cozy/cozy-client#1553 we introduced a new `startReplicationWithDebounce()` method that will be used by the SearchEngine from cozy-dataproxy We want to fine tune this method's behavior by configuring its debounce timings By doing so, all realtime events on searched doctypes will trigger a replication with a 30s debounce and in the case of many multiple realtime events, the maximum debounce would be of 10min Related PR: cozy/cozy-client#1553
Ldoppea
added a commit
to cozy/cozy-libs
that referenced
this pull request
Nov 6, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
Ldoppea
added a commit
to cozy/cozy-libs
that referenced
this pull request
Nov 6, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
Ldoppea
added a commit
to cozy/cozy-libs
that referenced
this pull request
Nov 6, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 6, 2024
In cozy/cozy-client#1553 we introduced a new `startReplicationWithDebounce()` method that will be used by the SearchEngine from cozy-dataproxy We want to fine tune this method's behavior by configuring its debounce timings By doing so, all realtime events on searched doctypes will trigger a replication with a 30s debounce and in the case of many multiple realtime events, the maximum debounce would be of 10min Related PR: cozy/cozy-client#1553
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 6, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 6, 2024
In cozy/cozy-client#1553 we introduced a new `startReplicationWithDebounce()` method that will be used by the SearchEngine from cozy-dataproxy We want to fine tune this method's behavior by configuring its debounce timings By doing so, all realtime events on searched doctypes will trigger a replication with a 30s debounce and in the case of many multiple realtime events, the maximum debounce would be of 10min Related PR: cozy/cozy-client#1553
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 6, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 6, 2024
In cozy/cozy-client#1553 we introduced a new `startReplicationWithDebounce()` method that will be used by the SearchEngine from cozy-dataproxy We want to fine tune this method's behavior by configuring its debounce timings By doing so, all realtime events on searched doctypes will trigger a replication with a 30s debounce and in the case of many multiple realtime events, the maximum debounce would be of 10min Related PR: cozy/cozy-client#1553
Ldoppea
added a commit
to cozy/cozy-web-data-proxy
that referenced
this pull request
Nov 6, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
Ldoppea
added a commit
to cozy/cozy-flagship-app
that referenced
this pull request
Nov 26, 2024
`cozy-pouch-link` has been upgraded to `50.3.1` in order to retrieve `startReplicationWithDebounce()` method implementation `cozy-client` has been upgraded to `50.3.1` in order to retrieve some typing fixes Related PR: cozy/cozy-client#1553 Related PR: cozy/cozy-client#1556
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 be able to debounce calls to
startReplication()This commit adds the
startReplicationWithDebounce()method that is responsible to debounce the call ofstartReplication()by a specific delayThe debounce delay can be configured using the CozyPouchLink constructor's
syncDebounceDelayInMsoptionCalling the
startReplication()will cancel debounced calls and immediately execute the replicationRelated PRs: