docs(proposal): mxcli microflow debugger — breakpoints by name#44
Merged
Conversation
Turns the runtime-debugger investigation from the mxcli-sudoku findings/README (and its scripts/mfdebug.sh wrapper) into a supported feature proposal. The Mendix microflow debugger spans two APIs: the M2EE admin plane (:8090, X-M2EE-Authentication) toggles enable/disable/status, and the app endpoint (<app>/debugger/, X-Debugger-Authentication) drives start_session / add_breakpoint / get_paused_microflows / get_object / step_* / continue. A breakpoint's object_id is an activity's model GUID, which nothing in the runtime surfaces. mxcli is uniquely positioned: run --local already owns the admin password + app URL, and sdk/mpr/parser_microflow.go already extracts each activity's $ID — so it can offer breakpoints BY NAME (Module.Flow --activity Name) rather than by GUID. The proposal specifies the `mxcli debug` command surface, a DebuggerClient for the second plane, the name→GUID resolver, warm-loop integration, safety (a breakpoint pauses the browser too; auto-disable on interrupt), five slices, tests, open questions, and a DAP-bridge follow-up. Docs-only; no code. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JXnEgoc2NQP1Y2TWMCMXC4
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Investigation + design proposal turning the
ako/mxcli-sudokuruntime-debugger findings (and itsscripts/mfdebug.shwrapper) into a supportedmxcli debugfeature.What the investigation found
The Mendix microflow debugger spans two APIs:
:8090,X-M2EE-Authentication) — toggles only:enable_debugger {password},disable_debugger,get_debugger_status.<app>/debugger/,X-Debugger-Authentication: base64(pass)) — the protocol:start_session(→session_token),add_breakpoint {microflow_name, object_id, condition?},get_paused_microflows,get_object,step_over|into|out,continue|continue_all,remove_breakpoint.paramsis mandatory even when{}; onlyX-Debugger-Authenticationworks (raw/Basic/Bearer → 401{}).The blocker for humans: a breakpoint's
object_idis an activity's model GUID (little-endian .NET GUID in the.mpr), and nothing in the runtime surfaces it.Why mxcli is the right home: confirmed against the code —
run --localalready owns the admin password + app URL (docker.CallM2EE), andsdk/mpr/parser_microflow.goalready extracts each activity's$ID. So mxcli can offer breakpoints by name (mxcli debug break Module.Flow --activity ACT_Name) rather than by GUID — which no other tool can.What the proposal specifies
mxcli debugcommand surface (status/enable/break/breaks/unbreak/paused/inspect/step/continue/disable) with name→GUID resolution and internal session-token handling.DebuggerClientfor the second plane; admin plane reusesCallM2EE.run --localreuse (flagless common case) + optionalrun --local --debug.statusshows paused count).run --localintegration run), open questions (activity naming, GUID form, REPL vs subcommands, default-on), and a DAP-bridge follow-up for vscode-mdl.Docs-only; no code. Continues the proposal-driven workflow in
docs/11-proposals/.🤖 Generated with Claude Code
Generated by Claude Code