Implement missing weblink add/remove (#3092)

* implement weblink add/remove

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* cleanup

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* refactor

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* css fix

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix tests

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

src/main/catalog-sources/index.ts

@@ -19,4 +19,5 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+export { initializeWeblinks } from "./weblinks";
 export { KubeconfigSyncManager } from "./kubeconfig-sync";

src/main/catalog-sources/weblinks.ts

@@ -0,0 +1,102 @@
+/**
+ * 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 { observable, reaction } from "mobx";
+import { WeblinkStore } from "../../common/weblink-store";
+import { WebLink } from "../../common/catalog-entities";
+import { catalogEntityRegistry } from "../catalog";
+import got from "got";
+import logger from "../logger";
+import { docsUrl, slackUrl } from "../../common/vars";
+
+const defaultLinks = [
+  { title: "Lens Website", url: "https://k8slens.dev" },
+  { title: "Lens Documentation", url: docsUrl },
+  { title: "Lens Community Slack", url: slackUrl },
+  { title: "Kubernetes Documentation", url: "https://kubernetes.io/docs/home/" },
+  { title: "Lens on Twitter", url: "https://twitter.com/k8slens" },
+  { title: "Lens Official Blog", url: "https://medium.com/k8slens" }
+].map((link) => (
+  new WebLink({
+    metadata: {
+      uid: link.url,
+      name: link.title,
+      source: "app",
+      labels: {}
+    },
+    spec: {
+      url: link.url
+    },
+    status: {
+      phase: "available",
+      active: true
+    }
+  })
+));
+
+async function validateLink(link: WebLink) {
+  try {
+    const response = await got.get(link.spec.url, {
+      throwHttpErrors: false
+    });
+
+    if (response.statusCode >= 200 && response.statusCode < 500) {
+      link.status.phase = "available";
+    } else {
+      link.status.phase = "unavailable";
+    }
+  } catch(error) {
+    link.status.phase = "unavailable";
+  }
+}
+
+
+export function initializeWeblinks() {
+  const weblinkStore = WeblinkStore.getInstance();
+  const weblinks = observable.array(defaultLinks);
+
+  reaction(() => weblinkStore.weblinks, (links) => {
+    weblinks.replace(links.map((data) => new WebLink({
+      metadata: {
+        uid: data.id,
+        name: data.name,
+        source: "local",
+        labels: {}
+      },
+      spec: {
+        url: data.url
+      },
+      status: {
+        phase: "available",
+        active: true
+      }
+    })));
+    weblinks.push(...defaultLinks);
+
+    for (const link of weblinks) {
+      validateLink(link).catch((error) => {
+        logger.error(`failed to validate link ${link.spec.url}: %s`, error);
+      });
+    }
+  }, {fireImmediately: true});
+
+  catalogEntityRegistry.addObservableSource("weblinks", weblinks);
+}

src/main/catalog/__tests__/catalog-entity-registry.test.ts

@@ -58,7 +58,7 @@ describe("CatalogEntityRegistry", () => {
       url: "https://k8slens.dev"
     },
     status: {
-      phase: "valid"
+      phase: "available"
     }
   });
   const invalidEntity = new InvalidEntity({
@@ -72,7 +72,7 @@ describe("CatalogEntityRegistry", () => {
       url: "https://k8slens.dev"
     },
     status: {
-      phase: "valid"
+      phase: "available"
     }
   });
 

src/main/index.ts

@@ -35,14 +35,10 @@ import { shellSync } from "./shell-sync";
 import { mangleProxyEnv } from "./proxy-env";
 import { registerFileProtocol } from "../common/register-protocol";
 import logger from "./logger";
-import { ClusterStore } from "../common/cluster-store";
-import { UserStore } from "../common/user-store";
 import { appEventBus } from "../common/event-bus";
 import { ExtensionLoader } from "../extensions/extension-loader";
-import { ExtensionsStore } from "../extensions/extensions-store";
 import { InstalledExtension, ExtensionDiscovery } from "../extensions/extension-discovery";
 import type { LensExtensionId } from "../extensions/lens-extension";
-import { FilesystemProvisionerStore } from "./extension-filesystem";
 import { installDeveloperTools } from "./developer-tools";
 import { LensProtocolRouterMain } from "./protocol-handler";
 import { disposer, getAppVersion, getAppVersionFromProxyServer } from "../common/utils";
@@ -51,7 +47,6 @@ import { startUpdateChecking } from "./app-updater";
 import { IpcRendererNavigationEvents } from "../renderer/navigation/events";
 import { pushCatalogToRenderer } from "./catalog-pusher";
 import { catalogEntityRegistry } from "./catalog";
-import { HotbarStore } from "../common/hotbar-store";
 import { HelmRepoManager } from "./helm/helm-repo-manager";
 import { KubeconfigSyncManager } from "./catalog-sources";
 import { handleWsUpgrade } from "./proxy/ws-upgrade";
@@ -128,24 +123,11 @@ app.on("ready", async () => {
   PrometheusProviderRegistry.createInstance();
   initializers.initPrometheusProviderRegistry();
 
-  const userStore = UserStore.createInstance();
-  const clusterStore = ClusterStore.createInstance();
-  const hotbarStore = HotbarStore.createInstance();
-  const extensionsStore = ExtensionsStore.createInstance();
-  const filesystemStore = FilesystemProvisionerStore.createInstance();
+  await initializers.initializeStores();
+  initializers.initializeWeblinks();
 
   HelmRepoManager.createInstance(); // create the instance
 
-  logger.info("💾 Loading stores");
-  // preload
-  await Promise.all([
-    userStore.load(),
-    clusterStore.load(),
-    hotbarStore.load(),
-    extensionsStore.load(),
-    filesystemStore.load(),
-  ]);
-
   const lensProxy = LensProxy.createInstance(
     handleWsUpgrade,
     req => ClusterManager.getInstance().getClusterForRequest(req),
@@ -257,13 +239,13 @@ app.on("will-quit", (event) => {
   // This is called when the close button of the main window is clicked
 
   const lprm = LensProtocolRouterMain.getInstance(false);
-  
+
   logger.info("APP:QUIT");
   appEventBus.emit({ name: "app", action: "close" });
   ClusterManager.getInstance(false)?.stop(); // close cluster connections
   KubeconfigSyncManager.getInstance(false)?.stopSync();
   cleanup();
-  
+
   if (lprm) {
     // This is set to false here so that LPRM can wait to send future lens://
     // requests until after it loads again
@@ -272,7 +254,7 @@ app.on("will-quit", (event) => {
 
   if (blockQuit) {
     // Quit app on Cmd+Q (MacOS)
-    
+
     event.preventDefault(); // prevent app's default shutdown (e.g. required for telemetry, etc.)
 
     return; // skip exit to make tray work, to quit go to app's global menu or tray's menu

src/main/initializers/index.ts

@@ -22,3 +22,5 @@
 export * from "./registries";
 export * from "./metrics-providers";
 export * from "./ipc";
+export * from "./weblinks";
+export * from "./stores";

src/main/initializers/stores.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { HotbarStore } from "../../common/hotbar-store";
+import { ClusterStore } from "../../common/cluster-store";
+import { UserStore } from "../../common/user-store";
+import { ExtensionsStore } from "../../extensions/extensions-store";
+import { FilesystemProvisionerStore } from "../extension-filesystem";
+import { WeblinkStore } from "../../common/weblink-store";
+import logger from "../logger";
+
+export async function initializeStores() {
+  const userStore = UserStore.createInstance();
+  const clusterStore = ClusterStore.createInstance();
+  const hotbarStore = HotbarStore.createInstance();
+  const extensionsStore = ExtensionsStore.createInstance();
+  const filesystemStore = FilesystemProvisionerStore.createInstance();
+  const weblinkStore = WeblinkStore.createInstance();
+
+  logger.info("💾 Loading stores");
+  // preload
+  await Promise.all([
+    userStore.load(),
+    clusterStore.load(),
+    hotbarStore.load(),
+    extensionsStore.load(),
+    filesystemStore.load(),
+    weblinkStore.load()
+  ]);
+}

src/main/initializers/weblinks.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+export { initializeWeblinks } from "../catalog-sources";