wip: restructure to monorepo

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2025-05-20 05:10:56 +00:00 · 2023-01-11 09:40:44 +02:00
1 parent 8f9dd11420
commit a9f150a827
@@ -0,0 +1,4 @@
+static/build
+binaries/
+dist/
+node_modules/
@@ -0,0 +1,237 @@
+{
+  "name": "open-lens",
+  "private": true,
+  "productName": "OpenLens",
+  "description": "OpenLens - Open Source IDE for Kubernetes",
+  "homepage": "https://github.com/lensapp/lens",
+  "version": "6.4.0-alpha.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lensapp/lens.git"
+  },
+  "keywords": [],
+  "bugs": {
+    "url": "https://github.com/lensapp/lens/issues"
+  },
+  "main": "static/build/main.js",
+  "copyright": "© 2023 OpenLens Authors",
+  "license": "MIT",
+  "author": "OpenLens Authors <info@k8slens.dev>",
+  "scripts": {
+    "clean": "rm -rf binaries/ dist/ static/build",
+    "build": "npm run compile && electron-builder",
+    "build:mac": "npm run compile && electron-builder --mac --dir",
+    "compile": "env NODE_ENV=production webpack --config webpack/webpack.ts --progress",
+    "postcompile": "npm run build:tray-icons && npm run download:binaries",
+    "predev": "rm -rf static/build/ && npm run build:tray-icons && npm run download:binaries",
+    "dev": "concurrently -i -k \"yarn run dev-run -C\" yarn:dev:*",
+    "dev-run": "nodemon --watch ./static/build/main.js --exec \"electron --remote-debugging-port=9223 --inspect .\"",
+    "dev:main": "env NODE_ENV=development webpack --config webpack/main.ts --progress --watch",
+    "dev:renderer": "env NODE_ENV=development ts-node ./webpack/dev-server.ts",
+    "build:tray-icons": "ts-node ../core/build/generate-tray-icons.ts",
+    "download:binaries": "ts-node ../core/build/download_binaries.ts"
+  },
+  "config": {
+    "k8sProxyVersion": "0.3.0",
+    "bundledKubectlVersion": "1.23.3",
+    "bundledHelmVersion": "3.7.2",
+    "sentryDsn": "",
+    "contentSecurityPolicy": "script-src 'unsafe-eval' 'self'; frame-src https://*.lens.app:*/; img-src * data:",
+    "welcomeRoute": "/welcome"
+  },
+  "engines": {
+    "node": ">=16 <17"
+  },
+  "jest": {
+    "collectCoverage": false,
+    "verbose": true,
+    "transform": {
+      "^.+\\.(t|j)sx?$": [
+        "@swc/jest"
+      ]
+    },
+    "testEnvironment": "jsdom",
+    "resolver": "<rootDir>/src/jest-28-resolver.js",
+    "moduleNameMapper": {
+      "\\.(css|scss)$": "identity-obj-proxy",
+      "\\.(svg|png|jpg|eot|woff2?|ttf)$": "<rootDir>/__mocks__/assetMock.ts"
+    },
+    "modulePathIgnorePatterns": [
+      "<rootDir>/dist",
+      "<rootDir>/packages"
+    ],
+    "setupFiles": [
+      "<rootDir>/src/jest.setup.ts",
+      "jest-canvas-mock"
+    ],
+    "globalSetup": "<rootDir>/src/jest.timezone.ts",
+    "setupFilesAfterEnv": [
+      "<rootDir>/src/jest-after-env.setup.ts"
+    ],
+    "runtime": "@side/jest-runtime"
+  },
+  "build": {
+    "generateUpdatesFilesForAllChannels": true,
+    "files": [
+      "static/**/*"
+    ],
+    "afterSign": "../core/build/notarize.js",
+    "extraResources": [
+      {
+        "from": "templates/",
+        "to": "./templates/",
+        "filter": "**/*.yaml"
+      },
+      "LICENSE"
+    ],
+    "linux": {
+      "category": "Network",
+      "artifactName": "${productName}-${version}.${arch}.${ext}",
+      "target": [
+        "deb",
+        "rpm",
+        "AppImage"
+      ],
+      "extraResources": [
+        {
+          "from": "binaries/client/linux/${arch}/kubectl",
+          "to": "./${arch}/kubectl"
+        },
+        {
+          "from": "binaries/client/linux/${arch}/lens-k8s-proxy",
+          "to": "./${arch}/lens-k8s-proxy"
+        },
+        {
+          "from": "binaries/client/linux/${arch}/helm",
+          "to": "./${arch}/helm"
+        }
+      ]
+    },
+    "rpm": {
+      "fpm": [
+        "--rpm-rpmbuild-define=%define _build_id_links none"
+      ]
+    },
+    "mac": {
+      "hardenedRuntime": true,
+      "gatekeeperAssess": false,
+      "entitlements": "../core/build/entitlements.mac.plist",
+      "entitlementsInherit": "../core/build/entitlements.mac.plist",
+      "extraResources": [
+        {
+          "from": "binaries/client/darwin/${arch}/kubectl",
+          "to": "./${arch}/kubectl"
+        },
+        {
+          "from": "binaries/client/darwin/${arch}/lens-k8s-proxy",
+          "to": "./${arch}/lens-k8s-proxy"
+        },
+        {
+          "from": "binaries/client/darwin/${arch}/helm",
+          "to": "./${arch}/helm"
+        }
+      ]
+    },
+    "win": {
+      "target": [
+        "nsis"
+      ],
+      "extraResources": [
+        {
+          "from": "binaries/client/windows/${arch}/kubectl.exe",
+          "to": "./${arch}/kubectl.exe"
+        },
+        {
+          "from": "binaries/client/windows/${arch}/lens-k8s-proxy.exe",
+          "to": "./${arch}/lens-k8s-proxy.exe"
+        },
+        {
+          "from": "binaries/client/windows/${arch}/helm.exe",
+          "to": "./${arch}/helm.exe"
+        }
+      ]
+    },
+    "nsis": {
+      "include": "../core/build/installer.nsh",
+      "oneClick": false,
+      "allowElevation": true,
+      "createStartMenuShortcut": true,
+      "allowToChangeInstallationDirectory": true
+    },
+    "protocols": {
+      "name": "Lens Protocol Handler",
+      "schemes": [
+        "lens"
+      ],
+      "role": "Viewer"
+    }
+  },
+  "dependencies": {
+    "@k8slens/open-lens": "^6.4.0-alpha.0",
+    "@ogre-tools/fp": "^12.0.1",
+    "@ogre-tools/injectable": "^12.0.1",
+    "@ogre-tools/injectable-extension-for-auto-registration": "^12.0.1",
+    "@ogre-tools/injectable-extension-for-mobx": "^12.0.1",
+    "@ogre-tools/injectable-react": "^12.0.1",
+    "mobx": "^6.7.0"
+  },
+  "devDependencies": {
+    "@pmmmwh/react-refresh-webpack-plugin": "^0.5.10",
+    "@types/node": "^16.18.6",
+    "@types/webpack": "^5.28.0",
+    "@types/webpack-dev-server": "^4.7.2",
+    "@types/webpack-env": "^1.18.0",
+    "@types/webpack-node-externals": "2.5.3",
+    "autoprefixer": "^10.4.13",
+    "circular-dependency-plugin": "^5.2.2",
+    "cli-progress": "^3.11.2",
+    "concurrently": "^7.6.0",
+    "css-loader": "^6.7.2",
+    "electron": "^19.1.9",
+    "electron-builder": "^23.6.0",
+    "electron-notarize": "^0.3.0",
+    "esbuild-loader": "^2.20.0",
+    "fork-ts-checker-webpack-plugin": "^7.2.14",
+    "gunzip-maybe": "^1.4.2",
+    "html-webpack-plugin": "^5.5.0",
+    "jsdom": "^20.0.3",
+    "jsonfile": "^6.1.0",
+    "mini-css-extract-plugin": "^2.7.1",
+    "monaco-editor-webpack-plugin": "^5.0.0",
+    "node-loader": "^2.0.0",
+    "nodemon": "^2.0.20",
+    "react-refresh": "^0.14.0",
+    "react-refresh-typescript": "^2.0.7",
+    "sharp": "^0.31.2",
+    "style-loader": "^3.3.1",
+    "tailwindcss": "^3.2.4",
+    "ts-loader": "^9.4.2",
+    "ts-node": "^10.9.1",
+    "type-fest": "^2.14.0",
+    "typescript": "^4.9.4",
+    "typescript-plugin-css-modules": "^4.1.1",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^4.11.1",
+    "webpack-node-externals": "^3.0.0",
+    "@types/byline": "^4.2.33",
+    "@types/chart.js": "^2.9.36",
+    "@types/color": "^3.0.3",
+    "@types/crypto-js": "^3.1.47",
+    "@types/lodash": "^4.14.191",
+    "@types/proper-lockfile": "^4.1.2",
+    "@types/react-dom": "^17.0.16",
+    "@types/react-router-dom": "^5.3.3",
+    "@types/react-virtualized-auto-sizer": "^1.0.1",
+    "@types/react-window": "^1.8.5",
+    "@types/request-promise-native": "^1.0.18",
+    "@types/tar": "^6.1.3",
+    "@types/tcp-port-used": "^1.0.1",
+    "@types/url-parse": "^1.4.8",
+    "@types/uuid": "^8.3.4",
+    "monaco-editor": "^0.29.1",
+    "react-select": "^5.7.0",
+    "typed-emitter": "^1.4.0",
+    "xterm-addon-fit": "^0.5.0"
+  }
+}
@@ -0,0 +1,17 @@
+
+import { getInjectable } from "@ogre-tools/injectable";
+import { applicationInformationToken, ApplicationInformation } from "@k8slens/open-lens/common";
+import packageJson from "../../package.json";
+
+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;
+  },
+  causesSideEffects: true,
+});
+
+export default applicationInformationInjectable;
@@ -0,0 +1,38 @@
+import { createContainer } from "@ogre-tools/injectable";
+import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration";
+import { runInAction } from "mobx";
+import { createApp, extensionApi } from "@k8slens/open-lens/main";
+
+const di = createContainer("main");
+const app = createApp({
+  di,
+  mode: process.env.NODE_ENV || "development"
+});
+
+runInAction(() => {
+  try {
+    autoRegister({
+      di,
+      requireContexts: [
+        require.context("./", true, CONTEXT_MATCHER_FOR_NON_FEATURES),
+        require.context("../common", true, CONTEXT_MATCHER_FOR_NON_FEATURES),
+      ],
+    });
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+});
+
+app.start().catch((error) => {
+  console.error(error);
+  process.exit(1);
+})
+
+const { Mobx, LensExtensions, Pty } = extensionApi;
+
+export {
+  Mobx,
+  LensExtensions,
+  Pty
+};
@@ -0,0 +1,43 @@
+import "@k8slens/open-lens/styles";
+import { createContainer } from "@ogre-tools/injectable";
+import { runInAction } from "mobx";
+import { createApp, extensionApi } from "@k8slens/open-lens/renderer";
+import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration";
+
+const di = createContainer("renderer");
+const app = createApp({
+  di,
+  mode: process.env.NODE_ENV || "development"
+});
+
+runInAction(() => {
+  autoRegister({
+    di,
+    requireContexts: [
+      require.context("./", true, CONTEXT_MATCHER_FOR_NON_FEATURES),
+      require.context("../common", true, CONTEXT_MATCHER_FOR_NON_FEATURES),
+    ],
+  });
+});
+
+app.start();
+
+const {
+  React,
+  ReactDOM,
+  ReactRouter,
+  ReactRouterDom,
+  Mobx,
+  MobxReact,
+  LensExtensions
+} = extensionApi;
+
+export {
+  React,
+  ReactDOM,
+  ReactRouter,
+  ReactRouterDom,
+  Mobx,
+  MobxReact,
+  LensExtensions
+};
@@ -0,0 +1,32 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "*": [
+        "node_modules/*",
+      ]
+    },
+    "plugins": [
+      {
+        "name": "typescript-plugin-css-modules"
+      }
+    ]
+  },
+  "include": [
+    "src/**/*",
+    "../core/types/*.d.ts"
+  ],
+  "exclude": [
+    "out",
+    "dist",
+    "coverage",
+    "binaries",
+    "static"
+  ],
+  "references": [
+    {
+      "path": "../core"
+    }
+  ]
+}
@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import Webpack from "webpack";
+import WebpackDevServer from "webpack-dev-server";
+import renderer from "./renderer";
+import { buildDir, webpackDevServerPort } from "./vars";
+
+/**
+ * API docs:
+ * @url https://webpack.js.org/configuration/dev-server/
+ * @url https://github.com/chimurai/http-proxy-middleware
+ */
+const compiler = Webpack(renderer);
+
+const server = new WebpackDevServer({
+  setupExitSignals: true,
+  headers: {
+    "Access-Control-Allow-Origin": "*",
+  },
+  allowedHosts: "127.0.0.1",
+  host: "localhost",
+  port: webpackDevServerPort,
+  static: buildDir, // aka `devServer.contentBase` in webpack@4
+  hot: "only", // use HMR only without errors
+  liveReload: false,
+  devMiddleware: {
+    writeToDisk: true,
+    index: "index.html",
+    publicPath: "/build",
+  },
+  proxy: {
+    "^/$": "/build/",
+  },
+  client: {
+    overlay: false, // don't show warnings and errors on top of rendered app view
+    logging: "error",
+  },
+}, compiler);
+
+console.info(`[WEBPACK-DEV-SERVER]: created with options`, server.options);
+
+server.start();
@@ -0,0 +1,59 @@
+import path from "path";
+import type webpack from "webpack";
+import { DefinePlugin } from "webpack";
+import nodeExternals from "webpack-node-externals";
+import { iconsAndImagesWebpackRules } from "./renderer";
+import { buildDir, isDevelopment, mainDir } from "./vars";
+import { platform } from "process";
+
+const main: webpack.Configuration = ({
+  name: "lens-app-main",
+  context: __dirname,
+  target: "electron-main",
+  mode: isDevelopment ? "development" : "production",
+  devtool: isDevelopment ? "cheap-module-source-map" : "source-map",
+  cache: isDevelopment ? { type: "filesystem" } : false,
+  entry: {
+    main: path.resolve(mainDir, "index.ts"),
+  },
+  output: {
+    libraryTarget: "global",
+    path: buildDir,
+  },
+  optimization: {
+    minimize: false,
+  },
+  resolve: {
+    extensions: [".json", ".js", ".ts"],
+  },
+  externals: [
+    nodeExternals(),
+  ],
+  module: {
+    parser: {
+      javascript: {
+        commonjsMagicComments: true,
+      },
+    },
+    rules: [
+      {
+        test: /\.node$/,
+        use: "node-loader",
+      },
+      {
+        test: /\.ts$/,
+        loader: "ts-loader",
+        options: {},
+       },
+      ...iconsAndImagesWebpackRules(),
+    ],
+  },
+  plugins: [
+    new DefinePlugin({
+      CONTEXT_MATCHER_FOR_NON_FEATURES: `/\\.injectable(\\.${platform})?\\.tsx?$/`,
+      CONTEXT_MATCHER_FOR_FEATURES: `/\\/(renderer|common)\\/.+\\.injectable(\\.${platform})?\\.tsx?$/`,
+    }),
+  ],
+});
+
+export default main;
@@ -0,0 +1,185 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+ import path from "path";
+ import type webpack from "webpack";
+ import HtmlWebpackPlugin from "html-webpack-plugin";
+ import MiniCssExtractPlugin from "mini-css-extract-plugin";
+ import ForkTsCheckerPlugin from "fork-ts-checker-webpack-plugin";
+ import MonacoWebpackPlugin from "monaco-editor-webpack-plugin";
+ import CircularDependencyPlugin from "circular-dependency-plugin";
+ import ReactRefreshWebpackPlugin from "@pmmmwh/react-refresh-webpack-plugin";
+ import type { WebpackPluginInstance } from "webpack";
+ import { DefinePlugin } from "webpack";
+ import { assetsFolderName, isDevelopment, rendererDir, buildDir, htmlTemplate, publicPath, sassCommonVars } from "./vars";
+ import { platform } from "process";
+ 
+ const renderer: webpack.Configuration = {
+  target: "electron-renderer",
+  name: "lens-app-renderer",
+  mode: isDevelopment ? "development" : "production",
+  // https://webpack.js.org/configuration/devtool/ (see description of each option)
+  devtool: isDevelopment ? "cheap-module-source-map" : "source-map",
+  cache: isDevelopment ? { type: "filesystem" } : false,
+  entry: {
+    lens: path.resolve(rendererDir, "index.ts"),
+  },
+  output: {
+    libraryTarget: "global",
+    globalObject: "this",
+    publicPath,
+    path: buildDir,
+    filename: "[name].js",
+    chunkFilename: "chunks/[name].js",
+    assetModuleFilename: `${assetsFolderName}/[name][ext][query]`,
+  },
+  watchOptions: {
+    ignored: /node_modules/, // https://webpack.js.org/configuration/watch/
+  },
+  ignoreWarnings: [
+    /Critical dependency: the request of a dependency is an expression/,
+    /require.extensions is not supported by webpack./, // handlebars
+    /\[ReactRefreshPlugin] .*?HMR.*? is not enabled/, // enabled in webpack.dev-server
+  ],
+  resolve: {
+    extensions: [
+      ".js", ".jsx", ".json",
+      ".ts", ".tsx",
+    ],
+  },
+  externals: {
+    "node-fetch": "commonjs node-fetch",
+    "npm": "commonjs npm",
+  },
+  optimization: {
+    minimize: false,
+  },
+  module: {
+    parser: {
+      javascript: {
+        commonjsMagicComments: true,
+      },
+    },
+    rules: [
+      {
+        test: /\.node$/,
+        use: "node-loader",
+      },
+      {
+      test: /\.tsx?$/,
+      loader: "ts-loader",
+      options: {},
+      },
+      cssModulesWebpackRule(),
+      ...iconsAndImagesWebpackRules(),
+      ...fontsLoaderWebpackRules(),
+    ],
+  },
+
+  plugins: [
+    new DefinePlugin({
+      CONTEXT_MATCHER_FOR_NON_FEATURES: `/\\.injectable(\\.${platform})?\\.tsx?$/`,
+      CONTEXT_MATCHER_FOR_FEATURES: `/\\/(renderer|common)\\/.+\\.injectable(\\.${platform})?\\.tsx?$/`,
+    }),
+    new ForkTsCheckerPlugin(),
+
+    // see also: https://github.com/Microsoft/monaco-editor-webpack-plugin#options
+    new MonacoWebpackPlugin({
+      // publicPath: "/",
+      // filename: "[name].worker.js",
+      languages: ["json", "yaml"],
+      globalAPI: isDevelopment,
+    }),
+
+    new HtmlWebpackPlugin({
+      filename: "index.html",
+      template: htmlTemplate,
+      inject: true,
+      hash: true,
+      templateParameters: {
+        assetPath: `${publicPath}${assetsFolderName}`,
+      },
+    }),
+
+    new CircularDependencyPlugin({
+      cwd: __dirname,
+      exclude: /node_modules/,
+      failOnError: true,
+    }) as unknown as WebpackPluginInstance,
+
+    new MiniCssExtractPlugin({
+      filename: "[name].css",
+    }),
+
+    ...(
+      isDevelopment
+        ? [new ReactRefreshWebpackPlugin()]
+        : []
+    ),
+  ],
+};
+ 
+ /**
+  * Import icons and image files.
+  * Read more about asset types: https://webpack.js.org/guides/asset-modules/
+  */
+ export function iconsAndImagesWebpackRules(): webpack.RuleSetRule[] {
+   return [
+     {
+       test: /\.svg$/,
+       type: "asset/source", // exports the source code of the asset, so we get XML
+     },
+     {
+       test: /\.(jpg|png|ico)$/,
+       type: "asset/resource", // path to file, e.g. "/static/build/assets/*"
+     },
+   ];
+ }
+ 
+ /**
+  * Import custom fonts as URL.
+  */
+ export function fontsLoaderWebpackRules(): webpack.RuleSetRule[] {
+   return [
+     {
+       test: /\.(ttf|eot|woff2?)$/,
+       type: "asset/resource",
+     },
+   ];
+ }
+ 
+ export interface CssModulesWebpackRuleOptions {
+   styleLoader?: string;
+ }
+ 
+ /**
+  * Import CSS or SASS styles with modules support (*.module.scss)
+  */
+ export function cssModulesWebpackRule({ styleLoader }: CssModulesWebpackRuleOptions = {}): webpack.RuleSetRule {
+   styleLoader ??= isDevelopment
+     ? "style-loader"
+     : MiniCssExtractPlugin.loader;
+ 
+   return {
+     test: /\.s?css$/,
+     use: [
+       styleLoader,
+       {
+         loader: "css-loader",
+         options: {
+           sourceMap: isDevelopment,
+           modules: {
+             auto: /\.module\./i, // https://github.com/webpack-contrib/css-loader#auto
+             mode: "local", // :local(.selector) by default
+             localIdentName: "[name]__[local]--[hash:base64:5]",
+           },
+         },
+       },
+     ],
+   };
+ }
+ 
+ export default renderer;
+ 
@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import assert from "assert";
+import path from "path";
+
+export const isDevelopment = process.env.NODE_ENV !== "production";
+export const mainDir = path.join(process.cwd(), "src", "main");
+export const buildDir = path.join(process.cwd(), "static", "build");
+export const assetsFolderName = "assets";
+export const rendererDir = path.join(process.cwd(), "src", "renderer");
+export const htmlTemplate = path.resolve(__dirname, "..", "node_modules", "@k8slens", "open-lens", "src/renderer", "template.html");
+export const publicPath = "/build/";
+export const sassCommonVars = path.resolve(__dirname, "..", "node_modules", "@k8slens", "open-lens", "src", "renderer", "components/vars.scss");
+export const webpackDevServerPort = Number(process.env.WEBPACK_DEV_SERVER_PORT) || 9191;
+
+assert(Number.isInteger(webpackDevServerPort), "WEBPACK_DEV_SERVER_PORT environment variable must only be an integer");
@@ -0,0 +1,4 @@
+import main from "./main";
+import renderer from "./renderer";
+
+export default [main, renderer];