adding port-forward for containers in pods (#528)

* adding port-forward for containers in pods

address review comments

use more idiomatic approach for async code

move some files in advance of merge conflict with Lens restructure work

* Separate the port forward links in the UI (so they don't all spin when one link is clicked)

* minor fixes

* addressed review comments (replaced <p> with <div>, moved key attribute to proper element)

* fix lint issue

* removed extraneous <div> from pod container port details

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

src/main/router.ts

@@ -123,7 +123,7 @@ export class Router {
     this.router.add({ method: "post", path: `${apiBase}/metrics` }, metricsRoute.routeMetrics.bind(metricsRoute))
 
     // Port-forward API
-    this.router.add({ method: "post", path: `${apiBase}/services/{namespace}/{service}/port-forward/{port}` }, portForwardRoute.routeServicePortForward.bind(portForwardRoute))
+    this.router.add({ method: "post", path: `${apiBase}/pods/{namespace}/{resourceType}/{resourceName}/port-forward/{port}` }, portForwardRoute.routePortForward.bind(portForwardRoute))
 
     // Helm API
     this.router.add({ method: "get", path: `${apiHelm}/v2/charts` }, helmApi.listCharts.bind(helmApi))

src/main/routes/port-forward.ts

@@ -14,7 +14,7 @@ class PortForward {
     return PortForward.portForwards.find((pf) => {
       return (
         pf.clusterId == forward.clusterId &&
-        pf.kind == "service" &&
+        pf.kind == forward.kind &&
         pf.name == forward.name &&
         pf.namespace == forward.namespace &&
         pf.port == forward.port
@@ -42,7 +42,7 @@ class PortForward {
       "--kubeconfig", this.kubeConfig,
       "port-forward",
       "-n", this.namespace,
-      `service/${this.name}`,
+      `${this.kind}/${this.name}`,
       `${this.localPort}:${this.port}`
     ]
 
@@ -72,21 +72,22 @@ class PortForward {
 
 class PortForwardRoute extends LensApi {
 
-  public async routeServicePortForward(request: LensApiRequest) {
+  public async routePortForward(request: LensApiRequest) {
     const { params, response, cluster} = request
+    const { namespace, port, resourceType, resourceName } = params
 
     let portForward = PortForward.getPortforward({
-      clusterId: cluster.id, kind: "service", name: params.service,
-      namespace: params.namespace, port: params.port
+      clusterId: cluster.id, kind: resourceType, name: resourceName,
+      namespace: namespace, port: port
     })
     if (!portForward) {
-      logger.info(`Creating a new port-forward ${params.namespace}/${params.service}:${params.port}`)
+      logger.info(`Creating a new port-forward ${namespace}/${resourceType}/${resourceName}:${port}`)
       portForward = new PortForward({
         clusterId: cluster.id,
-        kind: "service",
-        namespace: params.namespace,
-        name: params.service,
-        port: params.port,
+        kind: resourceType,
+        namespace: namespace,
+        name: resourceName,
+        port: port,
         kubeConfig: cluster.proxyKubeconfigPath()
       })
       const started = await portForward.start()

src/renderer/components/+network-services/service-details.tsx

@@ -11,7 +11,7 @@ import { Service, serviceApi, endpointApi } from "../../api/endpoints";
 import { _i18n } from "../../i18n";
 import { apiManager } from "../../api/api-manager";
 import { KubeObjectMeta } from "../kube-object/kube-object-meta";
-import { ServicePorts } from "./service-ports";
+import { ServicePortComponent } from "./service-port-component";
 import { endpointStore } from "../+network-endpoints/endpoints.store";
 import { ServiceDetailsEndpoint } from "./service-details-endpoint";
 
@@ -61,7 +61,13 @@ export class ServiceDetails extends React.Component<Props> {
         )}
 
         <DrawerItem name={<Trans>Ports</Trans>}>
-          <ServicePorts service={service}/>
+          <div>
+            {
+              service.getPorts().map((port) => (
+                <ServicePortComponent service={service} port={port} key={port.toString()}/>
+              ))
+            }
+          </div>
         </DrawerItem>
 
         {spec.type === "LoadBalancer" && spec.loadBalancerIP && (

src/renderer/components/+network-services/service-port-component.scss

@@ -0,0 +1,22 @@
+.ServicePortComponent {
+  &.waiting {
+    opacity: 0.5;
+    pointer-events: none;
+  }
+
+  &:not(:last-child) {
+    margin-bottom: $margin;
+  }
+
+  span {
+    cursor: pointer;
+    color: $primary;
+    text-decoration: underline;
+  }
+
+  .Spinner {
+    --spinner-size: #{$unit * 2};
+    margin-left: $margin;
+    position: absolute;
+  }
+}

src/renderer/components/+network-services/service-port-component.tsx

@@ -0,0 +1,48 @@
+import "./service-port-component.scss"
+
+import React from "react";
+import { observer } from "mobx-react";
+import { t } from "@lingui/macro";
+import { Service, ServicePort } from "../../api/endpoints";
+import { _i18n } from "../../i18n";
+import { apiBase } from "../../api"
+import { observable } from "mobx";
+import { cssNames } from "../../utils";
+import { Notifications } from "../notifications";
+import { Spinner } from "../spinner"
+
+interface Props {
+  service: Service;
+  port: ServicePort;
+}
+
+@observer
+export class ServicePortComponent extends React.Component<Props> {
+  @observable waiting = false;
+
+  async portForward() {
+    const { service, port } = this.props;
+    this.waiting = true;
+    try {
+      await apiBase.post(`/pods/${service.getNs()}/service/${service.getName()}/port-forward/${port.port}`, {})
+    } catch(error) {
+      Notifications.error(error);
+    } finally {
+      this.waiting = false;
+    }
+  }
+
+  render() {
+    const { port } = this.props;
+    return (
+      <div className={cssNames("ServicePortComponent", { waiting: this.waiting })}>
+        <span title={_i18n._(t`Open in a browser`)} onClick={() => this.portForward() }>
+          {port.toString()}
+          {this.waiting && (
+            <Spinner />
+          )}
+        </span>
+      </div>
+    );
+  }
+}

src/renderer/components/+network-services/service-ports.scss

@@ -1,24 +0,0 @@
-.ServicePorts {
-  &.waiting {
-    opacity: 0.5;
-    pointer-events: none;
-  }
-
-  p {
-    &:not(:last-child) {
-      margin-bottom: $margin;
-    }
-
-    span {
-      cursor: pointer;
-      color: $primary;
-      text-decoration: underline;
-    }
-  }
-
-  .Spinner {
-    --spinner-size: #{$unit * 2};
-    margin-left: $margin;
-    position: absolute;
-  }
-}

src/renderer/components/+network-services/service-ports.tsx

@@ -1,54 +0,0 @@
-import "./service-ports.scss"
-
-import React from "react";
-import { observer } from "mobx-react";
-import { t } from "@lingui/macro";
-import { Service, ServicePort } from "../../api/endpoints";
-import { _i18n } from "../../i18n";
-import { apiBase } from "../../api"
-import { observable } from "mobx";
-import { cssNames } from "../../utils";
-import { Notifications } from "../notifications";
-import { Spinner } from "../spinner"
-
-interface Props {
-  service: Service;
-}
-
-@observer
-export class ServicePorts extends React.Component<Props> {
-  @observable waiting = false;
-
-  async portForward(port: ServicePort) {
-    const { service } = this.props;
-    this.waiting = true;
-    apiBase.post(`/services/${service.getNs()}/${service.getName()}/port-forward/${port.port}`, {})
-      .catch(error => {
-        Notifications.error(error);
-      })
-      .finally(() => {
-        this.waiting = false;
-      });
-  }
-
-  render() {
-    const { service } = this.props;
-    return (
-      <div className={cssNames("ServicePorts", { waiting: this.waiting })}>
-        {
-          service.getPorts().map((port) => {
-            return(
-              <p key={port.toString()}>
-                <span title={_i18n._(t`Open in a browser`)} onClick={() => this.portForward(port) }>
-                  {port.toString()}
-                  {this.waiting && (
-                    <Spinner />
-                  )}
-                </span>
-              </p>
-            );
-          })}
-      </div>
-    );
-  }
-}

src/renderer/components/+workloads-pods/pod-container-port.scss

@@ -0,0 +1,23 @@
+.PodContainerPort {
+  &.waiting {
+    opacity: 0.5;
+    pointer-events: none;
+  }
+
+  &:not(:last-child) {
+    margin-bottom: $margin;
+  }
+
+  span {
+    cursor: pointer;
+    color: $primary;
+    text-decoration: underline;
+    position: relative;
+  }
+
+  .Spinner {
+    --spinner-size: #{$unit * 2};
+    margin-left: $margin;
+    position: absolute;
+  }
+}

src/renderer/components/+workloads-pods/pod-container-port.tsx

@@ -0,0 +1,54 @@
+import "./pod-container-port.scss"
+
+import React from "react";
+import { observer } from "mobx-react";
+import { t } from "@lingui/macro";
+import { Pod, IPodContainer } from "../../api/endpoints";
+import { _i18n } from "../../i18n";
+import { apiBase } from "../../api"
+import { observable } from "mobx";
+import { cssNames } from "../../utils";
+import { Notifications } from "../notifications";
+import { Spinner } from "../spinner"
+
+interface Props {
+  pod: Pod;
+  port: {
+    name?: string;
+    containerPort: number;
+    protocol: string;
+  }
+}
+
+@observer
+export class PodContainerPort extends React.Component<Props> {
+  @observable waiting = false;
+
+  async portForward() {
+    const { pod, port } = this.props;
+    this.waiting = true;
+    try {
+      await apiBase.post(`/pods/${pod.getNs()}/pod/${pod.getName()}/port-forward/${port.containerPort}`, {})
+    } catch(error) {
+      Notifications.error(error);
+    } finally {
+      this.waiting = false;
+    }
+  }
+
+  render() {
+    const { port } = this.props;
+    const { name, containerPort, protocol } = port;
+    const text = (name ? name + ': ' : '')+`${containerPort}/${protocol}`
+    return (
+      <div className={cssNames("PodContainerPort", { waiting: this.waiting })}>
+        <span title={_i18n._(t`Open in a browser`)} onClick={() => this.portForward() }>
+          {text}
+          {this.waiting && (
+            <Spinner />
+          )}
+        </span>
+      </div>
+    )
+  }
+}

src/renderer/components/+workloads-pods/pod-details-container.tsx

@@ -8,6 +8,7 @@ import { cssNames } from "../../utils";
 import { StatusBrick } from "../status-brick";
 import { Badge } from "../badge";
 import { ContainerEnvironment } from "./pod-container-env";
+import { PodContainerPort } from "./pod-container-port";
 import { ResourceMetrics } from "../resource-metrics";
 import { IMetrics } from "../../api/endpoints/metrics.api";
 import { ContainerCharts } from "./container-charts";
@@ -64,13 +65,10 @@ export class PodDetailsContainer extends React.Component<Props> {
         {ports && ports.length > 0 &&
         <DrawerItem name={<Trans>Ports</Trans>}>
           {
-            ports.map(port => {
-              const { name, containerPort, protocol } = port;
-              const key = `${container.name}-port-${containerPort}-${protocol}`
-              return (
-                <div key={key}>
-                  {name ? name + ': ' : ''}{containerPort}/{protocol}
-                </div>
+            ports.map((port) => {
+              const key = `${container.name}-port-${port.containerPort}-${port.protocol}`
+              return(
+                <PodContainerPort pod={pod} port={port} key={key}/>
               )
             })
           }