Escape does not cancel a launch that uses command:SpecifyProgramArgs

[sbj42]

When launching a Java program with ${command:SpecifyProgramArgs}, the popup says that I can press 'Escape' to cancel, but it runs anyway.

Environment

• Operating System: Windows 11
• JDK version: 17.0.4.1
• Visual Studio Code version: 1.86.2
• Java extension version: 1.28.1
• Java Debugger extension version: 17.0.4.1

Steps To Reproduce

1. Open the repo https://github.com/sbj42/vscode-specifyprogramargs
2. Open Test.java and press F5.
3. Pop-up appears with "Press 'Enter' to confirm your input or 'Escape' to cancel".
4. Press Escape.
5. Terminal appears and runs the test program with no arguments.

See repo above, but you only need these two files:

Test.java:

public class Test {
    public static void main(String[] args) {
        System.out.println("args: " + String.join(" ", args));
    }
}

.vscode/launch.json:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Launch with Arguments Prompt",
            "request": "launch",
            "mainClass": "",
            "args": "${command:SpecifyProgramArgs}"
        }
    ]
}

Verbose output log from "Language Support for Java": log.txt

Current Result

The debug session starts with no arguments.

Expected Result

The debug session should not start, because it was cancelled.

Additional Informations

The implementation of SpecifyProgramArgs is at extension.ts:185. When the user cancels, the function returns a string with a single space. That's indistinguishable from the user entering a space in the input.

I presume that throwing some sort of cancellation exception would be good here, for instance throw new Error('Launch cancelled'). It would be even better if the exception didn't display an error box, but I don't know enough about vscode extension command handlers to know if that's possible.

Alternatively you could just remove the "or 'Escape' to cancel" hint in the input popup.

[patrick-dojofive]

The same occurs with a promptString input, so this may be from VSCode itself

[github-actions]

Hi @sbj42, I'm an AI Support assistant here to help with your issue. While the team reviews your request, I wanted to provide some possible tips and documentation that might help you in the meantime.

Suggested Workarounds and Fixes

• Use a VS Code input variable instead of the custom command
  • Define in launch.json:

  "inputs": [
    {
      "id": "programArgs",
      "type": "promptString",
      "description": "Program arguments",
      "default": ""
    }
  ]

  and then:

  "args": ["${input:programArgs}"]

  • Pressing Escape still returns an empty string, but at least you avoid the misleading “cancel” hint.

• Propose a patch upstream to throw a proper CancellationError when the prompt is canceled
  • In SpecifyProgramArgs (extension.ts:185):

  const input = await vscode.window.showInputBox(options);
  if (input === undefined) {
    // user pressed Escape
    throw new vscode.CancellationError();
  }
  return input;

  • This signals to the debug adapter that the launch was canceled instead of returning a single space.
  • Edit and submit a PR against:
  

  vscode-java-debug/src/extension.ts

  Line 185 in b38e1df

  function specifyProgramArguments(context: vscode.ExtensionContext): Thenable<string> {

• File an issue or feature request in the Java Debugger repo
  • Request official support for cancellation in ${command:SpecifyProgramArgs}
  • Link to VS Code API docs for CancellationError:
  https://code.visualstudio.com/api/references/vscode-api#CancellationError

The team will respond to your issue shortly. I hope these suggestions are helpful in the meantime. If this comment helped you, please give it a 👍. If the suggestion was not helpful or incorrect, please give it a 👎. Your feedback helps us improve!