microsoft / microsoft/debug-adapter-protocol

Function and instruction breakpoint log message

Open
#569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
1.8k
Forks
173
Avg merge
7d 7h
Merged PRs (30d)
2

Description

There is not really any reason for them to not support logMessage field. This was raised in #114, but that post includes different issues as well.

"FunctionBreakpoint": {
	"type": "object",
	"description": "Properties of a breakpoint passed to the `setFunctionBreakpoints` request.",
	"properties": {
		"name": {
			"type": "string",
			"description": "The name of the function."
		},
		"condition": {
			"type": "string",
			"description": "An expression for conditional breakpoints.\nIt is only honored by a debug adapter if the corresponding capability `supportsConditionalBreakpoints` is true."
		},
		"hitCondition": {
			"type": "string",
			"description": "An expression that controls how many hits of the breakpoint are ignored.\nThe debug adapter is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsHitConditionalBreakpoints` is true."
		},
+		"logMessage": {
+			"type": "string",
+			"description": "If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)\nbut log the message instead. Expressions within `{}` are interpolated.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsLogPoints` is true.\nIf either `hitCondition` or `condition` is specified, then the message should only be logged if those conditions are met."
+		}
	},
	"required": [ "name" ]
},
"InstructionBreakpoint": {
	"type": "object",
	"description": "Properties of a breakpoint passed to the `setInstructionBreakpoints` request",
	"properties": {
		"instructionReference": {
			"type": "string",
			"description": "The instruction reference of the breakpoint.\nThis should be a memory or instruction pointer reference from an `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or `Breakpoint`."
		},
		"offset": {
			"type": "integer",
			"description": "The offset from the instruction reference in bytes.\nThis can be negative."
		},
		"condition": {
			"type": "string",
			"description": "An expression for conditional breakpoints.\nIt is only honored by a debug adapter if the corresponding capability `supportsConditionalBreakpoints` is true."
		},
		"hitCondition": {
			"type": "string",
			"description": "An expression that controls how many hits of the breakpoint are ignored.\nThe debug adapter is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsHitConditionalBreakpoints` is true."
		},
+		"logMessage": {
+			"type": "string",
+			"description": "If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)\nbut log the message instead. Expressions within `{}` are interpolated.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsLogPoints` is true.\nIf either `hitCondition` or `condition` is specified, then the message should only be logged if those conditions are met."
+		},
		"mode": {
			"type": "string",
			"description": "The mode of this breakpoint. If defined, this must be one of the `breakpointModes` the debug adapter advertised in its `Capabilities`."
		}
	},
	"required": [ "instructionReference" ]
},

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue identifies the FunctionBreakpoint and InstructionBreakpoint schema definitions; find those definitions in the protocol schema and compare their existing breakpoint properties. Add the proposed logMessage field to both, then verify that both schemas expose it consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.