Adding topBar extension registries

Signed-off-by: Alex Andreev <alex.andreev.email@gmail.com>

src/extensions/extension-loader.ts

@@ -251,6 +251,7 @@ export class ExtensionLoader extends Singleton {
         registries.commandRegistry.add(extension.commands),
         registries.welcomeMenuRegistry.add(extension.welcomeMenus),
         registries.catalogEntityDetailRegistry.add(extension.catalogEntityDetailItems),
+        registries.topBarRegistry.add(extension.topBarItems),
       ];
 
       this.events.on("remove", (removedExtension: LensRendererExtension) => {

src/extensions/lens-renderer-extension.ts

@@ -28,6 +28,7 @@ import { LensExtension } from "./lens-extension";
 import { getExtensionPageUrl } from "./registries/page-registry";
 import type { CommandRegistration } from "./registries/command-registry";
 import type { EntitySettingRegistration } from "./registries/entity-setting-registry";
+import type { TopBarRegistration } from "./registries/topbar-registry";
 
 export class LensRendererExtension extends LensExtension {
   globalPages: PageRegistration[] = [];
@@ -44,6 +45,7 @@ export class LensRendererExtension extends LensExtension {
   commands: CommandRegistration[] = [];
   welcomeMenus: WelcomeMenuRegistration[] = [];
   catalogEntityDetailItems: CatalogEntityDetailRegistration[] = [];
+  topBarItems: TopBarRegistration[] = [];
 
   async navigate<P extends object>(pageId?: string, params?: P) {
     const { navigate } = await import("../renderer/navigation");

src/extensions/registries/index.ts

@@ -35,3 +35,4 @@ export * from "./welcome-menu-registry";
 export * from "./protocol-handler-registry";
 export * from "./catalog-entity-detail-registry";
 export * from "./workloads-overview-detail-registry";
+export * from "./topbar-registry";

src/extensions/registries/topbar-registry.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import type React from "react";
+import { BaseRegistry } from "./base-registry";
+
+interface TopBarComponents {
+  Item?: React.ComponentType;
+}
+
+export interface TopBarRegistration {
+  components: TopBarComponents;
+}
+
+export class TopBarRegistry extends BaseRegistry<TopBarRegistration> {
+}
+
+export const topBarRegistry = new TopBarRegistry();

src/renderer/components/cluster-manager/topbar.test.tsx

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import React from "react";
+import { render } from "@testing-library/react";
+import "@testing-library/jest-dom/extend-expect";
+
+jest.mock("electron", () => ({
+  app: {
+    getPath: () => "/foo",
+  },
+}));
+
+jest.mock("../../../extensions/registries");
+
+import { topBarRegistry } from "../../../extensions/registries";
+import { TopBar } from "../layout/topbar";
+
+describe("<TopBar/>", () => {
+  it("renders w/o errors", () => {
+    const { container } = render(<TopBar label="test bar" />);
+
+    expect(container).toBeInstanceOf(HTMLElement);
+  });
+
+  it("renders title", async () => {
+    const { getByTestId } = render(<TopBar label="topbar" />);
+
+    expect(await getByTestId("topbarLabel")).toHaveTextContent("topbar");
+  });
+
+  it("renders items", async () => {
+    const testId = "testId";
+    const text = "an item";
+
+    topBarRegistry.getItems = jest.fn().mockImplementationOnce(() => [
+      {
+        components: {
+          Item: <span data-testid={testId}>{text}</span>
+        }
+      }
+    ]);
+
+    const { getByTestId } = render(<TopBar label="topbar" />);
+
+    expect(await getByTestId(testId)).toHaveTextContent(text);
+  });
+});

src/renderer/components/layout/topbar.module.css

@@ -43,4 +43,7 @@
   align-items: center;
   display: flex;
   height: 100%;
+}
+
+.extensionItem {
 }

src/renderer/components/layout/topbar.tsx

@@ -22,16 +22,44 @@
 import styles from "./topbar.module.css";
 import React from "react";
 import { observer } from "mobx-react";
+import { topBarRegistry } from "../../../extensions/registries";
 
 interface Props extends React.HTMLAttributes<any> {
   label: React.ReactNode;
 }
 
 export const TopBar = observer(({ label, children, ...rest }: Props) => {
+  const renderRegisteredItems = () => {
+    const items = topBarRegistry.getItems();
+
+    if (!Array.isArray(items)) {
+      return null;
+    }
+
+    return (
+      <div className="px-6">
+        {items.map((registration, index) => {
+          if (!registration?.components?.Item) {
+            return null;
+          }
+
+          return (
+            <div className={styles.extensionItem} key={index}>
+              {registration.components.Item}
+            </div>
+          );
+        })}
+      </div>
+    );
+  };
+
   return (
     <div className={styles.topBar} {...rest}>
-      <div className={styles.title}>{label}</div>
+      <div className={styles.title} data-testid="topbarLabel">{label}</div>
-      <div className={styles.controls}>{children}</div>
+      <div className={styles.controls}>
+        {renderRegisteredItems()}
+        {children}
+      </div>
     </div>
   );
 });