Introduce a centralised way to emit telemetry from calls of injectable functions (#6164)

Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>
Co-authored-by: Juho Heikka <juho.heikka@gmail.com>

src/renderer/api/__tests__/catalog-entity-registry.test.ts

@@ -80,7 +80,7 @@ describe("CatalogEntityRegistry", () => {
   let catalogCategoryRegistry: CatalogCategoryRegistry;
 
   beforeEach(() => {
-    const di = getDiForUnitTesting();
+    const di = getDiForUnitTesting({ doGeneralOverrides: true });
 
     entityRegistry = di.inject(catalogEntityRegistryInjectable);
     catalogCategoryRegistry = di.inject(catalogCategoryRegistryInjectable);

src/renderer/components/+catalog/__tests__/custom-columns.test.ts

@@ -43,7 +43,7 @@ describe("Custom Category Columns", () => {
   let di: DiContainer;
 
   beforeEach(() => {
-    di = getDiForUnitTesting();
+    di = getDiForUnitTesting({ doGeneralOverrides: true });
 
     di.override(hotbarStoreInjectable, () => ({}));
   });

src/renderer/components/+catalog/__tests__/custom-views.test.ts

@@ -16,7 +16,7 @@ describe("Custom Category Views", () => {
   let di: DiContainer;
 
   beforeEach(() => {
-    di = getDiForUnitTesting();
+    di = getDiForUnitTesting({ doGeneralOverrides: true });
   });
 
   it("should order items correctly over all extensions", () => {

src/renderer/components/kube-object-menu/kube-object-menu.test.tsx

@@ -14,7 +14,7 @@ import { ConfirmDialog } from "../confirm-dialog";
 import type { AsyncFnMock } from "@async-fn/jest";
 import asyncFn from "@async-fn/jest";
 import { getDiForUnitTesting } from "../../getDiForUnitTesting";
-import { computed } from "mobx";
+import { computed, runInAction } from "mobx";
 import clusterInjectable from "./dependencies/cluster.injectable";
 import type { DiRender } from "../test-utils/renderFor";
 import { renderFor } from "../test-utils/renderFor";
@@ -34,11 +34,13 @@ describe("kube-object-menu", () => {
   beforeEach(() => {
     di = getDiForUnitTesting({ doGeneralOverrides: true });
 
-    di.register(
-      someMenuItemInjectable,
-      someOtherMenuItemInjectable,
-      someAnotherMenuItemInjectable,
-    );
+    runInAction(() => {
+      di.register(
+        someMenuItemInjectable,
+        someOtherMenuItemInjectable,
+        someAnotherMenuItemInjectable,
+      );
+    });
 
     render = renderFor(di);
 

src/renderer/components/test-utils/get-application-builder.tsx

@@ -143,7 +143,9 @@ export const getApplicationBuilder = () => {
     doGeneralOverrides: true,
   });
 
-  mainDi.register(mainExtensionsStateInjectable);
+  runInAction(() => {
+    mainDi.register(mainExtensionsStateInjectable);
+  });
 
   const overrideChannelsForWindow = overrideChannels(mainDi);
 
@@ -184,7 +186,9 @@ export const getApplicationBuilder = () => {
 
     overrideChannelsForWindow(windowDi, windowId);
 
-    windowDi.register(rendererExtensionsStateInjectable);
+    runInAction(() => {
+      windowDi.register(rendererExtensionsStateInjectable);
+    });
 
     windowDi.override(
       currentlyInClusterFrameInjectable,
@@ -552,9 +556,11 @@ export const getApplicationBuilder = () => {
             getExtensionFakeForMain(mainDi, extension.id, extension.name, extension.mainOptions || {}),
           );
 
-          mainExtensionInstances.forEach(
-            enableExtensionFor(mainDi, mainExtensionsStateInjectable),
-          );
+          runInAction(() => {
+            mainExtensionInstances.forEach(
+              enableExtensionFor(mainDi, mainExtensionsStateInjectable),
+            );
+          });
         });
       },
 

src/renderer/getDi.tsx

@@ -6,24 +6,27 @@
 import { createContainer } from "@ogre-tools/injectable";
 import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration";
 import { registerMobX } from "@ogre-tools/injectable-extension-for-mobx";
+import { runInAction } from "mobx";
 import { Environments, setLegacyGlobalDiForExtensionApi } from "../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api";
 
 export const getDi = () => {
   const di = createContainer("renderer");
 
-  registerMobX(di);
-
-  autoRegister({
-    di,
-    requireContexts: [
-      require.context("./", true, /\.injectable\.(ts|tsx)$/),
-      require.context("../common", true, /\.injectable\.(ts|tsx)$/),
-      require.context("../extensions", true, /\.injectable\.(ts|tsx)$/),
-      require.context("../features", true, /.*\/(renderer|common)\/.*\.injectable\.(ts|tsx)$/),
-    ],
-  });
-
   setLegacyGlobalDiForExtensionApi(di, Environments.renderer);
 
+  runInAction(() => {
+    registerMobX(di);
+
+    autoRegister({
+      di,
+      requireContexts: [
+        require.context("./", true, /\.injectable\.(ts|tsx)$/),
+        require.context("../common", true, /\.injectable\.(ts|tsx)$/),
+        require.context("../extensions", true, /\.injectable\.(ts|tsx)$/),
+        require.context("../features", true, /.*\/(renderer|common)\/.*\.injectable\.(ts|tsx)$/),
+      ],
+    });
+  });
+
   return di;
 };

src/renderer/getDiForUnitTesting.tsx

@@ -33,7 +33,7 @@ import lensResourcesDirInjectable from "../common/vars/lens-resources-dir.inject
 import broadcastMessageInjectable from "../common/ipc/broadcast-message.injectable";
 import apiManagerInjectable from "../common/k8s-api/api-manager/manager.injectable";
 import setupOnApiErrorListenersInjectable from "./api/setup-on-api-errors.injectable";
-import { observable, computed } from "mobx";
+import { observable, computed, runInAction } from "mobx";
 import defaultShellInjectable from "./components/+preferences/default-shell.injectable";
 import appVersionInjectable from "../common/vars/app-version.injectable";
 import requestAnimationFrameInjectable from "./components/animate/request-animation-frame.injectable";
@@ -68,26 +68,30 @@ import getEntitySettingCommandsInjectable from "./components/command-palette/reg
 import storageSaveDelayInjectable from "./utils/create-storage/storage-save-delay.injectable";
 import type { GlobalOverride } from "../common/test-utils/get-global-override";
 
-export const getDiForUnitTesting = (opts: { doGeneralOverrides?: boolean } = {}) => {
-  const {
-    doGeneralOverrides = false,
-  } = opts;
+export const getDiForUnitTesting = (
+  opts: { doGeneralOverrides?: boolean } = {},
+) => {
+  const { doGeneralOverrides = false } = opts;
 
   const di = createContainer("renderer");
 
-  registerMobX(di);
+  di.preventSideEffects();
 
   setLegacyGlobalDiForExtensionApi(di, Environments.renderer);
 
-  const injectables: Injectable<any, any, any>[] = (global as any).rendererInjectablePaths.map(
+  const injectables: Injectable<any, any, any>[] = (
+      global as any
+  ).rendererInjectablePaths.map(
     (filePath: string) => require(filePath).default,
   );
 
-  chunk(100)(injectables).forEach(chunkInjectables => {
-    di.register(...chunkInjectables);
-  });
+  runInAction(() => {
+    registerMobX(di);
 
-  di.preventSideEffects();
+    chunk(100)(injectables).forEach((chunkInjectables) => {
+      di.register(...chunkInjectables);
+    });
+  });
 
   if (doGeneralOverrides) {
     const globalOverrides: GlobalOverride[] = (global as any).rendererGlobalOverridePaths.map(

src/renderer/routes/navigate-to-route.injectable.ts

@@ -33,6 +33,8 @@ const navigateToRouteInjectable = getInjectable({
     };
   },
 
+  tags: ["emit-telemetry"],
+
   injectionToken: navigateToRouteInjectionToken,
 });
 

src/renderer/utils/create-storage/storages-are-ready.ts

@@ -3,6 +3,7 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import type { DiContainer } from "@ogre-tools/injectable";
+import { runInAction } from "mobx";
 import type { CreateStorage } from "./create-storage";
 import createStorageInjectable from "./create-storage.injectable";
 
@@ -19,8 +20,10 @@ export const controlWhenStoragesAreReady = (di: DiContainer) => {
             return storage;
           };
 
-  // TODO: Remove when typing is added to the library
-  (di as any).decorateFunction(createStorageInjectable, decorated);
+  runInAction(() => {
+    // TODO: Remove when typing is added to the library
+    (di as any).decorateFunction(createStorageInjectable, decorated);
+  });
 
   return async () => {
     await Promise.all(storagesAreReady);