Skip to content

feat: Allow for providers with equal name in the multiprovider #1848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chrfwow wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Allow for providers with equal name in the multiprovider #1848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/main/java/dev/openfeature/sdk/multiprovider/FirstMatchStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.ProviderEvaluation;
import dev.openfeature.sdk.exceptions.FlagNotFoundError;
import java.util.Map;
import java.util.List;
import java.util.function.Function;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
Expand All @@ -31,12 +31,12 @@ public class FirstMatchStrategy implements Strategy {

@Override
public <T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
List<FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Function<FeatureProvider, ProviderEvaluation<T>> providerFunction) {
for (FeatureProvider provider : providers.values()) {
for (FeatureProvider provider : providers) {
try {
ProviderEvaluation<T> res = providerFunction.apply(provider);
ErrorCode errorCode = res.getErrorCode();
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/dev/openfeature/sdk/multiprovider/FirstSuccessfulStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.ProviderEvaluation;
import java.util.Map;
import java.util.List;
import java.util.function.Function;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
Expand All @@ -22,12 +22,12 @@ public class FirstSuccessfulStrategy implements Strategy {

@Override
public <T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
List<FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Function<FeatureProvider, ProviderEvaluation<T>> providerFunction) {
for (FeatureProvider provider : providers.values()) {
for (FeatureProvider provider : providers) {
try {
ProviderEvaluation<T> res = providerFunction.apply(provider);
if (res.getErrorCode() == null) {
Expand Down
36 changes: 10 additions & 26 deletions src/main/java/dev/openfeature/sdk/multiprovider/MultiProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,9 @@
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.Objects;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import lombok.Getter;
Expand All @@ -38,7 +34,7 @@ public class MultiProvider extends EventProvider {
// Use CPU count as upper bound for init threads.
public static final int INIT_THREADS_COUNT = Runtime.getRuntime().availableProcessors();

private final Map<String, FeatureProvider> providers;
private final List<FeatureProvider> providers;
private final Strategy strategy;
private MultiProviderMetadata metadata;

Expand All @@ -59,22 +55,10 @@ public MultiProvider(List<FeatureProvider> providers) {
* @param strategy the strategy (if {@code null}, {@link FirstMatchStrategy} is used)
*/
public MultiProvider(List<FeatureProvider> providers, Strategy strategy) {
this.providers = buildProviders(providers);
this.providers = providers;
this.strategy = Objects.requireNonNull(strategy, "strategy must not be null");
}

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.info("duplicated provider name: {}", provider.getMetadata().getName());
}
}
return Collections.unmodifiableMap(providersMap);
}

/**
* Initialize the provider.
*
Expand All @@ -85,27 +69,27 @@ protected static Map<String, FeatureProvider> buildProviders(List<FeatureProvide
@Override
public void initialize(EvaluationContext evaluationContext) throws Exception {
var metadataBuilder = MultiProviderMetadata.builder().name(NAME);
HashMap<String, Metadata> providersMetadata = new HashMap<>();

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

ExecutorService executorService = Executors.newFixedThreadPool(Math.min(INIT_THREADS_COUNT, providers.size()));
List<Metadata> providersMetadata = new ArrayList<>(providers.size());

var executorService = Executors.newFixedThreadPool(Math.min(INIT_THREADS_COUNT, providers.size()));
try {
Collection<Callable<Void>> tasks = new ArrayList<>(providers.size());
for (FeatureProvider provider : providers.values()) {
for (FeatureProvider provider : providers) {
tasks.add(() -> {
provider.initialize(evaluationContext);
return null;
});
Metadata providerMetadata = provider.getMetadata();
providersMetadata.put(providerMetadata.getName(), providerMetadata);
providersMetadata.add(provider.getMetadata());
}

metadataBuilder.originalMetadata(Collections.unmodifiableMap(providersMetadata));
metadataBuilder.originalMetadata(Collections.unmodifiableList(providersMetadata));

List<Future<Void>> results = executorService.invokeAll(tasks);
for (Future<Void> result : results) {
Expand Down Expand Up @@ -165,7 +149,7 @@ public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultVa
@Override
public void shutdown() {
log.debug("shutdown begin");
for (FeatureProvider provider : providers.values()) {
for (FeatureProvider provider : providers) {
try {
provider.shutdown();
} catch (Exception e) {
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/dev/openfeature/sdk/multiprovider/MultiProviderMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
package dev.openfeature.sdk.multiprovider;

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

/**
* Metadata for {@link MultiProvider}.
*
* <p>Contains the multiprovider's own name and a map of the original metadata from each underlying
* <p>Contains the multiprovider's own name and a list of the original metadata from each underlying
* provider.
*/
@Value
@Builder
public class MultiProviderMetadata implements Metadata {

String name;
Map<String, Metadata> originalMetadata;
List<Metadata> originalMetadata;
}
4 changes: 2 additions & 2 deletions src/main/java/dev/openfeature/sdk/multiprovider/Strategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.ProviderEvaluation;
import java.util.Map;
import java.util.List;
import java.util.function.Function;

/**
Expand All @@ -30,7 +30,7 @@ public interface Strategy {
* @return the resolved {@link ProviderEvaluation}
*/
<T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
List<FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Expand Down
13 changes: 7 additions & 6 deletions src/test/java/dev/openfeature/sdk/multiprovider/BaseStrategyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
import dev.openfeature.sdk.Value;
import dev.openfeature.sdk.providers.memory.Flag;
import dev.openfeature.sdk.providers.memory.InMemoryProvider;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.junit.jupiter.api.BeforeEach;

Expand All @@ -31,7 +32,7 @@ public abstract class BaseStrategyTest {
protected InMemoryProvider inMemoryProvider1;
protected InMemoryProvider inMemoryProvider2;

protected Map<String, FeatureProvider> orderedProviders;
protected List<FeatureProvider> orderedProviders;

protected EvaluationContext contextWithNewProvider;

Expand Down Expand Up @@ -84,10 +85,10 @@ public Metadata getMetadata() {
}

protected void setupOrderedProviders() {
orderedProviders = new LinkedHashMap<>();
orderedProviders.put("provider1", mockProvider1);
orderedProviders.put("provider2", mockProvider2);
orderedProviders.put("provider3", mockProvider3);
orderedProviders = new ArrayList<>(3);
orderedProviders.add(mockProvider1);
orderedProviders.add(mockProvider2);
orderedProviders.add(mockProvider3);
}

protected void setupEvaluationContexts() {
Expand Down
4 changes: 2 additions & 2 deletions src/test/java/dev/openfeature/sdk/multiprovider/FirstSuccessfulStrategyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ void shouldSkipProvidersThatOnlyReturnErrors() {
@Test
void shouldThrowGeneralErrorForNonExistentFlag() {
orderedProviders.clear();
orderedProviders.put("old-provider", inMemoryProvider1);
orderedProviders.put("new-provider", inMemoryProvider2);
orderedProviders.add(inMemoryProvider1);
orderedProviders.add(inMemoryProvider2);
ProviderEvaluation<String> providerEvaluation = strategy.evaluate(
orderedProviders,
FLAG_KEY,
Expand Down
19 changes: 11 additions & 8 deletions src/test/java/dev/openfeature/sdk/multiprovider/MultiProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
Expand All @@ -19,7 +20,6 @@
import dev.openfeature.sdk.exceptions.GeneralError;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.function.Function;
import lombok.SneakyThrows;
Expand All @@ -46,9 +46,9 @@ void shouldInitializeSuccessfully() {
multiProvider.initialize(null);

MultiProviderMetadata metadata = (MultiProviderMetadata) multiProvider.getMetadata();
Map<String, Metadata> map = metadata.getOriginalMetadata();
assertEquals(mockMetaData1, map.get(mockProvider1.getMetadata().getName()));
assertEquals(mockMetaData2, map.get(mockProvider2.getMetadata().getName()));
List<Metadata> list = metadata.getOriginalMetadata();
assertTrue(list.contains(mockMetaData1));
assertTrue(list.contains(mockMetaData2));
assertEquals("multiprovider", multiProvider.getMetadata().getName());
}

Expand Down Expand Up @@ -93,8 +93,8 @@ void shouldRetrieveCorrectMetadataName() {
MultiProvider multiProvider = new MultiProvider(providers, mockStrategy);
multiProvider.initialize(null);
MultiProviderMetadata metadata = (MultiProviderMetadata) multiProvider.getMetadata();
Map<String, Metadata> map = metadata.getOriginalMetadata();
assertEquals(mockMetaData1, map.get(mockProvider1.getMetadata().getName()));
List<Metadata> list = metadata.getOriginalMetadata();
assertTrue(list.contains(mockMetaData1));
}

@SneakyThrows
Expand Down Expand Up @@ -126,7 +126,7 @@ void shouldWorkWithCustomStrategy() {

@Override
public <T> ProviderEvaluation<T> evaluate(
Map<String, FeatureProvider> providers,
List<FeatureProvider> providers,
String key,
T defaultValue,
EvaluationContext ctx,
Expand All @@ -138,7 +138,10 @@ public <T> ProviderEvaluation<T> evaluate(
}

if (contextProvider != null && "new-provider".equals(contextProvider.asString())) {
return providerFunction.apply(providers.get("new-provider"));
return providerFunction.apply(providers.stream()
.filter(p -> "new-provider".equals(p.getMetadata().getName()))
.findFirst()
.orElseThrow());
}
return fallbackStrategy.evaluate(providers, key, defaultValue, ctx, providerFunction);
}
Expand Down
Loading