Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package dev.openfeature.sdk.multiprovider;

import static dev.openfeature.sdk.ErrorCode.FLAG_NOT_FOUND;

import dev.openfeature.sdk.ErrorCode;
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.ProviderEvaluation;
import dev.openfeature.sdk.exceptions.FlagNotFoundError;
import java.util.Map;
import java.util.function.Function;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

/**
* First match strategy. Return the first result returned by a provider. Skip providers that
* indicate they had no value due to FLAG_NOT_FOUND. In all other cases, use the value returned by
* the provider. If any provider returns an error result other than FLAG_NOT_FOUND, the whole
* evaluation should error and “bubble up” the individual provider’s error in the result. As soon as
* a value is returned by a provider, the rest of the operation should short-circuit and not call
* the rest of the providers.
*/
@Slf4j
@NoArgsConstructor
public class FirstMatchStrategy implements Strategy {

/**
* Represents a strategy that evaluates providers based on a first-match approach. Provides a
* method to evaluate providers using a specified function and return the evaluation result.
*
* @param providerFunction provider function
* @param <T> ProviderEvaluation type
* @return the provider evaluation
*/
@Override
public <T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Function<FeatureProvider, ProviderEvaluation<T>> providerFunction) {
for (FeatureProvider provider : providers.values()) {
try {
ProviderEvaluation<T> res = providerFunction.apply(provider);
if (!FLAG_NOT_FOUND.equals(res.getErrorCode())) {
return res;
}
} catch (FlagNotFoundError e) {
log.debug("flag not found {}", key, e);
}
}
return ProviderEvaluation.<T>builder()
.errorMessage("No provider successfully responded")
.errorCode(ErrorCode.GENERAL)
.build();
}
Comment on lines +52 to +56

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

When all providers return FLAG_NOT_FOUND, the strategy currently returns a GENERAL error. It would be more accurate to return a FLAG_NOT_FOUND error code to reflect that the flag was not found in any of the providers. The error message could also be more specific.

Note that this change will require updating FirstMatchStrategyTest.shouldThrowFlagNotFoundWhenAllProvidersReturnFlagNotFound and MultiProviderTest.shouldUseDefaultFirstMatchStrategy to assert for FLAG_NOT_FOUND instead of GENERAL.

Suggested change
return ProviderEvaluation.<T>builder()
.errorMessage("No provider successfully responded")
.errorCode(ErrorCode.GENERAL)
.build();
}
return ProviderEvaluation.<T>builder()
.errorMessage("Flag not found in any provider")
.errorCode(ErrorCode.FLAG_NOT_FOUND)
.build();

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package dev.openfeature.sdk.multiprovider;

import dev.openfeature.sdk.ErrorCode;
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.ProviderEvaluation;
import java.util.Map;
import java.util.function.Function;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

/**
* First Successful Strategy. Similar to “First Match”, except that errors from evaluated providers
* do not halt execution. Instead, it will return the first successful result from a provider. If no
* provider successfully responds, it will throw an error result.
*/
@Slf4j
@NoArgsConstructor
public class FirstSuccessfulStrategy implements Strategy {

@Override
public <T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Function<FeatureProvider, ProviderEvaluation<T>> providerFunction) {
for (FeatureProvider provider : providers.values()) {
try {
ProviderEvaluation<T> res = providerFunction.apply(provider);
if (res.getErrorCode() == null) {
return res;
}
} catch (Exception e) {
log.debug("evaluation exception {}", key, e);
}
}

return ProviderEvaluation.<T>builder()
.errorMessage("No provider successfully responded")
.errorCode(ErrorCode.GENERAL)
.build();
}
}
151 changes: 151 additions & 0 deletions src/main/java/dev/openfeature/sdk/multiprovider/MultiProvider.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
package dev.openfeature.sdk.multiprovider;

import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.EventProvider;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.Metadata;
import dev.openfeature.sdk.ProviderEvaluation;
import dev.openfeature.sdk.Value;
import dev.openfeature.sdk.exceptions.GeneralError;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;

/** <b>Experimental:</b> Provider implementation for Multi-provider. */
@Slf4j
public class MultiProvider extends EventProvider {

@Getter
private static final String NAME = "multiprovider";

public static final int INIT_THREADS_COUNT = 8;
private final Map<String, FeatureProvider> providers;
private final Strategy strategy;
private MultiProviderMetadata metadata;

/**
* Constructs a MultiProvider with the given list of FeatureProviders, by default uses FirstMatchStrategy.
*
* @param providers the list of FeatureProviders to initialize the MultiProvider with
*/
public MultiProvider(List<FeatureProvider> providers) {
this(providers, null);
}

/**
* Constructs a MultiProvider with the given list of FeatureProviders and a strategy.
*
* @param providers the list of FeatureProviders to initialize the MultiProvider with
* @param strategy the strategy
*/
public MultiProvider(List<FeatureProvider> providers, Strategy strategy) {
this.providers = buildProviders(providers);
if (strategy != null) {
this.strategy = strategy;
} else {
this.strategy = new FirstMatchStrategy();
}
}

protected static Map<String, FeatureProvider> buildProviders(List<FeatureProvider> providers) {
Map<String, FeatureProvider> providersMap = new LinkedHashMap<>(providers.size());
for (FeatureProvider provider : providers) {
FeatureProvider prevProvider =
providersMap.put(provider.getMetadata().getName(), provider);
if (prevProvider != null) {
log.warn("duplicated provider name: {}", provider.getMetadata().getName());
}
}
return Collections.unmodifiableMap(providersMap);
}

/**
* Initialize the provider.
*
* @param evaluationContext evaluation context
* @throws Exception on error
*/
@Override
public void initialize(EvaluationContext evaluationContext) throws Exception {
var metadataBuilder = MultiProviderMetadata.builder();
metadataBuilder.name(NAME);
HashMap<String, Metadata> providersMetadata = new HashMap<>();
ExecutorService executorService = Executors.newFixedThreadPool(Math.min(INIT_THREADS_COUNT, providers.size()));
Collection<Callable<Boolean>> tasks = new ArrayList<>(providers.size());
for (FeatureProvider provider : providers.values()) {
tasks.add(() -> {
provider.initialize(evaluationContext);
return true;
});
Metadata providerMetadata = provider.getMetadata();
providersMetadata.put(providerMetadata.getName(), providerMetadata);
}
metadataBuilder.originalMetadata(providersMetadata);
List<Future<Boolean>> results = executorService.invokeAll(tasks);
for (Future<Boolean> result : results) {
if (!result.get()) {
executorService.shutdown();
throw new GeneralError("init failed");
}
}
executorService.shutdown();
metadata = metadataBuilder.build();
}
Comment on lines +80 to +104

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The initialize method has a few critical issues:

  1. Crash on empty provider list: If MultiProvider is created with an empty list of providers, providers.size() will be 0, and Executors.newFixedThreadPool(0) will throw an IllegalArgumentException.
  2. Resource leak: If any provider's initialize method throws an exception, the ExecutorService is not shut down, leading to a resource leak.
  3. Unreachable code: The if (!result.get()) block is unreachable because result.get() will either return true or throw an exception.
  4. Mutable state: The providersMetadata map is passed to the builder without being made unmodifiable, which could lead to modification of internal state.

I suggest refactoring the method to handle these issues.

    public void initialize(EvaluationContext evaluationContext) throws Exception {
        var metadataBuilder = MultiProviderMetadata.builder().name(NAME);
        HashMap<String, Metadata> providersMetadata = new HashMap<>();

        if (providers.isEmpty()) {
            metadataBuilder.originalMetadata(providersMetadata);
            metadata = metadataBuilder.build();
            return;
        }

        ExecutorService executorService =
                Executors.newFixedThreadPool(Math.min(INIT_THREADS_COUNT, providers.size()));
        try {
            Collection<Callable<Void>> tasks = new ArrayList<>(providers.size());
            for (FeatureProvider provider : providers.values()) {
                tasks.add(() -> {
                    provider.initialize(evaluationContext);
                    return null;
                });
                Metadata providerMetadata = provider.getMetadata();
                providersMetadata.put(providerMetadata.getName(), providerMetadata);
            }
            // Make the metadata map unmodifiable to protect internal state.
            metadataBuilder.originalMetadata(Collections.unmodifiableMap(providersMetadata));
            List<Future<Void>> results = executorService.invokeAll(tasks);
            for (Future<Void> result : results) {
                // This will re-throw any exception from the provider's initialize method,
                // wrapped in an ExecutionException.
                result.get();
            }
        } finally {
            executorService.shutdown();
        }
        metadata = metadataBuilder.build();
    }


@SuppressFBWarnings(value = "EI_EXPOSE_REP")
@Override
public Metadata getMetadata() {
return metadata;
}

@Override
public ProviderEvaluation<Boolean> getBooleanEvaluation(String key, Boolean defaultValue, EvaluationContext ctx) {
return strategy.evaluate(
providers, key, defaultValue, ctx, p -> p.getBooleanEvaluation(key, defaultValue, ctx));
}

@Override
public ProviderEvaluation<String> getStringEvaluation(String key, String defaultValue, EvaluationContext ctx) {
return strategy.evaluate(providers, key, defaultValue, ctx, p -> p.getStringEvaluation(key, defaultValue, ctx));
}

@Override
public ProviderEvaluation<Integer> getIntegerEvaluation(String key, Integer defaultValue, EvaluationContext ctx) {
return strategy.evaluate(
providers, key, defaultValue, ctx, p -> p.getIntegerEvaluation(key, defaultValue, ctx));
}

@Override
public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double defaultValue, EvaluationContext ctx) {
return strategy.evaluate(providers, key, defaultValue, ctx, p -> p.getDoubleEvaluation(key, defaultValue, ctx));
}

@Override
public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext ctx) {
return strategy.evaluate(providers, key, defaultValue, ctx, p -> p.getObjectEvaluation(key, defaultValue, ctx));
}

@Override
public void shutdown() {
log.debug("shutdown begin");
for (FeatureProvider provider : providers.values()) {
try {
provider.shutdown();
} catch (Exception e) {
log.error("error shutdown provider {}", provider.getMetadata().getName(), e);
}
}
log.debug("shutdown end");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package dev.openfeature.sdk.multiprovider;

import dev.openfeature.sdk.Metadata;
import java.util.Map;
import lombok.Builder;
import lombok.Data;

/**
* Metadata class for Multiprovider.
*/
@Data
@Builder
public class MultiProviderMetadata implements Metadata {
String name;
Map<String, Metadata> originalMetadata;

@Override
public String getName() {
return name;
}
}
Comment on lines +11 to +21

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The MultiProviderMetadata class is currently mutable due to Lombok's @Data annotation, which generates setters. This could allow external code to modify the metadata of the MultiProvider, which is generally undesirable. To ensure immutability, I recommend using @Value instead of @Data. @Value creates an immutable class with private final fields and getters. The explicit getName() override also becomes unnecessary as @Value will generate it.

@lombok.Value
@Builder
public class MultiProviderMetadata implements Metadata {
    String name;
    Map<String, Metadata> originalMetadata;
}

17 changes: 17 additions & 0 deletions src/main/java/dev/openfeature/sdk/multiprovider/Strategy.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package dev.openfeature.sdk.multiprovider;

import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.ProviderEvaluation;
import java.util.Map;
import java.util.function.Function;

/** strategy. */
public interface Strategy {
<T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Function<FeatureProvider, ProviderEvaluation<T>> providerFunction);
}
Loading
Loading