-
Notifications
You must be signed in to change notification settings - Fork 142
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
fix(sync): move options sync to background process #2062
Open
smalluban
wants to merge
1
commit into
main
Choose a base branch
from
fix-sync
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+189
−172
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /** | ||
| * Ghostery Browser Extension | ||
| * https://www.ghostery.com/ | ||
| * | ||
| * Copyright 2017-present Ghostery GmbH. All rights reserved. | ||
| * | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0 | ||
| */ | ||
| import { store } from 'hybrids'; | ||
|
|
||
| import Options, { SYNC_OPTIONS } from '/store/options.js'; | ||
| import Session from '/store/session.js'; | ||
| import { getUserOptions, setUserOptions } from '/utils/api.js'; | ||
| import * as OptionsObserver from '/utils/options-observer.js'; | ||
| import { HOME_PAGE_URL, ACCOUNT_PAGE_URL } from '/utils/api.js'; | ||
|
|
||
| async function sync(options, prevOptions) { | ||
| if (sync.pending) { | ||
| console.warn('[sync] Sync already in progress...'); | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| sync.pending = true; | ||
|
|
||
| // Do not sync if revision is set or terms and sync options are false | ||
| if (!options.terms || !options.sync) { | ||
| return; | ||
| } | ||
|
|
||
| const { user } = await store.resolve(Session); | ||
|
|
||
| // If user is not logged in, clean up options revision and return | ||
| if (!user) { | ||
| if (options.revision !== 0) { | ||
| store.set(Options, { revision: 0 }); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| const keys = | ||
| prevOptions && | ||
| SYNC_OPTIONS.filter( | ||
| (key) => !OptionsObserver.isOptionEqual(options[key], prevOptions[key]), | ||
| ); | ||
|
|
||
| // If options update, set revision to "dirty" state | ||
| if (keys && options.revision > 0) { | ||
| // Updated keys are not synchronized | ||
| if (keys.length === 0) return; | ||
|
|
||
| options = await store.set(Options, { revision: options.revision * -1 }); | ||
| } | ||
|
|
||
| const serverOptions = await getUserOptions(); | ||
|
|
||
| // Server has newer options - merge with local options | ||
| // The try/catch block is used to prevent failure of updating local options | ||
| // with server options with obsolete structure | ||
| try { | ||
| if (serverOptions.revision > Math.abs(options.revision)) { | ||
| console.info( | ||
| '[sync] Merging server options with revision:', | ||
| serverOptions.revision, | ||
| ); | ||
| const values = SYNC_OPTIONS.reduce( | ||
| (acc, key) => { | ||
| if ( | ||
| !keys?.includes(key) && | ||
| hasOwnProperty.call(serverOptions, key) | ||
| ) { | ||
| acc[key] = serverOptions[key]; | ||
| } | ||
|
|
||
| return acc; | ||
| }, | ||
| { revision: serverOptions.revision }, | ||
| ); | ||
|
|
||
| options = await store.set(Options, values); | ||
| } | ||
| } catch (e) { | ||
| console.error(`[sync] Error while merging server options: `, e); | ||
| } | ||
|
|
||
| // Set options or update: | ||
| // * No revision on server - initial sync | ||
| // * Keys are passed - options update | ||
| // * Revision is negative - local options are dirty (not synced) | ||
| if (!serverOptions.revision || keys || options.revision < 0) { | ||
| console.info('[sync] Syncing options with updated keys:', keys); | ||
| const { revision } = await setUserOptions( | ||
| SYNC_OPTIONS.reduce( | ||
| (acc, key) => { | ||
| if (hasOwnProperty.call(options, key)) { | ||
| acc[key] = options[key]; | ||
| } | ||
| return acc; | ||
| }, | ||
| { revision: serverOptions.revision + 1 }, | ||
| ), | ||
| ); | ||
|
|
||
| // Update local revision | ||
| await store.set(Options, { revision }); | ||
| console.info('[sync] Options synced with revision:', revision); | ||
| } | ||
| } catch (e) { | ||
| console.error(`[sync] Error while syncing options: `, e); | ||
| } finally { | ||
| sync.pending = false; | ||
| } | ||
| } | ||
|
|
||
| // Sync options on startup and when options change | ||
| OptionsObserver.addListener(function syncOptions(options, prevOptions) { | ||
| // Sync options on startup | ||
| if (!prevOptions) { | ||
| sync(options); | ||
| } | ||
|
|
||
| // Sync options when options change (skip on revision change) | ||
| else if (options.revision === prevOptions.revision) { | ||
| sync(options, prevOptions); | ||
| } | ||
| }); | ||
|
|
||
| // Sync options when a user logs in/out directly | ||
| // from the ghostery.com page (not from the settings page) | ||
| chrome.webNavigation.onDOMContentLoaded.addListener(async ({ url = '' }) => { | ||
| if (url === HOME_PAGE_URL || url.includes(ACCOUNT_PAGE_URL)) { | ||
| store.resolve(Options).then((options) => sync(options)); | ||
| } | ||
| }); | ||
|
|
||
| // Sync options on demand - triggered by the options page and panel | ||
| // to force sync options when opened | ||
| chrome.runtime.onMessage.addListener((msg) => { | ||
| if (msg.action === 'syncOptions') { | ||
| store.resolve(Options).then((options) => sync(options)); | ||
| } | ||
| }); |
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we await here? we don't want UI to flicker in case option change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already discussed awaiting the sync process in another context, and our decision was to not wait for it. It can be long or failing for many reasons (bad internet connection etc) - The settings page are available immediately for the user (they are local).