mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
* Turn on strict mode in tsconfig.json - Add route, clusterRoute, and payloadValidatedClusterRoute helper functions to improve types with backend routes - Turn on the following new lints: - react/jsx-first-prop-new-line - react/jsx-wrap-multilines - react/jsx-one-expression-per-line - react/jsx-max-props-per-line - react/jsx-indent - react/jsx-indent-props Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix build Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace KubeObject scope strings with enum Signed-off-by: Sebastian Malton <sebastian@malton.name> * Revert package.json version changes Signed-off-by: Sebastian Malton <sebastian@malton.name> * revert move hostedCluster(Id) Signed-off-by: Sebastian Malton <sebastian@malton.name> * change some type param names to be not single letters Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove copy-extension-themes Signed-off-by: Sebastian Malton <sebastian@malton.name> * add new make clean action Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix build to not use webpack for generating types Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube-object-menu.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix select.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * revert move fileNameMigration to index Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix ref logic error Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix log-resource-selector.test.tsx tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-store.test.ts test by overriding createStorage to not touch file system Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cluster.test.ts tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube=api.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fixed hotbar-store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kubeconfig-manager.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cluster-role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix pods.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix delete-cluster-dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix daemonset.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix replicaset.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix statefulsets/dialog/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix replicasets/scale-dialog/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix deployments.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix deployments/scale/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cronjob.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix stateful-set.api.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix deployment.api.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix api-manager.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix statefulset.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix job.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix pods.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix scroll-spy.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix hotbar-remove-command.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog-entity-registry.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix welcome.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix verify-that-all-routes-have-route-component.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix pod-tolerations.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * better fix for previous 3 fixes, plus also select.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube-object-menu.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix app-paths.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-tabs.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix isReactNode typing Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix sub-title.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix drawer.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix list-layout.tsx and header.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix error-boundary.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix upgrade-chart/store.ts and dock-tab.store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix install-chart/store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix edit-resource/store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix create-resource/store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix namespace-select.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix namespace-select-filter.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix crd-list.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix wrong types for extensions Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix circular dependency Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix circular dependency on catalogCategoryRegistry Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix api-kube Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix type errors, most <Select /> errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * fixing more type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * some more fixing type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * convert all KubeApis to injectable with legacy global backups Signed-off-by: Sebastian Malton <sebastian@malton.name> * factor out into a common file all the exports Signed-off-by: Sebastian Malton <sebastian@malton.name> * convert all KubeObjectStores to injectable with legacy global backups Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix lint Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove unused legacy KubeApi globals Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix bad previous commit Signed-off-by: Sebastian Malton <sebastian@malton.name> * more crash fixing Signed-off-by: Sebastian Malton <sebastian@malton.name> * try and fix behavioural tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix sidebar-and-tab-navigation-for-core.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix sidebar-and-tab-navigation-for-extensions.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-using-application-menu.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make ThemeStore non-singleton and fix navigation-to-terminal-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * extensions.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog-entity-registry.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-using-application-menu.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix log-resource-selector.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-tabs.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix delete-cluster-dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-kubernetes-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-editor-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-proxy-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-using-application-menu.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-application-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix select.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix hotbar-remove-command.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cluster-role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-extension-specific-preferences.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-telemetry-preferences.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix closing-preferences.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-editor-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-proxy-preferences.test.ts - Fix other type errors too Signed-off-by: Sebastian Malton <sebastian@malton.name> * final tweaks Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add more tsconfig files, fix bug in <Catalog> - Make all of history, navigation injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all of kube-details-params/ and navigate/ to injectable - This fixes a runtime error that was encountered during testing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix runtime errors on renderer - remove all static uses of `createPageParam` (and then removed the legacy global) - Made LensRendererExtension and LensMainExtension just used dependencies and not the getLegacyDi - Fixed circular dep in extension-loader Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move registerStore calls to after injectMany Signed-off-by: Sebastian Malton <sebastian@malton.name> * replace all the rest of the legacy uses of apiManager Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix stack overflow and cycles in DI Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix NamespaceSelectFilter not opening Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix WizardStep and AddNamespaceDialog Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix KubeApi's not being registered Signed-off-by: Sebastian Malton <sebastian@malton.name> * cleanup WindowManager Signed-off-by: Sebastian Malton <sebastian@malton.name> * Proper fix for Wizard, fix NamespaceStore.subscribe Signed-off-by: Sebastian Malton <sebastian@malton.name> * Rewrite withTooltip to be more type correct - Fixes mobx related "too many recursive actions" error - Change all the uses of withTooltips to be functional components Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add e2e test to cover kube api registration Signed-off-by: Sebastian Malton <sebastian@malton.name> * cleanup internal-commands Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove cast in <Animate> Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix command-palette e2e test Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type error after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix test name Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix lint Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix code to help CodeQL scanner Signed-off-by: Sebastian Malton <sebastian@malton.name> * update intree extension lock files Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix build-extensions picking wrong @types/react Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix tests from rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix type error Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make KubeconfigSyncManager more injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix crash in test mode for Dialog Signed-off-by: Sebastian Malton <sebastian@malton.name> * make Select snapshots deterministic Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix new type error Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube-object.store.test.ts typing Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix merge build issues Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix snapshots after merge Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix lint after merge Signed-off-by: Sebastian Malton <sebastian@malton.name> * reexport BaseKubeJsonApiObjectMetadata Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix typo in terminalSpawningPool Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove duplicate license header Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix typo to waitUntilDefined Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove iter use from getLegacyGlobalDiForExtensionApi Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove complex createStorage override Signed-off-by: Sebastian Malton <sebastian@malton.name> * override logger with mocks only when needed for tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove specialized overrideStore flags for getDiForUnitTesting Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove unnecessary | undefined types from the exactOptionalFieldTypes experiment Signed-off-by: Sebastian Malton <sebastian@malton.name> * use more descriptive name for local test mocks Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove unnecessary addition to 'make clean' target Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove oddity of KubeObjectStore.getById(undefined) being allowed Signed-off-by: Sebastian Malton <sebastian@malton.name> * rename KubeObject.getDescriptor in favour of name without fundemental JS meaning Signed-off-by: Sebastian Malton <sebastian@malton.name> * Simplify legacyRegisterApi when working in behaviour unit tests - Don't emit within main environment as there should be no auto registering there Signed-off-by: Sebastian Malton <sebastian@malton.name> * change confusing variable name in ReactiveDuration Signed-off-by: Sebastian Malton <sebastian@malton.name> * make visitor pattern more explicit for Entity contextMenuOpen Signed-off-by: Sebastian Malton <sebastian@malton.name> * toggleDetails -> toggleKubeDetailsPane is more specific Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove outdated comment Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix bug where LensExtension dependencies are not set Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests from the revert of react 18 Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix more tests from merge Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix typings with new is-compatible-extension tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * more type fixing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Revert in-tree extension versions Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve name of guarding injectable for stores and apis - New name better implies that it is just a guard state and does not do anything Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add helper for <Select>.isMulti for storing in a Set<Value> Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix is-compatible-extension.test.ts types Signed-off-by: Sebastian Malton <sebastian@malton.name>
422 lines
14 KiB
TypeScript
422 lines
14 KiB
TypeScript
/**
|
|
* Copyright (c) OpenLens Authors. All rights reserved.
|
|
* Licensed under MIT License. See LICENSE in root directory for more information.
|
|
*/
|
|
|
|
import { ipcRenderer } from "electron";
|
|
import { isEqual } from "lodash";
|
|
import type { ObservableMap } from "mobx";
|
|
import { action, computed, makeObservable, observable, observe, reaction, when } from "mobx";
|
|
import path from "path";
|
|
import { broadcastMessage, ipcMainOn, ipcRendererOn, ipcMainHandle } from "../../common/ipc";
|
|
import type { Disposer } from "../../common/utils";
|
|
import { isDefined, toJS } from "../../common/utils";
|
|
import logger from "../../main/logger";
|
|
import type { CatalogEntity, KubernetesCluster } from "../common-api/catalog";
|
|
import type { InstalledExtension } from "../extension-discovery/extension-discovery";
|
|
import type { LensExtension, LensExtensionConstructor, LensExtensionId } from "../lens-extension";
|
|
import type { LensRendererExtension } from "../lens-renderer-extension";
|
|
import * as registries from "../registries";
|
|
import type { LensExtensionState } from "../extensions-store/extensions-store";
|
|
import { extensionLoaderFromMainChannel, extensionLoaderFromRendererChannel } from "../../common/ipc/extension-handling";
|
|
import { requestExtensionLoaderInitialState } from "../../renderer/ipc";
|
|
import assert from "assert";
|
|
import { EventEmitter } from "../../common/event-emitter";
|
|
import type { CreateExtensionInstance } from "./create-extension-instance.token";
|
|
|
|
const logModule = "[EXTENSIONS-LOADER]";
|
|
|
|
interface Dependencies {
|
|
updateExtensionsState: (extensionsState: Record<LensExtensionId, LensExtensionState>) => void;
|
|
createExtensionInstance: CreateExtensionInstance;
|
|
readonly extensionRegistrators: ((extension: LensExtension, extensionInstallationCount: number) => void)[];
|
|
readonly extensionInstallationCounter: Map<string, number>;
|
|
readonly extensionInstances: ObservableMap<LensExtensionId, LensExtension>;
|
|
}
|
|
|
|
export interface ExtensionLoading {
|
|
isBundled: boolean;
|
|
loaded: Promise<void>;
|
|
}
|
|
|
|
/**
|
|
* Loads installed extensions to the Lens application
|
|
*/
|
|
export class ExtensionLoader {
|
|
protected readonly extensions = observable.map<LensExtensionId, InstalledExtension>();
|
|
|
|
/**
|
|
* This is the set of extensions that don't come with either
|
|
* - Main.LensExtension when running in the main process
|
|
* - Renderer.LensExtension when running in the renderer process
|
|
*/
|
|
protected readonly nonInstancesByName = observable.set<string>();
|
|
|
|
/**
|
|
* This is updated by the `observe` in the constructor. DO NOT write directly to it
|
|
*/
|
|
protected readonly instancesByName = observable.map<string, LensExtension>();
|
|
|
|
private readonly onRemoveExtensionId = new EventEmitter<[string]>();
|
|
|
|
@observable isLoaded = false;
|
|
|
|
get whenLoaded() {
|
|
return when(() => this.isLoaded);
|
|
}
|
|
|
|
constructor(protected readonly dependencies: Dependencies) {
|
|
makeObservable(this);
|
|
|
|
observe(this.dependencies.extensionInstances, change => {
|
|
switch (change.type) {
|
|
case "add":
|
|
if (this.instancesByName.has(change.newValue.name)) {
|
|
throw new TypeError("Extension names must be unique");
|
|
}
|
|
|
|
this.instancesByName.set(change.newValue.name, change.newValue);
|
|
break;
|
|
case "delete":
|
|
this.instancesByName.delete(change.oldValue.name);
|
|
break;
|
|
case "update":
|
|
throw new Error("Extension instances shouldn't be updated");
|
|
}
|
|
});
|
|
}
|
|
|
|
@computed get userExtensions(): Map<LensExtensionId, InstalledExtension> {
|
|
const extensions = this.toJSON();
|
|
|
|
extensions.forEach((ext, extId) => {
|
|
if (ext.isBundled) {
|
|
extensions.delete(extId);
|
|
}
|
|
});
|
|
|
|
return extensions;
|
|
}
|
|
|
|
/**
|
|
* Get the extension instance by its manifest name
|
|
* @param name The name of the extension
|
|
* @returns one of the following:
|
|
* - the instance of `Main.LensExtension` on the main process if created
|
|
* - the instance of `Renderer.LensExtension` on the renderer process if created
|
|
* - `null` if no class definition is provided for the current process
|
|
* - `undefined` if the name is not known about
|
|
*/
|
|
getInstanceByName(name: string): LensExtension | null | undefined {
|
|
if (this.nonInstancesByName.has(name)) {
|
|
return null;
|
|
}
|
|
|
|
return this.instancesByName.get(name);
|
|
}
|
|
|
|
// Transform userExtensions to a state object for storing into ExtensionsStore
|
|
@computed get storeState() {
|
|
return Object.fromEntries(
|
|
Array.from(this.userExtensions)
|
|
.map(([extId, extension]) => [extId, {
|
|
enabled: extension.isEnabled,
|
|
name: extension.manifest.name,
|
|
}]),
|
|
);
|
|
}
|
|
|
|
@action
|
|
async init() {
|
|
if (ipcRenderer) {
|
|
await this.initRenderer();
|
|
} else {
|
|
await this.initMain();
|
|
}
|
|
|
|
await Promise.all([this.whenLoaded]);
|
|
|
|
// broadcasting extensions between main/renderer processes
|
|
reaction(() => this.toJSON(), () => this.broadcastExtensions(), {
|
|
fireImmediately: true,
|
|
});
|
|
|
|
reaction(
|
|
() => this.storeState,
|
|
|
|
(state) => {
|
|
this.dependencies.updateExtensionsState(state);
|
|
},
|
|
);
|
|
}
|
|
|
|
initExtensions(extensions: Map<LensExtensionId, InstalledExtension>) {
|
|
this.extensions.replace(extensions);
|
|
}
|
|
|
|
addExtension(extension: InstalledExtension) {
|
|
this.extensions.set(extension.id, extension);
|
|
}
|
|
|
|
@action
|
|
removeInstance(lensExtensionId: LensExtensionId) {
|
|
logger.info(`${logModule} deleting extension instance ${lensExtensionId}`);
|
|
const instance = this.dependencies.extensionInstances.get(lensExtensionId);
|
|
|
|
if (!instance) {
|
|
return;
|
|
}
|
|
|
|
try {
|
|
instance.disable();
|
|
this.onRemoveExtensionId.emit(instance.id);
|
|
this.dependencies.extensionInstances.delete(lensExtensionId);
|
|
this.nonInstancesByName.delete(instance.name);
|
|
} catch (error) {
|
|
logger.error(`${logModule}: deactivation extension error`, { lensExtensionId, error });
|
|
}
|
|
}
|
|
|
|
removeExtension(lensExtensionId: LensExtensionId) {
|
|
this.removeInstance(lensExtensionId);
|
|
|
|
if (!this.extensions.delete(lensExtensionId)) {
|
|
throw new Error(`Can't remove extension ${lensExtensionId}, doesn't exist.`);
|
|
}
|
|
}
|
|
|
|
setIsEnabled(lensExtensionId: LensExtensionId, isEnabled: boolean) {
|
|
const extension = this.extensions.get(lensExtensionId);
|
|
|
|
assert(extension, `Must register extension ${lensExtensionId} with before enabling it`);
|
|
|
|
extension.isEnabled = isEnabled;
|
|
}
|
|
|
|
protected async initMain() {
|
|
this.isLoaded = true;
|
|
this.loadOnMain();
|
|
|
|
ipcMainHandle(extensionLoaderFromMainChannel, () => {
|
|
return Array.from(this.toJSON());
|
|
});
|
|
|
|
ipcMainOn(extensionLoaderFromRendererChannel, (event, extensions: [LensExtensionId, InstalledExtension][]) => {
|
|
this.syncExtensions(extensions);
|
|
});
|
|
}
|
|
|
|
protected async initRenderer() {
|
|
const extensionListHandler = (extensions: [LensExtensionId, InstalledExtension][]) => {
|
|
this.isLoaded = true;
|
|
this.syncExtensions(extensions);
|
|
|
|
const receivedExtensionIds = extensions.map(([lensExtensionId]) => lensExtensionId);
|
|
|
|
// Remove deleted extensions in renderer side only
|
|
this.extensions.forEach((_, lensExtensionId) => {
|
|
if (!receivedExtensionIds.includes(lensExtensionId)) {
|
|
this.removeExtension(lensExtensionId);
|
|
}
|
|
});
|
|
};
|
|
|
|
requestExtensionLoaderInitialState().then(extensionListHandler);
|
|
ipcRendererOn(extensionLoaderFromMainChannel, (event, extensions: [LensExtensionId, InstalledExtension][]) => {
|
|
extensionListHandler(extensions);
|
|
});
|
|
}
|
|
|
|
broadcastExtensions() {
|
|
const channel = ipcRenderer
|
|
? extensionLoaderFromRendererChannel
|
|
: extensionLoaderFromMainChannel;
|
|
|
|
broadcastMessage(channel, Array.from(this.extensions));
|
|
}
|
|
|
|
syncExtensions(extensions: [LensExtensionId, InstalledExtension][]) {
|
|
extensions.forEach(([lensExtensionId, extension]) => {
|
|
if (!isEqual(this.extensions.get(lensExtensionId), extension)) {
|
|
this.extensions.set(lensExtensionId, extension);
|
|
}
|
|
});
|
|
}
|
|
|
|
loadOnMain() {
|
|
this.autoInitExtensions(() => Promise.resolve([]));
|
|
}
|
|
|
|
loadOnClusterManagerRenderer = () => {
|
|
logger.debug(`${logModule}: load on main renderer (cluster manager)`);
|
|
|
|
return this.autoInitExtensions(async (ext) => {
|
|
const extension = ext as LensRendererExtension;
|
|
const removeItems = [
|
|
registries.EntitySettingRegistry.getInstance().add(extension.entitySettings),
|
|
registries.CatalogEntityDetailRegistry.getInstance().add(extension.catalogEntityDetailItems),
|
|
];
|
|
|
|
this.onRemoveExtensionId.addListener((removedExtensionId) => {
|
|
if (removedExtensionId === extension.id) {
|
|
removeItems.forEach(remove => {
|
|
remove();
|
|
});
|
|
}
|
|
});
|
|
|
|
return removeItems;
|
|
});
|
|
};
|
|
|
|
loadOnClusterRenderer = (getCluster: () => CatalogEntity) => {
|
|
logger.debug(`${logModule}: load on cluster renderer (dashboard)`);
|
|
|
|
this.autoInitExtensions(async (ext) => {
|
|
const entity = getCluster() as KubernetesCluster;
|
|
const extension = ext as LensRendererExtension;
|
|
|
|
// getCluster must be a callback, as the entity might be available only after an extension has been loaded
|
|
if ((await extension.isEnabledForCluster(entity)) === false) {
|
|
return [];
|
|
}
|
|
|
|
const removeItems = [
|
|
registries.KubeObjectDetailRegistry.getInstance().add(extension.kubeObjectDetailItems),
|
|
];
|
|
|
|
this.onRemoveExtensionId.addListener((removedExtensionId) => {
|
|
if (removedExtensionId === extension.id) {
|
|
removeItems.forEach(remove => {
|
|
remove();
|
|
});
|
|
}
|
|
});
|
|
|
|
return removeItems;
|
|
});
|
|
};
|
|
|
|
protected async loadExtensions(installedExtensions: Map<string, InstalledExtension>, register: (ext: LensExtension) => Promise<Disposer[]>) {
|
|
// Steps of the function:
|
|
// 1. require and call .activate for each Extension
|
|
// 2. Wait until every extension's onActivate has been resolved
|
|
// 3. Call .enable for each extension
|
|
// 4. Return ExtensionLoading[]
|
|
|
|
const extensions = [...installedExtensions.entries()]
|
|
.map(([extId, extension]) => {
|
|
const alreadyInit = this.dependencies.extensionInstances.has(extId) || this.nonInstancesByName.has(extension.manifest.name);
|
|
|
|
if (extension.isCompatible && extension.isEnabled && !alreadyInit) {
|
|
try {
|
|
const LensExtensionClass = this.requireExtension(extension);
|
|
|
|
if (!LensExtensionClass) {
|
|
this.nonInstancesByName.add(extension.manifest.name);
|
|
|
|
return null;
|
|
}
|
|
|
|
const instance = this.dependencies.createExtensionInstance(
|
|
LensExtensionClass,
|
|
extension,
|
|
);
|
|
|
|
this.dependencies.extensionInstances.set(extId, instance);
|
|
|
|
return {
|
|
instance,
|
|
installedExtension: extension,
|
|
activated: instance.activate(),
|
|
};
|
|
} catch (err) {
|
|
logger.error(`${logModule}: error loading extension`, { ext: extension, err });
|
|
}
|
|
} else if (!extension.isEnabled && alreadyInit) {
|
|
this.removeInstance(extId);
|
|
}
|
|
|
|
return null;
|
|
})
|
|
// Remove null values
|
|
.filter(isDefined);
|
|
|
|
// We first need to wait until each extension's `onActivate` is resolved or rejected,
|
|
// as this might register new catalog categories. Afterwards we can safely .enable the extension.
|
|
await Promise.all(
|
|
extensions.map(extension =>
|
|
// If extension activation fails, log error
|
|
extension.activated.catch((error) => {
|
|
logger.error(`${logModule}: activation extension error`, { ext: extension.installedExtension, error });
|
|
}),
|
|
),
|
|
);
|
|
|
|
extensions.forEach(({ instance }) => {
|
|
const installationCount = (this.dependencies.extensionInstallationCounter.get(instance.sanitizedExtensionId) ?? 0) + 1;
|
|
|
|
this.dependencies.extensionInstallationCounter.set(instance.sanitizedExtensionId, installationCount);
|
|
|
|
this.dependencies.extensionRegistrators.forEach((register) =>
|
|
register(instance, installationCount),
|
|
);
|
|
});
|
|
|
|
// Return ExtensionLoading[]
|
|
return extensions.map(extension => {
|
|
const loaded = extension.instance.enable(register).catch((err) => {
|
|
logger.error(`${logModule}: failed to enable`, { ext: extension, err });
|
|
});
|
|
|
|
return {
|
|
isBundled: extension.installedExtension.isBundled,
|
|
loaded,
|
|
};
|
|
});
|
|
}
|
|
|
|
protected autoInitExtensions(register: (ext: LensExtension) => Promise<Disposer[]>) {
|
|
// Setup reaction to load extensions on JSON changes
|
|
reaction(() => this.toJSON(), installedExtensions => this.loadExtensions(installedExtensions, register));
|
|
|
|
// Load initial extensions
|
|
return this.loadExtensions(this.toJSON(), register);
|
|
}
|
|
|
|
protected requireExtension(extension: InstalledExtension): LensExtensionConstructor | null {
|
|
const entryPointName = ipcRenderer ? "renderer" : "main";
|
|
const extRelativePath = extension.manifest[entryPointName];
|
|
|
|
if (!extRelativePath) {
|
|
return null;
|
|
}
|
|
|
|
const extAbsolutePath = path.resolve(path.join(path.dirname(extension.manifestPath), extRelativePath));
|
|
|
|
try {
|
|
return __non_webpack_require__(extAbsolutePath).default;
|
|
} catch (error) {
|
|
if (window && error instanceof window.Error) {
|
|
console.error(`${logModule}: can't load ${entryPointName} for "${extension.manifest.name}": ${error.stack || error}`, extension);
|
|
} else {
|
|
logger.error(`${logModule}: can't load ${entryPointName} for "${extension.manifest.name}": ${error}`, { extension });
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
getExtension(extId: LensExtensionId) {
|
|
return this.extensions.get(extId);
|
|
}
|
|
|
|
getInstanceById(extId: LensExtensionId) {
|
|
return this.dependencies.extensionInstances.get(extId);
|
|
}
|
|
|
|
toJSON(): Map<LensExtensionId, InstalledExtension> {
|
|
return toJS(this.extensions);
|
|
}
|
|
}
|