Module ApiGraphShared::Public::ExplainFlow

Module to help debug and visualize the data flows underlying API graphs.

This module exports the query predicates for a path-problem query, and should be imported into the top-level of such a query.

The module argument should specify source and sink API nodes, and the resulting query will show paths of epsilon edges that go from a source to a sink. Only epsilon edges are visualized.

To condense the output a bit, paths in which the source and sink are the same node are omitted.

Import path

import codeql.ruby.typetracking.ApiGraphShared

Predicates

edges	Holds if `pred -> succ` is an edge in the graph to visualize.
nodes	Holds if `node` is part of the graph to visualize.
problems	Holds for each source/sink pair to visualize in the graph.

Parameters

ExplainFlowSig