ports-plugin.ts

/**********************************************************************
 * Copyright (c) 2022 Red Hat, Inc.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 ***********************************************************************/

/* eslint-disable header/header */

import * as vscode from 'vscode';

import { DevWorkspaceDevfileHandlerImpl } from './devfile-handler-devworkspace-impl';
import { DevfileHandler } from './devfile-handler';
import { Endpoint } from './endpoint';
import { EndpointCategory } from './endpoint-category';
import { EndpointExposure } from './endpoint-exposure';
import { EndpointsTreeDataProvider } from './endpoints-tree-data-provider';
import { ListeningPort } from './listening-port';
import { PortChangesDetector } from './port-changes-detector';
import { PortForwardServer } from './port-forward-server';

/**
 * Plugin that is monitoring new port being opened and closed.
 * Check README file for more details
 * @author Florent Benoit
 */

// map a listener and the endpoint port used
export interface ForwardedPort {
  portForwardServer: PortForwardServer;

  endpoint: Endpoint;
}

export class PortsPlugin {
  // constants
  public static readonly LISTEN_ALL_IPV4 = '0.0.0.0';
  public static readonly LISTEN_ALL_IPV6 = '::';
  public static readonly SERVER_REDIRECT_PATTERN = 'code-redirect-';
  public static readonly PORT_EXCLUDE_ENV_VAR_PREFIX: string = 'PORT_PLUGIN_EXCLUDE_';

  private devfileHandler: DevfileHandler;
  private devfileEndpoints: Endpoint[];
  private redirectPorts: Endpoint[];
  private portForwards: Map<number, ForwardedPort>;
  private excludedPorts: number[];
  private outputChannel: vscode.OutputChannel;
  private endpointsTreeDataProvider: EndpointsTreeDataProvider;
  private portChangesDetector: PortChangesDetector;

  constructor(private context: vscode.ExtensionContext) {
    this.devfileEndpoints = [];
    this.redirectPorts = [];
    this.devfileHandler = new DevWorkspaceDevfileHandlerImpl();
    this.portForwards = new Map();
    this.excludedPorts = [];
    this.endpointsTreeDataProvider = new EndpointsTreeDataProvider();
    this.portChangesDetector = new PortChangesDetector();
    this.outputChannel = vscode.window.createOutputChannel('Ports Plug-in');
  }
  /**
   * Prompt user to create a port redirect for the specific port
   * @param port the port that needs to be redirected
   * @param redirectMessage the message if there are 'free ports' in workspace
   * @param errorMessage  if no free port are available
   */
  async askRedirect(port: ListeningPort, redirectMessage: string, errorMessage: string): Promise<void> {
    // grab a free redirect
    if (this.redirectPorts.length === 0) {
      await vscode.window.showErrorMessage(errorMessage, { modal: true });
      return;
    }

    const interactions: vscode.MessageItem[] = [{ title: 'yes' }, { title: 'no' }];
    const result = await vscode.window.showInformationMessage(redirectMessage, ...interactions);
    if (result && result.title === 'yes') {
      // takes first available port
      const endpoint = this.redirectPorts.pop()!;

      // start a new server for port forwarding
      const portForwardServer = new PortForwardServer(endpoint.targetPort, 'localhost', port.portNumber);
      portForwardServer.start();

      // store port taken
      const forwardedPort = { portForwardServer, endpoint };
      this.portForwards.set(port.portNumber, forwardedPort);
      this.updateEndpoints();

      // show redirect
      const redirectInteractions: vscode.MessageItem[] = [{ title: 'Open In New Tab' }];
      if (endpoint.protocol === 'https') {
        redirectInteractions.push({ title: 'Open Link' });
      }
      if (endpoint.url) {
        const msg = `Redirect is now enabled on port ${port.portNumber}. External URL is ${endpoint.url}`;
        const resultShow = await vscode.window.showInformationMessage(msg, ...redirectInteractions);
        if (resultShow && resultShow.title === 'Open Link') {
          vscode.commands.executeCommand('simpleBrowser.show', endpoint.url);
        } else if (resultShow && resultShow.title === 'Open In New Tab') {
          vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(endpoint.url));
        }
      }
    }
  }

  async updateEndpoints(): Promise<void> {
    // first, start with current devfile endpoints (copying them)
    const currentEndpoints = [...this.devfileEndpoints];

    // Add new forwarded endpoint on matching devfile
    // override public endpoint that are redirect with a Port Forward name
    currentEndpoints
      .filter(endpoint => endpoint.exposure === EndpointExposure.FROM_DEVFILE_PUBLIC)
      .forEach(publicEndpoint => {
        Array.from(this.portForwards.keys()).forEach(redirectPort => {
          const forwardedPort = this.portForwards.get(redirectPort);
          if (forwardedPort && forwardedPort.endpoint.targetPort === publicEndpoint.targetPort) {
            const portForwardEndpoint = { ...publicEndpoint };
            portForwardEndpoint.name = `user-port-forward (${redirectPort})`;
            portForwardEndpoint.exposure = EndpointExposure.FROM_RUNTIME_PORT_FORWARDING;
            portForwardEndpoint.targetPort = redirectPort;
            portForwardEndpoint.category = EndpointCategory.USER;
            currentEndpoints.push(portForwardEndpoint);
          }
        });
      });

    // and then, we need to add all ports not defined in the devfile
    const listeningPorts = this.portChangesDetector.getOpenedPorts();
    listeningPorts.forEach(listeningPort => {
      const existInDevfile = currentEndpoints.some(endpoint => endpoint.targetPort === listeningPort.portNumber);
      if (!existInDevfile) {
        // need to add it as a custom user endpoint
        const endpoint: Endpoint = {
          name: 'user',
          exposure: EndpointExposure.FROM_RUNTIME_USER,
          url: 'N/A',
          protocol: 'unknown',
          targetPort: listeningPort.portNumber,
          category: EndpointCategory.USER,
        };
        currentEndpoints.push(endpoint);
      }
    });

    // update the endpoints on the tree data provider
    this.endpointsTreeDataProvider.updateEndpoints(currentEndpoints, listeningPorts);
  }

  // Callback when a new port is being opened in workspace
  async onOpenPort(port: ListeningPort): Promise<void> {
    this.updateEndpoints();

    // skip excluded
    if (this.excludedPorts.includes(port.portNumber)) {
      // this port is excluded so just print a notice but does not propose a redirect
      this.outputChannel.appendLine(`Ignoring excluded port ${port.portNumber}`);
      return;
    }

    // handle ephemeral ports
    if (port.portNumber >= 32000) {
      // this port is ephemeral so just print a notice but does not propose a redirect
      this.outputChannel.appendLine(
        `Ephemeral port now listening on port ${port.portNumber} (port range >= 32000). No redirect proposed for ephemerals.`
      );
      return;
    }
    // check now if the port is in workspace definition ?
    const matchingEndpoint = this.devfileEndpoints.find(endpoint => endpoint.targetPort === port.portNumber);

    if (matchingEndpoint) {
      if (matchingEndpoint.exposure === EndpointExposure.FROM_DEVFILE_PRIVATE) {
        this.outputChannel.appendLine(
          `Endpoint ${matchingEndpoint.name} on port ${matchingEndpoint.targetPort} is defined as exposure: internal. Do not prompt to open it.`
        );
        return;
      }
      if (matchingEndpoint.exposure === EndpointExposure.FROM_DEVFILE_NONE) {
        this.outputChannel.appendLine(
          `Endpoint ${matchingEndpoint.name} on port ${matchingEndpoint.targetPort} is defined as exposure: none. Do not prompt to open it.`
        );
        return;
      }
    }

    // if not listening on 0.0.0.0 then raise a prompt to add a port redirect
    if (port.interfaceListen !== PortsPlugin.LISTEN_ALL_IPV4 && port.interfaceListen !== PortsPlugin.LISTEN_ALL_IPV6) {
      if (matchingEndpoint && matchingEndpoint.exposure === EndpointExposure.FROM_DEVFILE_PUBLIC) {
        const desc = `Process ${matchingEndpoint.name} is now listening on port ${matchingEndpoint.targetPort}, but it is listening on ${port.interfaceListen},
          which is internal. You should change the code to listen on port 0.0.0.0 instead. Would you like to add a redirect to make this process available anyway?`;
        const err = `Process ${matchingEndpoint.name} is now listening on port ${matchingEndpoint.targetPort}, but it is listening on ${port.interfaceListen},
          which is internal. You should change the code to listen on port 0.0.0.0 instead.`;
        await this.askRedirect(port, desc, err);
      } else {
        const desc = `A new process is now listening on port ${port.portNumber} but is listening on interface ${port.interfaceListen} which is internal.
          You should change to be remotely available. Would you want to add a redirect for this port so it becomes available ?`;
        const err = `A new process is now listening on port ${port.portNumber} but is listening on interface ${port.interfaceListen} which is internal.
          This port is not available outside. You should change the code to listen on 0.0.0.0 for example.`;
        await this.askRedirect(port, desc, err);
      }
      return;
    }

    // if there, show prompt
    if (matchingEndpoint) {
      // internal stuff, no need to display anything
      if (matchingEndpoint.name.startsWith(PortsPlugin.SERVER_REDIRECT_PATTERN)) {
        return;
      }

      // check if endpoint has preview url, and if so do not show dialog to avoid duplication with task plugin
      if (matchingEndpoint.path) {
        return;
      }

      // open notification ?
      const interactions: vscode.MessageItem[] = [{ title: 'Open In New Tab' }];
      if (matchingEndpoint.protocol === 'https') {
        interactions.push({ title: 'Open In Preview' });
      }

      const msg = `Process ${matchingEndpoint.name} is now listening on port ${matchingEndpoint.targetPort}. Open it ?`;
      if (matchingEndpoint.url) {
        const result = await vscode.window.showInformationMessage(msg, {}, ...interactions);
        if (result && result.title === 'Open In New Tab') {
          vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(matchingEndpoint.url));
        } else if (result && result.title === 'Open In Preview') {
          vscode.commands.executeCommand('simpleBrowser.show', matchingEndpoint.url);
        }
      }
    } else {
      const desc = `A new process is now listening on port ${port.portNumber} but this port is not a current endpoint.
         Would you want to add a redirect for this port so it becomes available ?`;
      const err = `A new process is now listening on port ${port.portNumber} but this port is not exposed in the workspace as a server.
         You should add a new server with this port in order to access it`;
      await this.askRedirect(port, desc, err);
    }
    console.info(`The port ${port.portNumber} is now listening on interface ${port.interfaceListen}`);
  }

  async freeRedirectPort(portNumber: number): Promise<void> {
    // stop the redirect
    const forwardedPort = this.portForwards.get(portNumber)!;
    forwardedPort.portForwardServer.stop();

    // free up the redirect endpoint
    this.redirectPorts.push(forwardedPort.endpoint);

    // remove entry
    this.portForwards.delete(portNumber);
  }

  onClosedPort(port: ListeningPort): void {
    // free redirect listener if there is one
    const portNumber = port.portNumber;
    if (this.portForwards.has(portNumber)) {
      this.freeRedirectPort(portNumber);
    }
    this.updateEndpoints();

    // just log trace
    console.info(`The port ${port.portNumber} is no longer listening on interface ${port.interfaceListen}`);
  }

  async start(): Promise<void> {
    // initiate excluded ports
    const excludedPortEnvironmentVariables: string[] = Object.keys(process.env).filter(key =>
      key.startsWith(PortsPlugin.PORT_EXCLUDE_ENV_VAR_PREFIX)
    );
    excludedPortEnvironmentVariables.forEach(key => {
      const value = process.env[key]!.toLocaleLowerCase() || '';
      if (value !== 'no' && value !== 'false') {
        this.excludedPorts.push(parseInt(key.substring(PortsPlugin.PORT_EXCLUDE_ENV_VAR_PREFIX.length)));
      }
    });

    // first, grab ports of workspace
    this.devfileEndpoints = await this.devfileHandler.getEndpoints();

    this.redirectPorts = this.devfileEndpoints.filter(endpoint =>
      endpoint.name.startsWith(PortsPlugin.SERVER_REDIRECT_PATTERN)
    );

    this.portChangesDetector.onDidOpenPort(async port => this.onOpenPort(port));
    this.portChangesDetector.onDidClosePort(async port => this.onClosedPort(port));

    // init
    await this.endpointsTreeDataProvider.init(this.context);

    // start port changes
    await this.portChangesDetector.init();
    this.portChangesDetector.check();

    this.updateEndpoints();
  }

  async stop(): Promise<void> { }
}