hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

storage-helper fixes/ micro-refactoring

Browse Source 
Signed-off-by: Roman <ixrock@gmail.com>
This commit is contained in:
Roman 2021-05-03 20:14:43 +03:00
parent fa1bb210d1
commit 87cdaa3661
2 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/renderer/utils/createStorage.ts
View File

@ -1,11 +1,9 @@
// Keeps window.localStorage state in external JSON-files. // Keeps window.localStorage state in external JSON-files.
// Because app creates random port between restarts => storage session wiped out each time. // Because app creates random port between restarts => storage session wiped out each time.
import type { CreateObservableOptions } from "mobx";
import path from "path"; import path from "path";
import { app, remote } from "electron";
import { observable, reaction, when } from "mobx";
import fse from "fs-extra"; import fse from "fs-extra";
import { app, remote } from "electron";
import { observable, reaction, when, CreateObservableOptions } from "mobx";
import { StorageHelper } from "./storageHelper"; import { StorageHelper } from "./storageHelper";
import { ClusterStore, getHostedClusterId } from "../../common/cluster-store"; import { ClusterStore, getHostedClusterId } from "../../common/cluster-store";
import logger from "../../main/logger"; import logger from "../../main/logger";
@ -14,7 +12,7 @@ let initialized = false;
const loaded = observable.box(false); const loaded = observable.box(false);
const storage = observable.map<string/* key */, any /* serializable */>(); const storage = observable.map<string/* key */, any /* serializable */>();
export function createStorage<T>(key: string, defaultValue: T, observableOptions?: CreateObservableOptions) { export function createStorage<T>(key: string, defaultValue: T, observableOptions?: CreateObservableOptions): StorageHelper<T> {
const clusterId = getHostedClusterId(); const clusterId = getHostedClusterId();
const savingFolder = path.resolve((app || remote.app).getPath("userData"), "lens-local-storage"); const savingFolder = path.resolve((app || remote.app).getPath("userData"), "lens-local-storage");
const jsonFilePath = path.resolve(savingFolder, `${clusterId ?? "app"}.json`); const jsonFilePath = path.resolve(savingFolder, `${clusterId ?? "app"}.json`);
@ -53,7 +51,7 @@ export function createStorage<T>(key: string, defaultValue: T, observableOptions
return new StorageHelper<T>(key, { return new StorageHelper<T>(key, {
autoInit: true, autoInit: true,
observable: observableOptions, observableOptions,
defaultValue, defaultValue,
storage: { storage: {
async getItem(key: string) { async getItem(key: string) {

32
src/renderer/utils/storageHelper.ts
View File

@ -2,7 +2,7 @@
import { action, comparer, CreateObservableOptions, IObservableValue, IReactionDisposer, makeObservable, observable, reaction, toJS, when } from "mobx"; import { action, comparer, CreateObservableOptions, IObservableValue, IReactionDisposer, makeObservable, observable, reaction, toJS, when } from "mobx";
import produce, { Draft } from "immer"; import produce, { Draft } from "immer";
import { isEqual, isFunction, isPlainObject, merge } from "lodash"; import { isEqual, isFunction, isPlainObject } from "lodash";
import logger from "../../main/logger"; import logger from "../../main/logger";
export interface StorageAdapter<T> { export interface StorageAdapter<T> {
@ -14,8 +14,8 @@ export interface StorageAdapter<T> {
} }
export interface StorageHelperOptions<T> { export interface StorageHelperOptions<T> {
autoInit?: boolean; // start preloading data immediately, default: true autoInit?: boolean; // start preloading data immediately (default: true)
observable?: CreateObservableOptions; observableOptions?: CreateObservableOptions;
storage: StorageAdapter<T>; storage: StorageAdapter<T>;
defaultValue: T; defaultValue: T;
} }
@ -23,9 +23,10 @@ export interface StorageHelperOptions<T> {
export class StorageHelper<T> { export class StorageHelper<T> {
static defaultOptions: Partial<StorageHelperOptions<any>> = { static defaultOptions: Partial<StorageHelperOptions<any>> = {
autoInit: true, autoInit: true,
observable: { observableOptions: {
deep: true, deep: true,
equals: comparer.shallow, defaultDecorator: observable,
equals: comparer.structural,
} }
}; };
@ -40,20 +41,23 @@ export class StorageHelper<T> {
constructor(readonly key: string, private options: StorageHelperOptions<T>) { constructor(readonly key: string, private options: StorageHelperOptions<T>) {
makeObservable(this); makeObservable(this);
this.options = merge({}, StorageHelper.defaultOptions, options); this.options = Object.assign({}, StorageHelper.defaultOptions, options);
this.storage = options.storage; this.storage = options.storage;
this.defaultValue = options.defaultValue; this.defaultValue = options.defaultValue;
this.data = observable.box(this.defaultValue, this.options.observable); this.data = observable.box(this.defaultValue, this.options.observableOptions);
this.bindEvents();
this.unwatchChanges = reaction(() => toJS(this.data.get()), (newValue, oldValue) => {
this.onChange(newValue, oldValue);
}, this.options.observable);
if (this.options.autoInit) { if (this.options.autoInit) {
this.init(); this.init();
} }
} }
protected bindEvents() {
this.unwatchChanges = reaction(() => toJS(this.data.get()), (newValue, oldValue) => {
this.onChange(newValue, oldValue);
});
}
@action @action
init({ force = false } = {}) { init({ force = false } = {}) {
if (this.initialized && !force) return; if (this.initialized && !force) return;
@ -115,7 +119,7 @@ export class StorageHelper<T> {
} }
get(): T { get(): T {
return this.data.get(); return this.data.get() ?? this.defaultValue;
} }
set(value: T) { set(value: T) {
@ -143,8 +147,8 @@ export class StorageHelper<T> {
this.set(nextValue as T); this.set(nextValue as T);
} }
destroy() { unbindEvents() {
this.unwatchChanges(); this.unwatchChanges?.();
} }
toJS() { toJS() {