Add Java debugger support #12076

marshalhayes · 2025-10-16T02:09:54Z

Description

This PR introduces Java debugger support for the VSCode extension.

This will require a corresponding change in the Community Toolkit.

cc @adamint

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire-docs issue (consider using one of the following templates):
- No

github-actions · 2025-10-16T02:10:02Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12076

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12076"

adamint · 2025-10-16T02:22:44Z

extension/src/dcp/types.ts

+export interface JavaLaunchConfiguration extends ExecutableLaunchConfiguration {
+    type: "java";
+    main_class_path?: string;
+    project_path?: string;


write a comment to explain why both are included

extension/src/debugger/languages/java.ts

Copilot

Pull Request Overview

Adds Java debugger support to the VS Code extension, enabling detection, configuration, and launch handling for Java services.

Introduces Java launch configuration types and a Java-specific debugger extension.
Adds capability detection via the Java Extension Pack and updates supported capabilities.
Provides unit tests for Java getProjectFile behavior and updates README with Java docs.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
extension/src/test/javaDebugger.test.ts	Adds unit tests covering Java getProjectFile logic, precedence, and error cases.
extension/src/debugger/languages/java.ts	Implements the Java ResourceDebuggerExtension and getProjectFile resolution.
extension/src/debugger/debuggerExtensions.ts	Registers Java debugger extension when Java capability is present.
extension/src/dcp/types.ts	Adds JavaLaunchConfiguration type and type guard.
extension/src/capabilities.ts	Adds Java capability detection and capability list entries.
extension/README.md	Documents Java debugger option and links to VS Code Java debugging docs.

Copilot · 2025-10-17T03:10:48Z

extension/src/debugger/languages/java.ts

+            }
+        }
+
+        throw new Error(invalidLaunchConfiguration(JSON.stringify(launchConfig)));


The error includes the full serialized launch configuration, which may leak sensitive values (e.g., env vars) into logs. Prefer a concise, non-sensitive message (e.g., include only the type and which required fields are missing) instead of JSON-stringifying the entire object.

Copilot · 2025-10-17T03:10:49Z

extension/src/capabilities.ts

+export function isJavaInstalled() {
+    return isExtensionInstalled("vscjava.vscode-java-pack");
+}


Detecting capability via the extension pack ID may miss users who installed only the Debugger for Java extension. Consider checking for either the debugger extension or the pack: return isExtensionInstalled('vscjava.vscode-java-debug') || isExtensionInstalled('vscjava.vscode-java-pack');

Copilot · 2025-10-17T03:10:49Z

extension/src/capabilities.ts

+    if (isJavaInstalled()) {
+        capabilities.push("java");
+        capabilities.push("vscjava.vscode-java-pack");
+    }


If you adjust detection to include the Debugger for Java extension, reflect that here by pushing the actual installed extension ID (prefer the debugger extension if present). This keeps capabilities aligned with what's installed.

Copilot · 2025-10-17T03:10:49Z

extension/README.md

 The debuggers property stores common debug configuration properties for different types of Aspire services.
 C#-based services have common debugging properties under `project`. Python-based services have their common properties under `python`.


Please include Java here for consistency with the table above. Suggest: 'Java-based services have their common properties under java.'

marshalhayes · 2025-10-18T19:22:52Z

I'll add the new getSupportedFileTypes to the debugger extension soon.

I did hit a weird issue that crashes the Java debugger on startup. It looks like something is introducing duplicate environment variables. Is it possible the Java debugger already merges the launch configuration env with process.env?

This is the stacktrace from the Language Support for Java output window:

Oct 18, 2025 2:20:25 PM com.microsoft.java.debug.core.adapter.handler.LaunchRequestHandler constructEnvironmentVariables
WARNING: There are duplicated environment variables. The values specified in launch.json will be used. Here are the duplicated entries: ALLUSERSPROFILE,ANDROID_HOME,APPDATA,APPLICATION_INSIGHTS_NO_STATSBEAT,CHROME_CRASHPAD_PIPE_NAME,CommonPropertyBagPath,CommonPropertyBagWithConfigPath,COMPUTERNAME,ComSpec,CommonProgramFiles,CommonProgramFiles(x86),CommonProgramW6432,DOTNET_ROOT,DriverData,EFC_9208_1592913036,ELECTRON_RUN_AS_NODE,FPS_BROWSER_APP_PROFILE_STRING,FPS_BROWSER_USER_PROFILE_STRING,HOMEDRIVE,HOMEPATH,JAVA_HOME,LOCALAPPDATA,LOGONSERVER,NUGET_PACKAGES,NUMBER_OF_PROCESSORS,NVM_HOME,NVM_SYMLINK,ORIGINAL_XDG_CURRENT_DESKTOP,OS,OneDrive,OneDriveConsumer,PATHEXT,POWERSHELL_DISTRIBUTION_CHANNEL,PROCESSOR_ARCHITECTURE,PROCESSOR_IDENTIFIER,PROCESSOR_LEVEL,PROCESSOR_REVISION,PSModulePath,PUBLIC,Path,ProgramData,ProgramFiles,ProgramFiles(x86),ProgramW6432,SESSIONNAME,SystemDrive,SystemRoot,TEMP,TMP,USERDOMAIN,USERDOMAIN_ROAMINGPROFILE,USERNAME,USERPROFILE,VSCODE_CRASH_REPORTER_PROCESS_TYPE,VSCODE_CWD,VSCODE_DOTNET_INSTALL_TOOL_ORIGINAL_HOME,VSCODE_ESM_ENTRYPOINT,VSCODE_HANDLES_UNCAUGHT_ERRORS,VSCODE_IPC_HOOK,VSCODE_NLS_CONFIG,VSCODE_PID,ZES_ENABLE_SYSMAN,windir.
[Error - 2:20:25 PM] Oct 18, 2025, 2:20:25 PM [error response][launch]: Failed to launch debuggee VM. Reason: VM exited with status 1
Failed to launch debuggee VM. Reason: VM exited with status 1
com.microsoft.java.debug.core.DebugException: Failed to launch debuggee VM. Reason: VM exited with status 1
	at com.microsoft.java.debug.core.adapter.handler.LaunchRequestHandler.launch(LaunchRequestHandler.java:326)
	at com.microsoft.java.debug.core.adapter.handler.LaunchRequestHandler.handleLaunchCommand(LaunchRequestHandler.java:193)
	at com.microsoft.java.debug.core.adapter.handler.LaunchRequestHandler.handle(LaunchRequestHandler.java:95)
	at com.microsoft.java.debug.core.adapter.DebugAdapter.lambda$dispatchRequest$0(DebugAdapter.java:94)
	at java.base/java.util.concurrent.CompletableFuture.uniComposeStage(Unknown Source)
	at java.base/java.util.concurrent.CompletableFuture.thenCompose(Unknown Source)
	at com.microsoft.java.debug.core.adapter.DebugAdapter.dispatchRequest(DebugAdapter.java:93)
	at com.microsoft.java.debug.core.adapter.ProtocolServer.dispatchRequest(ProtocolServer.java:132)
	at com.microsoft.java.debug.core.protocol.AbstractProtocolServer.lambda$new$0(AbstractProtocolServer.java:81)
	at io.reactivex.internal.observers.LambdaObserver.onNext(LambdaObserver.java:63)
	at io.reactivex.internal.operators.observable.ObservableObserveOn$ObserveOnObserver.drainNormal(ObservableObserveOn.java:201)
	at io.reactivex.internal.operators.observable.ObservableObserveOn$ObserveOnObserver.run(ObservableObserveOn.java:255)
	at io.reactivex.internal.schedulers.ScheduledRunnable.run(ScheduledRunnable.java:66)
	at io.reactivex.internal.schedulers.ScheduledRunnable.call(ScheduledRunnable.java:57)
	at java.base/java.util.concurrent.FutureTask.run(Unknown Source)
	at java.base/java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(Unknown Source)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(Unknown Source)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source)
	at java.base/java.lang.Thread.run(Unknown Source)

adamint · 2025-10-18T22:27:17Z

You should place a breakpoint right before calling viscode.debug.startDebugging to see the contents of the env property. That may be a good place to start

Start Java debug extension support

e55e8be

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Oct 16, 2025

adamint assigned marshalhayes Oct 16, 2025

adamint added the area-extension label Oct 16, 2025

adamint reviewed Oct 16, 2025

View reviewed changes

extension/src/debugger/languages/java.ts Outdated Show resolved Hide resolved

marshalhayes mentioned this pull request Oct 16, 2025

Add VSCode debugger support for executable Java apps CommunityToolkit/Aspire#904

Open

10 tasks

marshalhayes added 4 commits October 16, 2025 20:32

Fallback to project_path if main_class_path is not provided

09a787e

Add basic tests for Java debugger extension

13c00b5

Add Java to README.md, and include links to debugger extension docs

68668ab

Merge branch 'dotnet:main' into vscode-extension/java

8a9369f

marshalhayes marked this pull request as ready for review October 17, 2025 03:09

Copilot AI review requested due to automatic review settings October 17, 2025 03:09

Copilot AI reviewed Oct 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Java debugger support #12076

Add Java debugger support #12076

marshalhayes commented Oct 16, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 16, 2025 •

edited

Loading

Uh oh!

adamint Oct 16, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

Copilot AI Oct 17, 2025

Uh oh!

marshalhayes commented Oct 18, 2025

Uh oh!

adamint commented Oct 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		The debuggers property stores common debug configuration properties for different types of Aspire services.
		C#-based services have common debugging properties under `project`. Python-based services have their common properties under `python`.

Add Java debugger support #12076

Are you sure you want to change the base?

Add Java debugger support #12076

Conversation

marshalhayes commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

github-actions bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adamint Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

marshalhayes commented Oct 18, 2025

Uh oh!

adamint commented Oct 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

marshalhayes commented Oct 16, 2025 •

edited

Loading

github-actions bot commented Oct 16, 2025 •

edited

Loading