lens/src/extensions/extension-loader.ts

import { app, ipcRenderer, remote } from "electron";
import { action, computed, observable, reaction, toJS, when } from "mobx";
import path from "path";
import { broadcastMessage, handleRequest, requestMain, subscribeToBroadcast } from "../common/ipc";
import logger from "../main/logger";
import type { InstalledExtension } from "./extension-discovery";
import { extensionsStore } from "./extensions-store";
import type { LensExtension, LensExtensionConstructor, LensExtensionId } from "./lens-extension";
import type { LensMainExtension } from "./lens-main-extension";
import type { LensRendererExtension } from "./lens-renderer-extension";
import * as registries from "./registries";

// lazy load so that we get correct userData
export function extensionPackagesRoot() {
  return path.join((app || remote.app).getPath("userData"));
}

const logModule = "[EXTENSIONS-LOADER]";

/**
 * Loads installed extensions to the Lens application
 */
export class ExtensionLoader {
  protected extensions = observable.map<LensExtensionId, InstalledExtension>();
  protected instances = observable.map<LensExtensionId, LensExtension>();
  protected readonly requestExtensionsChannel = "extensions:loaded";

  @observable isLoaded = false;
  whenLoaded = when(() => this.isLoaded);

  @computed get userExtensions(): Map<LensExtensionId, InstalledExtension> {
    const extensions = this.extensions.toJS();
    extensions.forEach((ext, extId) => {
      if (ext.isBundled) {
        extensions.delete(extId);
      }
    });
    return extensions;
  }

  @action
  async init() {
    if (ipcRenderer) {
      this.initRenderer();
    } else {
      this.initMain();
    }
    extensionsStore.manageState(this);
  }

  initExtensions(extensions?: Map<LensExtensionId, InstalledExtension>) {
    this.extensions.replace(extensions);
  }

  addExtension(extension: InstalledExtension) {
    this.extensions.set(extension.manifestPath as LensExtensionId, extension);
  }

  removeExtension(lensExtensionId: LensExtensionId) {
    // TODO: Remove the extension properly (from menus etc.)
    if (!this.extensions.delete(lensExtensionId)) {
      throw new Error(`Can't remove extension ${lensExtensionId}, doesn't exist.`);
    }
  }

  protected async initMain() {
    this.isLoaded = true;
    this.loadOnMain();
    this.broadcastExtensions();

    reaction(() => this.extensions.toJS(), () => {
      this.broadcastExtensions();
    });

    handleRequest(this.requestExtensionsChannel, () => {
      return Array.from(this.toJSON());
    });
  }

  protected async initRenderer() {
    const extensionListHandler = ( extensions: [LensExtensionId, InstalledExtension][]) => {
      this.isLoaded = true;
      extensions.forEach(([extId, ext]) => {
        if (!this.extensions.has(extId)) {
          this.extensions.set(extId, ext);
        }
      });
    };
    requestMain(this.requestExtensionsChannel).then(extensionListHandler);
    subscribeToBroadcast(this.requestExtensionsChannel, (event, extensions: [LensExtensionId, InstalledExtension][]) => {
      extensionListHandler(extensions);
    });
  }

  loadOnMain() {
    logger.info(`${logModule}: load on main`);
    this.autoInitExtensions((ext: LensMainExtension) => [
      registries.menuRegistry.add(ext.appMenus)
    ]);
  }

  loadOnClusterManagerRenderer() {
    logger.info(`${logModule}: load on main renderer (cluster manager)`);
    this.autoInitExtensions((ext: LensRendererExtension) => [
      registries.globalPageRegistry.add(ext.globalPages, ext),
      registries.globalPageMenuRegistry.add(ext.globalPageMenus, ext),
      registries.appPreferenceRegistry.add(ext.appPreferences),
      registries.clusterFeatureRegistry.add(ext.clusterFeatures),
      registries.statusBarRegistry.add(ext.statusBarItems),
    ]);
  }

  loadOnClusterRenderer() {
    logger.info(`${logModule}: load on cluster renderer (dashboard)`);
    this.autoInitExtensions((ext: LensRendererExtension) => [
      registries.clusterPageRegistry.add(ext.clusterPages, ext),
      registries.clusterPageMenuRegistry.add(ext.clusterPageMenus, ext),
      registries.kubeObjectMenuRegistry.add(ext.kubeObjectMenuItems),
      registries.kubeObjectDetailRegistry.add(ext.kubeObjectDetailItems),
      registries.kubeObjectStatusRegistry.add(ext.kubeObjectStatusTexts)
    ]);
  }

  protected autoInitExtensions(register: (ext: LensExtension) => Function[]) {
    return reaction(() => this.toJSON(), installedExtensions => {
      for (const [extId, ext] of installedExtensions) {
        const alreadyInit = this.instances.has(extId);

        if (ext.isEnabled && !alreadyInit) {
          try {
            const LensExtensionClass = this.requireExtension(ext);
            if (!LensExtensionClass) {
              continue;
            }

            const instance = new LensExtensionClass(ext);
            instance.whenEnabled(() => register(instance));
            instance.enable();
            this.instances.set(extId, instance);
          } catch (err) {
            logger.error(`${logModule}: activation extension error`, { ext, err });
          }
        } else if (!ext.isEnabled && alreadyInit) {
          try {
            const instance = this.instances.get(extId);
            instance.disable();
            this.instances.delete(extId);
          } catch (err) {
            logger.error(`${logModule}: deactivation extension error`, { ext, err });
          }
        }
      }
    }, {
      fireImmediately: true,
    });
  }

  protected requireExtension(extension: InstalledExtension): LensExtensionConstructor {
    let extEntrypoint = "";
    try {
      if (ipcRenderer && extension.manifest.renderer) {
        extEntrypoint = path.resolve(path.join(path.dirname(extension.manifestPath), extension.manifest.renderer));
      } else if (!ipcRenderer && extension.manifest.main) {
        extEntrypoint = path.resolve(path.join(path.dirname(extension.manifestPath), extension.manifest.main));
      }
      if (extEntrypoint !== "") {
        return __non_webpack_require__(extEntrypoint).default;
      }
    } catch (err) {
      console.error(`${logModule}: can't load extension main at ${extEntrypoint}: ${err}`, { extension });
      console.trace(err);
    }
  }

  getExtension(extId: LensExtensionId): InstalledExtension {
    return this.extensions.get(extId);
  }

  toJSON(): Map<LensExtensionId, InstalledExtension> {
    return toJS(this.extensions, {
      exportMapsAsObjects: false,
      recurseEverything: true,
    });
  }

  broadcastExtensions() {
    broadcastMessage(this.requestExtensionsChannel, Array.from(this.toJSON()));
  }
}

export const extensionLoader = new ExtensionLoader();