Skip to main content

Remove a boolean feature flag for feature key

org.openrewrite.featureflags.RemoveBooleanFlag

Replace method invocations for feature key with value, and simplify constant if branch execution.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringmethodPatternA method pattern to match against. The first argument must be the feature key as String.dev.openfeature.sdk.Client getBooleanValue(String, Boolean)
StringfeatureKeyThe key of the feature flag to remove.flag-key-123abc
BooleanreplacementValueThe value to replace the feature flag check with.true

Example​

Parameters​
ParameterValue
methodPatterncom.acme.bank.CustomLaunchDarklyWrapper featureFlagEnabled(String, boolean)
featureKeyflag-key-123abc
replacementValuetrue
Unchanged​
package com.acme.bank;

public class CustomLaunchDarklyWrapper {
    public boolean featureFlagEnabled(String key, boolean fallback) {
        return fallback;
    }
}
Before​
import com.acme.bank.CustomLaunchDarklyWrapper;
class Foo {
    private CustomLaunchDarklyWrapper wrapper = new CustomLaunchDarklyWrapper();
    void bar() {
        boolean enabled = wrapper.featureFlagEnabled("flag-key-123abc", false);
        if (enabled) {
            // Application code to show the feature
            System.out.println("Feature is on");
        }
        else {
          // The code to run if the feature is off
            System.out.println("Feature is off");
        }
    }
}
After​
class Foo {
    void bar() {
        // Application code to show the feature
        System.out.println("Feature is on");
    }
}

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.RemoveBooleanFlagExample. 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.RemoveBooleanFlagExample
displayName: Remove a boolean feature flag for feature key example
recipeList:
  - org.openrewrite.featureflags.RemoveBooleanFlag:
      methodPattern: dev.openfeature.sdk.Client getBooleanValue(String, Boolean)
      featureKey: flag-key-123abc
      replacementValue: true

Now that com.yourorg.RemoveBooleanFlagExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-feature-flags:1.6.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-feature-flags:1.6.0")
}
  1. 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.

Contributors​

Tim te Beek, Jonathan Schnéider, Jonathan Leitschuh