Automatically sync all existing files from cluster-store

- Change migration label, change store init order

Signed-off-by: Sebastian Malton <sebastian@malton.name>

package.json

@@ -3,7 +3,7 @@
   "productName": "OpenLens",
   "description": "OpenLens - Open Source IDE for Kubernetes",
   "homepage": "https://github.com/lensapp/lens",
-  "version": "5.0.2",
+  "version": "5.0.3-beta.1",
   "main": "static/build/main.js",
   "copyright": "© 2021 OpenLens Authors",
   "license": "MIT",

src/common/user-store/index.ts

@@ -20,4 +20,4 @@
  */
 
 export * from "./user-store";
-export type { KubeconfigSyncEntry, KubeconfigSyncValue } from "./preferences-helpers";
+export type { KubeconfigSyncEntry, KubeconfigSyncValue, UserPreferencesModel } from "./preferences-helpers";

src/common/user-store/user-store.ts

@@ -31,6 +31,7 @@ import path from "path";
 import { fileNameMigration } from "../../migrations/user-store";
 import { ObservableToggleSet, toJS } from "../../renderer/utils";
 import { DESCRIPTORS, KubeconfigSyncValue, UserPreferencesModel } from "./preferences-helpers";
+import logger from "../../main/logger";
 
 export interface UserStoreModel {
   lastSeenAppVersion: string;
@@ -155,8 +156,8 @@ export class UserStore extends BaseStore<UserStoreModel> /* implements UserStore
   }
 
   @action
-  protected fromStore(data: Partial<UserStoreModel> = {}) {
-    const { lastSeenAppVersion, preferences } = data;
+  protected fromStore({ lastSeenAppVersion, preferences }: Partial<UserStoreModel> = {}) {
+    logger.debug("UserStore.fromStore()", { lastSeenAppVersion, preferences });
 
     if (lastSeenAppVersion) {
       this.lastSeenAppVersion = lastSeenAppVersion;

src/main/index.ts

@@ -138,8 +138,8 @@ app.on("ready", async () => {
 
   logger.info("💾 Loading stores");
 
-  UserStore.createInstance().startMainReactions();
   ClusterStore.createInstance().provideInitialFromMain();
+  UserStore.createInstance().startMainReactions();
   HotbarStore.createInstance();
   ExtensionsStore.createInstance();
   FilesystemProvisionerStore.createInstance();

src/migrations/user-store/5.0.3-beta.1.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { app } from "electron";
+import { existsSync, readJsonSync } from "fs-extra";
+import path from "path";
+import os from "os";
+import { ClusterStore, ClusterStoreModel } from "../../common/cluster-store";
+import type { KubeconfigSyncEntry, UserPreferencesModel } from "../../common/user-store";
+import { MigrationDeclaration, migrationLog } from "../helpers";
+
+export default {
+  version: "5.0.3-beta.1",
+  run(store) {
+    const { syncKubeconfigEntries = [], ...preferences }: UserPreferencesModel = store.get("preferences") ?? {};
+    const { clusters = [] }: ClusterStoreModel = readJsonSync(path.resolve(app.getPath("userData"), "lens-cluster-store.json"));
+    const syncPaths = new Set(syncKubeconfigEntries.map(s => s.filePath));
+
+    syncPaths.add(path.join(os.homedir(), ".kube"));
+
+    for (const cluster of clusters) {
+      const dirOfKubeconfig = path.dirname(cluster.kubeConfigPath);
+
+      if (dirOfKubeconfig === ClusterStore.storedKubeConfigFolder) {
+        migrationLog(`Skipping ${cluster.id} because kubeConfigPath is under ClusterStore.storedKubeConfigFolder`);
+        continue;
+      }
+
+      if (syncPaths.has(cluster.kubeConfigPath) || syncPaths.has(dirOfKubeconfig)) {
+        migrationLog(`Skipping ${cluster.id} because kubeConfigPath is already being synced`);
+        continue;
+      }
+
+      if (!existsSync(cluster.kubeConfigPath)) {
+        migrationLog(`Skipping ${cluster.id} because kubeConfigPath no longer exists`);
+        continue;
+      }
+
+      migrationLog(`Adding ${cluster.kubeConfigPath} from ${cluster.id} to sync paths`);
+      syncPaths.add(cluster.kubeConfigPath);
+    }
+
+    const updatedSyncEntries: KubeconfigSyncEntry[] = [...syncPaths].map(filePath => ({ filePath }));
+
+    migrationLog("Final list of synced paths", updatedSyncEntries);
+    store.set("preferences", { ...preferences, syncKubeconfigEntries: updatedSyncEntries });
+  },
+} as MigrationDeclaration;

src/migrations/user-store/index.ts

@@ -25,6 +25,7 @@ import { joinMigrations } from "../helpers";
 
 import version210Beta4 from "./2.1.0-beta.4";
 import version500Alpha3 from "./5.0.0-alpha.3";
+import version503Beta1 from "./5.0.3-beta.1";
 import { fileNameMigration } from "./file-name-migration";
 
 export {
@@ -34,4 +35,5 @@ export {
 export default joinMigrations(
   version210Beta4,
   version500Alpha3,
+  version503Beta1,
 );