Restructure to monorepo (#6907)

* wip: restructure to monorepo Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * refactor create-release-pr to a package Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * build fixes Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * github workflow fixes Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix typo Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * add webpack-env types to core Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix github workflows Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * refactor/fix integration tests Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * lint fix Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * yarn run dev Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * eslint settings for vscode Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * move templates to right package Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * open-lens build fixes Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * integration test fix Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix nx task dependencies Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * use bash shell for unit tests in test workflow Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix test:unit for windows Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix win-ca webpack error in open-lens Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix win-ca webpack error in open-lens Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix build:app on windows Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * remove ELECTRON_BUILDER_EXTRA_ARGS Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * sync src/ from master Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * remove Makefile from core Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2025-05-20 05:10:56 +00:00 · 2023-01-24 10:46:26 -08:00
1 parent 0066ca4ea2
commit 2657df2293
@@ -0,0 +1,146 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { computed, runInAction } from "mobx";
+import type { DiContainer } from "@ogre-tools/injectable";
+import { getInjectable } from "@ogre-tools/injectable";
+import { getDiForUnitTesting } from "../../renderer/getDiForUnitTesting";
+import telemetryWhiteListForFunctionsInjectable from "./renderer/telemetry-white-list-for-functions.injectable";
+import emitEventInjectable from "../../common/app-event-bus/emit-event.injectable";
+
+describe("emit-telemetry-from-specific-function-calls", () => {
+  let di: DiContainer;
+
+  beforeEach(() => {
+    di = getDiForUnitTesting({ doGeneralOverrides: true });
+  });
+
+  describe("given a telemetry white-list for injectables which instantiate a function", () => {
+    let emitEventMock: jest.Mock;
+
+    beforeEach(() => {
+      di.override(telemetryWhiteListForFunctionsInjectable, () => [
+        "some-white-listed-function",
+      ]);
+
+      emitEventMock = jest.fn();
+      di.override(emitEventInjectable, () => emitEventMock);
+    });
+
+    describe("given instances of white-listed, non-white-listed and tagged functions", () => {
+      let whiteListedFunctionMock: jest.Mock;
+      let nonWhiteListedFunctionMock: jest.Mock;
+      let taggedFunctionMock: jest.Mock;
+      let injectedWhiteListedFunction: jest.Mock;
+      let injectedNonWhiteListedFunction: jest.Mock;
+      let injectedTaggedFunction: jest.Mock;
+
+      beforeEach(() => {
+        whiteListedFunctionMock = jest.fn();
+        nonWhiteListedFunctionMock = jest.fn();
+        taggedFunctionMock = jest.fn();
+
+        const whiteListedInjectable = getInjectable({
+          id: "some-white-listed-function",
+          instantiate: () => whiteListedFunctionMock,
+        });
+
+        const nonWhiteListedInjectable = getInjectable({
+          id: "some-non-white-listed-function",
+          instantiate: () => nonWhiteListedFunctionMock,
+        });
+
+        const taggedInjectable = getInjectable({
+          id: "some-tagged-function",
+          instantiate: () => taggedFunctionMock,
+          tags: ["emit-telemetry"],
+        });
+
+        runInAction(() => {
+          di.register(whiteListedInjectable);
+          di.register(nonWhiteListedInjectable);
+          di.register(taggedInjectable);
+        });
+
+        injectedWhiteListedFunction = di.inject(whiteListedInjectable);
+        injectedNonWhiteListedFunction = di.inject(nonWhiteListedInjectable);
+        injectedTaggedFunction = di.inject(taggedInjectable);
+      });
+
+      it("telemetry is not emitted yet", () => {
+        expect(emitEventMock).not.toHaveBeenCalled();
+      });
+
+      describe("when the white-listed function is called", () => {
+        beforeEach(() => {
+          injectedWhiteListedFunction("some-arg", "some-other-arg");
+        });
+
+        it("telemetry is emitted in event bus", () => {
+          expect(emitEventMock).toHaveBeenCalledWith({
+            destination: "auto-capture",
+            action: "telemetry-from-business-action",
+            name: "some-white-listed-function",
+            params: { args: ["some-arg", "some-other-arg"] },
+          });
+        });
+      });
+
+      describe("when the white-listed function is called with MobX reactive content", () => {
+        beforeEach(() => {
+          const someComputedProperty = computed(() => "some-computed-value");
+
+          const someObservable = {
+            someStaticProperty: "some-static-value",
+            someComputedProperty,
+          };
+
+          injectedWhiteListedFunction(someObservable);
+        });
+
+        it("telemetry is emitted in event bus without MobX internals or computeds", () => {
+          expect(emitEventMock).toHaveBeenCalledWith({
+            destination: "auto-capture",
+            action: "telemetry-from-business-action",
+            name: "some-white-listed-function",
+
+            params: {
+              args: [
+                {
+                  someStaticProperty: "some-static-value",
+                  someComputedProperty: "some-computed-value",
+                },
+              ],
+            },
+          });
+        });
+      });
+
+      describe("when the non-white-listed function is called", () => {
+        beforeEach(() => {
+          injectedNonWhiteListedFunction();
+        });
+
+        it("telemetry is not emitted", () => {
+          expect(emitEventMock).not.toHaveBeenCalled();
+        });
+      });
+
+      describe("when the tagged, but not white-listed function is called", () => {
+        beforeEach(() => {
+          injectedTaggedFunction("some-arg", "some-other-arg");
+        });
+
+        it("telemetry is emitted in event bus", () => {
+          expect(emitEventMock).toHaveBeenCalledWith({
+            destination: "auto-capture",
+            action: "telemetry-from-business-action",
+            name: "some-tagged-function",
+            params: { args: ["some-arg", "some-other-arg"] },
+          });
+        });
+      });
+    });
+  });
+});
@@ -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 emitEventInjectable from "../../../common/app-event-bus/emit-event.injectable";
+import { toJS, observable } from "mobx";
+
+const emitTelemetryInjectable = getInjectable({
+  id: "emit-telemetry",
+
+  instantiate: (di) => {
+    const emitEvent = di.inject(emitEventInjectable);
+
+    return ({ action, args }: { action: string; args: any[] }) => {
+      emitEvent({
+        destination: "auto-capture",
+        action: "telemetry-from-business-action",
+        name: action,
+        params: { args: toJS(observable(args)) },
+      });
+    };
+  },
+
+  decorable: false,
+});
+
+export default emitTelemetryInjectable;
@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type {
+  DiContainerForInjection,
+  Injectable,
+} from "@ogre-tools/injectable";
+
+import {
+  lifecycleEnum,
+  getInjectable,
+  instantiationDecoratorToken,
+} from "@ogre-tools/injectable";
+import assert from "assert";
+
+import { isFunction } from "lodash/fp";
+import emitTelemetryInjectable from "./emit-telemetry.injectable";
+import telemetryWhiteListForFunctionsInjectable from "./telemetry-white-list-for-functions.injectable";
+
+const telemetryDecoratorInjectable = getInjectable({
+  id: "telemetry-decorator",
+
+  instantiate: (diForDecorator) => {
+    const emitTelemetry = diForDecorator.inject(emitTelemetryInjectable);
+
+    const whiteList = diForDecorator.inject(
+      telemetryWhiteListForFunctionsInjectable,
+    );
+
+    const shouldEmitTelemetry = shouldEmitTelemetryFor(whiteList);
+
+    return {
+      decorate:
+        (instantiateToBeDecorated: any) =>
+          (di: DiContainerForInjection, instantiationParameter: any) => {
+            const instance = instantiateToBeDecorated(di, instantiationParameter);
+
+            if (isFunction(instance)) {
+              return (...args: any[]) => {
+                const currentContext = di.context.at(-1);
+
+                assert(currentContext);
+
+                if (shouldEmitTelemetry(currentContext.injectable)) {
+                  emitTelemetry({ action: currentContext.injectable.id, args });
+                }
+
+                return instance(...args);
+              };
+            }
+
+            return instance;
+          },
+    };
+  },
+
+  decorable: false,
+  // Todo: this is required because of imperfect typing in injectable.
+  lifecycle: lifecycleEnum.singleton,
+  injectionToken: instantiationDecoratorToken,
+});
+
+const shouldEmitTelemetryFor =
+  (whiteList: string[]) => (injectable: Injectable<any, any, any>) =>
+    injectable.tags?.includes("emit-telemetry") ||
+    whiteList.includes(injectable.id);
+
+export default telemetryDecoratorInjectable;
@@ -0,0 +1,117 @@
+/**
+ * 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";
+
+const navigateTo = [
+  "navigate-to-preference-tab-id",
+  "navigate-to-preference-tab",
+  "navigate-to-front-page",
+  "navigate-to-horizontal-pod-autoscalers",
+  "navigate-to-secrets",
+  "navigate-to-limit-ranges",
+  "navigate-to-pod-disruption-budgets",
+  "navigate-to-resource-quotas",
+  "navigate-to-priority-classes",
+  "navigate-to-config-maps",
+  "navigate-to-nodes",
+  "navigate-to-port-forwards",
+  "navigate-to-endpoints",
+  "navigate-to-network-policies",
+  "navigate-to-ingresses",
+  "navigate-to-services",
+  "navigate-to-persistent-volumes",
+  "navigate-to-persistent-volume-claims",
+  "navigate-to-storage-classes",
+  "navigate-to-namespaces",
+  "navigate-to-statefulsets",
+  "navigate-to-cron-jobs",
+  "navigate-to-pods",
+  "navigate-to-replicasets",
+  "navigate-to-daemonsets",
+  "navigate-to-jobs",
+  "navigate-to-workloads-overview",
+  "navigate-to-deployments",
+  "navigate-to-crd-list",
+  "navigate-to-custom-resources",
+  "navigate-to-pod-security-policies",
+  "navigate-to-cluster-role-bindings",
+  "navigate-to-roles",
+  "navigate-to-role-bindings",
+  "navigate-to-service-accounts",
+  "navigate-to-cluster-roles",
+  "navigate-to-events",
+  "navigate-to-cluster-overview",
+  "navigate-to-helm-releases",
+  "navigate-to-helm-charts",
+  "navigate-to-extension-preferences",
+  "navigate-to-app-preferences",
+  "navigate-to-proxy-preferences",
+  "navigate-to-preferences",
+  "navigate-to-terminal-preferences",
+  "navigate-to-telemetry-preferences",
+  "navigate-to-kubernetes-preferences",
+  "navigate-to-editor-preferences",
+  "navigate-to-add-cluster",
+  "navigate-to-catalog",
+  "navigate-to-welcome",
+  "navigate-to-extensions",
+  "navigate-to-cluster-view",
+  "navigate-to-entity-settings",
+];
+
+const helmInjectableIds = [
+  "update-helm-release",
+  "install-helm-chart",
+  "delete-helm-release",
+  "list-helm-charts",
+  "add-helm-repository-channel",
+  "remove-helm-repository-channel",
+  "select-helm-repository",
+  "call-for-helm-chart-versions",
+];
+
+const kubeConfigActions = [
+  "create-cluster",
+  "add-sync-entries",
+  "open-delete-cluster-dialog",
+];
+
+const extensions = [
+  "enable-extension",
+  "disable-extension",
+  "attempt-install",
+  "unpack-extension",
+  "install-extension-from-input",
+  "confirm-uninstall-extension",
+  "uninstall-extension",
+];
+
+const externalActions = [
+  "open-link-in-browser",
+];
+
+const uiInteraction = [
+  "show-details",
+];
+
+const terminal = [
+  "create-terminal-tab",
+];
+
+const telemetryWhiteListForFunctionsInjectable = getInjectable({
+  id: "telemetry-white-list-for-functions",
+  instantiate: () => [
+    ...navigateTo,
+    ...helmInjectableIds,
+    ...kubeConfigActions,
+    ...extensions,
+    ...externalActions,
+    ...uiInteraction,
+    ...terminal,
+  ],
+  decorable: false,
+});
+
+export default telemetryWhiteListForFunctionsInjectable;