Skip to main content

Adds a TimeUnit argument to the matched method invocations

org.openrewrite.apache.httpclient5.AddTimeUnitArgument

In Apache Http Client 5.x migration, an extra TimeUnit argument is required in the timeout and duration methods. Previously in 4.x, all these methods were implicitly having the timeout or duration expressed in milliseconds, but in 5.x the unit of the timeout or duration is required. So, by default this recipe adds TimeUnit.MILLISECONDS, it is possible to specify this as a parameter. Since all affected methods of the Apache Http Client 5.x migration only have one integer/long argument, the recipe applies with matched method invocations of exactly one parameter.

Recipe source​

GitHub: AddTimeUnitArgument.java, Issue Tracker, Code Genome Project

This recipe is available under the Moderne Source Available License. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

Options​

TypeNameDescriptionExample
StringmethodPatternA method pattern that is used to find matching method invocations.org.apache.http.client.config.RequestConfig.Builder setConnectionRequestTimeout(int)
TimeUnittimeUnitOptional. The TimeUnit enum value we want to add to the method invocation. Defaults to MILLISECONDS. Valid options: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYSMILLISECONDS

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
methodPatternA method(int)
timeUnitnull
Before​
class B {
    void test() {
        A a = new A();
        a.method(100);
    }
}
After​
import java.util.concurrent.TimeUnit;

class B {
    void test() {
        A a = new A();
        a.method(100, TimeUnit.MILLISECONDS);
    }
}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.AddTimeUnitArgumentExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddTimeUnitArgumentExample
displayName: Adds a TimeUnit argument to the matched method invocations example
recipeList:
  - org.openrewrite.apache.httpclient5.AddTimeUnitArgument:
      methodPattern: org.apache.http.client.config.RequestConfig.Builder setConnectionRequestTimeout(int)
      timeUnit: MILLISECONDS

Now that com.yourorg.AddTimeUnitArgumentExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-apache:2.31.0 in your build file:

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codeGenomeUsername=you@example.com
    codeGenomeToken=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codeGenomeUsername").get()
                    password = providers.gradleProperty("codeGenomeToken").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("com.yourorg.AddTimeUnitArgumentExample")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-apache:2.31.0")
    }
  4. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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 NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.