🦺 Include Finding ID in CodeTF Only When Provided by the Tool #38
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
In cases where a tool does not provide a finding identifier that has the same semantics as [guid from SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790891), codemodder does more harm than good when it uses some fallback value to satisfy the required field constraint. I know this, because I'm currently working on the data model for correlating codemod changes to tool issues :-) We should make the result identifier for fixed / unfixed findings optional. If the tool provides a result ID, then codemodder shall use it. But when the tool provides no such identifier (Snyk 👀), codemodder should not make one up.
drdavella
approved these changes
Aug 6, 2024
gilday
added a commit
to pixee/codetf-java-bindings
that referenced
this pull request
Aug 19, 2024
See [CodeTF specification update](pixee/codemodder-specs#38)
gilday
added a commit
to pixee/codetf-java-bindings
that referenced
this pull request
Aug 20, 2024
See [CodeTF specification update](pixee/codemodder-specs#38)
gilday
added a commit
to pixee/codetf-java-bindings
that referenced
this pull request
Aug 20, 2024
See [CodeTF specification update](pixee/codemodder-specs#38)
gilday
added a commit
to pixee/codetf-java-bindings
that referenced
this pull request
Aug 20, 2024
See [CodeTF specification update](pixee/codemodder-specs#38)
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.
In cases where a tool does not provide a finding identifier that has the same semantics as guid from SARIF, codemodder does more harm than good when it uses some fallback value to satisfy the required field constraint. I know this, because I'm currently working on the data model for correlating codemod changes to tool issues :-)
We should make the result identifier for fixed / unfixed findings optional. If the tool provides a result ID, then codemodder shall use it. But when the tool provides no such identifier (Snyk 👀), codemodder should not make one up.