Improve JetBrains port processing performance #20907
Conversation
Add throttling mechanism to prevent rapid successive port updates, reducing UI flicker and improving performance in the JetBrains backend plugin. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a throttling mechanism to batch rapid port updates in the JetBrains plugin, reducing UI flicker and improving performance.
- Adds an IntelliJ
Alarmto delay and merge successivePortsStatusResponseupdates - Replaces direct calls to
syncPortsListWithClientwith a newthrottledSyncPortsListWithClientwrapper - Introduces
pendingUpdatestorage and a 100 ms throttle interval
Comments suppressed due to low confidence (1)
components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/AbstractGitpodPortForwardingService.kt:112
- There aren’t unit tests for the new throttling logic. Adding tests to simulate rapid successive responses and verifying that only the latest update is processed would ensure correctness.
private fun throttledSyncPortsListWithClient(response: Status.PortsStatusResponse) {
| @@ -35,6 +36,11 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService | |||
| private val ignoredPortsForNotificationService = service<GitpodIgnoredPortsForNotificationService>() | |||
| private val lifetime = Lifetime.Eternal.createNested() | |||
|
|
|||
| // Throttling mechanism to prevent rapid successive port updates using IntelliJ Alarm | |||
| private var pendingUpdate: Status.PortsStatusResponse? = null | |||
| private val updateAlarm = Alarm(Alarm.ThreadToUse.SWING_THREAD, this) | |||
There was a problem hiding this comment.
Using this as the parent Disposable may leak if AbstractGitpodPortForwardingService isn't disposable. Consider supplying a proper Disposable (e.g., the plugin’s lifecycle parent) or disposing the Alarm when the service shuts down.
| private val updateAlarm = Alarm(Alarm.ThreadToUse.SWING_THREAD, this) | |
| private val updateAlarm = Alarm(Alarm.ThreadToUse.SWING_THREAD, application) |
Copilot uses AI. Check for mistakes.
| // Throttling mechanism to prevent rapid successive port updates using IntelliJ Alarm | ||
| private var pendingUpdate: Status.PortsStatusResponse? = null | ||
| private val updateAlarm = Alarm(Alarm.ThreadToUse.SWING_THREAD, this) | ||
| private val updateThrottleMs = 100 // 100ms throttle |
There was a problem hiding this comment.
[nitpick] The throttle interval is a magic number here. Consider extracting it into a named constant or configuration entry so it’s easier to adjust and document.
| private val updateThrottleMs = 100 // 100ms throttle | |
| private val updateThrottleMs = DEFAULT_UPDATE_THROTTLE_MS // Default throttle interval |
Copilot uses AI. Check for mistakes.
| if (!updateAlarm.isEmpty) { | ||
| updateAlarm.cancelAllRequests() | ||
| } |
There was a problem hiding this comment.
[nitpick] Checking isEmpty before cancelAllRequests() may be unnecessary, since cancelAllRequests() is idempotent. You could simplify by always calling cancelAllRequests() or guard by isDisposed if needed.
| if (!updateAlarm.isEmpty) { | |
| updateAlarm.cancelAllRequests() | |
| } | |
| updateAlarm.cancelAllRequests() |
Copilot uses AI. Check for mistakes.
Add throttling mechanism to prevent rapid successive port updates, reducing UI flicker and improving performance in the JetBrains backend plugin.
🤖 Generated with Claude Code
Description
Related Issue(s)
Relates CLC-1260
How to test
Integration tests
https://github.com/gitpod-io/gitpod/actions/runs/15700198958/job/44233991339?pr=20907
Documentation
Preview status
Gitpod was successfully deployed to your preview environment.
Build Options
Build
Run the build with werft instead of GHA
Run Leeway with
--dont-testPublish
Installer
Add desired feature flags to the end of the line above, space separated
Preview Environment / Integration Tests
If enabled this will build
install/previewIf enabled this will create the environment on GCE infra
Saves cost. Untick this only if you're really sure you need a non-preemtible machine.
Valid options are
all,workspace,webapp,ide,jetbrains,vscode,ssh. If enabled,with-previewandwith-large-vmwill be enabled./hold