[jb] check maxHeapSize of IDE server and guide users to set vmoptions in .gitpod.yml #11002

yaohui-wyh · 2022-06-29T11:16:57Z

Description

An idea is to detect a user change to the actual max heap size in the backend plugin and suggest a user to put in .gitpod.yml to persist. So the flow would be like:

a user starts using with default Xmx

experience perf issues and follow notifications to upgrade Xmx of the running instance

after JB backend restart there will be a warning on .gitpod.yml that Xmx of the running instance was changed, but it should be applied to .gitpod.yml to be persistent

Also check out #10768 for more background info

This PR implements Xmx config checks in JetBrains gitpod-remote plugin:

Register a background activity (GitpodStartupActivity) for handling postStart events
Add YAML plugin dependency for parsing & navigating PSI elements in .gitpod.yml
Show warning notification when the runtime Xmx is different from the configured Xmx
- Add edit/create-if-missing .gitpod.yml actions, and navigate caret to vmoptions YAML key if exists
- Add help action for browsing gitpod.yml references
Set jvmArgs for the runIde task (only affect local sandbox IDE instance with the developed plugin), which can be modified for local testing purpose

Related Issue(s)

Resolve #10924

How to test

Test locally:

Run runIde task from IntelliJ plugin, and modify jvmArgs = listOf("-Xmx4g") to simulate the user's change to the -Xmx of JetBrains IDE server inside a Gitpod workspace. When sandbox IDE instance is started, a warning Notification should popup, indicating current runtime maxHeapSize is different with default/configured vmoptions from .gitpod.yml. Click on "Edit .gitpod.yml" would open the file in the editor
If there is no .gitpod.yml in the project root, the notification popup would suggest the user to create a .gitpod.yml with generated content (with the current runtime Xmx configured)

Release Notes

- Detect user changes to the max heap size of IDE server when using JetBrains Gateway, and suggest a user to put in .gitpod.yml to persist.

Documentation

Werft options:

/werft with-preview

… in .gitpod.yml - Register a background activity (GitpodStartupActivity) for handling postStart events - Add YAML plugin dependency for parsing & navigating PSI elements (AST) in .gitpod.yml - Show warning notification when the runtime Xmx is different from the configured Xmx - Add edit/create-if-missing .gitpod.yml quick actions, and navigate caret to `vmoptions` YAML key if exists - Add help action for browsing gitpod.yml references - Set -Xmx for the `runIde` task (only affect local sandbox IDE instance with the developed plugin), which can be modified for local testing purpose

akosyakov · 2022-06-29T11:37:54Z

/werft run

👍 started the job as gitpod-build-yh-backend-plugin-fork.0
(with .werft/ from main)

werft-gitpod-dev-com · 2022-06-29T11:37:58Z

started the job as gitpod-build-yh-backend-plugin.0 because the annotations in the pull request description changed
(with .werft/ from main)

akosyakov · 2022-06-29T11:50:02Z

...jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodStartupActivity.kt

+        return YAMLUtil.getQualifiedKeyInFile(psiFile, jetbrains, productName, vmOptions)
+    }
+
+    private fun showEditVMOptionsNotification(project: Project, runtimeXmxMiB: Long, configXmxMiB: Long, productName: String) {


I don't think we need notificaiotns. They are too loud. Can we use inspections instead? https://plugins.jetbrains.com/docs/intellij/code-inspections.html

akosyakov · 2022-06-29T11:52:19Z

...jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodStartupActivity.kt

+import org.jetbrains.yaml.psi.YAMLKeyValue
+import java.nio.file.Paths
+
+class GitpodStartupActivity : StartupActivity.Background {


We should perform validation whenever content of .gitpod.yml is changing even if dirty. Not only once. Should not it be rather local inspection?

akosyakov · 2022-06-29T11:54:27Z

...jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodStartupActivity.kt

+            OpenFileAction.openFile(gitpodYaml, project)
+            val vmOptionsKeyValue = getGitpodYamlVMOptionsPsiElement(project, gitpodYaml, productName)
+            // navigate caret to "vmoptions" if exist
+            vmOptionsKeyValue?.navigate(true)


Cannot we automatically update it, instead of asking a user to edit?

akosyakov

I think warning should not be notifications, but dynamically update inspections. And there should be automatic quick fixes.

akosyakov · 2022-06-29T11:57:06Z

...de/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/utils/GitpodConfig.kt

+object GitpodConfig {
+
+    const val gitpodYamlFile = ".gitpod.yml"
+    const val defaultXmxOption = "-Xmx2048m"


I think we need to provide as env var from go status endpoint where we set it.

akosyakov · 2022-06-29T12:05:52Z

...jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/GitpodStartupActivity.kt

+        val notificationGroup = NotificationGroupManager.getInstance().getNotificationGroup("Gitpod Notifications")
+        val title = "Gitpod memory settings"
+        val message = """
+            |Current maxHeapSize <code>-Xmx${runtimeXmxMiB}m</code> is not matched to configured <code>-Xmx${configXmxMiB}m</code>.<br/>


There should be a warning inspection:
IDE's max heap size (-Xmx) is {runtimeValue}M, but not configured in .gitpod.yml - if it is missing in .gitpod.yml
IDE's max heap size (-Xmx) is {runtimeValue}M, but {configuredXmx}M in .gitpod.yml - if it is defined in .gitpod.yml

There should be quick fixes:

Add -Xmx{runtimeValue}M to .gitpod.yml (both cases) - It should automatically create .gitpod.yml if necessary and sections or update vmoptions string

Apply default -Xmx{defaultValue} (if not in .gitpod.yml) - it should apply default value using VMOptions api

Apply -Xmx{defaultValue} configured in .gitpod.yml (if not in .gitpod.yml) - it should apply configured value using VMOptions api

yaohui-wyh · 2022-06-29T13:26:44Z

Hi @akosyakov, thanks for the quick reply. About the notification part:

I do understand the Notification is a bit noisy and interrupting, so I was trying to make it a post-start activity once only. Inspection on .gitpod.yml might not fit into the memory settings scenario with:

Suppose a user experience perf issues and upgrade Xmx of the running instance (e.g. from the control center window of JBClient).
After JB backend restart the IDE would reopen the recent files of the project and the user continued on their work, and is unlikely to open (maybe also unaware of) the .gitpod.yml until they stop the workspace.
Due to the immutable nature of vmoptions, when they open the same project in a new Gitpod workspace they will encounter the perf issue again.
Inspections on .gitpod.yml cannot help users familiarize themselves with how to persist the vmoptions settings.

JetBrains IDEs also use Warning Notification & Dialog for low memory warning & settings:

yaohui-wyh · 2022-06-29T13:33:09Z

In short, I totally understand your points and agree with the necessity of Inspection & quickfix. IMHO, Inspection & quickfix features are more about adding Code IntelliSense to gitpod.yml schema (which I think is also nice to have). However, I was trying to solve the problem raised by the user story of #10924 (i.e. trying to help users to "gitpodify" a persistent IDE's memory setting with project-wide .gitpod.yml), which I might just understand it literally 😿

akosyakov · 2022-06-29T13:42:47Z

Can we run subset automatically on startup? Then a user should have a yellow warning sign in problems view at the bottom. I think having good diagnostics and automatic quick fixes which goes in both directions should be a starting point. If we see that it does not help we can be more noisy. Even if we go with the notification I would prefer automatically update .gitpod.yml instead of asking user to read something.

yaohui-wyh · 2022-06-29T15:42:30Z

think having good diagnostics and automatic quick fixes which goes in both directions should be a starting point. If we see that it does not help we can be more noisy. ...

Agree with this. I will try adding local inspection and quick fix intention on .gitpod.yml

yaohui-wyh · 2022-07-01T17:33:07Z

Thanks @akosyakov for the review, I will open a new PR that implements inspections & quickfixes. I will keep this one opened as Draft for a while, in case some discussions need context 🙏

stale · 2022-07-12T00:10:40Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

yaohui-wyh requested a review from a team June 29, 2022 11:16

roboquat added release-note size/L labels Jun 29, 2022

yaohui-wyh force-pushed the yh/backend-plugin branch from 25dc0b7 to e43e7bc Compare June 29, 2022 11:24

akosyakov reviewed Jun 29, 2022

View reviewed changes

yaohui-wyh marked this pull request as draft June 29, 2022 15:44

roboquat added the do-not-merge/work-in-progress label Jun 29, 2022

yaohui-wyh mentioned this pull request Jul 1, 2022

[jb] add inspections & quickfixes on .gitpod.yml vmoptions config #11089

Open

1 task

stale bot added the meta: stale This issue/PR is stale and will be closed soon label Jul 12, 2022

yaohui-wyh closed this Jul 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[jb] check maxHeapSize of IDE server and guide users to set vmoptions in .gitpod.yml #11002

[jb] check maxHeapSize of IDE server and guide users to set vmoptions in .gitpod.yml #11002

yaohui-wyh commented Jun 29, 2022 •

edited by akosyakov

Loading

akosyakov commented Jun 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

werft-gitpod-dev-com bot commented Jun 29, 2022

akosyakov Jun 29, 2022

akosyakov Jun 29, 2022

akosyakov Jun 29, 2022

akosyakov left a comment

akosyakov Jun 29, 2022

akosyakov Jun 29, 2022

yaohui-wyh commented Jun 29, 2022

yaohui-wyh commented Jun 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 29, 2022

yaohui-wyh commented Jun 29, 2022

yaohui-wyh commented Jul 1, 2022 •

edited by werft-gitpod-dev-com bot

Loading

stale bot commented Jul 12, 2022

[jb] check maxHeapSize of IDE server and guide users to set vmoptions in .gitpod.yml #11002

[jb] check maxHeapSize of IDE server and guide users to set vmoptions in .gitpod.yml #11002

Conversation

yaohui-wyh commented Jun 29, 2022 • edited by akosyakov Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

akosyakov commented Jun 29, 2022 • edited by werft-gitpod-dev-com bot Loading

werft-gitpod-dev-com bot commented Jun 29, 2022

akosyakov Jun 29, 2022

Choose a reason for hiding this comment

akosyakov Jun 29, 2022

Choose a reason for hiding this comment

akosyakov Jun 29, 2022

Choose a reason for hiding this comment

akosyakov left a comment

Choose a reason for hiding this comment

akosyakov Jun 29, 2022

Choose a reason for hiding this comment

akosyakov Jun 29, 2022

Choose a reason for hiding this comment

yaohui-wyh commented Jun 29, 2022

yaohui-wyh commented Jun 29, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jun 29, 2022

yaohui-wyh commented Jun 29, 2022

yaohui-wyh commented Jul 1, 2022 • edited by werft-gitpod-dev-com bot Loading

stale bot commented Jul 12, 2022

yaohui-wyh commented Jun 29, 2022 •

edited by akosyakov

Loading

akosyakov commented Jun 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

yaohui-wyh commented Jun 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

yaohui-wyh commented Jul 1, 2022 •

edited by werft-gitpod-dev-com bot

Loading