Remove deprecated keyExpectedValue, keyActualValue and issueType fields#232
Merged
Merged
Conversation
|
🎯 Code Coverage (details) 🔗 Commit SHA: 048e8ed | Docs | Datadog PR Page | Give us feedback! |
whitemerch
force-pushed
the
chakib.hamie/remove_deprecated_result_fields
branch
2 times, most recently
from
July 2, 2026 10:57
7013e77 to
4ae4044
Compare
whitemerch
marked this pull request as ready for review
July 2, 2026 10:58
…e scanner model, engine, and all report formats.
whitemerch
force-pushed
the
chakib.hamie/remove_deprecated_result_fields
branch
from
July 2, 2026 11:01
4ae4044 to
ad7bc15
Compare
ChouraquiBen
previously approved these changes
Jul 2, 2026
ChouraquiBen
left a comment
ChouraquiBen
left a comment
Contributor
There was a problem hiding this comment.
If the goal is to remove them completely, please know there are still some occurences:
- keyExpectedValue: 10 results in 5 files
- keyActualValue: 10 results in 5 files
- issueType: 24 results in 6 files
Otherwise, LGTM
Contributor
Author
@ChouraquiBen Yes it is, it's just that I am confusing my worktrees and directories between each other and I am oversighting some of the stuff. Will fix |
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.
Motivation
The
keyExpectedValue,keyActualValue, andissueTypefields were presentation-only outputs that rules used to populate. We don't even use them on the SARIF output anymore. Default rules no longer emit them (see datadog-iac-scanner-default-rules#72), and they are not part of the finding identity contract. Keeping code that reads them from rule results produces noisy warn-level log entries every time a finding is produced, at high volume in production scans. This is a follow-up for this PRChanges
Engine
Remove reads of
keyExpectedValue,keyActualValue, andissueTypefromvulnerability_builder.go. Remove theDefaultIssueTypeconstant frominspector.go.Model
Remove the
IssueTypetype, its constants,AllIssueTypesAsString, and theIssueType,KeyExpectedValue, andKeyActualValuefields from bothVulnerabilityandVulnerableFile.Report formats
Remove
issueType,expected_value, andactual_valuecolumns from CSV output. Remove the "Expected value / Actual value" text from ASFF, JUnit, CycloneDX, and HTML report messages and templates.Rule validation
Remove the
allowedIssueTypescheck from the rule test command —issueTypeis no longer a recognised result field.Author Checklist
QA Instruction
go test ./pkg/engine/ ./pkg/model/... ./pkg/report/... ./cmd/...Scan any IaC fixture and confirm no
Failed to get key keyExpectedValue in map/keyActualValue/issueTypewarnings appear in the scan log.Blast Radius
This PR only affects the scanner binary and its report outputs.
Additional Notes
Companion PR removing the fields from rule outputs: datadog-iac-scanner-default-rules#72
I submit this contribution under the Apache-2.0 license.