[lldb-dap] pathFormat in initialize request is treated as mandatory

[Calcoph]

On version 21.1.6, installed via winget install LLVM.LLVM:

On an initialize request, lldb-dap errors if the pathFormat argument is not present. However, it is marked as an optional parameter in the DAP especification: https://microsoft.github.io/debug-adapter-protocol/specification#Requests_Initialize

As seen in the following example:

C:\Users\calcoph>lldb-dap --version
lldb-dap: LLVM (http://llvm.org/):
  LLVM version 21.1.6
  Optimized build.
liblldb: lldb version 21.1.6
C:\Users\calcoph>lldb-dap
Content-Length: 87

{"seq":1,"command":"initialize","type":"request","arguments":{"adapterID":"aaaaaaaaa"}}
Content-Length: 283

{"body":{"error":{"format":"invalid arguments for request 'initialize': missing value at arguments.pathFormat\n/* error: missing value */\n{\n  \"adapterID\": \"aaaaaaaaa\"\n}","id":3,"showUser":true}},"command":"initialize","request_seq":1,"seq":0,"success":false,"type":"response"}DAP session error: expected 'Content-Length: ' and got '
'

This issue was apparently fixed in PR #155238, but that was merged in august, so this version should have that fix.

[llvmbot]

@llvm/issue-subscribers-lldb-dap

Author: Diego (Calcoph)

On version 21.1.6, installed via `winget install LLVM.LLVM`:

On an initialize request, lldb-dap errors if the pathFormat argument is not present. However, it is marked as an optional parameter in the DAP especification: https://microsoft.github.io/debug-adapter-protocol/specification#Requests_Initialize

As seen in the following example:

C:\Users\calcoph>lldb-dap --version
lldb-dap: LLVM (http://llvm.org/):
  LLVM version 21.1.6
  Optimized build.
liblldb: lldb version 21.1.6
C:\Users\calcoph>lldb-dap
Content-Length: 87

{"seq":1,"command":"initialize","type":"request","arguments":{"adapterID":"aaaaaaaaa"}}
Content-Length: 283

{"body":{"error":{"format":"invalid arguments for request 'initialize': missing value at arguments.pathFormat\n/* error: missing value */\n{\n  \"adapterID\": \"aaaaaaaaa\"\n}","id":3,"showUser":true}},"command":"initialize","request_seq":1,"seq":0,"success":false,"type":"response"}DAP session error: expected 'Content-Length: ' and got '
'

This issue was apparently fixed in PR #155238, but that was merged in august, so this version should have that fix.

[DavidSpickett]

The commit for that PR has not in fact made it into 21.x - 749537f. It's tricky to see but if you look below the commit message it says main(#155238). If it were included in a release it would have other branch names there alongside main.

This happens because the release branch starts some time before the first proper release of that version. In the meantime, main carries on developing and not everything gets backported.

I don't know of a way to get a pre-built main version on Windows. If you want to build it - https://lldb.llvm.org/resources/build.html.

Though you may actually prefer to build the 21.x branch, with that one commit cherry picked onto it. Just to avoid unnecessary changes.

@ashgti if what I said was correct, please close this issue.

[ashgti]

I agree with @DavidSpickett on this, if you want to cherry-pick that fix into the 21.x branch locally, that may be the easiest way to get that fix but otherwise this would be in the next major release of llvm (22.x).

[DavidSpickett]

This will be fixed in 22.x, and as we don't keep per-version issues I'm going to close this.