Merge commit 'be3e8236086165e5e45a5a10783823874b3f3ebd' as 'lib/vscode'

lib/vscode/src/vs/platform/state/node/stateService.ts

@@ -0,0 +1,158 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as path from 'vs/base/common/path';
+import * as fs from 'fs';
+import { INativeEnvironmentService } from 'vs/platform/environment/common/environment';
+import { writeFileSync, readFile } from 'vs/base/node/pfs';
+import { isUndefined, isUndefinedOrNull } from 'vs/base/common/types';
+import { IStateService } from 'vs/platform/state/node/state';
+import { ILogService } from 'vs/platform/log/common/log';
+
+type StorageDatabase = { [key: string]: any; };
+
+export class FileStorage {
+
+	private _database: StorageDatabase | null = null;
+	private lastFlushedSerializedDatabase: string | null = null;
+
+	constructor(private dbPath: string, private onError: (error: Error) => void) { }
+
+	private get database(): StorageDatabase {
+		if (!this._database) {
+			this._database = this.loadSync();
+		}
+
+		return this._database;
+	}
+
+	async init(): Promise<void> {
+		if (this._database) {
+			return; // return if database was already loaded
+		}
+
+		const database = await this.loadAsync();
+
+		if (this._database) {
+			return; // return if database was already loaded
+		}
+
+		this._database = database;
+	}
+
+	private loadSync(): StorageDatabase {
+		try {
+			this.lastFlushedSerializedDatabase = fs.readFileSync(this.dbPath).toString();
+
+			return JSON.parse(this.lastFlushedSerializedDatabase);
+		} catch (error) {
+			if (error.code !== 'ENOENT') {
+				this.onError(error);
+			}
+
+			return {};
+		}
+	}
+
+	private async loadAsync(): Promise<StorageDatabase> {
+		try {
+			this.lastFlushedSerializedDatabase = (await readFile(this.dbPath)).toString();
+
+			return JSON.parse(this.lastFlushedSerializedDatabase);
+		} catch (error) {
+			if (error.code !== 'ENOENT') {
+				this.onError(error);
+			}
+
+			return {};
+		}
+	}
+
+	getItem<T>(key: string, defaultValue: T): T;
+	getItem<T>(key: string, defaultValue?: T): T | undefined;
+	getItem<T>(key: string, defaultValue?: T): T | undefined {
+		const res = this.database[key];
+		if (isUndefinedOrNull(res)) {
+			return defaultValue;
+		}
+
+		return res;
+	}
+
+	setItem(key: string, data?: object | string | number | boolean | undefined | null): void {
+
+		// Remove an item when it is undefined or null
+		if (isUndefinedOrNull(data)) {
+			return this.removeItem(key);
+		}
+
+		// Shortcut for primitives that did not change
+		if (typeof data === 'string' || typeof data === 'number' || typeof data === 'boolean') {
+			if (this.database[key] === data) {
+				return;
+			}
+		}
+
+		this.database[key] = data;
+		this.saveSync();
+	}
+
+	removeItem(key: string): void {
+
+		// Only update if the key is actually present (not undefined)
+		if (!isUndefined(this.database[key])) {
+			this.database[key] = undefined;
+			this.saveSync();
+		}
+	}
+
+	private saveSync(): void {
+		const serializedDatabase = JSON.stringify(this.database, null, 4);
+		if (serializedDatabase === this.lastFlushedSerializedDatabase) {
+			return; // return early if the database has not changed
+		}
+
+		try {
+			writeFileSync(this.dbPath, serializedDatabase); // permission issue can happen here
+			this.lastFlushedSerializedDatabase = serializedDatabase;
+		} catch (error) {
+			this.onError(error);
+		}
+	}
+}
+
+export class StateService implements IStateService {
+
+	declare readonly _serviceBrand: undefined;
+
+	private static readonly STATE_FILE = 'storage.json';
+
+	private fileStorage: FileStorage;
+
+	constructor(
+		@INativeEnvironmentService environmentService: INativeEnvironmentService,
+		@ILogService logService: ILogService
+	) {
+		this.fileStorage = new FileStorage(path.join(environmentService.userDataPath, StateService.STATE_FILE), error => logService.error(error));
+	}
+
+	init(): Promise<void> {
+		return this.fileStorage.init();
+	}
+
+	getItem<T>(key: string, defaultValue: T): T;
+	getItem<T>(key: string, defaultValue: T | undefined): T | undefined;
+	getItem<T>(key: string, defaultValue?: T): T | undefined {
+		return this.fileStorage.getItem(key, defaultValue);
+	}
+
+	setItem(key: string, data?: object | string | number | boolean | undefined | null): void {
+		this.fileStorage.setItem(key, data);
+	}
+
+	removeItem(key: string): void {
+		this.fileStorage.removeItem(key);
+	}
+}