Extract injection token for application information to separate NPM package (#7211)

* Introduce dummy package for application

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

* Introduce application information token in application Feature

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

* Switch to using applicationInformationToken from application feature

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

---------

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

packages/core/package.json

@@ -330,6 +330,7 @@
     "xterm-addon-fit": "^0.5.0"
   },
   "peerDependencies": {
+    "@k8slens/application": "^6.4.0-beta.13",
     "@types/byline": "^4.2.33",
     "@types/chart.js": "^2.9.36",
     "@types/color": "^3.0.3",

packages/core/src/common/front-end-routing/routes/welcome/welcome-route-config.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 { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "../../../vars/application-information-token";
 
 const welcomeRouteConfigInjectable = getInjectable({
   id: "welcome-route-config",
 
-  instantiate: (di) => di.inject(applicationInformationToken).config.welcomeRoute,
+  instantiate: (di) => di.inject(applicationInformationToken).welcomeRoute,
 });
 
 export default welcomeRouteConfigInjectable;

packages/core/src/common/library.ts

@@ -4,6 +4,4 @@
  */
 
 // @experimental
-export { applicationInformationToken } from "./vars/application-information-token";
-export type { ApplicationInformation } from "./vars/application-information-token";
 export { bundledExtensionInjectionToken } from "../extensions/extension-discovery/bundled-extension-token";

packages/core/src/common/vars/application-copyright.injectable.ts

@@ -2,8 +2,8 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const applicationCopyrightInjectable = getInjectable({
   id: "application-copyright",

packages/core/src/common/vars/application-description.injectable.ts

@@ -2,8 +2,8 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const applicationDescriptionInjectable = getInjectable({
   id: "application-description",

packages/core/src/common/vars/application-information-fake-injectable.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { applicationInformationToken } from "@k8slens/application";
+
+export const applicationInformationFakeInjectable = getInjectable({
+  id: "application-information-fake",
+
+  instantiate: () => ({
+    name: "some-product-name",
+    productName: "some-product-name",
+    version: "6.0.0",
+    updatingIsEnabled: false,
+    k8sProxyVersion: "0.2.1",
+    bundledKubectlVersion: "1.23.3",
+    bundledHelmVersion: "3.7.2",
+    sentryDsn: "",
+    contentSecurityPolicy:
+      "script-src 'unsafe-eval' 'self'; frame-src http://*.localhost:*/; img-src * data:",
+
+    welcomeRoute: "/welcome",
+    copyright: "some-copyright-information",
+    description: "some-descriptive-text",
+  }),
+
+  injectionToken: applicationInformationToken,
+});

packages/core/src/common/vars/application-information-injectable.ts

@@ -1,20 +0,0 @@
-/**
- * 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 packageJson from "../../../package.json";
-import { applicationInformationToken } from "../../common/vars/application-information-token";
-
-const applicationInformationInjectable = getInjectable({
-  id: "application-information",
-  injectionToken: applicationInformationToken,
-  instantiate: () => {
-    const { version, config, productName, build, copyright, description, name } = packageJson;
-
-    return { version, config, productName, build, copyright, description, name };
-  },
-  causesSideEffects: true,
-});
-
-export default applicationInformationInjectable;

packages/core/src/common/vars/application-information-token.ts

@@ -1,15 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-
-import { getInjectionToken } from "@ogre-tools/injectable";
-import type packageJson from "../../../package.json";
-
-export type ApplicationInformation = Pick<typeof packageJson, "version" | "config" | "productName" | "copyright" | "description" | "name"> & {
-  build: Partial<typeof packageJson["build"]> & { publish?: unknown[] };
-};
-
-export const applicationInformationToken = getInjectionToken<ApplicationInformation>({
-  id: "application-information-token",
-});

packages/core/src/common/vars/application-information.global-override-for-injectable.ts

@@ -1,24 +0,0 @@
-/**
- * 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 applicationInformationInjectable from "./application-information-injectable";
-
-export default getGlobalOverride(applicationInformationInjectable, () => ({
-  name: "some-product-name",
-  productName: "some-product-name",
-  version: "6.0.0",
-  build: {} as any,
-  config: {
-    k8sProxyVersion: "0.2.1",
-    bundledKubectlVersion: "1.23.3",
-    bundledHelmVersion: "3.7.2",
-    sentryDsn: "",
-    contentSecurityPolicy: "script-src 'unsafe-eval' 'self'; frame-src http://*.localhost:*/; img-src * data:",
-    welcomeRoute: "/welcome",
-  },
-  copyright: "some-copyright-information",
-  description: "some-descriptive-text",
-}));

packages/core/src/common/vars/bundled-kubectl-version.injectable.ts

@@ -2,12 +2,12 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const bundledKubectlVersionInjectable = getInjectable({
   id: "bundled-kubectl-version",
-  instantiate: (di) => di.inject(applicationInformationToken).config.bundledKubectlVersion,
+  instantiate: (di) => di.inject(applicationInformationToken).bundledKubectlVersion,
 });
 
 export default bundledKubectlVersionInjectable;

packages/core/src/common/vars/content-security-policy.injectable.ts

@@ -2,12 +2,12 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const contentSecurityPolicyInjectable = getInjectable({
   id: "content-security-policy",
-  instantiate: (di) => di.inject(applicationInformationToken).config.contentSecurityPolicy,
+  instantiate: (di) => di.inject(applicationInformationToken).contentSecurityPolicy,
 });
 
 export default contentSecurityPolicyInjectable;

packages/core/src/common/vars/product-name.injectable.ts

@@ -2,8 +2,8 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const productNameInjectable = getInjectable({
   id: "product-name",

packages/core/src/common/vars/sentry-dsn-url.injectable.ts

@@ -2,12 +2,12 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const sentryDataSourceNameInjectable = getInjectable({
   id: "sentry-data-source-name",
-  instantiate: (di) => di.inject(applicationInformationToken).config.sentryDsn,
+  instantiate: (di) => di.inject(applicationInformationToken).sentryDsn,
 });
 
 export default sentryDataSourceNameInjectable;

packages/core/src/common/vars/store-migration-version.injectable.ts

@@ -2,8 +2,8 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const storeMigrationVersionInjectable = getInjectable({
   id: "store-migration-version",

packages/core/src/features/application-update/main/updating-is-enabled/publish-is-configured/publish-is-configured.injectable.ts

@@ -2,12 +2,12 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+import { applicationInformationToken } from "@k8slens/application";
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "../../../../../common/vars/application-information-token";
 
 const publishIsConfiguredInjectable = getInjectable({
   id: "publish-is-configured",
-  instantiate: (di) => Boolean(di.inject(applicationInformationToken).build.publish?.length),
+  instantiate: (di) => Boolean(di.inject(applicationInformationToken).updatingIsEnabled),
 });
 
 export default publishIsConfiguredInjectable;

packages/core/src/main/cluster/store-migrations/snap.injectable.ts

@@ -6,12 +6,12 @@
 // Fix embedded kubeconfig paths under snap config
 
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "../../../common/vars/application-information-token";
 import { clusterStoreMigrationInjectionToken } from "../../../common/cluster-store/migration-token";
 import loggerInjectable from "../../../common/logger.injectable";
 import isSnapPackageInjectable from "../../../common/vars/is-snap-package.injectable";
 import type { ClusterModel } from "../../../common/cluster-types";
 import pathExistsSyncInjectable from "../../../common/fs/path-exists-sync.injectable";
+import { applicationInformationToken } from "@k8slens/application";
 
 const clusterStoreSnapMigrationInjectable = getInjectable({
   id: "cluster-store-snap-migration",

packages/core/src/main/getDi.ts

@@ -3,15 +3,5 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { createContainer } from "@ogre-tools/injectable";
-import { runInAction } from "mobx";
-import applicationInformationInjectable from "../common/vars/application-information-injectable";
 
-export const getDi = () => {
-  const di = createContainer("main");
-
-  runInAction(() => {
-    di.register(applicationInformationInjectable);
-  });
-
-  return di;
-};
+export const getDi = () => createContainer("main");

packages/core/src/main/getDiForUnitTesting.ts

@@ -29,9 +29,9 @@ import { registerMobX } from "@ogre-tools/injectable-extension-for-mobx";
 import electronInjectable from "./utils/resolve-system-proxy/electron.injectable";
 import initializeClusterManagerInjectable from "./cluster/initialize-manager.injectable";
 import type { GlobalOverride } from "../common/test-utils/get-global-override";
-import applicationInformationInjectable from "../common/vars/application-information-injectable";
 import nodeEnvInjectionToken from "../common/vars/node-env-injection-token";
 import { getOverrideFsWithFakes } from "../test-utils/override-fs-with-fakes";
+import { applicationInformationFakeInjectable } from "../common/vars/application-information-fake-injectable";
 
 export function getDiForUnitTesting(opts: { doGeneralOverrides?: boolean } = {}) {
   const {
@@ -57,9 +57,10 @@ export function getDiForUnitTesting(opts: { doGeneralOverrides?: boolean } = {})
       .filter(isInjectable)
   ) as Injectable<any, any, any>[];
 
+  registerMobX(di);
+
   runInAction(() => {
-    registerMobX(di);
-    di.register(applicationInformationInjectable);
+    di.register(applicationInformationFakeInjectable);
 
     chunk(100)(injectables).forEach(chunkInjectables => {
       di.register(...chunkInjectables);

packages/core/src/main/start-main-application/lens-window/application-window/create-electron-window.injectable.ts

@@ -13,9 +13,9 @@ import openLinkInBrowserInjectable from "../../../../common/utils/open-link-in-b
 import getAbsolutePathInjectable from "../../../../common/path/get-absolute-path.injectable";
 import lensResourcesDirInjectable from "../../../../common/vars/lens-resources-dir.injectable";
 import isLinuxInjectable from "../../../../common/vars/is-linux.injectable";
-import { applicationInformationToken } from "../../../../common/vars/application-information-token";
 import pathExistsSyncInjectable from "../../../../common/fs/path-exists-sync.injectable";
 import lensProxyCertificateInjectable from "../../../../common/certificate/lens-proxy-certificate.injectable";
+import { applicationInformationToken } from "@k8slens/application";
 
 export type ElectronWindowTitleBarStyle = "hiddenInset" | "hidden" | "default" | "customButtonsOnHover";
 

packages/core/src/main/weblinks-store/migrations/currentVersion.injectable.ts

@@ -7,8 +7,8 @@ import { docsUrl, slackUrl } from "../../../common/vars";
 import type { WeblinkData } from "../../../common/weblinks-store/weblink-store";
 import { getInjectable } from "@ogre-tools/injectable";
 import { weblinkStoreMigrationInjectionToken } from "../../../common/weblinks-store/migration-token";
-import { applicationInformationToken } from "../../../common/vars/application-information-token";
 import { lensDocumentationWeblinkId, lensSlackWeblinkId } from "../links";
+import { applicationInformationToken } from "@k8slens/application";
 
 const currentVersionWeblinkStoreMigrationInjectable = getInjectable({
   id: "current-version-weblink-store-migration",

packages/core/src/renderer/getDi.tsx

@@ -4,15 +4,5 @@
  */
 
 import { createContainer } from "@ogre-tools/injectable";
-import { runInAction } from "mobx";
-import applicationInformationInjectable from "../common/vars/application-information-injectable";
 
-export const getDi = () => {
-  const di = createContainer("renderer");
-
-  runInAction(() => {
-    di.register(applicationInformationInjectable);
-  });
-
-  return di;
-};
+export const getDi = () => createContainer("renderer");

packages/core/src/renderer/getDiForUnitTesting.tsx

@@ -18,8 +18,8 @@ import { registerMobX } from "@ogre-tools/injectable-extension-for-mobx";
 import watchHistoryStateInjectable from "./remote-helpers/watch-history-state.injectable";
 import legacyOnChannelListenInjectable from "./ipc/legacy-channel-listen.injectable";
 import type { GlobalOverride } from "../common/test-utils/get-global-override";
-import applicationInformationInjectable from "../common/vars/application-information-injectable";
 import nodeEnvInjectionToken from "../common/vars/node-env-injection-token";
+import { applicationInformationFakeInjectable } from "../common/vars/application-information-fake-injectable";
 
 export const getDiForUnitTesting = (
   opts: { doGeneralOverrides?: boolean } = {},
@@ -45,9 +45,10 @@ export const getDiForUnitTesting = (
       .filter(isInjectable)
   ) as Injectable<any, any, any>[];
 
+  registerMobX(di);
+
   runInAction(() => {
-    registerMobX(di);
-    di.register(applicationInformationInjectable);
+    di.register(applicationInformationFakeInjectable);
 
     chunk(100)(injectables).forEach((chunkInjectables) => {
       di.register(...chunkInjectables);

packages/open-lens/package.json

@@ -195,6 +195,7 @@
     }
   },
   "dependencies": {
+    "@k8slens/application": "^6.4.0-beta.13",
     "@k8slens/core": "^6.4.0-beta.13",
     "@k8slens/ensure-binaries": "^6.4.0-beta.13",
     "@k8slens/generate-tray-icons": "^6.4.0-beta.13",

packages/open-lens/src/common/application-information.injectable.ts

@@ -1,15 +1,49 @@
-
+/**
+ * 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 { applicationInformationToken, ApplicationInformation } from "@k8slens/core/common";
 import packageJson from "../../package.json";
+import { applicationInformationToken } from "@k8slens/application";
 
 const applicationInformationInjectable = getInjectable({
   id: "application-information",
   injectionToken: applicationInformationToken,
-  instantiate: () => {
-    const { version, config, productName, build, copyright, description, name } = packageJson;
 
-    return { version, config, productName, build, copyright, description, name } as ApplicationInformation;
+  instantiate: () => {
+    const {
+      version,
+
+      config: {
+        bundledHelmVersion,
+        bundledKubectlVersion,
+        contentSecurityPolicy,
+        k8sProxyVersion,
+        sentryDsn,
+        welcomeRoute,
+      },
+
+      productName,
+      build,
+      copyright,
+      description,
+      name,
+    } = packageJson;
+
+    return {
+      version,
+      productName,
+      copyright,
+      description,
+      name,
+      k8sProxyVersion,
+      bundledKubectlVersion,
+      bundledHelmVersion,
+      sentryDsn,
+      contentSecurityPolicy,
+      welcomeRoute,
+      updatingIsEnabled: (build as any)?.publish?.length > 0,
+    };
   },
   causesSideEffects: true,
 });

packages/technical-features/application/README.md

@@ -0,0 +1,18 @@
+# @k8slens/application
+
+This package contains stuff related to creating Lens-applications. 
+
+In the beginning it will contain just the injection tokens used to configure the application.
+
+## Install
+```bash
+$ npm install @k8slens/application
+```
+
+
+## Usage
+
+As of now, this package doesn't do anything alone. It just provides you way to register implementation for contract. 
+
+Future ambition is that all stuff related to how applications are built will be relocated here.
+

packages/technical-features/application/index.ts

@@ -0,0 +1,3 @@
+export { applicationInformationToken } from "./src/application-information-token";
+export type { ApplicationInformation } from "./src/application-information-token";
+

packages/technical-features/application/jest.config.js

@@ -0,0 +1,2 @@
+module.exports =
+  require("@k8slens/jest").monorepoPackageConfig(__dirname).configForReact;

packages/technical-features/application/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@k8slens/application",
+  "private": false,
+  "version": "6.4.0-beta.13",
+  "description": "Package for creating Lens applications",
+  "type": "commonjs",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lensapp/monorepo.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": {
+    "name": "OpenLens Authors",
+    "email": "info@k8slens.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/lensapp/lens",
+  "scripts": {
+    "build": "lens-build",
+    "build:remove": "lens-remove-build",
+    "code-style:fix": "lens-fix-code-style",
+    "code-style:verify": "lens-verify-code-style",
+    "test": "lens-test"
+  },
+  "peerDependencies": {
+    "@ogre-tools/fp": "^12.0.1",
+    "@ogre-tools/injectable": "^12.0.1",
+    "lodash": "^4.17.15"
+  }
+}

packages/technical-features/application/src/application-information-token.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectionToken } from "@ogre-tools/injectable";
+
+export type ApplicationInformation = {
+  name: string;
+  version: string;
+  productName: string;
+  copyright: string;
+  description: string;
+  k8sProxyVersion: string,
+  bundledKubectlVersion: string,
+  bundledHelmVersion: string,
+  sentryDsn: string,
+  contentSecurityPolicy: string,
+  welcomeRoute: string,
+  updatingIsEnabled: boolean;
+}
+
+export const applicationInformationToken = getInjectionToken<ApplicationInformation>({
+  id: "application-information-token",
+});

packages/technical-features/application/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@k8slens/typescript/config/base.json"
+}

packages/technical-features/application/webpack.config.js

@@ -0,0 +1 @@
+module.exports = require("@k8slens/webpack").configForNode;