added Notebook congif tests for vm options, updated description label for vm options, updated config values flow so that they are set to default if nothing is sent by lsp client

Achal1607 · Achal1607 · commit 446711ce0dd3 · 2026-01-28T12:17:48.000+05:30
diff --git a/nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/NotebookConfigs.java b/nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/NotebookConfigs.java
@@ -19,12 +19,14 @@
 import com.google.gson.JsonObject;
 import java.io.File;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import org.eclipse.lsp4j.ConfigurationItem;
 import org.eclipse.lsp4j.ConfigurationParams;
+import org.netbeans.api.annotations.common.NonNull;
 import org.netbeans.modules.java.lsp.server.protocol.NbCodeLanguageClient;
 
 /**
@@ -46,7 +48,7 @@ public class NotebookConfigs {
     private volatile String addModules = null;
     private volatile boolean enablePreview = false;
     private volatile JsonObject notebookProjectMapping = new JsonObject();
-    private volatile List<String> notebookVmOptions = new ArrayList<>();
+    private volatile List<String> notebookVmOptions = Collections.emptyList();
     private volatile List<String> implicitImports = null;
     private volatile CompletableFuture<Void> initialized;
 
@@ -77,7 +79,8 @@ public List<String> getImplicitImports() {
     public JsonObject getNotebookProjectMapping() {
         return notebookProjectMapping;
     }
-
+    
+    @NonNull
     public List<String> getNotebookVmOptions() {
         return notebookVmOptions;
     }
@@ -125,36 +128,50 @@ private CompletableFuture<Void> initializeConfigs() {
                     JsonArray classPathConfig = NotebookUtils.getArgument(c, 0, JsonArray.class);
                     if (classPathConfig != null) {
                         classPath = String.join(File.pathSeparator,classPathConfig.asList().stream().map((elem) -> elem.getAsString()).toList());
+                    } else {
+                        classPath = null;
                     }
                     
                     JsonArray modulePathConfig = NotebookUtils.getArgument(c, 1, JsonArray.class);
                     if (modulePathConfig != null) {
                         modulePath = String.join(File.pathSeparator,modulePathConfig.asList().stream().map((elem) -> elem.getAsString()).toList());
+                    } else {
+                        modulePath = null;
                     }
                     
                     JsonArray addModulesConfig = NotebookUtils.getArgument(c, 2, JsonArray.class);
                     if (addModulesConfig != null) {
                         addModules = String.join(",",addModulesConfig.asList().stream().map((elem) -> elem.getAsString()).toList());
+                    } else {
+                        addModules = null;
                     }
                     
                     Boolean enablePreviewConfig = NotebookUtils.getArgument(c, 3, Boolean.class);
                     if (enablePreviewConfig != null) {
                         enablePreview = enablePreviewConfig;
+                    } else {
+                        enablePreview = false;
                     }
                     
                     JsonArray implicitImportsConfig = NotebookUtils.getArgument(c, 4, JsonArray.class);
                     if (implicitImportsConfig != null) {
                         implicitImports = implicitImportsConfig.asList().stream().map((elem) -> elem.getAsString()).toList();
+                    } else {
+                        implicitImports = null;
                     }
 
                     JsonObject notebookProjectMappingConfig = NotebookUtils.getArgument(c, 5, JsonObject.class);
                     if (notebookProjectMappingConfig != null) {
                         notebookProjectMapping = notebookProjectMappingConfig;
+                    } else {
+                        notebookProjectMapping = new JsonObject();
                     }
                     
                     JsonArray notebookVmOptionsConfig = NotebookUtils.getArgument(c, 6, JsonArray.class);
                     if (notebookVmOptionsConfig != null) {
                         notebookVmOptions = notebookVmOptionsConfig.asList().stream().map(el -> el.getAsString()).toList();
+                    } else {
+                        notebookVmOptions = Collections.emptyList();
                     }
                 }
             });
diff --git a/nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/NotebookSessionManager.java b/nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/NotebookSessionManager.java
@@ -94,15 +94,14 @@ private JShell jshellBuildWithProject(String notebookUri, Project prj, JshellStr
         List<String> compilerOptions = getCompilerOptions(prj);
         List<String> remoteOptions = getRemoteVmOptions(prj);
         setSystemPropertiesForRemoteVm(remoteOptions, notebookUri);
-        
         JShell.Builder builder = JShell.builder()
                 .out(streamsHandler.getPrintOutStream())
                 .err(streamsHandler.getPrintErrStream())
                 .in(streamsHandler.getInputStream());
 
-        LOG.log(Level.INFO, "Initializing Notebook kernel for {0}", notebookUri);
-        LOG.log(Level.INFO, "Compiler options being passed: {0}", compilerOptions.toString());
-        LOG.log(Level.INFO, "VM Options being passed to notebook kernel: {0}", remoteOptions.toString());
+        LOG.log(Level.FINE, "Initializing Notebook kernel for {0}", notebookUri);
+        LOG.log(Level.FINE, "Compiler options being passed: {0}", compilerOptions);
+        LOG.log(Level.FINE, "VM Options being passed to notebook kernel: {0}", remoteOptions);
         if (!compilerOptions.isEmpty()) {
             builder.compilerOptions(compilerOptions.toArray(new String[0]))
                     .remoteVMOptions(remoteOptions.toArray(new String[0]));
diff --git a/nbcode/notebooks/test/unit/src/org/netbeans/modules/nbcode/java/notebook/NotebookConfigsTest.java b/nbcode/notebooks/test/unit/src/org/netbeans/modules/nbcode/java/notebook/NotebookConfigsTest.java
@@ -18,6 +18,7 @@
 
 import com.google.gson.JsonObject;
 import com.google.gson.JsonArray;
+import com.google.gson.JsonElement;
 import com.google.gson.JsonPrimitive;
 import java.io.File;
 import java.util.ArrayList;
@@ -193,7 +194,47 @@ public void testGetNotebookVmOptions() {
            fail("Configuration initialization failed");
        }
    }
+   
+    /**
+     * Test of getNotebookVmOptions method when the configuration key is
+     * missing. Verifies that the system handles a null/missing key gracefully
+     * (likely returning an empty list).
+     */
+    @Test
+    public void testGetNotebookVmOptionsWhenMissing() {
+        try {
+            updateConfigValue(VM_OPTIONS_KEY, null);
+            List<String> result = instance.getNotebookVmOptions();
+            assertNotNull("Result should not be null even if key is missing", result);
+            assertTrue("Result should be empty when key is missing", result.isEmpty());
 
+        } catch (Exception ex) {
+            fail("Failed to handle missing VM_OPTIONS_KEY: " + ex.getMessage());
+        }
+    }
+    
+    /**
+     * Test of getNotebookVmOptions with quoted spaces.
+     * Verifies that options containing spaces (like directory paths) are preserved.
+     */
+    @Test
+    public void testGetNotebookVmOptionsWithQuotedSpaces() {
+        try {
+            String quotedOption = "\"-Djava.io.tmpdir=C:\\Temp Folder\\java\"";
+
+            JsonArray vmOptions = new JsonArray();
+            vmOptions.add(new JsonPrimitive(quotedOption));
+            updateConfigValue(VM_OPTIONS_KEY, vmOptions);
+            List<String> result = instance.getNotebookVmOptions();
+            
+            assertTrue("Result should contain the quoted option", result.contains(quotedOption));
+            assertEquals("Should have exactly 1 option", 1, result.size());
+            
+        } catch (Exception ex) {
+            fail("Configuration with quoted spaces failed");
+        }
+    }
+    
     private void setConfigObject() {
         JsonArray imports = new JsonArray();
         imports.add(new JsonPrimitive("java.math.*"));
@@ -222,6 +263,12 @@ private void setConfigObject() {
         configsObj.add(VM_OPTIONS_KEY, vmOptions);
 
     }
+    
+    private void updateConfigValue(String key, JsonElement value){
+        configsObj.add(key, value);
+        instance.initConfigs(); 
+        instance.getInitialized();
+    }
 
     private class MockNbClientConfigs extends MockNbClient {
 
diff --git a/vscode/package.json b/vscode/package.json
@@ -300,6 +300,11 @@
 					"default": {},
 					"description": "%jdk.notebook.projects.mapping.description%"
 				},
+				"jdk.notebook.vmOptions": {
+					"type": "array",
+					"default": [],
+					"description": "%jdk.notebook.vmOptions.description%"
+				},
 				"jdk.telemetry.enabled": {
 					"type": "boolean",
 					"description": "%jdk.configuration.telemetry.enabled.description%",
@@ -331,11 +336,6 @@
 							"%jdk.configuration.inlay.enabled.enum.var.markdownDescription%"
 						]
 					}
-				},
-				"jdk.notebook.vmOptions": {
-					"description": "%jdk.configuration.notebook.vmOptions.description%",
-					"type": "array",
-					"default": []
 				}
 			}
 		},
diff --git a/vscode/package.nls.ja.json b/vscode/package.nls.ja.json
@@ -78,7 +78,7 @@
     "jdk.notebook.implicitImports.description": "Javaノートブックで暗黙的にインポートする要素のリスト。空のときのデフォルトはjava.util、java.ioおよびjava.mathパッケージのスター・インポート。",
     "jdk.notebook.implicitImports.markdownDescription": "Javaノートブックで暗黙的にインポートする要素のリスト。空のときのデフォルトは`java.util`、`java.io`および`java.math`パッケージのスター・インポート。",
     "jdk.notebook.projects.mapping.description": "Javaノートブック・パスの、コンテキストを提供するプロジェクトのパスへのマッピング。",
-    "jdk.configuration.notebook.vmOptions.description": "The specific JVM options for use in Java notebooks. These options are added in addition to the project configuration, including class-path, module-path, preview features, and added modules.",
+    "jdk.configuration.notebook.vmOptions.description": "The specific Java VM options for use in Java notebooks. These options are added in addition to the project configuration, including class-path, module-path, preview features, and added modules.",
     "jdk.configuration.java.completion.commit.chars": "コード補完の提案の受入れをトリガーする文字を指定します。たとえば、ピリオド(.)を入力したときに提案を受け入れるには、これを[\".\"]に設定します",
     "jdk.initialConfigurations.launchJavaApp.name": "Javaアプリケーションの起動",
     "jdk.configurationSnippets.name": "Javaアプリケーションの起動",
diff --git a/vscode/package.nls.json b/vscode/package.nls.json
@@ -78,7 +78,7 @@
     "jdk.notebook.implicitImports.description": "List of elements to implicitly import in Java notebooks. Defaults to star-imports of java.util, java.io and java.math packages, when empty.",
     "jdk.notebook.implicitImports.markdownDescription": "List of elements to implicitly import in Java notebooks. Defaults to star-imports of `java.util`, `java.io` and `java.math` packages, when empty.",
     "jdk.notebook.projects.mapping.description": "Mapping of Java notebook paths to the path of the project that provides it context.",
-    "jdk.configuration.notebook.vmOptions.description": "The specific JVM options for use in Java notebooks. These options are added in addition to the project configuration, including class-path, module-path, preview features, and added modules.",
+    "jdk.configuration.notebook.vmOptions.description": "The specific Java VM options for use in Java notebooks. These options are added in addition to the project configuration, including class-path, module-path, preview features, and added modules.",
     "jdk.configuration.java.completion.commit.chars": "Specifies the characters that trigger accepting a code completion suggestion. For example, to accept suggestions when typing a dot (.), set this to [\".\"]",
     "jdk.initialConfigurations.launchJavaApp.name": "Launch Java App",
     "jdk.configurationSnippets.name": "Launch Java App",
diff --git a/vscode/package.nls.zh-cn.json b/vscode/package.nls.zh-cn.json
@@ -78,7 +78,7 @@
     "jdk.notebook.implicitImports.description": "要在 Java 记事本中隐式导入的元素列表。为空时，默认为 java.util、java.io 和 java.math 程序包的星型导入。",
     "jdk.notebook.implicitImports.markdownDescription": "要在 Java 记事本中隐式导入的元素列表。为空时，默认为 `java.util`、`java.io` 和 `java.math` 程序包的星型导入。",
     "jdk.notebook.projects.mapping.description": "将 Java 记事本路径映射到提供记事本上下文的项目的路径。",
-    "jdk.configuration.notebook.vmOptions.description": "The specific JVM options for use in Java notebooks. These options are added in addition to the project configuration, including class-path, module-path, preview features, and added modules.",
+    "jdk.configuration.notebook.vmOptions.description": "The specific Java VM options for use in Java notebooks. These options are added in addition to the project configuration, including class-path, module-path, preview features, and added modules.",
     "jdk.configuration.java.completion.commit.chars": "指定用于触发接受代码补全建议的字符。例如，要在键入点 (.) 时接受建议，请将该字符设为 [\".\"]",
     "jdk.initialConfigurations.launchJavaApp.name": "启动 Java 应用程序",
     "jdk.configurationSnippets.name": "启动 Java 应用程序",
diff --git a/vscode/src/configurations/configuration.ts b/vscode/src/configurations/configuration.ts
@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2023-2024, Oracle and/or its affiliates.
+  Copyright (c) 2023-2026, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -36,9 +36,9 @@ export const configKeys = {
     notebookAddModules: "notebook.addmodules",
     notebookEnablePreview: "notebook.enablePreview",
     notebookImplicitImports: "notebook.implicitImports",
-    telemetryEnabled: 'telemetry.enabled',
     notebookProjectMapping: "notebook.projects.mapping",
-    notebookVmOptions: "notebook.vmOptions"
+    notebookVmOptions: "notebook.vmOptions",
+    telemetryEnabled: 'telemetry.enabled'
 };
 
 export const builtInConfigKeys = {

Original file line number	Diff line number	Diff line change
`@@ -300,6 +300,11 @@`
`300`	`300`	`"default": {},`
`301`	`301`	`"description": "%jdk.notebook.projects.mapping.description%"`
`302`	`302`	`},`
	`303`	`+ "jdk.notebook.vmOptions": {`
	`304`	`+ "type": "array",`
	`305`	`+ "default": [],`
	`306`	`+ "description": "%jdk.notebook.vmOptions.description%"`
	`307`	`+ },`
`303`	`308`	`"jdk.telemetry.enabled": {`
`304`	`309`	`"type": "boolean",`
`305`	`310`	`"description": "%jdk.configuration.telemetry.enabled.description%",`
`@@ -331,11 +336,6 @@`
`331`	`336`	`"%jdk.configuration.inlay.enabled.enum.var.markdownDescription%"`
`332`	`337`	`]`
`333`	`338`	`}`
`334`		`- },`
`335`		`- "jdk.notebook.vmOptions": {`
`336`		`- "description": "%jdk.configuration.notebook.vmOptions.description%",`
`337`		`- "type": "array",`
`338`		`- "default": []`
`339`	`339`	`}`
`340`	`340`	`}`
`341`	`341`	`},`