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,142 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import type { InstalledExtension } from "./extension-discovery/extension-discovery";
+import { action, computed, makeObservable, observable } from "mobx";
+import type { PackageJson } from "type-fest";
+import { disposer } from "../common/utils";
+import type { LensExtensionDependencies } from "./lens-extension-set-dependencies";
+import type { ProtocolHandlerRegistration } from "./common-api/registrations";
+
+export type LensExtensionId = string; // path to manifest (package.json)
+export type LensExtensionConstructor = new (...args: ConstructorParameters<typeof LensExtension>) => LensExtension;
+
+export interface LensExtensionManifest extends PackageJson {
+  name: string;
+  version: string;
+  main?: string; // path to %ext/dist/main.js
+  renderer?: string; // path to %ext/dist/renderer.js
+  /**
+   * Supported Lens version engine by extension could be defined in `manifest.engines.lens`
+   * Only MAJOR.MINOR version is taken in consideration.
+   */
+  engines: {
+    lens: string; // "semver"-package format
+    npm?: string;
+    node?: string;
+  };
+}
+
+export const lensExtensionDependencies = Symbol("lens-extension-dependencies");
+export const Disposers = Symbol("disposers");
+
+export class LensExtension<Dependencies extends LensExtensionDependencies = LensExtensionDependencies> {
+  readonly id: LensExtensionId;
+  readonly manifest: LensExtensionManifest;
+  readonly manifestPath: string;
+  readonly isBundled: boolean;
+
+  get sanitizedExtensionId() {
+    return sanitizeExtensionName(this.name);
+  }
+
+  protocolHandlers: ProtocolHandlerRegistration[] = [];
+
+  @observable private _isEnabled = false;
+
+  @computed get isEnabled() {
+    return this._isEnabled;
+  }
+
+  [Disposers] = disposer();
+
+  constructor({ id, manifest, manifestPath, isBundled }: InstalledExtension) {
+    makeObservable(this);
+    this.id = id;
+    this.manifest = manifest;
+    this.manifestPath = manifestPath;
+    this.isBundled = !!isBundled;
+  }
+
+  get name() {
+    return this.manifest.name;
+  }
+
+  get version() {
+    return this.manifest.version;
+  }
+
+  get description() {
+    return this.manifest.description;
+  }
+
+  readonly [lensExtensionDependencies]!: Dependencies;
+
+  /**
+   * getExtensionFileFolder returns the path to an already created folder. This
+   * folder is for the sole use of this extension.
+   *
+   * Note: there is no security done on this folder, only obfuscation of the
+   * folder name.
+   */
+  async getExtensionFileFolder(): Promise<string> {
+    return this[lensExtensionDependencies].fileSystemProvisionerStore.requestDirectory(this.id);
+  }
+
+  @action
+  async enable() {
+    if (this._isEnabled) {
+      return;
+    }
+
+    this._isEnabled = true;
+    this[lensExtensionDependencies].logger.info(`[EXTENSION]: enabled ${this.name}@${this.version}`);
+  }
+
+  @action
+  async disable() {
+    if (!this._isEnabled) {
+      return;
+    }
+
+    this._isEnabled = false;
+
+    try {
+      await this.onDeactivate();
+      this[Disposers]();
+      this[lensExtensionDependencies].logger.info(`[EXTENSION]: disabled ${this.name}@${this.version}`);
+    } catch (error) {
+      this[lensExtensionDependencies].logger.error(`[EXTENSION]: disabling ${this.name}@${this.version} threw an error: ${error}`);
+    }
+  }
+
+  async activate(): Promise<void> {
+    return this.onActivate();
+  }
+
+  protected onActivate(): Promise<void> | void {
+    return;
+  }
+
+  protected onDeactivate(): Promise<void> | void {
+    return;
+  }
+}
+
+export function sanitizeExtensionName(name: string) {
+  return name.replace("@", "").replace("/", "--");
+}
+
+export function getSanitizedPath(...parts: string[]) {
+  return parts
+    .filter(Boolean)
+    .join("/")
+    .replace(/\/+/g, "/")
+    .replace(/\/$/, "");
+} // normalize multi-slashes (e.g. coming from page.id)
+
+export function extensionDisplayName(name: string, version: string) {
+  return `${name}@${version}`;
+}