Settings Sync reset the profile state after updating VS Code (microsoft#166101) (microsoft#167298)

Author: bpasero

src/vs/base/parts/storage/common/storage.ts

@@ -14,7 +14,11 @@ export enum StorageHint {
 	// does not exist on disk yet. This allows
 	// the storage library to improve startup
 	// time by not checking the storage for data.
-	STORAGE_DOES_NOT_EXIST
+	STORAGE_DOES_NOT_EXIST,
+
+	// A hint to the storage that the storage
+	// is backed by an in-memory storage.
+	STORAGE_IN_MEMORY
 }
 
 export interface IStorageOptions {
@@ -339,6 +343,10 @@ export class Storage extends Disposable implements IStorage {
 		return new Promise(resolve => this.whenFlushedCallbacks.push(resolve));
 	}
 
+	isInMemory(): boolean {
+		return this.options.hint === StorageHint.STORAGE_IN_MEMORY;
+	}
+
 	override dispose(): void {
 		this.flushDelayer.dispose();
 

src/vs/platform/storage/common/storage.ts

@@ -8,7 +8,7 @@ import { Emitter, Event, PauseableEmitter } from 'vs/base/common/event';
 import { Disposable, dispose, MutableDisposable } from 'vs/base/common/lifecycle';
 import { mark } from 'vs/base/common/performance';
 import { isUndefinedOrNull } from 'vs/base/common/types';
-import { InMemoryStorageDatabase, IStorage, Storage } from 'vs/base/parts/storage/common/storage';
+import { InMemoryStorageDatabase, IStorage, Storage, StorageHint } from 'vs/base/parts/storage/common/storage';
 import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
 import { isUserDataProfile, IUserDataProfile } from 'vs/platform/userDataProfile/common/userDataProfile';
 import { IAnyWorkspaceIdentifier } from 'vs/platform/workspace/common/workspace';
@@ -623,9 +623,9 @@ export function isProfileUsingDefaultStorage(profile: IUserDataProfile): boolean
 
 export class InMemoryStorageService extends AbstractStorageService {
 
-	private readonly applicationStorage = this._register(new Storage(new InMemoryStorageDatabase()));
-	private readonly profileStorage = this._register(new Storage(new InMemoryStorageDatabase()));
-	private readonly workspaceStorage = this._register(new Storage(new InMemoryStorageDatabase()));
+	private readonly applicationStorage = this._register(new Storage(new InMemoryStorageDatabase(), { hint: StorageHint.STORAGE_IN_MEMORY }));
+	private readonly profileStorage = this._register(new Storage(new InMemoryStorageDatabase(), { hint: StorageHint.STORAGE_IN_MEMORY }));
+	private readonly workspaceStorage = this._register(new Storage(new InMemoryStorageDatabase(), { hint: StorageHint.STORAGE_IN_MEMORY }));
 
 	constructor() {
 		super();

src/vs/platform/storage/electron-main/storageMain.ts

@@ -91,6 +91,11 @@ export interface IStorageMain extends IDisposable {
 	 */
 	delete(key: string): void;
 
+	/**
+	 * Whether the storage is using in-memory persistence or not.
+	 */
+	isInMemory(): boolean;
+
 	/**
 	 * Close the storage connection.
 	 */
@@ -111,7 +116,7 @@ abstract class BaseStorageMain extends Disposable implements IStorageMain {
 	private readonly _onDidCloseStorage = this._register(new Emitter<void>());
 	readonly onDidCloseStorage = this._onDidCloseStorage.event;
 
-	private _storage: IStorage = new Storage(new InMemoryStorageDatabase()); // storage is in-memory until initialized
+	private _storage = new Storage(new InMemoryStorageDatabase(), { hint: StorageHint.STORAGE_IN_MEMORY }); // storage is in-memory until initialized
 	get storage(): IStorage { return this._storage; }
 
 	abstract get path(): string | undefined;
@@ -130,6 +135,10 @@ abstract class BaseStorageMain extends Disposable implements IStorageMain {
 		super();
 	}
 
+	isInMemory(): boolean {
+		return this._storage.isInMemory();
+	}
+
 	init(): Promise<void> {
 		if (!this.initializePromise) {
 			this.initializePromise = (async () => {
@@ -188,7 +197,7 @@ abstract class BaseStorageMain extends Disposable implements IStorageMain {
 		return storage.init();
 	}
 
-	protected abstract doCreate(): Promise<IStorage>;
+	protected abstract doCreate(): Promise<Storage>;
 
 	get items(): Map<string, string> { return this._storage.items; }
 
@@ -281,10 +290,10 @@ class BaseProfileAwareStorageMain extends BaseStorageMain {
 		super(logService, fileService);
 	}
 
-	protected async doCreate(): Promise<IStorage> {
+	protected async doCreate(): Promise<Storage> {
 		return new Storage(new SQLiteStorageDatabase(this.path ?? SQLiteStorageDatabase.IN_MEMORY_PATH, {
 			logging: this.createLoggingOptions()
-		}));
+		}), !this.path ? { hint: StorageHint.STORAGE_IN_MEMORY } : undefined);
 	}
 }
 
@@ -359,12 +368,12 @@ export class WorkspaceStorageMain extends BaseStorageMain {
 		super(logService, fileService);
 	}
 
-	protected async doCreate(): Promise<IStorage> {
+	protected async doCreate(): Promise<Storage> {
 		const { storageFilePath, wasCreated } = await this.prepareWorkspaceStorageFolder();
 
 		return new Storage(new SQLiteStorageDatabase(storageFilePath, {
 			logging: this.createLoggingOptions()
-		}), { hint: wasCreated ? StorageHint.STORAGE_DOES_NOT_EXIST : undefined });
+		}), { hint: this.options.useInMemoryStorage ? StorageHint.STORAGE_IN_MEMORY : wasCreated ? StorageHint.STORAGE_DOES_NOT_EXIST : undefined });
 	}
 
 	private async prepareWorkspaceStorageFolder(): Promise<{ storageFilePath: string; wasCreated: boolean }> {
@@ -420,7 +429,7 @@ export class InMemoryStorageMain extends BaseStorageMain {
 		return undefined; // in-memory has no path
 	}
 
-	protected async doCreate(): Promise<IStorage> {
-		return new Storage(new InMemoryStorageDatabase());
+	protected async doCreate(): Promise<Storage> {
+		return new Storage(new InMemoryStorageDatabase(), { hint: StorageHint.STORAGE_IN_MEMORY });
 	}
 }

src/vs/platform/storage/test/electron-main/storageMainService.test.ts

@@ -54,6 +54,7 @@ suite('StorageMainService', function () {
 	}
 
 	async function testStorage(storage: IStorageMain, scope: StorageScope): Promise<void> {
+		strictEqual(storage.isInMemory(), true);
 
 		// Telemetry: added after init unless workspace/profile scoped
 		if (scope === StorageScope.APPLICATION) {