[jb] configure vmoptions for intellij backend server performance optimization

Author: yaohui-wyh

components/ide/jetbrains/image/leeway.Dockerfile

@@ -9,7 +9,6 @@ RUN apk add --no-cache --upgrade curl gzip tar unzip
 RUN curl -sSLo backend.tar.gz "$JETBRAINS_BACKEND_URL" && tar -xf backend.tar.gz --strip-components=1 && rm backend.tar.gz
 COPY --chown=33333:33333 components-ide-jetbrains-backend-plugin--plugin/build/distributions/gitpod-remote-0.0.1.zip /workdir
 RUN unzip gitpod-remote-0.0.1.zip -d plugins/ && rm gitpod-remote-0.0.1.zip
-RUN printf '\n-Dgtw.disable.exit.dialog=true\n' >> $(find /workdir/bin/ -name "*64.vmoptions")
 # enable shared indexes by default
 RUN printf '\nshared.indexes.download.auto.consent=true' >> "/workdir/bin/idea.properties"
 

components/ide/jetbrains/image/status/main.go

@@ -91,6 +91,10 @@ func main() {
 	if err != nil {
 		log.WithError(err).Error("failed to configure backend Xmx")
 	}
+	err = configureVMOptions(alias)
+	if err != nil {
+		log.WithError(err).Error("failed to configure vmoptions")
+	}
 	go run(wsInfo, alias)
 
 	http.HandleFunc("/joinLink", func(w http.ResponseWriter, r *http.Request) {
@@ -322,6 +326,35 @@ func configureXmx(alias string) error {
 	return ioutil.WriteFile(launcherPath, []byte(newContent), 0)
 }
 
+func configureVMOptions(alias string) error {
+	idePrefix := alias
+	if alias == "intellij" {
+		idePrefix = "idea"
+	}
+	// [idea64|goland64|pycharm64|phpstorm64].vmoptions
+	path := fmt.Sprintf("/ide-desktop/backend/bin/%s64.vmoptions", idePrefix)
+	content, err := ioutil.ReadFile(path)
+	if err != nil {
+		return err
+	}
+	newContent := updateVMOptions(alias, string(content))
+	return ioutil.WriteFile(path, []byte(newContent), 0)
+}
+
+func updateVMOptions(alias string, content string) string {
+	var newContent = content
+	// 1. replace -Xmx with -XX:MaxRAMPercentage (when env var set)
+	maxRAM := os.Getenv(strings.ToUpper(alias) + "_MaxRAMPercentage")
+	if maxRAM != "" {
+		re := regexp.MustCompile(`-Xmx(\d+)([MmGg])`)
+		newContent = re.ReplaceAllString(newContent, "-XX:MaxRAMPercentage="+maxRAM)
+		fmt.Println(newContent)
+	}
+	// 2. disable the exit dialog
+	newContent += "\n-Dgtw.disable.exit.dialog=true"
+	return newContent
+}
+
 /**
 {
   "buildNumber" : "221.4994.44",

components/ide/jetbrains/image/status/main_test.go

@@ -23,3 +23,29 @@ func TestGetProductConfig(t *testing.T) {
 		t.Errorf("unexpected output (-want +got):\n%s", diff)
 	}
 }
+
+func TestUpdateVMOptions(t *testing.T) {
+	tests := []struct {
+		Desc        string
+		Alias       string
+		EnvVar      map[string]string
+		Src         string
+		Expectation string
+	}{
+		{"goland64.vmoptions", "goland", nil, "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true\n-Dgtw.disable.exit.dialog=true"},
+		{"idea64.vmoptions", "intellij", nil, "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true\n-Dgtw.disable.exit.dialog=true"},
+		{"idea64.vmoptions (MaxRAMPercentage env set)", "intellij", map[string]string{"INTELLIJ_MaxRAMPercentage": "50"}, "-Xms128m\n-Xmx2048m\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-XX:MaxRAMPercentage=50\n-Dsun.tools.attach.tmp.only=true\n-Dgtw.disable.exit.dialog=true"},
+		{"idea64.vmoptions (MaxRAMPercentage env set)", "intellij", map[string]string{"INTELLIJ_MaxRAMPercentage": "75"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-XX:MaxRAMPercentage=75\n-Dsun.tools.attach.tmp.only=true\n-Dgtw.disable.exit.dialog=true"},
+	}
+	for _, test := range tests {
+		t.Run(test.Desc, func(t *testing.T) {
+			for v := range test.EnvVar {
+				t.Setenv(v, test.EnvVar[v])
+			}
+			actual := updateVMOptions(test.Alias, test.Src)
+			if diff := cmp.Diff(test.Expectation, actual); diff != "" {
+				t.Errorf("unexpected output (-want +got):\n%s", diff)
+			}
+		})
+	}
+}