|
| 1 | +// Copyright (c) 2022 Gitpod GmbH. All rights reserved. |
| 2 | +// Licensed under the GNU Affero General Public License (AGPL). |
| 3 | +// See License-AGPL.txt in the project root for license information. |
| 4 | + |
| 5 | +package io.gitpod.jetbrains.remote.latest |
| 6 | + |
| 7 | +import com.intellij.openapi.diagnostic.thisLogger |
| 8 | +import com.intellij.openapi.project.Project |
| 9 | +import com.intellij.remoteDev.util.onTerminationOrNow |
| 10 | +import com.intellij.util.application |
| 11 | +import com.jetbrains.codeWithMe.model.RdPortType |
| 12 | +import com.jetbrains.rd.platform.util.lifetime |
| 13 | +import com.jetbrains.rd.util.lifetime.LifetimeStatus |
| 14 | +import com.jetbrains.rdserver.portForwarding.ForwardedPortInfo |
| 15 | +import com.jetbrains.rdserver.portForwarding.PortForwardingManager |
| 16 | +import com.jetbrains.rdserver.portForwarding.remoteDev.PortEventsProcessor |
| 17 | +import io.gitpod.jetbrains.remote.GitpodManager |
| 18 | +import io.gitpod.supervisor.api.Status |
| 19 | +import io.gitpod.supervisor.api.StatusServiceGrpc |
| 20 | +import io.grpc.stub.ClientCallStreamObserver |
| 21 | +import io.grpc.stub.ClientResponseObserver |
| 22 | +import io.ktor.utils.io.* |
| 23 | +import java.util.concurrent.CompletableFuture |
| 24 | +import java.util.concurrent.TimeUnit |
| 25 | + |
| 26 | +@Suppress("UnstableApiUsage") |
| 27 | +class GitpodPortForwardingService(private val project: Project) { |
| 28 | + companion object { |
| 29 | + const val FORWARDED_PORT_LABEL = "gitpod" |
| 30 | + } |
| 31 | + |
| 32 | + init { start() } |
| 33 | + |
| 34 | + private fun start() { |
| 35 | + if (application.isHeadlessEnvironment) return |
| 36 | + |
| 37 | + observePortsListWhileProjectIsOpen() |
| 38 | + } |
| 39 | + |
| 40 | + private fun observePortsListWhileProjectIsOpen() = application.executeOnPooledThread { |
| 41 | + while (project.lifetime.status == LifetimeStatus.Alive) { |
| 42 | + try { |
| 43 | + observePortsList().get() |
| 44 | + } catch (throwable: Throwable) { |
| 45 | + when (throwable) { |
| 46 | + is InterruptedException, is CancellationException -> break |
| 47 | + else -> thisLogger().error( |
| 48 | + "gitpod: Got an error while trying to get ports list from Supervisor. " + |
| 49 | + "Will try again in 1 second.", |
| 50 | + throwable |
| 51 | + ) |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + TimeUnit.SECONDS.sleep(1) |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + private fun observePortsList(): CompletableFuture<Void> { |
| 60 | + val completableFuture = CompletableFuture<Void>() |
| 61 | + |
| 62 | + val statusServiceStub = StatusServiceGrpc.newStub(GitpodManager.supervisorChannel) |
| 63 | + |
| 64 | + val portsStatusRequest = Status.PortsStatusRequest.newBuilder().setObserve(true).build() |
| 65 | + |
| 66 | + val portsStatusResponseObserver = object : |
| 67 | + ClientResponseObserver<Status.PortsStatusRequest, Status.PortsStatusResponse> { |
| 68 | + override fun beforeStart(request: ClientCallStreamObserver<Status.PortsStatusRequest>) { |
| 69 | + project.lifetime.onTerminationOrNow { request.cancel("gitpod: Project terminated.", null) } |
| 70 | + } |
| 71 | + override fun onNext(response: Status.PortsStatusResponse) { handlePortStatusResponse(response) } |
| 72 | + override fun onCompleted() { completableFuture.complete(null) } |
| 73 | + override fun onError(throwable: Throwable) { completableFuture.completeExceptionally(throwable) } |
| 74 | + } |
| 75 | + |
| 76 | + statusServiceStub.portsStatus(portsStatusRequest, portsStatusResponseObserver) |
| 77 | + |
| 78 | + return completableFuture |
| 79 | + } |
| 80 | + |
| 81 | + private fun handlePortStatusResponse(response: Status.PortsStatusResponse) { |
| 82 | + val portNumberToServedStatusMap = mutableMapOf<Int, Boolean>() |
| 83 | + |
| 84 | + for (port in response.portsList) { |
| 85 | + val isServed = (port.exposed != null || port.tunneled != null) && port.served |
| 86 | + |
| 87 | + portNumberToServedStatusMap[port.localPort] = isServed |
| 88 | + } |
| 89 | + |
| 90 | + updateForwardedPortsList(portNumberToServedStatusMap) |
| 91 | + } |
| 92 | + |
| 93 | + private fun updateForwardedPortsList(portNumberToServedStatusMap: Map<Int, Boolean>) { |
| 94 | + val portForwardingManager = PortForwardingManager.getInstance(project) |
| 95 | + val forwardedPortsList = portForwardingManager.getForwardedPortsWithLabel(FORWARDED_PORT_LABEL) |
| 96 | + |
| 97 | + portNumberToServedStatusMap.forEach { (hostPort, isServed) -> |
| 98 | + if (isServed && !forwardedPortsList.containsKey(hostPort)) { |
| 99 | + val portEventsProcessor = object : PortEventsProcessor { |
| 100 | + override fun onPortForwarded(hostPort: Int, clientPort: Int) { |
| 101 | + thisLogger().info("gitpod: Forwarded port $hostPort to client's port $clientPort.") |
| 102 | + } |
| 103 | + |
| 104 | + override fun onPortForwardingEnded(hostPort: Int) { |
| 105 | + thisLogger().info("gitpod: Finished forwarding port $hostPort.") |
| 106 | + } |
| 107 | + |
| 108 | + override fun onPortForwardingFailed(hostPort: Int, reason: String) { |
| 109 | + thisLogger().error("gitpod: Failed to forward port $hostPort: $reason") |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + val portInfo = ForwardedPortInfo( |
| 114 | + hostPort, |
| 115 | + RdPortType.HTTP, |
| 116 | + FORWARDED_PORT_LABEL, |
| 117 | + emptyList(), |
| 118 | + portEventsProcessor |
| 119 | + ) |
| 120 | + |
| 121 | + portForwardingManager.forwardPort(portInfo) |
| 122 | + } |
| 123 | + |
| 124 | + if (!isServed && forwardedPortsList.containsKey(hostPort)) { |
| 125 | + portForwardingManager.removePort(hostPort) |
| 126 | + thisLogger().info("gitpod: Stopped forwarding port $hostPort.") |
| 127 | + } |
| 128 | + } |
| 129 | + } |
| 130 | +} |
0 commit comments