[#25] Add info to README about protocol events, remove feature gate

Fixes #25

Author: stefcameron

README.md

@@ -127,6 +127,92 @@ Due to technical issues with generating a unique kubeConfig per cluster, when th
 
 We hope to overcome this limitation in the future.
 
+## Supported protocol requests
+
+[Lens 4.2](https://medium.com/k8slens/lens-4-2-released-f1c3268d3f95) introduced a new __custom Lens protocol handler__. This means Lens can now respond to `lens://` URL requests made in the browser, and this extension can now support some interesting requests that enable tighter integration between Mirantis Container Cloud instances and Lens.
+
+> Note that this integration is a one-way street: Container Cloud -> Lens. It does not work the other way around. _Reverse_ integration is achieved simply by making Container Cloud API requests from Lens, which is much easier to achieve, and has been used by this extension since its inception.
+
+The __base URL__ for requests that this extension can respond to is:
+
+```
+lens://extensions/@mirantis/lens-extension-cc
+```
+
+The following APIs are currently supported by this extension, from the base URL above:
+
+### Protocol - Activate cluster
+
+Activates a cluster __already added__ to Lens.
+
+```
+GET /activateCluster
+  ?cloudUrl={string}
+  &namespace={string}
+  &clusterName={string}
+  &clusterId={string}
+```
+
+- `cloudUrl`: URL to the instance, e.g. `https://container-cloud.my-company.com`
+- `namespace`: ID of the Container Cloud namespace containing the cluster to activate.
+- `clusterName`: Name of the cluster to activate.
+- `clusterId`: ID of the cluster (in `namespace`) to activate.
+
+### Protocol - Add one cluster
+
+Adds a __single__ cluster to Lens (if it hasn't already been added) by providing a pre-configured kubeConfig JSON object for the cluster. As such, this endpoint does not require the extension to perform any authentication/authorization requests. It simply stores the kubeConfig on disk and tells Lens where to find it.
+
+```
+GET /kubeConfig
+  ?cloudUrl={string}
+  &namespace={string}
+  &clusterName={string}
+  &clusterId={string}
+  &kubeConfig={string}
+```
+
+- `cloudUrl`: URL to the instance, e.g. `https://container-cloud.my-company.com`
+- `namespace`: ID of the Container Cloud namespace containing the cluster to activate.
+- `clusterName`: Name of the cluster to activate.
+- `clusterId`: ID of the cluster (in `namespace`) to activate.
+- `kubeConfig`: JSON-stringified, Base64-encoded kubeConfig payload.
+
+### Protocol - Add multiple clusters
+
+Allows the user to add __one or more__ clusters to Lens by telling the extension where to find them. Unlike [adding one cluster](#add-one-cluster), it does not automatically add any clusters to Lens. It simply triggers the extension to immediately list all available clusters, and then lets the user choose which ones to add.
+
+```
+GET /addClusters
+  ?cloudUrl={string}
+  &username={string}
+  &tokens={string}
+  [ &keycloakLogin={boolean} ]
+  [ &namespaces={string} ]
+```
+
+- `cloudUrl`: URL to the instance, e.g. `https://container-cloud.my-company.com`
+- `username`: Username associated with the `tokens`.
+- `tokens`: JSON-stringified, Base64-encoded OAuth2 tokens for the user.
+- `keycloakLogin` (Optional): `false` (default) if the instance in `cloudUrl` uses basic (username/password) authentication; `true` if the instance in `cloudUrl` uses SSO authorization.
+- `namespaces` (Optional): Comma-delimited list of namespace IDs to restrict the list of clusters presented by the extension (i.e. a filter on namespaces). Only clusters in these namespaces will be listed.
+
+### Protocol - SSO OAuth Code
+
+Allow the extension to use the system's default browser to broker an OAuth authorization code with a Keycloak client in a Container Cloud instance. This is used both for general access (to list clusters) as well as specific cluster access to generate kubeConfig files to add to Lens.
+
+```
+GET /oauth/code
+  ?code={string}
+  [ &state={string} ]
+  [ &error={string} ]
+  [ &error_description={string} ]
+```
+
+- `code`: Temporary authorization code to exchange for API tokens.
+- `state` (Optional): Used to differentiate between requests for general access and specific access. The value is generated by the extension as part of the request and should come back as part of the response.
+- `error` (Optional): OAuth error message, if an error occurs.
+- `error_description` (Optional): OAuth error description, if an error occurs.
+
 ## FAQ
 
 - Why are management clusters not selected by default?

src/cc/View.js

@@ -641,11 +641,8 @@ export const View = function ({ extension }) {
 
       <HelpColumn>
         <HelpContent
-          // TRACKING: https://github.com/Mirantis/lens-extension-cc/issues/25
           dangerouslySetInnerHTML={{
-            __html: strings.view.help.html(
-              Array.isArray(extension.protocolHandlers)
-            ),
+            __html: strings.view.help.html(),
           }}
         />
         <PreferencesPanel />

src/renderer.tsx

@@ -138,35 +138,24 @@ export default class ExtensionRenderer extends LensRendererExtension {
   };
 
   async onActivate() {
-    // TODO remove this HACK once updated type is published that includes the new method;
-    //  for how, this just gets around the TSC complaining the method isn't defined on `this`
-    // TRACKING: https://github.com/Mirantis/lens-extension-cc/issues/25
-    const that = this as any;
-    if (Array.isArray(that.protocolHandlers)) {
-      that.protocolHandlers = [
-        {
-          pathSchema: `/${EXT_EVENT_ACTIVATE_CLUSTER}`,
-          handler: this.handleProtocolActivateCluster,
-        },
-        {
-          pathSchema: `/${EXT_EVENT_ADD_CLUSTERS}`,
-          handler: this.handleProtocolAddClusters,
-        },
-        {
-          pathSchema: `/${EXT_EVENT_KUBECONFIG}`,
-          handler: this.handleProtocolKubeConfig,
-        },
-        {
-          pathSchema: `/${EXT_EVENT_OAUTH_CODE}`,
-          handler: this.handleProtocolOauthCode,
-        },
-      ];
-    } else {
-      logger.warn(
-        'renderer/onActivate',
-        'This version of Lens does not support "lens://" protocol requests.'
-      );
-    }
+    this.protocolHandlers = [
+      {
+        pathSchema: `/${EXT_EVENT_ACTIVATE_CLUSTER}`,
+        handler: this.handleProtocolActivateCluster,
+      },
+      {
+        pathSchema: `/${EXT_EVENT_ADD_CLUSTERS}`,
+        handler: this.handleProtocolAddClusters,
+      },
+      {
+        pathSchema: `/${EXT_EVENT_KUBECONFIG}`,
+        handler: this.handleProtocolKubeConfig,
+      },
+      {
+        pathSchema: `/${EXT_EVENT_OAUTH_CODE}`,
+        handler: this.handleProtocolOauthCode,
+      },
+    ];
 
     await prefStore.loadExtension(this);
   }

src/strings.ts

@@ -69,10 +69,8 @@ export const view: Dict = {
     close: () => 'Reset back to normal view',
   },
   help: {
-    html: (showLinkInfo = false) => {
-      // TODO: remove parameter and always show info once links supported
-      // TRACKING: https://github.com/Mirantis/lens-extension-cc/issues/25
-      let text = `
+    html: () =>
+      `
 <h2>Adding Clusters</h2>
 <p>
   This extension makes it easy to add clusters from a ${mccFullName} instance.
@@ -93,20 +91,13 @@ export const view: Dict = {
   be added to the <code>${workspacePrefix}demo</code> workspace (and the workspace will be
   created if it doesn't exist already).
 </p>
-`;
-
-      text += showLinkInfo
-        ? `
 <h2>Links</h2>
 <p>
   When activating this extension via links from a ${mccFullName} instance (requires Lens
-  4.1 or later), the extension UI will add an X (Close) button to the top/right corner
+  4.2 or later), the extension UI will add an X (Close) button to the top/right corner
   of its main panel in certain cases. Click the Close button to return to the default view.
 </p>
-`
-        : '';
-      return text;
-    },
+`,
   },
 };