-
Notifications
You must be signed in to change notification settings - Fork 1.7k
JS: Better type-tracking through Promise.all() #19412
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -4,6 +4,7 @@ | |||||||||
|
||||||||||
private import javascript | ||||||||||
private import semmle.javascript.dataflow.FlowSummary | ||||||||||
private import semmle.javascript.dataflow.TypeTracking | ||||||||||
private import FlowSummaryUtil | ||||||||||
|
||||||||||
DataFlow::SourceNode promiseConstructorRef() { | ||||||||||
|
@@ -211,12 +212,57 @@ private class PromiseReject extends SummarizedCallable { | |||||||||
} | ||||||||||
} | ||||||||||
|
||||||||||
/** | ||||||||||
* A call to `Promise.all()`. | ||||||||||
*/ | ||||||||||
class PromiseAllCall extends DataFlow::CallNode { | ||||||||||
PromiseAllCall() { this = promiseConstructorRef().getAMemberCall("all") } | ||||||||||
|
||||||||||
/** Gets the source of the input array */ | ||||||||||
DataFlow::ArrayCreationNode getInputArray() { result = this.getArgument(0).getALocalSource() } | ||||||||||
|
||||||||||
/** Gets the `n`th element of the input array */ | ||||||||||
DataFlow::Node getNthInput(int n) { result = this.getInputArray().getElement(n) } | ||||||||||
|
||||||||||
/** Gets a reference to the output array. */ | ||||||||||
DataFlow::SourceNode getOutputArray() { | ||||||||||
exists(AwaitExpr await | | ||||||||||
this.flowsToExpr(await.getOperand()) and | ||||||||||
result = await.flow() | ||||||||||
) | ||||||||||
or | ||||||||||
result = this.getAMethodCall("then").getCallback(0).getParameter(0) | ||||||||||
} | ||||||||||
|
||||||||||
/** Gets the `n`th output */ | ||||||||||
DataFlow::SourceNode getNthOutput(int n) { | ||||||||||
exists(string prop | | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [nitpick] Consider adding an inline comment clarifying that the property names read from the output array are expected to be numeric strings, which justifies the conversion using toInt().
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||||
result = this.getOutputArray().getAPropertyRead(prop) and | ||||||||||
n = prop.toInt() | ||||||||||
) | ||||||||||
} | ||||||||||
} | ||||||||||
|
||||||||||
/** | ||||||||||
* Helps type-tracking simple uses of `Promise.all()` such as `const [a, b] = await Promise.all([x, y])`. | ||||||||||
* | ||||||||||
* Due to limited access path depth, type tracking can't track things that are in a promise and an array | ||||||||||
* at once. This generates a step directly from the input array to the output array. | ||||||||||
*/ | ||||||||||
private class PromiseAllStep extends SharedTypeTrackingStep { | ||||||||||
override predicate loadStep(DataFlow::Node node1, DataFlow::Node node2, string prop) { | ||||||||||
exists(PromiseAllCall call, int n | | ||||||||||
node1 = call.getNthInput(n) and | ||||||||||
node2 = call.getNthOutput(n) and | ||||||||||
prop = Promises::valueProp() | ||||||||||
) | ||||||||||
} | ||||||||||
} | ||||||||||
|
||||||||||
private class PromiseAll extends SummarizedCallable { | ||||||||||
PromiseAll() { this = "Promise.all()" } | ||||||||||
|
||||||||||
override DataFlow::InvokeNode getACallSimple() { | ||||||||||
result = promiseConstructorRef().getAMemberCall("all") | ||||||||||
} | ||||||||||
override DataFlow::InvokeNode getACallSimple() { result instanceof PromiseAllCall } | ||||||||||
|
||||||||||
override predicate propagatesFlow(string input, string output, boolean preservesValue) { | ||||||||||
preservesValue = true and | ||||||||||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
category: minorAnalysis | ||
--- | ||
* Type information is now propagated more precisely through `Promise.all()` calls, | ||
leading to more resolved calls and more sources and sinks being detected. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider adding a comment to explain that this fallback branch captures the Promise resolution callback when an AwaitExpr is not present, which aids future maintainability.
Copilot uses AI. Check for mistakes.