JS: Restrict receiver-flow in API graphs #20586
Merged
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR restricts receiver-flow in API graphs to improve performance by preventing flow tracking from following argument-passing edges for receivers of method calls. The change recognizes that external library objects typically don't have methods defined in the current codebase, making such tracking unnecessary except in subclassing scenarios which are handled separately.
Key changes:
- Introduces a new
CallReceiverSteptype to distinguish receiver argument-passing from regular argument-passing - Blocks API graph tracking through receiver steps to prevent unnecessary flow analysis
- Adds test case to verify the new behavior with explicit receiver binding
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| javascript/ql/lib/semmle/javascript/dataflow/internal/StepSummary.qll | Introduces CallReceiverStep type and logic to detect method dispatch receivers |
| javascript/ql/lib/semmle/javascript/dataflow/TypeTracking.qll | Updates type tracking to handle the new CallReceiverStep |
| javascript/ql/lib/semmle/javascript/ApiGraphs.qll | Blocks API graph tracking through receiver steps |
| javascript/ql/test/ApiGraphs/explicit-this/tst.js | Test case demonstrating explicit receiver binding scenario |
| javascript/ql/test/ApiGraphs/explicit-this/package.json | Package configuration for test case |
| javascript/ql/test/ApiGraphs/explicit-this/VerifyAssertions.ql | Test query to verify assertions |
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.
Restricts the flow of use/def nodes in API graphs to not follow argument-passing edges for receivers of method calls.
When tracking a use-node, the intent is to track an object that was created in external code (usually an imported library). Such objects will generally not have methods that were defined in the current codebase, except in subclassing scenarios which is modelled by other means (not by argument-passing).
This fixes a performance issue observed in some codebases.