Rust: Source and sink doc / tidy up#18977
Merged
geoffw0 merged 9 commits intogithub:mainfrom Mar 13, 2025
Merged
Conversation
geoffw0
added
no-change-note-required
Contributor
There was a problem hiding this comment.
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
Contributor
Author
|
DCA LGTM (some additional sinks are detected as a result of the third commit; performance is unchanged). |
hvitved
reviewed
Mar 12, 2025
| * v | ||
| * `sinkNode` predicate | other QL defined sinks, for example using concepts | ||
| * v v | ||
| * various `Sink` classes for specific data flow configurations <- extending `QuerySink` |
Contributor
There was a problem hiding this comment.
This QL doc does not render well in VS code. Consider using a code block, e.g.
* ```
* data from `*.model.yml` or QL extensions of `FlowSink::Range`
* v
* `FlowSink` (associated with a models-as-data `kind` string)
* v
* `sinkNode` predicate | other QL defined sinks, for example using concepts
* v
* various `Sink` classes for specific data flow configurations <- extending `QuerySink`
* ```
Contributor
Author
There was a problem hiding this comment.
Ah, I wasn't aware this was actually rendered anywhere (it's rendered when mousing over an import, possibly other places).
Done.
| * v | ||
| * `ActiveThreatModelSource` (just the enabled sources) | ||
| * v | ||
| * various `Source` classes for specific data flow configurations |
Contributor
Author
|
I've also added regular expression injection sinks to the sink metrics now, since that query was just merged. |
hvitved
approved these changes
Mar 12, 2025
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
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.
Source and sink tidy up:
FlowSource.qllandFlowSink.qllexplaining what they are, what the related classes are, and how it all fits together.QuerySinkconcept, a thin wrapper onDataFlow::Nodethat all Rust query sinks should extend now. This replaces the incomplete and easily forgottengetAQuerySinkKindinStats.qllas a mechanism for finding all query sinks, e.g. for metric reporting.QuerySink(they were missing fromgetAQuerySinkKind).