[JetBrains] Show notification when port becomes available 🔔 #10107

andreafalzetti · 2022-05-18T16:22:54Z

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

Start a workspace using the following link: https://afalz-9908c5dfc24116.staging.gitpod-dev.com/#https://github.com/andreafalzetti/gitpod-experiments-b
Choose a JetBrains product as your preferred editor
Notice a prompt to open the browser on port 8080
Notice a notification for port 8081 being available
Notice a notification for port 8083 being available (set to be notify in .gitpod.yml)
Port 8082 should not trigger a notification (set to be ignored in .gitpod.yml)
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

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

andreafalzetti · 2022-05-27T02:40:39Z

...ckend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodClientProjectSessionTracker.kt

+        p.url = port.exposed.url
+
+        try {
+            manager.client.server.openPort(workspaceId, p).await()


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

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

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

akosyakov · 2022-05-27T07:05:33Z

@andreafalzetti I see these ports too:

...ckend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodClientProjectSessionTracker.kt

akosyakov · 2022-05-27T07:13:56Z

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 · 2022-05-27T14:48:59Z

@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 · 2022-05-27T18:27:05Z

@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 · 2022-05-28T03:51:08Z

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 · 2022-05-30T20:18:39Z

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 · 2022-05-30T21:07:14Z

/unhold

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/M labels May 18, 2022

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch 11 times, most recently from 87e97e5 to 0949310 Compare May 24, 2022 16:50

roboquat added size/L and removed size/M labels May 24, 2022

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch 2 times, most recently from 20a346f to d1b64dc Compare May 24, 2022 20:20

andreafalzetti commented May 24, 2022

View reviewed changes

...nts/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodManager.kt Outdated Show resolved Hide resolved

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch 5 times, most recently from 57e3dee to d790f82 Compare May 25, 2022 15:00

akosyakov added the team: IDE label May 25, 2022

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch from d790f82 to 66bafa0 Compare May 25, 2022 20:27

roboquat added release-note and removed do-not-merge/release-note-label-needed labels May 25, 2022

andreafalzetti changed the title ~~[WIP] [JetBrains] Observe ports status and send notification~~ [WIP] [JetBrains] Show notification when port becomes available 🔔 May 25, 2022

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch from 66bafa0 to cf6cf73 Compare May 25, 2022 21:45

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch from 5ab5547 to 7a10c72 Compare May 26, 2022 14:10

andreafalzetti marked this pull request as draft May 26, 2022 17:15

roboquat added the do-not-merge/work-in-progress label May 26, 2022

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch 3 times, most recently from 8426b15 to 2221755 Compare May 27, 2022 02:31

andreafalzetti commented May 27, 2022

View reviewed changes

andreafalzetti marked this pull request as ready for review May 27, 2022 03:00

roboquat removed the do-not-merge/work-in-progress label May 27, 2022

akosyakov reviewed May 27, 2022

View reviewed changes

...ckend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodClientProjectSessionTracker.kt Outdated Show resolved Hide resolved

akosyakov approved these changes May 27, 2022

View reviewed changes

roboquat added the do-not-merge/hold label May 27, 2022

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch from 2221755 to 1e84823 Compare May 27, 2022 18:36

loujaybee requested a review from a team May 30, 2022 09:30

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch 2 times, most recently from db680a3 to 96bb30d Compare May 30, 2022 19:35

feat(jb): observe ports status and send notification

406ebf8

andreafalzetti force-pushed the afalz/9908-jb-port-notifications branch from 96bb30d to 406ebf8 Compare May 30, 2022 20:32

roboquat removed the do-not-merge/hold label May 30, 2022

roboquat merged commit 8f5f7b6 into main May 30, 2022

roboquat deleted the afalz/9908-jb-port-notifications branch May 30, 2022 21:07

roboquat added deployed: IDE IDE change is running in production deployed Change is completely running in production labels May 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JetBrains] Show notification when port becomes available 🔔 #10107

[JetBrains] Show notification when port becomes available 🔔 #10107

andreafalzetti commented May 18, 2022 •

edited

Loading

andreafalzetti May 27, 2022 •

edited

Loading

akosyakov May 27, 2022

andreafalzetti May 27, 2022

akosyakov commented May 27, 2022 •

edited

Loading

akosyakov commented May 27, 2022 •

edited

Loading

akosyakov left a comment

akosyakov commented May 27, 2022

andreafalzetti commented May 27, 2022 •

edited

Loading

akosyakov commented May 28, 2022 •

edited

Loading

andreafalzetti commented May 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

andreafalzetti commented May 30, 2022

[JetBrains] Show notification when port becomes available 🔔 #10107

[JetBrains] Show notification when port becomes available 🔔 #10107

Conversation

andreafalzetti commented May 18, 2022 • edited Loading

Description

Context

Approach

Related Issue(s)

How to test

Release Notes

Documentation

andreafalzetti May 27, 2022 • edited Loading

Choose a reason for hiding this comment

akosyakov May 27, 2022

Choose a reason for hiding this comment

andreafalzetti May 27, 2022

Choose a reason for hiding this comment

akosyakov commented May 27, 2022 • edited Loading

akosyakov commented May 27, 2022 • edited Loading

akosyakov left a comment

Choose a reason for hiding this comment

akosyakov commented May 27, 2022

andreafalzetti commented May 27, 2022 • edited Loading

akosyakov commented May 28, 2022 • edited Loading

andreafalzetti commented May 30, 2022 • edited by werft-gitpod-dev-com bot Loading

andreafalzetti commented May 30, 2022

andreafalzetti commented May 18, 2022 •

edited

Loading

andreafalzetti May 27, 2022 •

edited

Loading

akosyakov commented May 27, 2022 •

edited

Loading

akosyakov commented May 27, 2022 •

edited

Loading

andreafalzetti commented May 27, 2022 •

edited

Loading

akosyakov commented May 28, 2022 •

edited

Loading

andreafalzetti commented May 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading