1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Get rid of this.disposers while registering stuff in extensions #1145

Signed-off-by: Roman <ixrock@gmail.com>
This commit is contained in:
Roman 2020-10-26 17:59:24 +02:00
parent e9ebd06664
commit cee4d1ea1f
16 changed files with 91 additions and 82 deletions

View File

@ -8,16 +8,16 @@ export default class ExampleExtension extends LensRendererExtension {
} }
registerClusterPage(registry: Registry.ClusterPageRegistry) { registerClusterPage(registry: Registry.ClusterPageRegistry) {
this.disposers.push( return [
registry.add({ {
path: "/extension-example", path: "/extension-example",
title: "Example Extension", title: "Example Extension",
components: { components: {
Page: () => <ExamplePage extension={this} />, Page: () => <ExamplePage extension={this} />,
MenuIcon: ExampleIcon, MenuIcon: ExampleIcon,
} }
}) }
) ]
} }
onDeactivate() { onDeactivate() {

View File

@ -4,8 +4,8 @@ import React from "react"
export default class ClusterMetricsFeatureExtension extends LensRendererExtension { export default class ClusterMetricsFeatureExtension extends LensRendererExtension {
registerClusterFeatures(registry: Registry.ClusterFeatureRegistry) { registerClusterFeatures(registry: Registry.ClusterFeatureRegistry) {
this.disposers.push( return [
registry.add({ {
title: "Metrics Stack", title: "Metrics Stack",
components: { components: {
Description: () => { Description: () => {
@ -19,7 +19,7 @@ export default class ClusterMetricsFeatureExtension extends LensRendererExtensio
} }
}, },
feature: new MetricsFeature() feature: new MetricsFeature()
}) }
) ]
} }
} }

View File

@ -1,6 +1,6 @@
import { Registry, LensRendererExtension } from "@k8slens/extensions"; import { Registry, LensRendererExtension } from "@k8slens/extensions";
import React from "react" import React from "react"
import { NodeMenu } from "./src/node-menu" import { NodeMenu, NodeMenuProps } from "./src/node-menu"
export default class NodeMenuRendererExtension extends LensRendererExtension { export default class NodeMenuRendererExtension extends LensRendererExtension {
async onActivate() { async onActivate() {
@ -8,14 +8,14 @@ export default class NodeMenuRendererExtension extends LensRendererExtension {
} }
registerKubeObjectMenus(registry: Registry.KubeObjectMenuRegistry) { registerKubeObjectMenus(registry: Registry.KubeObjectMenuRegistry) {
this.disposers.push( return [
registry.add({ {
kind: "Node", kind: "Node",
apiVersions: ["v1"], apiVersions: ["v1"],
components: { components: {
MenuItem: (props) => <NodeMenu {...props} /> MenuItem: (props: NodeMenuProps) => <NodeMenu {...props} />
} }
}) }
) ]
} }
} }

View File

@ -1,7 +1,10 @@
import React from "react"; import React from "react";
import { Component, K8sApi, Navigation} from "@k8slens/extensions" import { Component, K8sApi, Navigation} from "@k8slens/extensions"
export function NodeMenu(props: Component.KubeObjectMenuProps<K8sApi.Node>) { export interface NodeMenuProps extends Component.KubeObjectMenuProps<K8sApi.Node> {
}
export function NodeMenu(props: NodeMenuProps) {
const { object: node, toolbar } = props; const { object: node, toolbar } = props;
if (!node) return null; if (!node) return null;
const nodeName = node.getName(); const nodeName = node.getName();

View File

@ -1,6 +1,6 @@
import { Registry, LensRendererExtension } from "@k8slens/extensions"; import { Registry, LensRendererExtension } from "@k8slens/extensions";
import { PodShellMenu } from "./src/shell-menu" import { PodShellMenu, PodShellMenuProps } from "./src/shell-menu"
import { PodLogsMenu } from "./src/logs-menu" import { PodLogsMenu, PodLogsMenuProps } from "./src/logs-menu"
import React from "react" import React from "react"
export default class PodMenuRendererExtension extends LensRendererExtension { export default class PodMenuRendererExtension extends LensRendererExtension {
@ -9,23 +9,21 @@ export default class PodMenuRendererExtension extends LensRendererExtension {
} }
registerKubeObjectMenus(registry: Registry.KubeObjectMenuRegistry) { registerKubeObjectMenus(registry: Registry.KubeObjectMenuRegistry) {
this.disposers.push( return [
registry.add({ {
kind: "Pod", kind: "Pod",
apiVersions: ["v1"], apiVersions: ["v1"],
components: { components: {
MenuItem: (props) => <PodShellMenu {...props} /> MenuItem: (props: PodShellMenuProps) => <PodShellMenu {...props} />
} }
}) },
) {
this.disposers.push(
registry.add({
kind: "Pod", kind: "Pod",
apiVersions: ["v1"], apiVersions: ["v1"],
components: { components: {
MenuItem: (props) => <PodLogsMenu {...props} /> MenuItem: (props: PodLogsMenuProps) => <PodLogsMenu {...props} />
} }
}) }
) ]
} }
} }

View File

@ -1,10 +1,10 @@
import React from "react"; import React from "react";
import { Component, K8sApi, Util, Navigation } from "@k8slens/extensions"; import { Component, K8sApi, Util, Navigation } from "@k8slens/extensions";
interface Props extends Component.KubeObjectMenuProps<K8sApi.Pod> { export interface PodLogsMenuProps extends Component.KubeObjectMenuProps<K8sApi.Pod> {
} }
export class PodLogsMenu extends React.Component<Props> { export class PodLogsMenu extends React.Component<PodLogsMenuProps> {
showLogs(container: K8sApi.IPodContainer) { showLogs(container: K8sApi.IPodContainer) {
Navigation.hideDetails(); Navigation.hideDetails();
const pod = this.props.object; const pod = this.props.object;

View File

@ -3,10 +3,10 @@
import React from "react"; import React from "react";
import { Component, K8sApi, Util, Navigation } from "@k8slens/extensions"; import { Component, K8sApi, Util, Navigation } from "@k8slens/extensions";
interface Props extends Component.KubeObjectMenuProps<K8sApi.Pod> { export interface PodShellMenuProps extends Component.KubeObjectMenuProps<K8sApi.Pod> {
} }
export class PodShellMenu extends React.Component<Props> { export class PodShellMenu extends React.Component<PodShellMenuProps> {
async execShell(container?: string) { async execShell(container?: string) {
Navigation.hideDetails(); Navigation.hideDetails();
const { object: pod } = this.props const { object: pod } = this.props

View File

@ -6,9 +6,9 @@ export default class SupportPageMainExtension extends LensMainExtension {
console.log("support page extension activated") console.log("support page extension activated")
} }
async registerAppMenus(registry: Registry.MenuRegistry) { registerAppMenus(registry: Registry.MenuRegistry) {
this.disposers.push( return [
registry.add({ {
parentId: "help", parentId: "help",
label: "Support", label: "Support",
click() { click() {
@ -17,7 +17,7 @@ export default class SupportPageMainExtension extends LensMainExtension {
url: supportPageURL(), url: supportPageURL(),
}); });
} }
}) }
) ]
} }
} }

View File

@ -8,22 +8,22 @@ export default class SupportPageRendererExtension extends LensRendererExtension
console.log("support page extension activated") console.log("support page extension activated")
} }
registerGlobalPage(registry: Registry.GlobalPageRegistry) { registerGlobalPages(registry: Registry.GlobalPageRegistry) {
this.disposers.push( return [
registry.add({ {
...supportPageRoute, ...supportPageRoute,
url: supportPageURL(), url: supportPageURL(),
hideInMenu: true, hideInMenu: true,
components: { components: {
Page: Support, Page: Support,
} }
}) }
) ]
} }
registerStatusBarItem(registry: Registry.StatusBarRegistry) { registerStatusBarItems(registry: Registry.StatusBarRegistry) {
this.disposers.push( return [
registry.add({ {
item: ( item: (
<div <div
className="flex align-center gaps hover-highlight" className="flex align-center gaps hover-highlight"
@ -33,7 +33,7 @@ export default class SupportPageRendererExtension extends LensRendererExtension
<span>Support</span> <span>Support</span>
</div> </div>
) )
}) }
) ]
} }
} }

View File

@ -12,15 +12,15 @@ export default class TelemetryRendererExtension extends LensRendererExtension {
} }
registerAppPreferences(registry: Registry.AppPreferenceRegistry) { registerAppPreferences(registry: Registry.AppPreferenceRegistry) {
this.disposers.push( return [
registry.add({ {
title: "Telemetry & Usage Tracking", title: "Telemetry & Usage Tracking",
components: { components: {
Hint: () => <TelemetryPreferenceHint />, Hint: () => <TelemetryPreferenceHint />,
Input: () => <TelemetryPreferenceInput telemetry={telemetryPreferencesStore} /> Input: () => <TelemetryPreferenceInput telemetry={telemetryPreferencesStore} />
} }
}) }
) ]
} }
onDeactivate() { onDeactivate() {

View File

@ -36,26 +36,26 @@ export class ExtensionLoader {
loadOnMain() { loadOnMain() {
logger.info('[EXTENSIONS-LOADER]: load on main') logger.info('[EXTENSIONS-LOADER]: load on main')
this.autoloadExtensions((instance: LensMainExtension) => { this.autoloadExtensions((extension: LensMainExtension) => {
instance.registerAppMenus(menuRegistry); extension.register(menuRegistry, extension.registerAppMenus(menuRegistry))
}) })
} }
loadOnClusterManagerRenderer() { loadOnClusterManagerRenderer() {
logger.info('[EXTENSIONS-LOADER]: load on main renderer (cluster manager)') logger.info('[EXTENSIONS-LOADER]: load on main renderer (cluster manager)')
this.autoloadExtensions((instance: LensRendererExtension) => { this.autoloadExtensions((extension: LensRendererExtension) => {
instance.registerGlobalPage(globalPageRegistry) extension.register(globalPageRegistry, extension.registerGlobalPages(globalPageRegistry))
instance.registerAppPreferences(appPreferenceRegistry) extension.register(appPreferenceRegistry, extension.registerAppPreferences(appPreferenceRegistry))
instance.registerClusterFeatures(clusterFeatureRegistry) extension.register(clusterFeatureRegistry, extension.registerClusterFeatures(clusterFeatureRegistry))
instance.registerStatusBarItem(statusBarRegistry) extension.register(statusBarRegistry, extension.registerStatusBarItems(statusBarRegistry))
}) })
} }
loadOnClusterRenderer() { loadOnClusterRenderer() {
logger.info('[EXTENSIONS-LOADER]: load on cluster renderer (dashboard)') logger.info('[EXTENSIONS-LOADER]: load on cluster renderer (dashboard)')
this.autoloadExtensions((instance: LensRendererExtension) => { this.autoloadExtensions((extension: LensRendererExtension) => {
instance.registerClusterPage(clusterPageRegistry) extension.register(clusterPageRegistry, extension.registerClusterPages(clusterPageRegistry))
instance.registerKubeObjectMenus(kubeObjectMenuRegistry) extension.register(kubeObjectMenuRegistry, extension.registerKubeObjectMenus(kubeObjectMenuRegistry))
}) })
} }

View File

@ -1,6 +1,7 @@
import { readJsonSync } from "fs-extra"; import { readJsonSync } from "fs-extra";
import { action, observable, toJS } from "mobx"; import { action, observable, toJS } from "mobx";
import logger from "../main/logger"; import logger from "../main/logger";
import { BaseRegistry } from "./registries/base-registry";
export type ExtensionId = string | ExtensionPackageJsonPath; export type ExtensionId = string | ExtensionPackageJsonPath;
export type ExtensionPackageJsonPath = string; export type ExtensionPackageJsonPath = string;
@ -25,7 +26,7 @@ export interface ExtensionManifest extends ExtensionModel {
export class LensExtension implements ExtensionModel { export class LensExtension implements ExtensionModel {
public id: ExtensionId; public id: ExtensionId;
public updateUrl: string; public updateUrl: string;
protected disposers: Function[] = []; protected disposers: (() => void)[] = [];
@observable name = ""; @observable name = "";
@observable description = ""; @observable description = "";
@ -77,6 +78,14 @@ export class LensExtension implements ExtensionModel {
// mock // mock
} }
register<T = any>(registry: BaseRegistry<T>, registryItems: T[]) {
const disposers = registryItems.map(item => registry.add(item));
this.disposers.push(...disposers);
return () => {
this.disposers = this.disposers.filter(disposer => !disposers.includes(disposer))
};
}
getMeta() { getMeta() {
return toJS({ return toJS({
id: this.id, id: this.id,

View File

@ -1,12 +1,12 @@
import { LensExtension } from "./lens-extension" import { LensExtension } from "./lens-extension"
import type { MenuRegistry } from "./registries/menu-registry"; import type { MenuRegistration, MenuRegistry } from "./registries/menu-registry";
export class LensMainExtension extends LensExtension { export class LensMainExtension extends LensExtension {
registerAppMenus(registry: MenuRegistry) { registerAppMenus(registry: MenuRegistry): MenuRegistration[] {
// return []
} }
registerPrometheusProviders(registry: any) { registerPrometheusProviders(registry: any): any[] {
// return []
} }
} }

View File

@ -1,28 +1,28 @@
import { LensExtension } from "./lens-extension" import { LensExtension } from "./lens-extension"
import type { GlobalPageRegistry, ClusterPageRegistry, AppPreferenceRegistry, StatusBarRegistry, KubeObjectMenuRegistry, ClusterFeatureRegistry } from "./registries" import type { GlobalPageRegistry, ClusterPageRegistry, AppPreferenceRegistry, StatusBarRegistry, KubeObjectMenuRegistry, ClusterFeatureRegistry, PageRegistration, AppPreferenceRegistration, ClusterFeatureRegistration, StatusBarRegistration, KubeObjectMenuRegistration } from "./registries"
export class LensRendererExtension extends LensExtension { export class LensRendererExtension extends LensExtension {
registerGlobalPage(registry: GlobalPageRegistry) { registerGlobalPages(registry: GlobalPageRegistry): PageRegistration[] {
return return []
} }
registerClusterPage(registry: ClusterPageRegistry) { registerClusterPages(registry: ClusterPageRegistry): PageRegistration[] {
return return []
} }
registerAppPreferences(registry: AppPreferenceRegistry) { registerAppPreferences(registry: AppPreferenceRegistry): AppPreferenceRegistration[] {
return return []
} }
registerClusterFeatures(registry: ClusterFeatureRegistry) { registerClusterFeatures(registry: ClusterFeatureRegistry): ClusterFeatureRegistration[] {
return return []
} }
registerStatusBarItem(registry: StatusBarRegistry) { registerStatusBarItems(registry: StatusBarRegistry): StatusBarRegistration[] {
return return []
} }
registerKubeObjectMenus(registry: KubeObjectMenuRegistry) { registerKubeObjectMenus(registry: KubeObjectMenuRegistry): KubeObjectMenuRegistration[] {
return return []
} }
} }

View File

@ -1,11 +1,10 @@
// Extensions API -> Global menu customizations // Extensions API -> Global menu customizations
import type { MenuTopId } from "../../main/menu";
import type { MenuItemConstructorOptions } from "electron"; import type { MenuItemConstructorOptions } from "electron";
import { BaseRegistry } from "./base-registry"; import { BaseRegistry } from "./base-registry";
export interface MenuRegistration extends MenuItemConstructorOptions { export interface MenuRegistration extends MenuItemConstructorOptions {
parentId?: MenuTopId; parentId: string;
} }
export class MenuRegistry extends BaseRegistry<MenuRegistration> { export class MenuRegistry extends BaseRegistry<MenuRegistration> {

View File

@ -209,7 +209,7 @@ export function buildMenu(windowManager: WindowManager) {
// Modify menu from extensions-api // Modify menu from extensions-api
menuRegistry.getItems().forEach(({ parentId, ...menuItem }) => { menuRegistry.getItems().forEach(({ parentId, ...menuItem }) => {
try { try {
const topMenu = appMenu[parentId].submenu as MenuItemConstructorOptions[]; const topMenu = appMenu[parentId as MenuTopId].submenu as MenuItemConstructorOptions[];
topMenu.push(menuItem); topMenu.push(menuItem);
} catch (err) { } catch (err) {
logger.error(`[MENU]: can't register menu item, parentId=${parentId}`, { menuItem }) logger.error(`[MENU]: can't register menu item, parentId=${parentId}`, { menuItem })