Make notifications about open ports display localhost links when the plugin is auto-forwarding ports

Author: felladrin

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

@@ -26,6 +26,7 @@ import org.jetbrains.io.response
 import java.io.OutputStreamWriter
 import java.nio.file.InvalidPathException
 import java.nio.file.Path
+import java.util.regex.Pattern
 
 @Suppress("UnstableApiUsage")
 class GitpodCLIService : RestService() {
@@ -64,10 +65,30 @@ class GitpodCLIService : RestService() {
             }
         }
         if (operation == "preview") {
-            val url = getStringParameter("url", urlDecoder)
+            var url = getStringParameter("url", urlDecoder)
+
             if (url.isNullOrBlank()) {
                 return "url is missing"
             }
+
+            // When it's auto-forwarding ports, we need to consider Gitpod Tasks running "gp preview".
+            // For example: gp preview --external $(gp url 3000)
+            if (manager.isAutoForwardingPorts) {
+                val isGitpodPortUrl = url.matches(
+                        Regex("^https?://([0-9]{1,5})-" + System.getenv("JETBRAINS_GITPOD_WORKSPACE_HOST") + "$")
+                )
+
+                if (isGitpodPortUrl) {
+                    val portsPrefix = "://"
+                    val matcher = Pattern.compile("$portsPrefix([0-9]{1,5})").matcher(url)
+
+                    if (matcher.find()) {
+                        val portString = matcher.group().substring(portsPrefix.length)
+                        url = "http://localhost:${portString}"
+                    }
+                }
+            }
+
             return withClient(request, context) { project ->
                 BrowserUtil.browse(url, project)
             }

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

@@ -33,6 +33,7 @@ import org.jetbrains.ide.BuiltInServerManager
 import java.util.concurrent.CancellationException
 import java.util.concurrent.CompletableFuture
 
+@Suppress("UnstableApiUsage", "OPT_IN_USAGE")
 class GitpodClientProjectSessionTracker(
         private val session: ClientProjectSession
 ) : Disposable {
@@ -54,19 +55,26 @@ class GitpodClientProjectSessionTracker(
         }
     }
 
-    private fun isExposedServedPort(port: Status.PortsStatus?): Boolean {
+    private fun isExposedServedPort(port: PortsStatus?): Boolean {
         if (port === null) {
             return false
         }
         return port.served && port.hasExposed()
     }
 
+    private fun getForwardedPortUrl(port: PortsStatus): String {
+        return when {
+            manager.isAutoForwardingPorts -> "http://localhost:${port.localPort}"
+            else -> port.exposed.url
+        }
+    }
+
     private fun showOpenServiceNotification(port: PortsStatus, offerMakePublic: Boolean = false) {
         val message = "A service is available on port ${port.localPort}"
         val notification = manager.notificationGroup.createNotification(message, NotificationType.INFORMATION)
 
-        val openBrowserAction = NotificationAction.createSimple("Open Browser") {
-            openBrowser(port.exposed.url)
+        val openBrowserAction = NotificationAction.createSimple("Open browser") {
+            openBrowser(getForwardedPortUrl(port))
         }
         notification.addAction(openBrowserAction)
 
@@ -76,7 +84,7 @@ class GitpodClientProjectSessionTracker(
                     makePortPublic(info.workspaceId, port)
                 }
             }
-            val makePublicAction = NotificationAction.createSimple("Make Public", makePublicLambda)
+            val makePublicAction = NotificationAction.createSimple("Make public", makePublicLambda)
             notification.addAction(makePublicAction)
         }
 
@@ -113,7 +121,7 @@ class GitpodClientProjectSessionTracker(
         val backendPort = BuiltInServerManager.getInstance().waitForStart().port
         val serverPort = StartupUtil.getServerFuture().await().port
         val ignorePorts = listOf(backendPort, serverPort, 5990)
-        val portsStatus = hashMapOf<Int, Status.PortsStatus>()
+        val portsStatus = hashMapOf<Int, PortsStatus>()
 
         val status = StatusServiceGrpc.newStub(GitpodManager.supervisorChannel)
         while (isActive) {
@@ -147,7 +155,7 @@ class GitpodClientProjectSessionTracker(
                                         }
 
                                         if (port.exposed.onExposed.number == Status.OnPortExposedAction.open_browser_VALUE || port.exposed.onExposed.number == Status.OnPortExposedAction.open_preview_VALUE) {
-                                            openBrowser(port.exposed.url)
+                                            openBrowser(getForwardedPortUrl(port))
                                             continue
                                         }
 
@@ -157,7 +165,7 @@ class GitpodClientProjectSessionTracker(
                                         }
 
                                         if (port.exposed.onExposed.number == Status.OnPortExposedAction.notify_private_VALUE) {
-                                            showOpenServiceNotification(port, port.exposed.visibilityValue !== PortVisibility.public_visibility_VALUE)
+                                            showOpenServiceNotification(port, port.exposed.visibilityValue != PortVisibility.public_visibility_VALUE)
                                             continue
                                         }
                                     }

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

@@ -62,6 +62,7 @@ class GitpodManager : Disposable {
     }
 
     val devMode = System.getenv("JB_DEV").toBoolean()
+    var isAutoForwardingPorts = false
     private val backendKind = System.getenv("JETBRAINS_GITPOD_BACKEND_KIND") ?: "unknown"
     private val backendQualifier = System.getenv("JETBRAINS_BACKEND_QUALIFIER") ?: "unknown"
 

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

@@ -4,6 +4,7 @@
 
 package io.gitpod.jetbrains.remote.latest
 
+import com.intellij.openapi.components.service
 import com.intellij.openapi.diagnostic.thisLogger
 import com.intellij.openapi.project.Project
 import com.intellij.remoteDev.util.onTerminationOrNow
@@ -38,6 +39,10 @@ class GitpodPortForwardingService(private val project: Project) {
     }
 
     private fun observePortsListWhileProjectIsOpen() = application.executeOnPooledThread {
+        val gitpodManager = service<GitpodManager>()
+
+        gitpodManager.isAutoForwardingPorts = true
+
         while (project.lifetime.status == LifetimeStatus.Alive) {
             try {
                 observePortsList().get()
@@ -54,6 +59,8 @@ class GitpodPortForwardingService(private val project: Project) {
 
             TimeUnit.SECONDS.sleep(1)
         }
+
+        gitpodManager.isAutoForwardingPorts = false
     }
 
     private fun observePortsList(): CompletableFuture<Void> {