diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index 0c4137ed0..5614f2ed3 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -54,5 +54,8 @@ jobs: fail_ci_if_error: true # optional (default = false) verbose: true # optional (default = false) + - name: Run JMH benchmark + run: 'jmh:benchmark -rf json -rff output.json .*' + - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@624d0bca90f761ffa7ce50c41875a1a226969a02 diff --git a/pom.xml b/pom.xml index c4461155f..6cd01abe2 100644 --- a/pom.xml +++ b/pom.xml @@ -167,7 +167,12 @@ 1.37 test - + + org.openjdk.jmh + jmh-generator-annprocess + 1.37 + test + @@ -703,6 +708,19 @@ + + maven-compiler-plugin + 3.8.1 + + + + org.openjdk.jmh + jmh-generator-annprocess + 1.37 + + + + diff --git a/src/bench/java/dev/openfeature/sdk/FlagEvaluationBenchmark.java b/src/bench/java/dev/openfeature/sdk/FlagEvaluationBenchmark.java new file mode 100644 index 000000000..123849e23 --- /dev/null +++ b/src/bench/java/dev/openfeature/sdk/FlagEvaluationBenchmark.java @@ -0,0 +1,31 @@ +package dev.openfeature.sdk; + +import dev.openfeature.sdk.state.FlagEvaluationState; +import java.util.concurrent.TimeUnit; +import dev.openfeature.sdk.state.HooksState; +import org.openjdk.jmh.annotations.Benchmark; +import org.openjdk.jmh.annotations.BenchmarkMode; +import org.openjdk.jmh.annotations.Fork; +import org.openjdk.jmh.annotations.Measurement; +import org.openjdk.jmh.annotations.Mode; +import org.openjdk.jmh.annotations.Warmup; + + +@BenchmarkMode(Mode.Throughput) +@Warmup(time = 1, timeUnit = TimeUnit.SECONDS, iterations = 1) +//@Warmup(time = 1, timeUnit = TimeUnit.SECONDS, iterations = 2) +@Measurement(time = 5, timeUnit = TimeUnit.SECONDS, iterations = 1) +//@Measurement(time = 5, timeUnit = TimeUnit.SECONDS, iterations = 4) +@Fork(1) +public class FlagEvaluationBenchmark { + + @Benchmark + public String flagEvaluations(FlagEvaluationState state) { + return state.client.getStringDetails(FlagEvaluationState.FLAG_KEY, "default").getValue(); + } + + @Benchmark + public String hookExecution(HooksState state) { + return state.client.getStringDetails(HooksState.FLAG_KEY, "default").getValue(); + } +} diff --git a/src/bench/java/dev/openfeature/sdk/state/FlagEvaluationState.java b/src/bench/java/dev/openfeature/sdk/state/FlagEvaluationState.java new file mode 100644 index 000000000..7682b3026 --- /dev/null +++ b/src/bench/java/dev/openfeature/sdk/state/FlagEvaluationState.java @@ -0,0 +1,45 @@ +package dev.openfeature.sdk.state; + +import dev.openfeature.sdk.Client; +import dev.openfeature.sdk.ImmutableMetadata; +import dev.openfeature.sdk.OpenFeatureAPI; +import dev.openfeature.sdk.providers.memory.Flag; +import dev.openfeature.sdk.providers.memory.InMemoryProvider; +import org.openjdk.jmh.annotations.Level; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.Setup; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; +import java.util.Map; + +@State(Scope.Benchmark) +public class FlagEvaluationState { + public static final String FLAG_KEY = "flag-key"; + public static final String DOMAIN = "jmh-domain"; + + public InMemoryProvider provider; + public Client client; + + @Setup(Level.Trial) + public void setup() { + provider = new InMemoryProvider( + Map.of( + FLAG_KEY, + Flag.builder() + .variant("a", "a-value") + .variant("b", "b-value") + .defaultVariant("b") + .flagMetadata(ImmutableMetadata.builder().addString("meta", "data").build()) + .build() + ) + ); + OpenFeatureAPI.getInstance().setProviderAndWait(DOMAIN, provider); + client = OpenFeatureAPI.getInstance().getClient(DOMAIN); + } + + @TearDown(Level.Trial) + public void teardown() { + OpenFeatureAPI.getInstance().shutdown(); + OpenFeatureAPI.getInstance().clearHooks(); + } +} diff --git a/src/bench/java/dev/openfeature/sdk/state/HooksState.java b/src/bench/java/dev/openfeature/sdk/state/HooksState.java new file mode 100644 index 000000000..976824189 --- /dev/null +++ b/src/bench/java/dev/openfeature/sdk/state/HooksState.java @@ -0,0 +1,48 @@ +package dev.openfeature.sdk.state; + +import dev.openfeature.sdk.Client; +import dev.openfeature.sdk.Hook; +import dev.openfeature.sdk.ImmutableMetadata; +import dev.openfeature.sdk.OpenFeatureAPI; +import dev.openfeature.sdk.StringHook; +import dev.openfeature.sdk.providers.memory.Flag; +import dev.openfeature.sdk.providers.memory.InMemoryProvider; +import java.util.Map; +import org.openjdk.jmh.annotations.Level; +import org.openjdk.jmh.annotations.Scope; +import org.openjdk.jmh.annotations.Setup; +import org.openjdk.jmh.annotations.State; +import org.openjdk.jmh.annotations.TearDown; + +@State(Scope.Benchmark) +public class HooksState { + public static final String FLAG_KEY = "flag-key"; + public static final String DOMAIN = "jmh-domain"; + + public InMemoryProvider provider; + public Client client; + + @Setup(Level.Trial) + public void setup() { + provider = new InMemoryProvider( + Map.of( + FLAG_KEY, + Flag.builder() + .variant("a", "a-value") + .variant("b", "b-value") + .defaultVariant("b") + .flagMetadata(ImmutableMetadata.builder().addString("meta", "data").build()) + .build() + ) + ); + OpenFeatureAPI.getInstance().setProviderAndWait(DOMAIN, provider); + client = OpenFeatureAPI.getInstance().getClient(DOMAIN); + client.addHooks(new StringHook() {}, new Hook() {}); + } + + @TearDown(Level.Trial) + public void teardown() { + OpenFeatureAPI.getInstance().shutdown(); + OpenFeatureAPI.getInstance().clearHooks(); + } +}