Sync worker: kickoff #1056
Open
Sync worker: kickoff #1056
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
So that features are available through the Platform. I think logically it makes sense to have the Platform load the features, as where features are coming from depends on the Platform. On Web they come from localStorage, on other platforms they might come from elsewhere. This will allow us to inject the FeatureSet into a SyncFactory class in next commits.
When sync is running in a worker, the start() method will need to be async, as we will need to send messages to the worker to start the sync.
I think it makes sense to not have the logic of whether sync runs in a worker in Client, as that is platform-specific, so that logic should not be in the matrix layer.
Will proxy calls to a worker. Doesn't do anything yet.
... and the browser supports SharedWorkers.
Doesn't do anything yet.
Without this the build fails.
Will address this in a follow-up PR as it's not trivial to fix.
psrpinto
force-pushed
the
sync-worker-kickoff
branch
from
ee78cbd to
9a2674a
Compare
16 tasks
This was referenced Mar 14, 2023
11 tasks
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.
First step to address #1045.
Please see #1041 for context and motivation on these changes.
This PR serves as the kickoff for having sync running in a worker. With this PR, the sync worker is spawned if a newly-added feature flag is enabled, but won't do anything yet. Follow-up PRs will implement the worker.
I would suggest commit-by-commit review, as I made sure to structure the commits in an iterative way, with context for the change provided in the commit message.
Merging this should have no user-facing changes, unless the user enables the feature flag (which they are advised not to do).
Screen capture
Summary of changes
SameSessionInMultipleTabsfeature flagSync, so we can have sync running in a worker, while making it transparent toClient.Clientgets an instance of aSyncProxy, which has the same public API asSync, but offloads sync to a worker.sync-worker.js.Next steps
sync-worker.ts. This is not trivial so we'll address it in a separate PR.