Skip to content

Disable JetBrains local ports forwarding with FF #20274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 11, 2024
Merged

Disable JetBrains local ports forwarding with FF #20274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed0a8d8
Disable gitpod port forwarding
mustard-mh Oct 8, 2024
3b1b0c4
Use FF and env to control port exposing
mustard-mh Oct 9, 2024
f7d94fe
Rename to `forwarding`
mustard-mh Oct 10, 2024
1cf6e05
disable local ports forwarding only
mustard-mh Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 26 additions & 16 deletions ...-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/AbstractGitpodPortForwardingService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import com.intellij.util.application
import com.jetbrains.rd.platform.codeWithMe.portForwarding.*
import com.jetbrains.rd.util.URI
import com.jetbrains.rd.util.lifetime.Lifetime
import com.jetbrains.rd.util.threading.coroutines.launch
import io.gitpod.supervisor.api.Status
import io.gitpod.supervisor.api.Status.PortsStatus
import io.gitpod.supervisor.api.StatusServiceGrpc
Expand Down Expand Up @@ -41,6 +40,10 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
private fun start() {
if (application.isHeadlessEnvironment) return

if (isLocalPortForwardingDisabled()) {
thisLogger().warn("gitpod: Local port forwarding is disabled.")
}

observePortsListWhileProjectIsOpen()
}

Expand Down Expand Up @@ -77,7 +80,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) }
}
Expand All @@ -100,6 +103,10 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
return completableFuture
}

private fun isLocalPortForwardingDisabled(): Boolean {
return System.getenv("GITPOD_DISABLE_JETBRAINS_LOCAL_PORT_FORWARDING")?.toBoolean() ?: false
}

private fun syncPortsListWithClient(response: Status.PortsStatusResponse) {
val ignoredPorts = ignoredPortsForNotificationService.getIgnoredPorts()
val portsList = response.portsList.filter { !ignoredPorts.contains(it.localPort) }
Expand All @@ -114,11 +121,11 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
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) }
.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) }
.map { it.hostPortNumber }
.filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }

servedPortsToStartForwarding.forEach { startForwarding(it) }

Expand All @@ -132,11 +139,14 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
}

private fun startForwarding(portStatus: PortsStatus) {
if (isLocalPortForwardingDisabled()) {
return
}
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) {
Expand All @@ -147,22 +157,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) {
Expand Down
6 changes: 5 additions & 1 deletion components/server/src/workspace/workspace-starter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1552,16 +1552,20 @@ export class WorkspaceStarter {
sysEnvvars.push(orgIdEnv);

const client = getExperimentsClientForBackend();
const [isSetJavaXmx, isSetJavaProcessorCount] = await Promise.all([
const [isSetJavaXmx, isSetJavaProcessorCount, disableJetBrainsLocalPortForwarding] = 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_forwarding", false, { user })
.then((v) => newEnvVar("GITPOD_DISABLE_JETBRAINS_LOCAL_PORT_FORWARDING", String(v))),
]);
sysEnvvars.push(isSetJavaXmx);
sysEnvvars.push(isSetJavaProcessorCount);
sysEnvvars.push(disableJetBrainsLocalPortForwarding);
const spec = new StartWorkspaceSpec();
await createGitpodTokenPromise;
spec.setEnvvarsList(envvars);
Expand Down
Loading