-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
Allow to set data breakpoints #139
base: main
Are you sure you want to change the base?
Allow to set data breakpoints #139
Conversation
973a7d7
to
fe7ae6d
Compare
I haven't looked at the code in detail, but I'm a little confused about the 'internal' vs. 'external' data breakpoint accounting. It looks like 'internal' breakpoints are those set through the Memory Inspector UI while 'external' are set by other means, but I'm not sure that that that should really matter. Are there differences in what the user can / should do with the two types? |
} | ||
|
||
if (isSessionEvent('stopped', event)) { | ||
// TODO: Only for demo purposes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When should this be removed?
return <span | ||
className='byte-group hoverable' | ||
className={classNames('byte-group', 'hoverable', ...BreakpointService.inlineClasses(breakpointMetadata))} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like it should perhaps be done as decorations rather than class names.
data-column='data' | ||
data-range={`${startAddress}-${endAddress}`} | ||
key={startAddress.toString(16)} | ||
onDoubleClick={this.setGroupEdit} | ||
{...createGroupVscodeContext(startAddress, toOffset(startAddress, endAddress, this.props.options.bytesPerMau * 8))} | ||
{...createGroupVscodeContext(startAddress, toOffset(startAddress, endAddress, this.props.options.bytesPerMau * 8), breakpointMetadata)} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This also suggests that context menu context generation should perhaps be a contributable activity rather than hardcoded in a single function.
new Set(columnContributionService | ||
.getUpdateExecutors() | ||
.concat(decorationService.getUpdateExecutors()) | ||
.concat(breakpointService)), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit suspicious that the breakpoint service stands alone here. Can its functionality be broken down into more composable parts?
export interface TrackedDataBreakpoint { | ||
type: TrackedBreakpointType; | ||
breakpoint: DebugProtocol.DataBreakpoint; | ||
/** | ||
* The respective response for the breakpoint. | ||
*/ | ||
response: DebugProtocol.SetDataBreakpointsResponse['body']['breakpoints'][0] | ||
} | ||
|
||
export interface TrackedDataBreakpoints { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tracked
here may be a bit of distracting detail that shouldn't be part of the name: it doesn't contrast with any untracked
counterpart, but it raises the question of whether one should exist.
/** | ||
* The respective response for the breakpoint. | ||
*/ | ||
response: DebugProtocol.SetDataBreakpointsResponse['body']['breakpoints'][0] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe that this parses to DebugProtocol.Breakpoint
.
@colin-grant-work You are absolutely right. However, due to the problem with not being able to set data breakpoints in the VS Code extension API, this was a way to overcame it. We have the following situation right now: For this reason, the current solution tracks all data breakpoints and splits them into If you can recommend a better/stable approach I would be glad to implement it to overcome the API issue. |
I agree with the problem statement, but I think the details don't need to leak as widely as they currently do: we're strictly more knowledgeable / powerful than the VSCode UI, because we know about their breakpoints, but they don't know about our breakpoints. This has two consequences:
That is, both But it also suggests a further enhancement: a data breakpoints tree contributed to the debug view. There, we could show what we know to be the full set of current data breakpoints so that users have an authoritative record in the debug view as well as in our views. We still have the problem that if users use the VSCode builtin commands from the variable view, then their GUI will know about the breakpoint but not any others, but we also have our record right next to theirs. |
First of all, thanks a lot @haydar-metin for this PR! This is awesome work and I like the out-of-the-box thinking to overcome the data breakpoint gap in the VS Code API. This is going to be a powerful feature once we get a handle on the disconnect to the VS Code breakpoint view. What's worrying me more in the meanwhile is the disconnect between custom data breakpoints and VS Code. However, I'd advise against creating a new view for that. We need to ensure this integrates with the existing centralized breakpoint view. Otherwise, this gets difficult to manage for users. I've played around with a couple of things, but neither found a good way yet without fixing this in VS Code:
I'll keep on thinking about other ways to achieve that sync. But we may also want to consider creating a PR on VS Code. If I understand correctly, an issue exists already there. |
I think that this might be the easiest way to attack the problem from a VSCode standpoint. I think that data breakpoints have languished a bit because they've backed themselves into a corner: other breakpoints can be added without reference to a session and then sent to any session, but the way data breakpoints have been implemented, they're at least partly bound to a session. That means that they can't really treat data breakpoints the same in the plugin API - I once started down the naive path and then realized that expectations differ quite a bit - and that means that they'd have to implement entirely new API for data breakpoints. It wouldn't really be that bad - either an |
Thanks a lot, @colin-grant-work , for sharing your findings from previous investigations! This is really useful! |
What it does
Allows to set data breakpoints within the memory table.
Peek.2024-05-30.12-16.mp4
Breakpoints set externally will have a dashed outline, internal breakpoints will be solid.
Extension API
The VSCode extension API does not support creating Data Breakpoints directly through their API. The method extHostDebugService.ts#addBreakpoints currently lacks the ability to forward data breakpoints (i.e., missing DTOs), while MainThreadDebugService.ts#$registerBreakpoints already supports it. However, we only have access to the extension API which uses the extHostDebugService internally. That means, we don't have a way to tell VSCode to show new Data Breakpoints within their UI! Consequently, we need to manually track our breakpoints (for now).
microsoft/vscode#195151
Debugger / Logs
Unfortunately, the debugger does not return the hitpoints on a stop event (it is not set). For that reason, to see the inline breakpoint marker, you need to set the data breakpoint through VSCode. For the prototype, all data breakpoints set from the outside will be assumed to be always hit for demonstration purposes.
The logs and workarounds for showcasing the prototype will be removed before merging.
https://microsoft.github.io/debug-adapter-protocol/specification
How to test
Review checklist
Reminder for reviewers