Use FF and env to control port exposing

Author: mustard-mh

components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/AbstractGitpodPortForwardingService.kt

@@ -76,7 +76,7 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
         val portsStatusRequest = Status.PortsStatusRequest.newBuilder().setObserve(true).build()
 
         val portsStatusResponseObserver = object :
-                ClientResponseObserver<Status.PortsStatusRequest, Status.PortsStatusResponse> {
+            ClientResponseObserver<Status.PortsStatusRequest, Status.PortsStatusResponse> {
             override fun beforeStart(request: ClientCallStreamObserver<Status.PortsStatusRequest>) {
                 lifetime.onTerminationOrNow { request.cancel("gitpod: Service lifetime terminated.", null) }
             }
@@ -99,43 +99,51 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
         return completableFuture
     }
 
+    private fun isPortExposingDisabled(): Boolean {
+        return System.getenv("GITPOD_DISABLE_JETBRAINS_LOCAL_PORT_EXPOSE")?.toBoolean() ?: false
+    }
+
     private fun syncPortsListWithClient(response: Status.PortsStatusResponse) {
-//        val ignoredPorts = ignoredPortsForNotificationService.getIgnoredPorts()
-//        val portsList = response.portsList.filter { !ignoredPorts.contains(it.localPort) }
-//        val portsNumbersFromPortsList = portsList.map { it.localPort }
-//        val servedPorts = portsList.filter { it.served }
-//        val exposedPorts = servedPorts.filter { it.exposed?.url?.isNotBlank() ?: false }
-//        val portsNumbersFromNonServedPorts = portsList.filter { !it.served }.map { it.localPort }
-//        val servedPortsToStartForwarding = servedPorts.filter {
-//            perClientPortForwardingManager.getPorts(it.localPort).none { p -> p.labels.contains(FORWARDED_PORT_LABEL) }
-//        }
-//        val exposedPortsToStartExposingOnClient = exposedPorts.filter {
-//            perClientPortForwardingManager.getPorts(it.localPort).none { p -> p.labels.contains(EXPOSED_PORT_LABEL) }
-//        }
-//        val forwardedPortsToStopForwarding = perClientPortForwardingManager.getPorts(FORWARDED_PORT_LABEL)
-//                .map { it.hostPortNumber }
-//                .filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }
-//        val exposedPortsToStopExposingOnClient = perClientPortForwardingManager.getPorts(EXPOSED_PORT_LABEL)
-//                .map { it.hostPortNumber }
-//                .filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }
-//
-//        servedPortsToStartForwarding.forEach { startForwarding(it) }
-//
-//        exposedPortsToStartExposingOnClient.forEach { startExposingOnClient(it) }
-//
-//        forwardedPortsToStopForwarding.forEach { stopForwarding(it) }
-//
-//        exposedPortsToStopExposingOnClient.forEach { stopExposingOnClient(it) }
-//
-//        portsList.forEach { updatePortsPresentation(it) }
+        if (isPortExposingDisabled()) {
+            thisLogger().warn("gitpod: Port exposing is disabled.")
+            return
+        }
+        val ignoredPorts = ignoredPortsForNotificationService.getIgnoredPorts()
+        val portsList = response.portsList.filter { !ignoredPorts.contains(it.localPort) }
+        val portsNumbersFromPortsList = portsList.map { it.localPort }
+        val servedPorts = portsList.filter { it.served }
+        val exposedPorts = servedPorts.filter { it.exposed?.url?.isNotBlank() ?: false }
+        val portsNumbersFromNonServedPorts = portsList.filter { !it.served }.map { it.localPort }
+        val servedPortsToStartForwarding = servedPorts.filter {
+            perClientPortForwardingManager.getPorts(it.localPort).none { p -> p.labels.contains(FORWARDED_PORT_LABEL) }
+        }
+        val exposedPortsToStartExposingOnClient = exposedPorts.filter {
+            perClientPortForwardingManager.getPorts(it.localPort).none { p -> p.labels.contains(EXPOSED_PORT_LABEL) }
+        }
+        val forwardedPortsToStopForwarding = perClientPortForwardingManager.getPorts(FORWARDED_PORT_LABEL)
+            .map { it.hostPortNumber }
+            .filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }
+        val exposedPortsToStopExposingOnClient = perClientPortForwardingManager.getPorts(EXPOSED_PORT_LABEL)
+            .map { it.hostPortNumber }
+            .filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }
+
+        servedPortsToStartForwarding.forEach { startForwarding(it) }
+
+        exposedPortsToStartExposingOnClient.forEach { startExposingOnClient(it) }
+
+        forwardedPortsToStopForwarding.forEach { stopForwarding(it) }
+
+        exposedPortsToStopExposingOnClient.forEach { stopExposingOnClient(it) }
+
+        portsList.forEach { updatePortsPresentation(it) }
     }
 
     private fun startForwarding(portStatus: PortsStatus) {
         try {
             perClientPortForwardingManager.forwardPort(
-                    portStatus.localPort,
-                    PortType.TCP,
-                    setOf(FORWARDED_PORT_LABEL),
+                portStatus.localPort,
+                PortType.TCP,
+                setOf(FORWARDED_PORT_LABEL),
             )
         } catch (throwable: Throwable) {
             if (throwable !is PortAlreadyForwardedException) {
@@ -146,22 +154,22 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
 
     private fun stopForwarding(hostPort: Int) {
         perClientPortForwardingManager.getPorts(hostPort)
-                .filter { it.labels.contains(FORWARDED_PORT_LABEL) }
-                .forEach { perClientPortForwardingManager.removePort(it) }
+            .filter { it.labels.contains(FORWARDED_PORT_LABEL) }
+            .forEach { perClientPortForwardingManager.removePort(it) }
     }
 
     private fun startExposingOnClient(portStatus: PortsStatus) {
         perClientPortForwardingManager.exposePort(
-                portStatus.localPort,
-                portStatus.exposed.url,
-                setOf(EXPOSED_PORT_LABEL),
+            portStatus.localPort,
+            portStatus.exposed.url,
+            setOf(EXPOSED_PORT_LABEL),
         )
     }
 
     private fun stopExposingOnClient(hostPort: Int) {
         perClientPortForwardingManager.getPorts(hostPort)
-                .filter { it.labels.contains(EXPOSED_PORT_LABEL) }
-                .forEach { perClientPortForwardingManager.removePort(it) }
+            .filter { it.labels.contains(EXPOSED_PORT_LABEL) }
+            .forEach { perClientPortForwardingManager.removePort(it) }
     }
 
     private fun updatePortsPresentation(portStatus: PortsStatus) {

components/server/src/workspace/workspace-starter.ts

@@ -1552,16 +1552,18 @@ export class WorkspaceStarter {
         sysEnvvars.push(orgIdEnv);
 
         const client = getExperimentsClientForBackend();
-        const [isSetJavaXmx, isSetJavaProcessorCount] = await Promise.all([
+        const [isSetJavaXmx, isSetJavaProcessorCount, disableJetBrainsPortExpose] = await Promise.all([
             client
                 .getValueAsync("supervisor_set_java_xmx", false, { user })
                 .then((v) => newEnvVar("GITPOD_IS_SET_JAVA_XMX", String(v))),
             client
                 .getValueAsync("supervisor_set_java_processor_count", false, { user })
                 .then((v) => newEnvVar("GITPOD_IS_SET_JAVA_PROCESSOR_COUNT", String(v))),
+            client.getValueAsync("disable_jetbrains_local_port_expose", false, { user }).then((v) => newEnvVar("GITPOD_DISABLE_JETBRAINS_LOCAL_PORT_EXPOSE", String(v)))
         ]);
         sysEnvvars.push(isSetJavaXmx);
         sysEnvvars.push(isSetJavaProcessorCount);
+        sysEnvvars.push(disableJetBrainsPortExpose);
         const spec = new StartWorkspaceSpec();
         await createGitpodTokenPromise;
         spec.setEnvvarsList(envvars);