Skip to content

Commit 9ca7904

Browse files
toddbaerttoddbaert
committed
feat!: use sdk-maintained state, require 1.12
Signed-off-by: Todd Baert <[email protected]>
1 parent 096d407 commit 9ca7904

File tree

24 files changed

+544
-877
lines changed

24 files changed

+544
-877
lines changed

‎hooks/open-telemetry/pom.xml‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,6 @@
3838
</dependencyManagement>
3939

4040
<dependencies>
41-
<dependency>
42-
<groupId>dev.openfeature</groupId>
43-
<artifactId>sdk</artifactId>
44-
<version>[1.4,2.0)</version>
45-
<scope>provided</scope>
46-
</dependency>
47-
4841
<dependency>
4942
<groupId>io.opentelemetry</groupId>
5043
<artifactId>opentelemetry-semconv</artifactId>

‎pom.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,11 @@
6262
<dependencies>
6363
<dependency>
6464
<!-- provided -->
65+
<!-- this can be overriden in child POMs to support specific SDK requirements -->
6566
<groupId>dev.openfeature</groupId>
6667
<artifactId>sdk</artifactId>
67-
<!-- 1.0 <= v < 2.0 -->
68-
<version>[1.0,2.0)</version>
68+
<!-- 1.12 <= v < 2.0 -->
69+
<version>[1.12,2.0)</version>
6970
<!-- use the version provided at runtime -->
7071
<scope>provided</scope>
7172
</dependency>

‎providers/configcat/src/main/java/dev/openfeature/contrib/providers/configcat/ConfigCatProvider.java‎

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ public class ConfigCatProvider extends EventProvider {
3636
@Getter
3737
private ConfigCatClient configCatClient;
3838

39-
@Getter
40-
private ProviderState state = ProviderState.NOT_READY;
41-
4239
private AtomicBoolean isInitialized = new AtomicBoolean(false);
4340

4441
/**
@@ -64,8 +61,7 @@ public void initialize(EvaluationContext evaluationContext) throws Exception {
6461
configCatClient = ConfigCatClient.get(configCatProviderConfig.getSdkKey(),
6562
configCatProviderConfig.getOptions());
6663
configCatProviderConfig.postInit();
67-
state = ProviderState.READY;
68-
log.info("finished initializing provider, state: {}", state);
64+
log.info("finished initializing provider");
6965

7066
configCatClient.getHooks().addOnClientReady(() -> {
7167
ProviderEventDetails providerEventDetails = ProviderEventDetails.builder()
@@ -123,12 +119,6 @@ public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultVa
123119

124120
private <T> ProviderEvaluation<T> getEvaluation(Class<T> classOfT, String key, T defaultValue,
125121
EvaluationContext ctx) {
126-
if (!ProviderState.READY.equals(state)) {
127-
if (ProviderState.NOT_READY.equals(state)) {
128-
throw new ProviderNotReadyError(PROVIDER_NOT_YET_INITIALIZED);
129-
}
130-
throw new GeneralError(UNKNOWN_ERROR);
131-
}
132122
User user = ctx == null ? null : ContextTransformer.transform(ctx);
133123
EvaluationDetails<T> evaluationDetails;
134124
T evaluatedValue;
@@ -157,6 +147,5 @@ public void shutdown() {
157147
if (configCatClient != null) {
158148
configCatClient.close();
159149
}
160-
state = ProviderState.NOT_READY;
161150
}
162151
}

‎providers/configcat/src/test/java/dev/openfeature/contrib/providers/configcat/ConfigCatProviderTest.java‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -181,27 +181,6 @@ void getStringEvaluationByUser() {
181181
assertEquals("fallback", client.getStringValue(USERS_FLAG_NAME + "Str", "111", evaluationContext));
182182
}
183183

184-
@SneakyThrows
185-
@Test
186-
void shouldThrowIfNotInitialized() {
187-
ConfigCatProviderConfig configCatProviderConfig = ConfigCatProviderConfig.builder().sdkKey("configcat-sdk-1/TEST_KEY-0123456789012/1234567890123456789012").build();
188-
ConfigCatProvider tempConfigCatProvider = new ConfigCatProvider(configCatProviderConfig);
189-
190-
assertThrows(ProviderNotReadyError.class, ()-> tempConfigCatProvider.getBooleanEvaluation("fail_not_initialized", false, new ImmutableContext()));
191-
192-
OpenFeatureAPI.getInstance().setProviderAndWait("tempConfigCatProvider", tempConfigCatProvider);
193-
194-
assertThrows(GeneralError.class, ()-> tempConfigCatProvider.initialize(null));
195-
196-
tempConfigCatProvider.shutdown();
197-
198-
assertThrows(ProviderNotReadyError.class, ()-> tempConfigCatProvider.getBooleanEvaluation("fail_not_initialized", false, new ImmutableContext()));
199-
assertThrows(ProviderNotReadyError.class, ()-> tempConfigCatProvider.getDoubleEvaluation("fail_not_initialized", 0.1, new ImmutableContext()));
200-
assertThrows(ProviderNotReadyError.class, ()-> tempConfigCatProvider.getIntegerEvaluation("fail_not_initialized", 3, new ImmutableContext()));
201-
assertThrows(ProviderNotReadyError.class, ()-> tempConfigCatProvider.getObjectEvaluation("fail_not_initialized", null, new ImmutableContext()));
202-
assertThrows(ProviderNotReadyError.class, ()-> tempConfigCatProvider.getStringEvaluation("fail_not_initialized", "", new ImmutableContext()));
203-
}
204-
205184
@Test
206185
void eventsTest() {
207186
configCatProvider.emitProviderReady(ProviderEventDetails.builder().build());

‎providers/flagd/pom.xml‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,7 @@
3232
</developers>
3333

3434
<dependencies>
35-
3635
<!-- we inherent dev.openfeature.javasdk and the test dependencies from the parent pom -->
37-
<!-- override parent definition -->
38-
<dependency>
39-
<groupId>dev.openfeature</groupId>
40-
<artifactId>sdk</artifactId>
41-
<version>[1.4,2.0)</version>
42-
<scope>provided</scope>
43-
</dependency>
44-
4536
<dependency>
4637
<groupId>io.grpc</groupId>
4738
<artifactId>grpc-netty</artifactId>

‎providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/FlagdProvider.java‎

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@
2525
@SuppressWarnings({"PMD.TooManyStaticImports", "checkstyle:NoFinalizer"})
2626
public class FlagdProvider extends EventProvider {
2727
private static final String FLAGD_PROVIDER = "flagD Provider";
28-
29-
private final ReadWriteLock lock = new ReentrantReadWriteLock();
3028
private final Resolver flagResolver;
31-
private ProviderState state = ProviderState.NOT_READY;
32-
private boolean initialized = false;
29+
private volatile boolean initialized = false;
30+
private volatile boolean connected = false;
3331

3432
private EvaluationContext evaluationContext;
3533

@@ -52,14 +50,14 @@ public FlagdProvider() {
5250
public FlagdProvider(final FlagdOptions options) {
5351
switch (options.getResolverType().asString()) {
5452
case Config.RESOLVER_IN_PROCESS:
55-
this.flagResolver = new InProcessResolver(options, this::setState);
53+
this.flagResolver = new InProcessResolver(options, this::isConnected, this::onResolverConnectionChanged);
5654
break;
5755
case Config.RESOLVER_RPC:
5856
this.flagResolver =
5957
new GrpcResolver(options,
6058
new Cache(options.getCacheType(), options.getMaxCacheSize()),
61-
this::getState,
62-
this::setState);
59+
this::isConnected,
60+
this::onResolverConnectionChanged);
6361
break;
6462
default:
6563
throw new IllegalStateException(
@@ -86,24 +84,13 @@ public synchronized void shutdown() {
8684

8785
try {
8886
this.flagResolver.shutdown();
89-
this.initialized = false;
9087
} catch (Exception e) {
9188
log.error("Error during shutdown {}", FLAGD_PROVIDER, e);
92-
}
93-
}
94-
95-
@Override
96-
public ProviderState getState() {
97-
Lock l = this.lock.readLock();
98-
try {
99-
l.lock();
100-
return this.state;
10189
} finally {
102-
l.unlock();
90+
this.initialized = false;
10391
}
10492
}
10593

106-
10794
@Override
10895
public Metadata getMetadata() {
10996
return () -> FLAGD_PROVIDER;
@@ -142,49 +129,32 @@ private EvaluationContext mergeContext(final EvaluationContext clientCallCtx) {
142129
return clientCallCtx;
143130
}
144131

145-
private void setState(ProviderState newState, List<String> changedFlagsKeys) {
146-
ProviderState oldState;
147-
Lock l = this.lock.writeLock();
148-
try {
149-
l.lock();
150-
oldState = this.state;
151-
this.state = newState;
152-
} finally {
153-
l.unlock();
154-
}
155-
this.handleStateTransition(oldState, newState, changedFlagsKeys);
132+
private boolean isConnected() {
133+
return this.connected;
156134
}
157135

158-
private void handleStateTransition(ProviderState oldState, ProviderState newState, List<String> changedFlagKeys) {
159-
// we got initialized
160-
if (ProviderState.NOT_READY.equals(oldState) && ProviderState.READY.equals(newState)) {
161-
// nothing to do, the SDK emits the events
162-
log.debug("Init completed");
163-
return;
164-
}
165-
// we got shutdown, not checking oldState as behavior remains the same for shutdown
166-
if (ProviderState.NOT_READY.equals(newState)) {
167-
// nothing to do
168-
log.debug("shutdown completed");
169-
return;
170-
}
136+
private void onResolverConnectionChanged(boolean newConnectedState, List<String> changedFlagKeys) {
137+
boolean previous = connected;
138+
boolean current = newConnectedState;
139+
this.connected = newConnectedState;
140+
171141
// configuration changed
172-
if (ProviderState.READY.equals(oldState) && ProviderState.READY.equals(newState)) {
142+
if (initialized && previous && current) {
173143
log.debug("Configuration changed");
174144
ProviderEventDetails details = ProviderEventDetails.builder().flagsChanged(changedFlagKeys)
175145
.message("configuration changed").build();
176146
this.emitProviderConfigurationChanged(details);
177147
return;
178148
}
179149
// there was an error
180-
if (ProviderState.READY.equals(oldState) && ProviderState.ERROR.equals(newState)) {
150+
if (initialized && previous && !current) {
181151
log.debug("There has been an error");
182152
ProviderEventDetails details = ProviderEventDetails.builder().message("there has been an error").build();
183153
this.emitProviderError(details);
184154
return;
185155
}
186-
// we recover from an error
187-
if (ProviderState.ERROR.equals(oldState) && ProviderState.READY.equals(newState)) {
156+
// we recovered from an error
157+
if (initialized && !previous && current) {
188158
log.debug("Recovered from error");
189159
ProviderEventDetails details = ProviderEventDetails.builder().message("recovered from error").build();
190160
this.emitProviderReady(details);

‎providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/common/Util.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package dev.openfeature.contrib.providers.flagd.resolver.common;
22

33
import java.util.concurrent.atomic.AtomicBoolean;
4+
import java.util.function.Supplier;
45

56
import dev.openfeature.sdk.exceptions.GeneralError;
67

@@ -14,11 +15,11 @@ private Util() {
1415

1516
/**
1617
* A helper to block the caller for given conditions.
17-
*
1818
* @param deadline number of milliseconds to block
19-
* @param check {@link AtomicBoolean} to check for status true
19+
* @param connectedSupplier func to check for status true
20+
* @throws InterruptedException
2021
*/
21-
public static void busyWaitAndCheck(final Long deadline, final AtomicBoolean check) throws InterruptedException {
22+
public static void busyWaitAndCheck(final Long deadline, final Supplier<Boolean> connectedSupplier) throws InterruptedException {
2223
long start = System.currentTimeMillis();
2324

2425
do {
@@ -28,6 +29,6 @@ public static void busyWaitAndCheck(final Long deadline, final AtomicBoolean che
2829
}
2930

3031
Thread.sleep(50L);
31-
} while (!check.get());
32+
} while (!connectedSupplier.get());
3233
}
3334
}

‎providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/grpc/EventStreamObserver.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
@Slf4j
2121
@SuppressFBWarnings(justification = "cache needs to be read and write by multiple objects")
2222
class EventStreamObserver implements StreamObserver<EventStreamResponse> {
23-
private final BiConsumer<ProviderState, List<String>> stateConsumer;
23+
private final BiConsumer<Boolean, List<String>> stateConsumer;
2424
private final Object sync;
2525
private final Cache cache;
2626

@@ -35,7 +35,7 @@ class EventStreamObserver implements StreamObserver<EventStreamResponse> {
3535
* @param cache cache to update
3636
* @param stateConsumer lambda to call for setting the state
3737
*/
38-
EventStreamObserver(Object sync, Cache cache, BiConsumer<ProviderState, List<String>> stateConsumer) {
38+
EventStreamObserver(Object sync, Cache cache, BiConsumer<Boolean, List<String>> stateConsumer) {
3939
this.sync = sync;
4040
this.cache = cache;
4141
this.stateConsumer = stateConsumer;
@@ -61,7 +61,7 @@ public void onError(Throwable t) {
6161
if (this.cache.getEnabled()) {
6262
this.cache.clear();
6363
}
64-
this.stateConsumer.accept(ProviderState.ERROR, Collections.emptyList());
64+
this.stateConsumer.accept(false, Collections.emptyList());
6565

6666
// handle last call of this stream
6767
handleEndOfStream();
@@ -72,7 +72,7 @@ public void onCompleted() {
7272
if (this.cache.getEnabled()) {
7373
this.cache.clear();
7474
}
75-
this.stateConsumer.accept(ProviderState.ERROR, Collections.emptyList());
75+
this.stateConsumer.accept(false, Collections.emptyList());
7676

7777
// handle last call of this stream
7878
handleEndOfStream();
@@ -99,11 +99,11 @@ private void handleConfigurationChangeEvent(EventStreamResponse value) {
9999
}
100100
}
101101

102-
this.stateConsumer.accept(ProviderState.READY, changedFlags);
102+
this.stateConsumer.accept(true, changedFlags);
103103
}
104104

105105
private void handleProviderReadyEvent() {
106-
this.stateConsumer.accept(ProviderState.READY, Collections.emptyList());
106+
this.stateConsumer.accept(true, Collections.emptyList());
107107
if (this.cache.getEnabled()) {
108108
this.cache.clear();
109109
}

0 commit comments

Comments
 (0)