Redact constants that get inlined from variables into query in log #35724
+533
−89
Conversation
This file contains 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
There was a problem hiding this comment.
PR Overview
This PR introduces a new mechanism to mark constant SQL expressions that were originally parameters so that, when inlined into a query, they are handled like parameters with respect to sensitive data logging. Key changes include:
- Adding an extra flag (“originallyParameter”) to the SqlConstantExpression and propagating it through various factory methods and visitors.
- Updating multiple components (SQL generators, expression visitors, and diagnostic loggers) to use the new flag and to pass along a new “logCommandText” parameter for redacted logging.
- Revising XML documentation and method signatures across the EF Core Relational components for consistency.
Reviewed Changes
| File | Description |
|---|---|
| src/EFCore.Relational/Query/SqlExpressions/SqlConstantExpression.cs | Adds the “originallyParameter” flag to the constructors and updates ApplyTypeMapping/Quote. |
| src/EFCore.Relational/Query/QuerySqlGenerator.cs | Updates SQL generation logic to pass the flag when composing the command text. |
| src/EFCore.Relational/Query/ISqlExpressionFactory.cs | Modifies Constant method overloads to include the new parameter with a default value. |
| src/EFCore.Relational/Diagnostics/*.cs | Introduces a new “logCommandText” parameter and revises log formatting in diagnostic events. |
| src/EFCore.Relational/Query/SqlNullabilityProcessor.cs | Revises calls to Constant to include the originallyParameter flag (often set to true). |
| (Other files across the query translation and diagnostics areas) | Propagates the new flag through SQL expression visitors and translators. |
Copilot reviewed 57 out of 57 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
src/EFCore.Relational/Query/SqlNullabilityProcessor.cs:131
- [nitpick] Consider adding unit tests to verify that inline constant expressions flagged with 'originallyParameter: true' are correctly redacted when sensitive data logging is disabled.
processedValues.Add(_sqlExpressionFactory.Constant(value, value?.GetType() ?? typeof(object), originallyParameter: true, typeMapping: typeMapping));
src/EFCore.Relational/Diagnostics/Internal/RelationalCommandDiagnosticsLogger.cs:320
- [nitpick] Consider adding tests to verify that the new 'logCommandText' parameter is used appropriately in scenarios where sensitive data logging is disabled, ensuring the redacted command text is correctly applied.
command.CommandText.TrimEnd());
roji
requested changes
Mar 7, 2025
src/EFCore.Relational/Diagnostics/Internal/RelationalCommandDiagnosticsLogger.cs
Show resolved
Hide resolved
src/EFCore.Relational/Diagnostics/Internal/RelationalCommandDiagnosticsLogger.cs
Show resolved
Hide resolved
src/EFCore.Relational/Query/SqlExpressions/SqlConstantExpression.cs
Outdated
Show resolved
Hide resolved
cincuranet
force-pushed
the
query-log
branch
4 times, most recently
from
0ea1635 to
74f20da
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR introduces support for redacting inlined constant values during SQL generation. Key changes include:
- Adding the InlinedRedacting test in the Relational.Specification.Tests project.
- Extending SqlConstantExpression and its factory methods to support a new “sensitive” flag.
- Updating logging and command construction APIs to propagate a redacted log command text.
Reviewed Changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/EFCore.Relational.Specification.Tests/Query/AdHocMiscellaneousQueryRelationalTestBase.cs | Added tests for verifying redaction of inlined constants. |
| src/EFCore.Relational/Query/SqlExpressions/SqlConstantExpression.cs | Updated constructors and the Quote method to accept a sensitive flag. |
| src/EFCore.Relational/Query/ISqlExpressionFactory.cs | Introduced overloads for constant expressions with sensitivity support. |
| src/EFCore.Relational/Diagnostics/* | Updated logging classes to include and propagate a redacted command text. |
| src/EFCore.Relational/Storage/IRelationalCommandTemplate.cs | Added a LogCommandText property for redacted logging output. |
| src/EFCore.Relational/Query/QuerySqlGenerator.cs | Modified SQL generation to take the sensitive flag into account. |
| src/EFCore.Relational/Storage/RelationalCommandBuilder.cs | Updated command builder to support construction of redacted command text. |
Comments suppressed due to low confidence (1)
src/EFCore.Relational/Query/SqlExpressions/SqlConstantExpression.cs:104
- Ensure that the reflection usage for retrieving the constructor remains valid with any future updates to the constructor signature. Consider adding a unit test to verify that the expected constructor is always correctly obtained.
.GetConstructor([typeof(object), typeof(Type), typeof(bool), typeof(RelationalTypeMapping)])!,
test/EFCore.Relational.Specification.Tests/Query/AdHocMiscellaneousQueryRelationalTestBase.cs
Show resolved
Hide resolved
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.
This adds
OriginallyParameterintoSqlConstantExpressionto detect a case when something that was originally a parameter in query was turned into inline value. This value should be then handled the same way as we do for parameters (regardingEnableSensitiveDataLogging).The SQL generator is then generating two versions of query. The first is the standard one that will be sent to database and other is with inlined values redacted. Later, if sensitive logging is off, diagnostic logger will use it instead of regular
DbCommand.CommandText.Fixes #35757