Skip to content
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

JS: Add deprecation qldoc to Configuration classes #18349

Draft
wants to merge 1 commit into
base: js/shared-dataflow-branch
Choose a base branch
from
+20 −0
Draft

JS: Add deprecation qldoc to Configuration classes #18349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions javascript/ql/lib/semmle/javascript/dataflow/Configuration.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ private import semmle.javascript.internal.CachedStages
private import AdditionalFlowSteps

/**
* DEPRECATED.
* Subclasses of this class should be replaced by a module implementing the new `ConfigSig` or `StateConfigSig` interface.
* See the [data flow guide](https://codeql.github.com/docs/codeql-language-guides/analyzing-data-flow-in-javascript-and-typescript/#using-global-data-flow)
* for details about how to use this new interface.
*
* Data flow configurations that used the `FlowLabel` class should be translated to use the `StateConfigSig` interface.
* See [guide on using flow state](https://codeql.github.com/docs/codeql-language-guides/using-flow-labels-for-precise-data-flow-analysis) for more details.
*
* #### Legacy documentation
* A data flow tracking configuration for finding inter-procedural paths from
* sources to sinks.
*
Expand Down
11 changes: 11 additions & 0 deletions javascript/ql/lib/semmle/javascript/dataflow/TaintTracking.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ module TaintTracking {
import AdditionalTaintSteps

/**
* DEPRECATED.
* Subclasses of this class should be replaced by a module implementing the new `ConfigSig` or `StateConfigSig` interface.
* See the [data flow guide](https://codeql.github.com/docs/codeql-language-guides/analyzing-data-flow-in-javascript-and-typescript/#using-global-taint-tracking)
* for details about how to use this new interface.
*
* When migrating a `TaintTracking::Configuration` to `DataFlow::ConfigSig`, use `TaintTracking::Global<...>` instead of `DataFlow::Global<...>`.
*
* Taint-tracking configurations that used the `FlowLabel` class should be translated to use the `StateConfigSig` interface.
* See [guide on using flow state](https://codeql.github.com/docs/codeql-language-guides/using-flow-labels-for-precise-data-flow-analysis) for more details.
*
* #### Legacy documentation
* A data flow tracking configuration that considers taint propagation through
* objects, arrays, promises and strings in addition to standard data flow.
*
Expand Down
Loading