/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import * as objects from 'vs/base/common/objects'; import { IStorageValue } from 'vs/platform/userDataSync/common/userDataSync'; import { IStringDictionary } from 'vs/base/common/collections'; import { ILogService } from 'vs/platform/log/common/log'; export interface IMergeResult { local: { added: IStringDictionary, removed: string[], updated: IStringDictionary }; remote: IStringDictionary | null; } export function merge(localStorage: IStringDictionary, remoteStorage: IStringDictionary | null, baseStorage: IStringDictionary | null, storageKeys: { machine: ReadonlyArray, unregistered: ReadonlyArray }, logService: ILogService): IMergeResult { if (!remoteStorage) { return { remote: Object.keys(localStorage).length > 0 ? localStorage : null, local: { added: {}, removed: [], updated: {} } }; } const localToRemote = compare(localStorage, remoteStorage); if (localToRemote.added.size === 0 && localToRemote.removed.size === 0 && localToRemote.updated.size === 0) { // No changes found between local and remote. return { remote: null, local: { added: {}, removed: [], updated: {} } }; } const baseToRemote = baseStorage ? compare(baseStorage, remoteStorage) : { added: Object.keys(remoteStorage).reduce((r, k) => { r.add(k); return r; }, new Set()), removed: new Set(), updated: new Set() }; const baseToLocal = baseStorage ? compare(baseStorage, localStorage) : { added: Object.keys(localStorage).reduce((r, k) => { r.add(k); return r; }, new Set()), removed: new Set(), updated: new Set() }; const local: { added: IStringDictionary, removed: string[], updated: IStringDictionary } = { added: {}, removed: [], updated: {} }; const remote: IStringDictionary = objects.deepClone(remoteStorage); // Added in local for (const key of baseToLocal.added.values()) { // Skip if local was not synced before and remote also has the key // In this case, remote gets precedence if (!baseStorage && baseToRemote.added.has(key)) { continue; } else { remote[key] = localStorage[key]; } } // Updated in local for (const key of baseToLocal.updated.values()) { remote[key] = localStorage[key]; } // Removed in local for (const key of baseToLocal.removed.values()) { // Do not remove from remote if key is not registered. if (storageKeys.unregistered.includes(key)) { continue; } delete remote[key]; } // Added in remote for (const key of baseToRemote.added.values()) { const remoteValue = remoteStorage[key]; if (storageKeys.machine.includes(key)) { logService.info(`GlobalState: Skipped adding ${key} in local storage because it is declared as machine scoped.`); continue; } // Skip if the value is also added in local from the time it is last synced if (baseStorage && baseToLocal.added.has(key)) { continue; } const localValue = localStorage[key]; if (localValue && localValue.value === remoteValue.value) { continue; } if (localValue) { local.updated[key] = remoteValue; } else { local.added[key] = remoteValue; } } // Updated in Remote for (const key of baseToRemote.updated.values()) { const remoteValue = remoteStorage[key]; if (storageKeys.machine.includes(key)) { logService.info(`GlobalState: Skipped updating ${key} in local storage because it is declared as machine scoped.`); continue; } // Skip if the value is also updated or removed in local if (baseToLocal.updated.has(key) || baseToLocal.removed.has(key)) { continue; } const localValue = localStorage[key]; if (localValue && localValue.value === remoteValue.value) { continue; } local.updated[key] = remoteValue; } // Removed in remote for (const key of baseToRemote.removed.values()) { if (storageKeys.machine.includes(key)) { logService.trace(`GlobalState: Skipped removing ${key} in local storage because it is declared as machine scoped.`); continue; } // Skip if the value is also updated or removed in local if (baseToLocal.updated.has(key) || baseToLocal.removed.has(key)) { continue; } local.removed.push(key); } return { local, remote: areSame(remote, remoteStorage) ? null : remote }; } function compare(from: IStringDictionary, to: IStringDictionary): { added: Set, removed: Set, updated: Set } { const fromKeys = Object.keys(from); const toKeys = Object.keys(to); const added = toKeys.filter(key => fromKeys.indexOf(key) === -1).reduce((r, key) => { r.add(key); return r; }, new Set()); const removed = fromKeys.filter(key => toKeys.indexOf(key) === -1).reduce((r, key) => { r.add(key); return r; }, new Set()); const updated: Set = new Set(); for (const key of fromKeys) { if (removed.has(key)) { continue; } const value1 = from[key]; const value2 = to[key]; if (!objects.equals(value1, value2)) { updated.add(key); } } return { added, removed, updated }; } function areSame(a: IStringDictionary, b: IStringDictionary): boolean { const { added, removed, updated } = compare(a, b); return added.size === 0 && removed.size === 0 && updated.size === 0; }