Fix crash on clean startup (#6276)

* Convert ReleaseChannel into an InitializableState

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

* Fix init timing for DefaultUpdateChannel

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

* Make UserStore loading seperate from creation to fix initialization timing errors

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

* Fix overrides of UserStore

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

* Fix UserStore tests

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

* Move userStoreFileMigration call to the init runnable

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

* Add global override for userStoreFileMigratiom

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

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

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

@@ -33,6 +33,8 @@ import writeFileInjectable from "../fs/write-file.injectable";
 import { getDiForUnitTesting } from "../../main/getDiForUnitTesting";
 import getConfigurationFileModelInjectable from "../get-configuration-file-model/get-configuration-file-model.injectable";
 import storeMigrationVersionInjectable from "../vars/store-migration-version.injectable";
+import releaseChannelInjectable from "../vars/release-channel.injectable";
+import defaultUpdateChannelInjectable from "../application-update/selected-update-channel/default-update-channel.injectable";
 
 console = new Console(stdout, stderr);
 
@@ -40,7 +42,7 @@ describe("user store tests", () => {
   let userStore: UserStore;
   let di: DiContainer;
 
-  beforeEach(() => {
+  beforeEach(async () => {
     di = getDiForUnitTesting({ doGeneralOverrides: true });
 
     mockFs();
@@ -50,6 +52,12 @@ describe("user store tests", () => {
     di.permitSideEffects(getConfigurationFileModelInjectable);
     di.permitSideEffects(userStoreInjectable);
 
+    di.override(releaseChannelInjectable, () => ({
+      get: () => "latest" as const,
+      init: async () => {},
+    }));
+    await di.inject(defaultUpdateChannelInjectable).init();
+
     di.unoverride(userStoreInjectable);
   });
 
@@ -62,6 +70,7 @@ describe("user store tests", () => {
       mockFs({ "some-directory-for-user-data": { "config.json": "{}", "kube_config": "{}" }});
 
       userStore = di.inject(userStoreInjectable);
+      userStore.load();
     });
 
     it("allows setting and retrieving lastSeenAppVersion", () => {
@@ -119,6 +128,7 @@ describe("user store tests", () => {
       di.override(storeMigrationVersionInjectable, () => "10.0.0");
 
       userStore = di.inject(userStoreInjectable);
+      userStore.load();
     });
 
     it("sets last seen app version to 0.0.0", () => {

src/common/application-update/selected-update-channel/default-update-channel.injectable.ts

@@ -8,7 +8,7 @@ import { updateChannels } from "../update-channels";
 
 const defaultUpdateChannelInjectable = createInitializableState({
   id: "default-update-channel",
-  init: (di) => updateChannels[di.inject(releaseChannelInjectable)],
+  init: (di) => updateChannels[di.inject(releaseChannelInjectable).get()],
 });
 
 export default defaultUpdateChannelInjectable;

src/common/error-reporting/initialize-sentry-reporting.injectable.ts

@@ -20,6 +20,7 @@ const initializeSentryReportingWithInjectable = getInjectable({
   instantiate: (di): InitializeSentryReportingWith => {
     const sentryDataSourceName = di.inject(sentryDataSourceNameInjectable);
     const isProduction = di.inject(isProductionInjectable);
+    const userStore = di.inject(userStoreInjectable);
 
     if (!sentryDataSourceName) {
       return () => {};
@@ -27,9 +28,6 @@ const initializeSentryReportingWithInjectable = getInjectable({
 
     return (initSentry) => initSentry({
       beforeSend: (event) => {
-        // TODO: remove loading from userStoreInjectable so that this can be moved out
-        const userStore = di.inject(userStoreInjectable);
-
         if (userStore.allowErrorReporting) {
           return event;
         }

src/common/user-store/file-name-migration.global-override-for-injectable.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import userStoreFileNameMigrationInjectable from "./file-name-migration.injectable";
+
+export default getGlobalOverride(userStoreFileNameMigrationInjectable, () => async () => {});

src/common/user-store/file-name-migration.injectable.ts

@@ -9,27 +9,32 @@ import directoryForUserDataInjectable from "../app-paths/directory-for-user-data
 import { isErrnoException } from "../utils";
 import { getInjectable } from "@ogre-tools/injectable";
 
+export type UserStoreFileNameMigration = () => Promise<void>;
+
 const userStoreFileNameMigrationInjectable = getInjectable({
   id: "user-store-file-name-migration",
-  instantiate: (di) => {
+  instantiate: (di): UserStoreFileNameMigration => {
     const userDataPath = di.inject(directoryForUserDataInjectable);
     const configJsonPath = path.join(userDataPath, "config.json");
     const lensUserStoreJsonPath = path.join(userDataPath, "lens-user-store.json");
 
-    try {
+    return async () => {
-      fse.moveSync(configJsonPath, lensUserStoreJsonPath);
+      try {
-    } catch (error) {
+        await fse.move(configJsonPath, lensUserStoreJsonPath);
-      if (error instanceof Error && error.message === "dest already exists.") {
+      } catch (error) {
-        fse.removeSync(configJsonPath);
+        if (error instanceof Error && error.message === "dest already exists.") {
-      } else if (isErrnoException(error) && error.code === "ENOENT" && error.path === configJsonPath) {
+          await fse.remove(configJsonPath);
-        // (No such file or directory)
+        } else if (isErrnoException(error) && error.code === "ENOENT" && error.path === configJsonPath) {
-        return; // file already moved
+          // (No such file or directory)
-      } else {
+          return; // file already moved
-        // pass other errors along
+        } else {
-        throw error;
+          // pass other errors along
+          throw error;
+        }
       }
-    }
+    };
   },
+  causesSideEffects: true,
 });
 
 export default userStoreFileNameMigrationInjectable;

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

@@ -3,8 +3,6 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
-import { ipcMain } from "electron";
-import userStoreFileNameMigrationInjectable from "./file-name-migration.injectable";
 import { UserStore } from "./user-store";
 import selectedUpdateChannelInjectable from "../application-update/selected-update-channel/selected-update-channel.injectable";
 
@@ -14,10 +12,6 @@ const userStoreInjectable = getInjectable({
   instantiate: (di) => {
     UserStore.resetInstance();
 
-    if (ipcMain) {
-      di.inject(userStoreFileNameMigrationInjectable);
-    }
-
     return UserStore.createInstance({
       selectedUpdateChannel: di.inject(selectedUpdateChannelInjectable),
     });

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

@@ -34,7 +34,6 @@ export class UserStore extends BaseStore<UserStoreModel> /* implements UserStore
     });
 
     makeObservable(this);
-    this.load();
   }
 
   @observable lastSeenAppVersion = "0.0.0";

src/common/vars/release-channel.injectable.ts

@@ -2,13 +2,13 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-import { getInjectable } from "@ogre-tools/injectable";
 import type { ReleaseChannel } from "../application-update/update-channels";
+import { createInitializableState } from "../initializable-state/create";
 import buildSemanticVersionInjectable from "./build-semantic-version.injectable";
 
-const releaseChannelInjectable = getInjectable({
+const releaseChannelInjectable = createInitializableState({
   id: "release-channel",
-  instantiate: (di): ReleaseChannel => {
+  init: (di): ReleaseChannel => {
     const buildSemanticVersion = di.inject(buildSemanticVersionInjectable);
     const currentReleaseChannel = buildSemanticVersion.get().prerelease[0];
 

src/main/application-update/check-for-updates/update-can-be-downgraded.injectable.ts

@@ -16,7 +16,7 @@ const updateCanBeDowngradedInjectable = getInjectable({
 
     return computed(() => (
       selectedUpdateChannel.value.get().id === "latest"
-      && releaseChannel !== "latest"
+      && releaseChannel.get() !== "latest"
     ));
   },
 });

src/main/getDiForUnitTesting.ts

@@ -132,7 +132,11 @@ export function getDiForUnitTesting(opts: { doGeneralOverrides?: boolean } = {})
       getDisplayIndex: () => "0",
     }) as unknown as HotbarStore);
 
-    di.override(userStoreInjectable, () => ({ startMainReactions: () => {}, extensionRegistryUrl: { customUrl: "some-custom-url" }}) as UserStore);
+    di.override(userStoreInjectable, () => ({
+      startMainReactions: () => {},
+      extensionRegistryUrl: { customUrl: "some-custom-url" },
+      load: () => {},
+    }) as Partial<UserStore> as UserStore);
     di.override(extensionsStoreInjectable, () => ({ isEnabled: (opts) => (void opts, false) }) as ExtensionsStore);
     di.override(fileSystemProvisionerStoreInjectable, () => ({}) as FileSystemProvisionerStore);
 

src/main/stores/init-user-store.injectable.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import userStoreFileNameMigrationInjectable from "../../common/user-store/file-name-migration.injectable";
+import userStoreInjectable from "../../common/user-store/user-store.injectable";
+import { beforeApplicationIsLoadingInjectionToken } from "../start-main-application/runnable-tokens/before-application-is-loading-injection-token";
+import initDefaultUpdateChannelInjectableInjectable from "../vars/default-update-channel/init.injectable";
+
+const initUserStoreInjectable = getInjectable({
+  id: "init-user-store",
+  instantiate: (di) => {
+    const userStore = di.inject(userStoreInjectable);
+    const userStoreFileNameMigration = di.inject(userStoreFileNameMigrationInjectable);
+
+    return {
+      run: async () => {
+        await userStoreFileNameMigration();
+        userStore.load();
+      },
+      runAfter: di.inject(initDefaultUpdateChannelInjectableInjectable),
+    };
+  },
+  injectionToken: beforeApplicationIsLoadingInjectionToken,
+});
+
+export default initUserStoreInjectable;

src/main/vars/default-update-channel/init.injectable.ts

@@ -4,8 +4,8 @@
  */
 import { getInjectable } from "@ogre-tools/injectable";
 import defaultUpdateChannelInjectable from "../../../common/application-update/selected-update-channel/default-update-channel.injectable";
-import initSemanticBuildVersionInjectable from "../../../renderer/vars/semantic-build-version/init.injectable";
 import { beforeApplicationIsLoadingInjectionToken } from "../../start-main-application/runnable-tokens/before-application-is-loading-injection-token";
+import initReleaseChannelInjectable from "../release-channel/init.injectable";
 
 const initDefaultUpdateChannelInjectableInjectable = getInjectable({
   id: "init-default-update-channel-injectable",
@@ -14,7 +14,7 @@ const initDefaultUpdateChannelInjectableInjectable = getInjectable({
 
     return {
       run: () => defaultUpdateChannel.init(),
-      runAfter: di.inject(initSemanticBuildVersionInjectable),
+      runAfter: di.inject(initReleaseChannelInjectable),
     };
   },
   injectionToken: beforeApplicationIsLoadingInjectionToken,

src/main/vars/release-channel/init.injectable.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import releaseChannelInjectable from "../../../common/vars/release-channel.injectable";
+import { beforeApplicationIsLoadingInjectionToken } from "../../start-main-application/runnable-tokens/before-application-is-loading-injection-token";
+import initSemanticBuildVersionInjectable from "../semantic-build-version/init.injectable";
+
+const initReleaseChannelInjectable = getInjectable({
+  id: "init-release-channel",
+  instantiate: (di) => {
+    const releaseChannel = di.inject(releaseChannelInjectable);
+
+    return {
+      run: () => releaseChannel.init(),
+      runAfter: di.inject(initSemanticBuildVersionInjectable),
+    };
+  },
+  injectionToken: beforeApplicationIsLoadingInjectionToken,
+});
+
+export default initReleaseChannelInjectable;

src/renderer/bootstrap.tsx

@@ -28,7 +28,6 @@ import extensionLoaderInjectable from "../extensions/extension-loader/extension-
 import extensionDiscoveryInjectable from "../extensions/extension-discovery/extension-discovery.injectable";
 import extensionInstallationStateStoreInjectable from "../extensions/extension-installation-state-store/extension-installation-state-store.injectable";
 import clusterStoreInjectable from "../common/cluster-store/cluster-store.injectable";
-import userStoreInjectable from "../common/user-store/user-store.injectable";
 import initRootFrameInjectable from "./frames/root-frame/init-root-frame/init-root-frame.injectable";
 import initClusterFrameInjectable from "./frames/cluster-frame/init-cluster-frame/init-cluster-frame.injectable";
 import commandOverlayInjectable from "./components/command-palette/command-overlay.injectable";
@@ -92,9 +91,6 @@ export async function bootstrap(di: DiContainer) {
    */
   di.inject(autoRegistrationInjectable);
 
-  // TODO: Remove temporal dependencies to make timing of initialization not important
-  di.inject(userStoreInjectable);
-
   await attachChromeDebugger();
   rootElem.classList.toggle("is-mac", isMac);
 

src/renderer/getDiForUnitTesting.tsx

@@ -66,6 +66,7 @@ import legacyOnChannelListenInjectable from "./ipc/legacy-channel-listen.injecta
 import getEntitySettingCommandsInjectable from "./components/command-palette/registered-commands/get-entity-setting-commands.injectable";
 import storageSaveDelayInjectable from "./utils/create-storage/storage-save-delay.injectable";
 import type { GlobalOverride } from "../common/test-utils/get-global-override";
+import type { PartialDeep } from "type-fest";
 
 export const getDiForUnitTesting = (
   opts: { doGeneralOverrides?: boolean } = {},
@@ -184,17 +185,14 @@ export const getDiForUnitTesting = (
 
     di.override(defaultShellInjectable, () => "some-default-shell");
 
-    di.override(
+    di.override(userStoreInjectable, () => ({
-      userStoreInjectable,
+      isTableColumnHidden: () => false,
-      () =>
+      extensionRegistryUrl: { customUrl: "some-custom-url" },
-        ({
+      syncKubeconfigEntries: observable.map(),
-          isTableColumnHidden: () => false,
+      terminalConfig: { fontSize: 42 },
-          extensionRegistryUrl: { customUrl: "some-custom-url" },
+      editorConfiguration: { minimap: {}, tabSize: 42, fontSize: 42 },
-          syncKubeconfigEntries: observable.map(),
+      load: () => {},
-          terminalConfig: { fontSize: 42 },
+    } as PartialDeep<UserStore> as UserStore));
-          editorConfiguration: { minimap: {}, tabSize: 42, fontSize: 42 },
-        } as unknown as UserStore),
-    );
 
     di.override(apiManagerInjectable, () => new ApiManager());
 

src/renderer/stores/init-user-store.injectable.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import userStoreInjectable from "../../common/user-store/user-store.injectable";
+import { beforeFrameStartsInjectionToken } from "../before-frame-starts/before-frame-starts-injection-token";
+import initDefaultUpdateChannelInjectableInjectable from "../vars/default-update-channel/init.injectable";
+
+const initUserStoreInjectable = getInjectable({
+  id: "init-user-store",
+  instantiate: (di) => {
+    const userStore = di.inject(userStoreInjectable);
+
+    return {
+      run: () => userStore.load(),
+      runAfter: di.inject(initDefaultUpdateChannelInjectableInjectable),
+    };
+  },
+  injectionToken: beforeFrameStartsInjectionToken,
+});
+
+export default initUserStoreInjectable;

src/renderer/vars/default-update-channel/init.injectable.ts

@@ -4,8 +4,8 @@
  */
 import { getInjectable } from "@ogre-tools/injectable";
 import defaultUpdateChannelInjectable from "../../../common/application-update/selected-update-channel/default-update-channel.injectable";
-import initSemanticBuildVersionInjectable from "../../../renderer/vars/semantic-build-version/init.injectable";
 import { beforeFrameStartsInjectionToken } from "../../before-frame-starts/before-frame-starts-injection-token";
+import initReleaseChannelInjectable from "../release-channel/init.injectable";
 
 const initDefaultUpdateChannelInjectableInjectable = getInjectable({
   id: "init-default-update-channel-injectable",
@@ -14,7 +14,7 @@ const initDefaultUpdateChannelInjectableInjectable = getInjectable({
 
     return {
       run: () => defaultUpdateChannel.init(),
-      runAfter: di.inject(initSemanticBuildVersionInjectable),
+      runAfter: di.inject(initReleaseChannelInjectable),
     };
   },
   injectionToken: beforeFrameStartsInjectionToken,

src/renderer/vars/release-channel/init.injectable.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import releaseChannelInjectable from "../../../common/vars/release-channel.injectable";
+import { beforeFrameStartsInjectionToken } from "../../before-frame-starts/before-frame-starts-injection-token";
+import initSemanticBuildVersionInjectable from "../semantic-build-version/init.injectable";
+
+const initReleaseChannelInjectable = getInjectable({
+  id: "init-release-channel",
+  instantiate: (di) => {
+    const releaseChannel = di.inject(releaseChannelInjectable);
+
+    return {
+      run: () => releaseChannel.init(),
+      runAfter: di.inject(initSemanticBuildVersionInjectable),
+    };
+  },
+  injectionToken: beforeFrameStartsInjectionToken,
+});
+
+export default initReleaseChannelInjectable;