Introduce a fhirpath debug tracer #3210
Draft
Conversation
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
…ant (that's the base class of identifier) Permits being able to differentiate in the expression tree between them.
only has minor impact on expression compilation, and no effect on runtime if no debugger injected.
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces a FhirPath debugger feature that enables tracing of expression evaluation. The changes implement a debug tracing system that captures execution context and results for each expression during FhirPath evaluation.
- Adds a new
DebugTracerclass with delegate-based tracing functionality - Integrates debug tracing into the expression evaluation visitor
- Replaces
ConstantExpressionwithIdentifierExpressionfor better semantic representation of identifiers
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
src/Hl7.Fhir.Base/FhirPath/DebugTracer.cs |
New debug tracer implementation with trace delegate and output formatting |
src/Hl7.Fhir.Base/FhirPath/Expressions/EvaluatorVisitor.cs |
Integration of debug tracing wrapper and constructor parameter |
src/Hl7.Fhir.Base/FhirPath/Expressions/Closure.cs |
Adds Variables() method to expose internal named values |
src/Hl7.Fhir.Base/FhirPath/Parser/Grammar.cs |
Changes identifier parsing to use IdentifierExpression instead of ConstantExpression |
src/Hl7.Fhir.Base/FhirPath/Expressions/ExpressionNode.cs |
Updates ChildExpression constructors to use IdentifierExpression |
src/Hl7.FhirPath.Tests/Tests/FhirPathGrammarTest.cs |
Updates test expectation to use IdentifierExpression |
Comment on lines
45
to
65
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},constant"); | ||
| exprName = "constant"; | ||
| } | ||
| else if (expr is ChildExpression child) | ||
| { | ||
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},{child.ChildName}"); | ||
| exprName = child.ChildName; | ||
| } | ||
| else if (expr is IndexerExpression indexer) | ||
| { | ||
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},[]"); | ||
| exprName = "[]"; | ||
| } | ||
| else if (expr is UnaryExpression ue) | ||
| { | ||
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},{ue.Op}"); | ||
| exprName = ue.Op; | ||
| } | ||
| else if (expr is BinaryExpression be) | ||
| { | ||
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},{be.Op}"); |
There was a problem hiding this comment.
[nitpick] The trace output format is inconsistent. Some lines use comma-separated values while others use descriptive text. Consider standardizing the format.
Suggested change
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},constant"); | |
| exprName = "constant"; | |
| } | |
| else if (expr is ChildExpression child) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},{child.ChildName}"); | |
| exprName = child.ChildName; | |
| } | |
| else if (expr is IndexerExpression indexer) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},[]"); | |
| exprName = "[]"; | |
| } | |
| else if (expr is UnaryExpression ue) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},{ue.Op}"); | |
| exprName = ue.Op; | |
| } | |
| else if (expr is BinaryExpression be) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"{expr.Location.LineNumber},{expr.Location.LinePosition},{be.Op}"); | |
| System.Diagnostics.Trace.WriteLine($"Line: {expr.Location.LineNumber}, Position: {expr.Location.LinePosition}, Type: constant"); | |
| exprName = "constant"; | |
| } | |
| else if (expr is ChildExpression child) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"Line: {expr.Location.LineNumber}, Position: {expr.Location.LinePosition}, Type: Child, Name: {child.ChildName}"); | |
| exprName = child.ChildName; | |
| } | |
| else if (expr is IndexerExpression indexer) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"Line: {expr.Location.LineNumber}, Position: {expr.Location.LinePosition}, Type: Indexer, Symbol: []"); | |
| exprName = "[]"; | |
| } | |
| else if (expr is UnaryExpression ue) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"Line: {expr.Location.LineNumber}, Position: {expr.Location.LinePosition}, Type: Unary, Operator: {ue.Op}"); | |
| exprName = ue.Op; | |
| } | |
| else if (expr is BinaryExpression be) | |
| { | |
| System.Diagnostics.Trace.WriteLine($"Line: {expr.Location.LineNumber}, Position: {expr.Location.LinePosition}, Type: Binary, Operator: {be.Op}"); |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
I was intentionally keeping the descriptions brief.
And are consistent with how I'm displaying them in the fhirpath-lab, but not fussed if we adopted this.
Only inject the debugger break when in debug mode. This code should never be hit, so excluding the break is good. Intended to wake the developer if it ever hits here, as that means a new Expression type has been added that doesn't derived from one of the existing ones. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…e into the compiled expression
…variable processing
brianpos
changed the title
… show in the debug output what steps the evaluation took.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Introduce a capability to inject a debug trace into the fhirpath evaluation.
This will be used by systems that want to trace execution and debug what happened at each stage.
(such as in the fhirpath-lab)
Related issues
Closes|Fixes|Resolves [issue #].
Testing
There is specific unit testing to verify the captuing of the trace informtion
FirelyTeam Checklist