JS: Incremental API graph #20733

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.

Sign up for GitHub

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

Jump to bottom

Draft

asgerf wants to merge 59 commits into github:main from asgerf:js/incremental-api-graphs

+2,548 −689

Contributor

asgerf commented Oct 31, 2025

No description provided.

asgerf and others added 13 commits

October 31, 2025 09:51


          JS: Overlay annotations for AST layer

2cbcc1d


          JS: Fix getRawEnclosingStmt call

4950fa0


          JS: Add overlay[local?] to new summaries after rebasing

afa8cd9


          JS: Make more general-purpose data flow things local

eded45a


          JS: Overlay annotations for some failing tests

1da2fc9

Locally these seem to get rid of the compilation warnings, but of course
CI is the true arbiter here.


          JS: Add some overlay[caller] and a pragma[nomagic] annotations

cfda393


          JS: Add more overlay[caller?] annotations

b86d88f


          JS: Fix bad join in DuplicateProperty.ql

fd96b72


          JS: Add overlay[local] to restore magic in unwrap() predicate

1bcb2ea

In this case we actually want magic to apply, but was prevented by locality.


          JS: Avoid bad join in shared predicate induced by 'forex'.

88351d5

Use manual recursion instead.


          JS: Avoid more bad joins due to locality

8dd1a9e


          JS: Improve join orders related to getABooleanValue()

4ef6f02


          JS: Remove obsolete overlay[global] annotations

84e7101

github-actions bot added the JS label

github-advanced-security bot found potential problems

View reviewed changes

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                  private import semmle.javascript.dataflow.TypeTracking

                  private module Stage1Input implements StageInputSig {

                    pragma[inline]

                    predicate isAdditionalUseRoot(Node node) { none() }

Check warning

Code scanning / CodeQL

Cannot inline predicate across overlay frontier Warning

This possibly local non-private inline predicate will not be inlined across the overlay frontier. This may negatively affect evaluation performance. Consider adding an overlay[caller] or overlay[caller?] annotation to allow inlining across the overlay frontier. Note that adding an overlay[caller] or overlay[caller?] annotation affects semantics under overlay evaluation.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                    t = useStep(nd, promisified, boundArgs, prop, result)

                  }

                    pragma[inline]

                    predicate isAdditionalDefRoot(Node node) { none() }

Check warning

Code scanning / CodeQL

Cannot inline predicate across overlay frontier Warning

This possibly local non-private inline predicate will not be inlined across the overlay frontier. This may negatively affect evaluation performance. Consider adding an overlay[caller] or overlay[caller?] annotation to allow inlining across the overlay frontier. Note that adding an overlay[caller] or overlay[caller?] annotation affects semantics under overlay evaluation.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                    pragma[nomagic]

                    private predicate shouldTrackIntoOverlay(DataFlow::SourceNode nd) {

                      exists(DataFlow::Node overlayNode |

Check warning

Code scanning / CodeQL

Omittable 'exists' variable Warning

This exists variable can be omitted by using a don't-care expression

in this argument

.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                    pragma[nomagic]

                    private predicate shouldBacktrackIntoOverlay(DataFlow::SourceNode nd) {

                      exists(DataFlow::Node overlayNode |

Check warning

Code scanning / CodeQL

Omittable 'exists' variable Warning

This exists variable can be omitted by using a don't-care expression

in this argument

.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                  private module Debug {

                    private module FullInput implements StageInputSig {

                      pragma[inline]

                      predicate isAdditionalUseRoot(Node node) { none() }

Check warning

Code scanning / CodeQL

Cannot inline predicate across overlay frontier Warning

This possibly local non-private inline predicate will not be inlined across the overlay frontier. This may negatively affect evaluation performance. Consider adding an overlay[caller] or overlay[caller?] annotation to allow inlining across the overlay frontier. Note that adding an overlay[caller] or overlay[caller?] annotation affects semantics under overlay evaluation.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                      predicate inScope(DataFlow::Node node) { any() }

                    }

                    private module Full = Stage<FullInput>;

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                    private module Full = Stage<FullInput>;

                    query predicate missingDefNode(DataFlow::Node node) {

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                      not exists(MkDef(node))

                    }

                    query predicate missingUseNode(DataFlow::Node node) {

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                      not exists(MkUse(node))

                    }

                    query predicate lostEdge(Node pred, Label::ApiLabel lbl, Node succ) {

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

    
                      not Cached::edge(pred, lbl, succ)

                    }

                    query predicate counts(int numEdges, int numOverlayEdges, float ratio) {

Check warning

Code scanning / CodeQL

Dead code Warning

This code is never used, and it's not publicly exported.

asgerf added 15 commits

November 3, 2025 10:05


          JS: Make isAssignedInUniqueFile global, as it should be

7c9c992


          Sync ApiGraphModelsExtensions.qll

15cc9a2


          Sync ApiGraphModels.qll

b9c4636

wp

7fcc357


          JS: Convert boolean to a newtype

a6f3990


          WIP: Factor out Promisification state

39cba9e


          Revert "WIP: Factor out Promisification state"

f5d105c

This reverts commit 79d2b84.


          Revert "JS: Convert boolean to a newtype"

f0f93c3

This reverts commit bac3951.


          JS: Make MkSyntheticCallbackArg() independent of trackUseNode

6b423e5


          JS: Make other node types not depend on tracking predicates

0a181be


          JS: Remove unused predicate

73531e5


          JS: Make use() and rhs() uncached and private

4511f7c


          JS: Wrap in a module

cf09daa

Simply wraps everything in 'cached private module Stage {}' and adds 'import Stage'.
The diff is large because of indentation changes.


          JS: Parameterise the module (still only one instantiation)

f7208f9


          Revert "JS: Remove unused predicate"

0c39e04

This reverts commit 336eb37.

asgerf added 27 commits

November 3, 2025 11:49


          JS: Localize MkModuleImport

523054b


          JS: Localize MkClassInstance

5d09ab5


          JS: Further localize MkDef

77da92f


          JS: Temporarily disable MkTypeUse (too hard to localize for now)

aa7a02e


          JS: Remove unused predicate

93aa190


          JS: Make API nodes and labels local

8fcaa72


          JS: Apply forceLocal overlay trick to API graphs

6c20d52


          JS: Also forceLocal getAPromisifiedInvocation

e9fe48b


          JS: Stop dependeding on getPath() for toString()

8489bdd


          JS:Add more member labels

60c6c0e


          JS: Add predicate for detecting lost edges

20b2ac0


          JS: Add MkDef case for 'export const bar = foo'

e88ed69


          Debug predicates for missing def/use nodes

f1177ac


          JS: Add MkDef case for export namespace specifiers

c900baf


          JS: Restrict entry point edges to those in scope

3b776e7


          JS: Change signature of 'edges' to support quick eval

981cf13


          JS: Refine criteria so that explicit this-passing is not affected

f90f863


          JS: Add receivers to MkDef

a58b1b4


          JS: Minor improvements to some join orders

a1c41cc

wip

b7cd35f


          JS: Add back CallReceiverStep() restriction

67eef3a

This was initially lost after rebasing with indentation changes


          JS: Update debugging stuff in API graphs

05e2d26


          JS: Mass overlay[local?]

dc4ca96


          JS: Add overlay[global] to abstract classes with fields

c8e83df

Some abstract classes defines fields without binding them, leaving it up to the subclasses to bind them. When combined with overlay[local?], the charpred for such an abstract class can become local, while the subclasses are global. The means the charpred needs to be materialized, even though it doesn't bind the fields, leading to a cartesian product.


          JS: Use forceLocal to implement MkTypeUse

e0fb2d0


          JS: Add a few missing node types

a2251ec


          JS: Remove global dependency that wasnt needed anyway

c8abbdc

asgerf force-pushed the js/incremental-api-graphs branch from 2e5779a to c8abbdc Compare

November 3, 2025 10:52

github-actions bot added Python Ruby labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels