[JetBrains] Show notification when port becomes available 🔔

[andreafalzetti]

Description

This PR introduces ports notification in JetBrains IDEs. 🔔

Context

Currently, when ports become available (e.g. a web server is ready to handle requests and the port is exposed to the internet), in VS Code you get a toast notification within the IDE, to inform you. Additionally, you get an action within the notification to open the browser or the preview (specifically for VS Code, as it supports preview windows). While, for JetBrains IDEs, we didn't yet show any notification when ports became available.

Example notification in VS Code

Approach

The approach used is to listen to supervisor ports status updates (see status.proto).

Gitpod's JetBrains backend-plugin already integrates with supervisor generic notification, so this feature leverages the existing integration and re-uses the same notification group.

After this change, the notifications will appear in the native notifications panel. See example below:

Additionally, we offer to "Make Public" a port when its visibility is private.

Notes

• To avoid noise and undesired notifications, certain ports are explicitly ignored. Most of those are ports used internally by the IDE itself.

Related Issue(s)

Fixes #9908

How to test

1. Start a workspace using the following link: https://afalz-9908c5dfc24116.staging.gitpod-dev.com/#https://github.com/andreafalzetti/gitpod-experiments-b
2. Choose a JetBrains product as your preferred editor
3. Notice a prompt to open the browser on port 8080
4. Notice a notification for port 8081 being available
5. Notice a notification for port 8083 being available (set to be notify in .gitpod.yml)
6. Port 8082 should not trigger a notification (set to be ignored in .gitpod.yml)
7. Try exposing a new port, make it public, verify that it's accessible

Release Notes

[JetBrains] Show notification when port becomes available

Documentation

---

• /werft with-vm
• /werft without-vm
• /werft with-clean-slate-deployment

[andreafalzetti]

at the moment, pressing the button doesn't update the UI (in VS Code in the ports view you can see the text "private" change into "public"), so it looks a bit unfinished. We could consider adding an extra notification like:

val message = "The port ${port.localPort} is now public"
val notification = manager.notificationGroup.createNotification(message, NotificationType.INFORMATION)
ClientId.withClientId(session.clientId) {
   val project = RestService.getLastFocusedOrOpenedProject()
   notification.notify(project)
}

Thoughts?

cc @akosyakov @loujaybee

[akosyakov]

Too many notification is also not nice. Is it possible to update an action? Maybe just make it expirable?

[andreafalzetti]

it was a good idea, unfortunately if I do "Make Public" createSimpleExpiring - when I click it, it expires all actions including "Open Browser" :(

[akosyakov]

@andreafalzetti I see these ports too:

[akosyakov]

If I close a client and open again, I don't see notifications it is something with state management. But it is rather minor.

[akosyakov]

lgtm

/hold
because we need to filter out JB built-in server and CWM ports

[akosyakov]

@andreafalzetti 5990 is a default port for SSH connection from JB GW. You can hardcore it as to ignore.

I'm not sure why built-in server port is not ignored. It seems you are waiting properly for it.

[andreafalzetti]

@andreafalzetti 5990 is a default port for SSH connection from JB GW. You can hardcore it as to ignore.

I'm not sure why built-in server port is not ignored. It seems you are waiting properly for it.

I think 6942 is also IntelliJ as I mentioned previously. There is mention of it here (not 100% sure it's the same port we are talking about tho)

Also, the backend port is 63343. It's the port that I get from BuiltInServerManager.getInstance().waitForStart().port. And I never got notification about that one.

[akosyakov]

I think 6942 is also IntelliJ as I mentioned previously. There is mention of it here (not 100% sure it's the same port we are talking about tho)

then you should also add something like to ignore it

const serverPort = StartupUtil.getServerFuture().await().port

[andreafalzetti]

I think 6942 is also IntelliJ as I mentioned previously. There is mention of it here (not 100% sure it's the same port we are talking about tho)

then you should also add something like to ignore it

const serverPort = StartupUtil.getServerFuture().await().port

Added 👍

[andreafalzetti]

/unhold