From d4d03532d7da646a818095f6362f8d9e41c613da Mon Sep 17 00:00:00 2001 From: Roman Date: Fri, 7 May 2021 14:10:04 +0300 Subject: [PATCH] storage-helper refactoring Signed-off-by: Roman --- src/renderer/hooks/useStorage.ts | 5 +- src/renderer/utils/createStorage.ts | 84 ++++++++++++++++++----------- src/renderer/utils/storageHelper.ts | 20 +++---- 3 files changed, 62 insertions(+), 47 deletions(-) diff --git a/src/renderer/hooks/useStorage.ts b/src/renderer/hooks/useStorage.ts index 003b63bf86..9c95d57f6f 100644 --- a/src/renderer/hooks/useStorage.ts +++ b/src/renderer/hooks/useStorage.ts @@ -1,9 +1,8 @@ import { useState } from "react"; import { createStorage } from "../utils"; -import { CreateObservableOptions } from "mobx"; -export function useStorage(key: string, initialValue: T, options?: CreateObservableOptions) { - const storage = createStorage(key, initialValue, options); +export function useStorage(key: string, initialValue: T) { + const storage = createStorage(key, initialValue); const [storageValue, setStorageValue] = useState(storage.get()); const setValue = (value: T) => { setStorageValue(value); diff --git a/src/renderer/utils/createStorage.ts b/src/renderer/utils/createStorage.ts index 08d9d30ebf..8045875fe9 100755 --- a/src/renderer/utils/createStorage.ts +++ b/src/renderer/utils/createStorage.ts @@ -2,68 +2,90 @@ // Because app creates random port between restarts => storage session wiped out each time. import path from "path"; import { app, remote } from "electron"; -import { observable, reaction, when, CreateObservableOptions } from "mobx"; +import { comparer, observable, reaction, toJS, when } from "mobx"; import fse from "fs-extra"; import { StorageHelper } from "./storageHelper"; import { ClusterStore, getHostedClusterId } from "../../common/cluster-store"; import logger from "../../main/logger"; -let initialized = false; -const loaded = observable.box(false); -const storage = observable.map(); +const LOG_PREFIX = '[LocalStorageHelper]:'; -export function createStorage(key: string, defaultValue: T, observableOptions?: CreateObservableOptions) { +const storage = observable({ + initialized: false, + loaded: false, + data: {} as { [key: string]: any }, // json-compatible state +}); + +/** + * Creates a helper for saving data under the "key" intended for window.localStorage + * @param key + * @param defaultValue + */ +export function createStorage(key: string, defaultValue: T) { const clusterId = getHostedClusterId(); - const savingFolder = path.resolve((app || remote.app).getPath("userData"), "lens-local-storage"); - const jsonFilePath = path.resolve(savingFolder, `${clusterId ?? "app"}.json`); + const folder = path.resolve((app || remote.app).getPath("userData"), "lens-local-storage"); + const fileName = `${clusterId ?? "app"}.json`; + const filePath = path.resolve(folder, fileName); - if (!initialized) { - initialized = true; + if (!storage.initialized) { + init(); // called once per cluster-view + } - // read once per cluster domain - fse.readJson(jsonFilePath) - .then((data = {}) => storage.merge(data)) + function init() { + storage.initialized = true; + + // read previously saved state (if any) + fse.readJson(filePath) + .then(data => storage.data = data) .catch(() => null) // ignore empty / non-existing / invalid json files - .finally(() => loaded.set(true)); + .finally(() => { + logger.info(`${LOG_PREFIX} loaded local-storage file "${filePath}"`); + storage.loaded = true; + }); - // bind auto-saving - reaction(() => storage.toJSON(), saveFile, { delay: 250 }); + // bind auto-saving data changes to %storage-file.json + reaction(() => toJS(storage.data), saveFile, { + delay: 250, // lazy, avoid excessive writes to fs + equals: comparer.structural, // save only when something really changed + }); // remove json-file when cluster deleted if (clusterId !== undefined) { when(() => ClusterStore.getInstance(false)?.removedClusters.has(clusterId)).then(removeFile); } - } - async function saveFile(json = {}) { - try { - await fse.ensureDir(savingFolder, { mode: 0o755 }); - await fse.writeJson(jsonFilePath, json, { spaces: 2 }); - } catch (error) { - logger.error(`[save]: ${error}`, { json, jsonFilePath }); + async function saveFile(state: Record = {}) { + logger.info(`${LOG_PREFIX} saving ${filePath}`); + try { + await fse.ensureDir(folder, { mode: 0o755 }); + await fse.writeJson(filePath, state, { spaces: 2 }); + } catch (error) { + logger.error(`${LOG_PREFIX} saving failed: ${error}`, { + json: state, jsonFilePath: filePath + }); + } } - } - function removeFile() { - logger.debug("[remove]:", jsonFilePath); - fse.unlink(jsonFilePath).catch(Function); + function removeFile() { + logger.debug(`${LOG_PREFIX} removing ${filePath}`); + fse.unlink(filePath).catch(Function); + } } return new StorageHelper(key, { autoInit: true, - observable: observableOptions, defaultValue, storage: { async getItem(key: string) { - await when(() => loaded.get()); + await when(() => storage.loaded); - return storage.get(key); + return storage.data[key]; }, setItem(key: string, value: any) { - storage.set(key, value); + storage.data[key] = value; }, removeItem(key: string) { - storage.delete(key); + delete storage.data[key]; } }, }); diff --git a/src/renderer/utils/storageHelper.ts b/src/renderer/utils/storageHelper.ts index 8bb55c42da..a35ea17215 100755 --- a/src/renderer/utils/storageHelper.ts +++ b/src/renderer/utils/storageHelper.ts @@ -1,6 +1,6 @@ // Helper for working with storages (e.g. window.localStorage, NodeJS/file-system, etc.) -import { action, comparer, CreateObservableOptions, IObservableValue, makeObservable, observable, toJS, when, } from "mobx"; +import { action, CreateObservableOptions, IObservableValue, makeObservable, observable, toJS, when, } from "mobx"; import produce, { Draft } from "immer"; import { isEqual, isFunction, isPlainObject } from "lodash"; import logger from "../../main/logger"; @@ -15,7 +15,6 @@ export interface StorageAdapter { export interface StorageHelperOptions { autoInit?: boolean; // start preloading data immediately, default: true - observable?: CreateObservableOptions; storage: StorageAdapter; defaultValue: T; } @@ -23,10 +22,6 @@ export interface StorageHelperOptions { export class StorageHelper { static readonly defaultOptions: Partial> = { autoInit: true, - observable: { - deep: true, - equals: comparer.shallow, - } }; private data: IObservableValue; @@ -38,16 +33,14 @@ export class StorageHelper { constructor(readonly key: string, private options: StorageHelperOptions) { makeObservable(this); - this.data = observable.box(this.options.defaultValue, { - ...StorageHelper.defaultOptions.observable, - ...(options.observable ?? {}) - }); - this.data.observe_(({ newValue, oldValue }) => { - this.onChange(newValue as T, oldValue as T); - }); this.storage = options.storage; this.defaultValue = options.defaultValue; + this.data = observable.box(this.defaultValue); + + this.data.observe_(({ newValue, oldValue }) => { + this.onChange(newValue as T, oldValue as T); + }); if (this.options.autoInit) { this.init(); @@ -126,6 +119,7 @@ export class StorageHelper { this.data.set(this.defaultValue); } + @action merge(value: Partial | ((draft: Draft) => Partial | void)) { const nextValue = produce(this.get(), (state: Draft) => { const newValue = isFunction(value) ? value(state) : value;