Skip to content

dap: stop sending null to conform to the specification #3481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jsternberg merged 2 commits into from
Oct 24, 2025
Merged

dap: stop sending null to conform to the specification #3481

jsternberg merged 2 commits into from
Oct 24, 2025

Conversation

@rcjsuen
Copy link
Contributor

@rcjsuen rcjsuen commented Oct 23, 2025 •
edited
Loading

The setBreakpoints response body is defined to be an array of breakpoints but the debug adapter incorrectly serialized an empty array as null in the JSON message. Explicitly initializing the array will force the JSON serialization process to send an empty array back instead of null.

Edit: This fixes #3480.

Before:

{
    "command": "setBreakpoints",
    "arguments": {
        "source": {
            "name": "Dockerfile",
            "path": "/tmp/buildx-debugging-demo/Dockerfile"
        },
        "lines": [],
        "breakpoints": [],
        "sourceModified": false
    },
    "type": "request",
    "seq": 12
}
{
    "seq": 32,
    "type": "response",
    "request_seq": 12,
    "success": true,
    "command": "setBreakpoints",
    "body": {
        "breakpoints": null
    }
}

After:

{
    "command": "setBreakpoints",
    "arguments": {
        "source": {
            "name": "Dockerfile",
            "path": "/tmp/buildx-debugging-demo/Dockerfile"
        },
        "lines": [],
        "breakpoints": [],
        "sourceModified": false
    },
    "type": "request",
    "seq": 12
}
{
    "seq": 35,
    "type": "response",
    "request_seq": 12,
    "success": true,
    "command": "setBreakpoints",
    "body": {
        "breakpoints": []
    }
}

@rcjsuen
dap: stop sending null to conform to the specification
7c4dd41 
The setBreakpoints response body is defined to be an array of
breakpoints but the debug adapter incorrectly serialized an empty array
as null in the JSON message. Explicitly initializing the array will
force the JSON serialization process to send an empty array back instead
of null.

Signed-off-by: Remy Suen <remy.suen@docker.com>
jsternberg
jsternberg requested changes Oct 23, 2025
View reviewed changes
@rcjsuen
Initialize the breakpoints map in the beginning
2af3005 
Signed-off-by: Remy Suen <remy.suen@docker.com>
@rcjsuen rcjsuen requested a review from jsternberg October 23, 2025 14:44
@rcjsuen
Copy link
Contributor Author

rcjsuen commented Oct 23, 2025

The test failure is the TestLaunch one from #3479.

=== Failed
=== FAIL: dap TestLaunch (10.01s)
    adapter_test.go:176: [client] send: {"seq":1,"type":"request","command":"initialize","arguments":{"adapterID":"","linesStartAt1":false,"columnsStartAt1":false}}
    adapter_test.go:193: [server] recv: {"seq":1,"type":"request","command":"initialize","arguments":{"adapterID":"","linesStartAt1":false,"columnsStartAt1":false,"pathFormat":"path"}}
    adapter_test.go:176: [server] send: {"seq":1,"type":"response","request_seq":1,"success":true,"command":"initialize","body":{"supportsConfigurationDoneRequest":true}}
    adapter_test.go:193: [client] recv: {"seq":1,"type":"response","request_seq":1,"success":true,"command":"initialize","body":{"supportsConfigurationDoneRequest":true}}
    adapter_test.go:176: [client] send: {"seq":2,"type":"request","command":"launch","arguments":null}
    adapter_test.go:193: [server] recv: {"seq":2,"type":"request","command":"launch","arguments":null}
    adapter_test.go:176: [server] send: {"seq":2,"type":"event","event":"initialized"}
    adapter_test.go:176: [server] send: {"seq":3,"type":"response","request_seq":2,"success":true,"command":"launch"}
    adapter_test.go:193: [client] recv: {"seq":2,"type":"event","event":"initialized"}
    adapter_test.go:193: [client] recv: {"seq":3,"type":"response","request_seq":2,"success":true,"command":"launch"}
    adapter_test.go:176: [client] send: {"seq":3,"type":"request","command":"configurationDone"}
    adapter_test.go:193: [server] recv: {"seq":3,"type":"request","command":"configurationDone"}
    adapter_test.go:176: [server] send: {"seq":4,"type":"response","request_seq":3,"success":true,"command":"configurationDone"}
    adapter_test.go:193: [client] recv: {"seq":4,"type":"response","request_seq":3,"success":true,"command":"configurationDone"}
    adapter_test.go:65: 
        	Error Trace:	/home/runner/work/buildx/buildx/dap/adapter_test.go:65
        	            				/home/runner/work/buildx/buildx/vendor/golang.org/x/sync/errgroup/errgroup.go:93
        	            				/opt/hostedtoolcache/go/1.25.3/x64/src/runtime/asm_amd64.s:1693
        	Error:      	did not receive configurationDone response
        	Test:       	TestLaunch
    adapter_test.go:188: [client] recv error: context canceled
    adapter_test.go:176: [server] send: {"seq":5,"type":"event","event":"terminated","body":{}}
    adapter_test.go:188: [server] recv error: context canceled

@jsternberg jsternberg merged commit 166ab97 into docker:master Oct 24, 2025
201 of 202 checks passed
@rcjsuen rcjsuen deleted the dap-set-breakpoints-null-fix branch October 24, 2025 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsternberg jsternberg jsternberg approved these changes

Assignees

@rcjsuen rcjsuen

Labels

area/dap area/tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

setBreakpoints DAP response does not conform to the specification

2 participants

@rcjsuen @jsternberg