Datasets:
File size: 9,431 Bytes
0e239c6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | diff --git a/.gitignore b/.gitignore
index bd26102..31051c7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,4 @@ target
# used for spec compliance tooling
java-report.json
+.worktrees/
diff --git a/src/main/java/dev/openfeature/sdk/FeatureProvider.java b/src/main/java/dev/openfeature/sdk/FeatureProvider.java
index a010e55..54ca2dd 100644
--- a/src/main/java/dev/openfeature/sdk/FeatureProvider.java
+++ b/src/main/java/dev/openfeature/sdk/FeatureProvider.java
@@ -185,6 +185,38 @@ public interface FeatureProvider {
// Intentionally left blank
}
+ /**
+ * This method is called before a provider is used to evaluate flags, with the
+ * bound domain supplied when the provider is registered to a named client.
+ *
+ * <p>
+ * The default provider is initialized with a {@code null} domain. Providers that
+ * maintain per-domain state (for example a persistent cache) should override this
+ * method and declare themselves {@linkplain #isDomainScoped() domain-scoped}.
+ * </p>
+ *
+ * @param evaluationContext the global evaluation context
+ * @param domain the bound domain, or {@code null} for the default provider
+ */
+ default void initialize(EvaluationContext evaluationContext, String domain) throws Exception {
+ initialize(evaluationContext);
+ }
+
+ /**
+ * Returns whether this provider maintains state specific to a single domain that
+ * cannot be shared across domains.
+ *
+ * <p>
+ * Domain-scoped providers may only be bound to one domain within a single API
+ * instance.
+ * </p>
+ *
+ * @return {@code true} if this provider is domain-scoped
+ */
+ default boolean isDomainScoped() {
+ return false;
+ }
+
/**
* Called when a provider is about to be replaced or the SDK is shutting down. Providers can
* override this method if they have resources to release (background threads, connections,
diff --git a/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java b/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java
index cbdb4d8..eb461d7 100644
--- a/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java
+++ b/src/main/java/dev/openfeature/sdk/FeatureProviderStateManager.java
@@ -19,11 +19,15 @@ class FeatureProviderStateManager implements EventProviderListener {
}
public void initialize(EvaluationContext evaluationContext) throws Exception {
+ initialize(evaluationContext, null);
+ }
+
+ public void initialize(EvaluationContext evaluationContext, String domain) throws Exception {
if (isInitialized.getAndSet(true)) {
return;
}
try {
- delegate.initialize(evaluationContext);
+ delegate.initialize(evaluationContext, domain);
setState(ProviderState.READY);
} catch (OpenFeatureError openFeatureError) {
if (ErrorCode.PROVIDER_FATAL.equals(openFeatureError.getErrorCode())) {
diff --git a/src/main/java/dev/openfeature/sdk/ProviderRepository.java b/src/main/java/dev/openfeature/sdk/ProviderRepository.java
index 7fcb8f4..816f05a 100644
--- a/src/main/java/dev/openfeature/sdk/ProviderRepository.java
+++ b/src/main/java/dev/openfeature/sdk/ProviderRepository.java
@@ -169,6 +169,7 @@ class ProviderRepository {
throw new IllegalStateException("Provider cannot be set while repository is shutting down");
}
FeatureProviderStateManager existing = getExistingStateManagerForProvider(newProvider);
+ validateDomainScopedBinding(domain, newProvider);
if (existing == null) {
openFeatureAPI.registerGlobalProvider(newProvider);
newStateManager = new FeatureProviderStateManager(newProvider);
@@ -185,29 +186,68 @@ class ProviderRepository {
}
if (waitForInit) {
- initializeProvider(newStateManager, afterInit, afterShutdown, afterError, oldStateManager);
+ initializeProvider(domain, newStateManager, afterInit, afterShutdown, afterError, oldStateManager);
} else {
taskExecutor.submit(() -> {
// initialization happens in a different thread if we're not waiting for it
- initializeProvider(newStateManager, afterInit, afterShutdown, afterError, oldStateManager);
+ initializeProvider(domain, newStateManager, afterInit, afterShutdown, afterError, oldStateManager);
});
}
}
+ private void validateDomainScopedBinding(String domain, FeatureProvider newProvider) {
+ if (!newProvider.isDomainScoped()) {
+ return;
+ }
+
+ // a re-set to the identical binding is always allowed (it's a no-op)
+ boolean alreadyBoundHere = domain == null
+ ? isDefaultProviderInstance(newProvider)
+ : getBoundDomainsForProviderInstance(newProvider).contains(domain);
+ if (alreadyBoundHere) {
+ return;
+ }
+
+ // any other existing binding means this instance would span more than one domain
+ if (isDefaultProviderInstance(newProvider)
+ || !getBoundDomainsForProviderInstance(newProvider).isEmpty()) {
+ throw new IllegalArgumentException("Domain-scoped provider cannot be bound to more than one domain");
+ }
+ }
+
+ private boolean isDefaultProviderInstance(FeatureProvider provider) {
+ return defaultStateManger.get().getProvider() == provider;
+ }
+
+ private List<String> getBoundDomainsForProviderInstance(FeatureProvider provider) {
+ return stateManagers.entrySet().stream()
+ .filter(entry -> entry.getValue().getProvider() == provider)
+ .map(Map.Entry::getKey)
+ .collect(Collectors.toList());
+ }
+
private FeatureProviderStateManager getExistingStateManagerForProvider(FeatureProvider provider) {
for (FeatureProviderStateManager stateManager : stateManagers.values()) {
- if (stateManager.hasSameProvider(provider)) {
+ if (matchesProvider(stateManager.getProvider(), provider)) {
return stateManager;
}
}
FeatureProviderStateManager defaultFeatureProviderStateManager = defaultStateManger.get();
- if (defaultFeatureProviderStateManager.hasSameProvider(provider)) {
+ if (matchesProvider(defaultFeatureProviderStateManager.getProvider(), provider)) {
return defaultFeatureProviderStateManager;
}
return null;
}
+ private boolean matchesProvider(FeatureProvider registered, FeatureProvider candidate) {
+ if (candidate.isDomainScoped()) {
+ return registered == candidate;
+ }
+ return registered.equals(candidate);
+ }
+
private void initializeProvider(
+ String domain,
FeatureProviderStateManager newManager,
Consumer<FeatureProvider> afterInit,
Consumer<FeatureProvider> afterShutdown,
@@ -215,7 +255,7 @@ class ProviderRepository {
FeatureProviderStateManager oldManager) {
try {
if (ProviderState.NOT_READY.equals(newManager.getState())) {
- newManager.initialize(openFeatureAPI.getEvaluationContext());
+ newManager.initialize(openFeatureAPI.getEvaluationContext(), domain);
afterInit.accept(newManager.getProvider());
}
shutDownOld(oldManager, afterShutdown);
diff --git a/src/main/java/dev/openfeature/sdk/multiprovider/MultiProvider.java b/src/main/java/dev/openfeature/sdk/multiprovider/MultiProvider.java
index cc6fb8d..00611ed 100644
--- a/src/main/java/dev/openfeature/sdk/multiprovider/MultiProvider.java
+++ b/src/main/java/dev/openfeature/sdk/multiprovider/MultiProvider.java
@@ -76,14 +76,24 @@ public class MultiProvider extends EventProvider {
}
/**
- * Initialize the provider.
+ * {@inheritDoc}
*
- * @param evaluationContext evaluation context
* @throws Exception on error (e.g. wrapped {@link java.util.concurrent.ExecutionException}
* from a failing provider)
*/
@Override
public void initialize(EvaluationContext evaluationContext) throws Exception {
+ initialize(evaluationContext, null);
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * @throws Exception on error (e.g. wrapped {@link java.util.concurrent.ExecutionException}
+ * from a failing provider)
+ */
+ @Override
+ public void initialize(EvaluationContext evaluationContext, String domain) throws Exception {
var metadataBuilder = MultiProviderMetadata.builder().name(NAME);
HashMap<String, Metadata> providersMetadata = new HashMap<>();
@@ -98,7 +108,7 @@ public class MultiProvider extends EventProvider {
Collection<Callable<Void>> tasks = new ArrayList<>(providers.size());
for (FeatureProvider provider : providers.values()) {
tasks.add(() -> {
- provider.initialize(evaluationContext);
+ provider.initialize(evaluationContext, domain);
return null;
});
Metadata providerMetadata = provider.getMetadata();
|