Cascade different refactorings to eliminate global shared state from app paths

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

src/renderer/components/dock/dock-tab-store/create-dock-tab-store.injectable.ts

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import { DockTabStore, DockTabStoreOptions } from "./dock-tab.store";
+import dockStoreInjectable from "../dock-store/dock-store.injectable";
+import createStorageInjectable from "../../../utils/create-storage/create-storage.injectable";
+
+const createDockTabStoreInjectable = getInjectable({
+  instantiate: (di) => {
+    const dependencies = {
+      dockStore: di.inject(dockStoreInjectable),
+      createStorage: di.inject(createStorageInjectable),
+    };
+
+    return <T>(options: DockTabStoreOptions = {}) => new DockTabStore<T>(dependencies, options);
+  },
+
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default createDockTabStoreInjectable;

src/renderer/components/dock/dock-tab-store/dock-tab.store.ts

@@ -0,0 +1,113 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import { autorun, observable, reaction } from "mobx";
+import { autoBind, StorageHelper, toJS } from "../../../utils";
+import type { DockStore, TabId } from "../dock-store/dock.store";
+
+export interface DockTabStoreOptions {
+  autoInit?: boolean; // load data from storage when `storageKey` is provided and bind events, default: true
+  storageKey?: string; // save data to persistent storage under the key
+}
+
+export type DockTabStorageState<T> = Record<TabId, T>;
+
+interface Dependencies {
+  dockStore: DockStore
+  createStorage: <T>(storageKey: string, options: DockTabStorageState<T>) => StorageHelper<DockTabStorageState<T>>
+}
+
+export class DockTabStore<T> {
+  protected storage?: StorageHelper<DockTabStorageState<T>>;
+  protected data = observable.map<TabId, T>();
+
+  constructor(protected dependencies: Dependencies, protected options: DockTabStoreOptions) {
+    autoBind(this);
+
+    this.options = {
+      autoInit: true,
+      ...this.options,
+    };
+
+    if (this.options.autoInit) {
+      this.init();
+    }
+  }
+
+  protected init() {
+    const { storageKey } = this.options;
+
+    // auto-save to local-storage
+    if (storageKey) {
+      this.storage = this.dependencies.createStorage<T>(storageKey, {});
+      this.storage.whenReady.then(() => {
+        this.data.replace(this.storage.get());
+        reaction(() => this.toJSON(), data => this.storage.set(data));
+      });
+    }
+
+    // clear data for closed tabs
+    autorun(() => {
+      const currentTabs = this.dependencies.dockStore.tabs.map(tab => tab.id);
+
+      Array.from(this.data.keys()).forEach(tabId => {
+        if (!currentTabs.includes(tabId)) {
+          this.clearData(tabId);
+        }
+      });
+    });
+  }
+
+  protected finalizeDataForSave(data: T): T {
+    return data;
+  }
+
+  protected toJSON(): DockTabStorageState<T> {
+    const deepCopy = toJS(this.data);
+
+    deepCopy.forEach((tabData, key) => {
+      deepCopy.set(key, this.finalizeDataForSave(tabData));
+    });
+
+    return Object.fromEntries<T>(deepCopy);
+  }
+
+  isReady(tabId: TabId): boolean {
+    return Boolean(this.getData(tabId) !== undefined);
+  }
+
+  getData(tabId: TabId) {
+    return this.data.get(tabId);
+  }
+
+  setData(tabId: TabId, data: T) {
+    this.data.set(tabId, data);
+  }
+
+  clearData(tabId: TabId) {
+    this.data.delete(tabId);
+  }
+
+  reset() {
+    this.data.clear();
+    this.storage?.reset();
+  }
+}