Skip to content
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

feat: Set Unleash changed flags on change event. #724

Closed
wants to merge 1 commit into from
Closed

feat: Set Unleash changed flags on change event. #724

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
8 changes: 8 additions & 0 deletions ...ash/src/main/java/dev/openfeature/contrib/providers/unleash/UnleashSubscriberWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import dev.openfeature.sdk.EventProvider;
import dev.openfeature.sdk.ImmutableMetadata;
import dev.openfeature.sdk.ProviderEventDetails;
import io.getunleash.FeatureToggle;
import io.getunleash.UnleashException;
import io.getunleash.event.ImpressionEvent;
import io.getunleash.event.ToggleEvaluated;
Expand All @@ -18,6 +19,8 @@
import lombok.extern.slf4j.Slf4j;

import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;

/**
* UnleashSubscriber wrapper for emitting event provider events.
Expand Down Expand Up @@ -69,7 +72,12 @@ public void toggleEvaluated(ToggleEvaluated toggleEvaluated) {
public void togglesFetched(FeatureToggleResponse toggleResponse) {
unleashSubscriber.togglesFetched(toggleResponse);
if (FeatureToggleResponse.Status.CHANGED.equals(toggleResponse.getStatus())) {
List<String> flagsChanged = new ArrayList<>();
for (FeatureToggle featureToggle : toggleResponse.getToggleCollection().getFeatures()) {
Copy link
Member

Choose a reason for hiding this comment

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

What does toggleResponse.getToggleCollection().getFeatures() contain ?
Only changed features ?
Any documentation reference from Unleash ?

Copy link
Author

Choose a reason for hiding this comment

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

Yeah, unfortunately, as per my other comment, it contains all the feature toggles available from the Unleash API, not just the changed ones, so this implementation doesn't work as intended.

flagsChanged.add(featureToggle.getName());
}
eventProvider.emitProviderConfigurationChanged(ProviderEventDetails.builder()
.flagsChanged(flagsChanged)
.eventMetadata(ImmutableMetadata.builder()
.build()).build());
}
Expand Down
43 changes: 42 additions & 1 deletion .../unleash/src/test/java/dev/openfeature/contrib/providers/unleash/UnleashProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
import com.github.tomakehurst.wiremock.junit5.WireMockTest;
import dev.openfeature.sdk.Client;
import dev.openfeature.sdk.EventDetails;
import dev.openfeature.sdk.ImmutableContext;
import dev.openfeature.sdk.ImmutableMetadata;
import dev.openfeature.sdk.MutableContext;
Expand All @@ -13,12 +14,16 @@
import dev.openfeature.sdk.Value;
import dev.openfeature.sdk.exceptions.GeneralError;
import dev.openfeature.sdk.exceptions.ProviderNotReadyError;
import io.getunleash.FeatureToggle;
import io.getunleash.UnleashContext;
import io.getunleash.UnleashException;
import io.getunleash.event.ToggleEvaluated;
import io.getunleash.event.UnleashEvent;
import io.getunleash.event.UnleashSubscriber;
import io.getunleash.repository.ClientFeaturesResponse;
import io.getunleash.repository.FeatureToggleResponse;
import io.getunleash.repository.SegmentCollection;
import io.getunleash.repository.ToggleCollection;
import io.getunleash.util.UnleashConfig;
import lombok.SneakyThrows;
import org.junit.jupiter.api.AfterAll;
Expand All @@ -32,18 +37,23 @@
import java.nio.file.Paths;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;

import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
import static com.github.tomakehurst.wiremock.client.WireMock.any;
import static com.github.tomakehurst.wiremock.client.WireMock.anyUrl;
import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
import static com.github.tomakehurst.wiremock.client.WireMock.get;
import static com.github.tomakehurst.wiremock.client.WireMock.post;
import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
import static com.github.tomakehurst.wiremock.client.WireMock.get;
import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

/**
* UnleashProvider test, based on APIs mocking.
Expand Down Expand Up @@ -289,6 +299,37 @@ void subscriberWrapperTest() {
unleashSubscriberWrapper.togglesBootstrapped(null);
}

@Test
void changedFlagsAreAvailableOnConfigChangedEvent() throws InterruptedException {
UnleashProvider asyncInitUnleashProvider = buildUnleashProvider(false,
"http://fakeAPI", null);
UnleashSubscriberWrapper unleashSubscriberWrapper = new UnleashSubscriberWrapper(
new TestSubscriber(), asyncInitUnleashProvider);
OpenFeatureAPI.getInstance().setProviderAndWait("async", asyncInitUnleashProvider);
Client client = OpenFeatureAPI.getInstance().getClient("async");
CountDownLatch latch = new CountDownLatch(1);
AtomicReference<EventDetails> eventDetails = new AtomicReference<>();
client.onProviderConfigurationChanged(e -> {
eventDetails.set(e);
latch.countDown();
});
Collection<FeatureToggle> changedToggles = new ArrayList<>();
changedToggles.add(new FeatureToggle("a-flag", true, new ArrayList<>()));
changedToggles.add(new FeatureToggle("another-flag", false, new ArrayList<>()));
unleashSubscriberWrapper.togglesFetched(
new ClientFeaturesResponse(
FeatureToggleResponse.Status.CHANGED,
new ToggleCollection(changedToggles),
new SegmentCollection(new ArrayList<>())
)
);
List<String> expectedChangedFlags = new ArrayList<>();
expectedChangedFlags.add("a-flag");
expectedChangedFlags.add("another-flag");
assertTrue(latch.await(1, TimeUnit.SECONDS));
assertEquals(expectedChangedFlags, eventDetails.get().getFlagsChanged());
}

private class TestSubscriber implements UnleashSubscriber {

private FeatureToggleResponse.Status status;
Expand Down
Loading