Finds flow between two methods
org.openrewrite.analysis.search.FindFlowBetweenMethods
Takes two patterns for the start/end methods to find flow between.
Recipe source
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite.meta
- artifactId: rewrite-analysis
- version: 2.11.2
Options
Type | Name | Description | Example |
---|---|---|---|
String | startMethodPattern | A method pattern that is used to find matching the start point's method invocations. | java.util.List add(..) |
Boolean | startMatchOverrides | Optional. When enabled, find methods that are overrides of the method pattern. | |
String | endMethodPattern | A method pattern that is used to find matching the end point's method invocations. | java.util.List add(..) |
Boolean | endMatchOverrides | Optional. When enabled, find methods that are overrides of the method pattern. | |
String | target | The part of the method flow should traverse to Valid options: Select , Arguments , Both | |
String | flow | When enabled, show the data or taint flow of the method invocation. Valid options: Data , Taint |
Usage
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml
create a new recipe with a unique name. For example: com.yourorg.FindFlowBetweenMethodsExample
.
Here's how you can define and customize such a recipe within your rewrite.yml:
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindFlowBetweenMethodsExample
displayName: Finds flow between two methods example
recipeList:
- org.openrewrite.analysis.search.FindFlowBetweenMethods:
startMethodPattern: java.util.List add(..)
endMethodPattern: java.util.List add(..)
target: null
flow: null
Now that com.yourorg.FindFlowBetweenMethodsExample
has been defined, activate it and take a dependency on org.openrewrite.meta:rewrite-analysis:2.11.2 in your build file:
- Gradle
- Maven
- Moderne CLI
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("6.26.0")
}
rewrite {
activeRecipe("com.yourorg.FindFlowBetweenMethodsExample")
exportDatatables = true
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.meta:rewrite-analysis:2.11.2")
}
- Run
gradle rewriteRun
to run the recipe.
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.43.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.FindFlowBetweenMethodsExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.meta</groupId>
<artifactId>rewrite-analysis</artifactId>
<version>2.11.2</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe FindFlowBetweenMethodsExample
See how this recipe works across multiple open-source repositories
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Data Tables
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
Recipe that made changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |