Skip to content

feat!: update to sdk 0.3.0 #116

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

Merged
merged 3 commits into from
Oct 13, 2022
Merged

feat!: update to sdk 0.3.0 #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c763aeb
feat!: udpate to sdk 0.3.0
toddbaert Oct 6, 2022
1e1f547
use real sdk
toddbaert Oct 13, 2022
2d4d49d
update comment
toddbaert Oct 13, 2022
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 hooks/open-telemetry/src/main/java/dev/openfeature/contrib/hooks/otel/OpenTelemetryHook.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package dev.openfeature.contrib.hooks.otel;

import dev.openfeature.javasdk.Client;
import dev.openfeature.javasdk.NoOpProvider;
import dev.openfeature.javasdk.OpenFeatureAPI;
import dev.openfeature.sdk.Client;
import dev.openfeature.sdk.NoOpProvider;
import dev.openfeature.sdk.OpenFeatureAPI;

/**
* A placeholder.
Expand Down
8 changes: 4 additions & 4 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@

<dependencies>
<dependency>
<!-- provided -->
<!-- provided -->
<groupId>dev.openfeature</groupId>
<artifactId>javasdk</artifactId>
<!-- 0.2.0 or greater -->
<version>[0.2,)</version>
<artifactId>sdk</artifactId>
<!-- 0.3.0 or greater -->
<version>[0.3,)</version>
<!-- use the version provided at runtime -->
<scope>provided</scope>
</dependency>
Expand Down
36 changes: 12 additions & 24 deletions providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/FlagdProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
import java.util.Map;
import java.util.stream.Collectors;

import org.apache.commons.lang3.EnumUtils;

import dev.openfeature.flagd.grpc.Schema.ResolveBooleanRequest;
import dev.openfeature.flagd.grpc.Schema.ResolveBooleanResponse;
import dev.openfeature.flagd.grpc.Schema.ResolveFloatRequest;
Expand All @@ -19,13 +17,12 @@
import dev.openfeature.flagd.grpc.Schema.ResolveStringResponse;
import dev.openfeature.flagd.grpc.ServiceGrpc;
import dev.openfeature.flagd.grpc.ServiceGrpc.ServiceBlockingStub;
import dev.openfeature.javasdk.EvaluationContext;
import dev.openfeature.javasdk.FeatureProvider;
import dev.openfeature.javasdk.Metadata;
import dev.openfeature.javasdk.ProviderEvaluation;
import dev.openfeature.javasdk.Reason;
import dev.openfeature.javasdk.Structure;
import dev.openfeature.javasdk.Value;
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.Metadata;
import dev.openfeature.sdk.MutableStructure;
import dev.openfeature.sdk.ProviderEvaluation;
import dev.openfeature.sdk.Value;
import io.grpc.ManagedChannelBuilder;
import lombok.extern.slf4j.Slf4j;

Expand Down Expand Up @@ -97,7 +94,7 @@ public ProviderEvaluation<Boolean> getBooleanEvaluation(String key, Boolean defa
return ProviderEvaluation.<Boolean>builder()
.value(r.getValue())
.variant(r.getVariant())
.reason(this.mapReason(r.getReason()))
.reason(r.getReason())
.build();
}

Expand All @@ -110,7 +107,7 @@ public ProviderEvaluation<String> getStringEvaluation(String key, String default
ResolveStringResponse r = this.serviceStub.resolveString(request);
return ProviderEvaluation.<String>builder().value(r.getValue())
.variant(r.getVariant())
.reason(this.mapReason(r.getReason()))
.reason(r.getReason())
.build();
}

Expand All @@ -125,7 +122,7 @@ public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double default
return ProviderEvaluation.<Double>builder()
.value(r.getValue())
.variant(r.getVariant())
.reason(this.mapReason(r.getReason()))
.reason(r.getReason())
.build();
}

Expand All @@ -140,7 +137,7 @@ public ProviderEvaluation<Integer> getIntegerEvaluation(String key, Integer defa
return ProviderEvaluation.<Integer>builder()
.value((int) r.getValue())
.variant(r.getVariant())
.reason(this.mapReason(r.getReason()))
.reason(r.getReason())
.build();
}

Expand All @@ -155,19 +152,10 @@ public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultVa
return ProviderEvaluation.<Value>builder()
.value(this.convertObjectResponse(r.getValue()))
.variant(r.getVariant())
.reason(this.mapReason(r.getReason()))
.reason(r.getReason())
.build();
}

// Map FlagD reasons to Java SDK reasons.
private Reason mapReason(String flagdReason) {
if (!EnumUtils.isValidEnum(Reason.class, flagdReason)) {
return Reason.UNKNOWN;
} else {
return Reason.valueOf(flagdReason);
}
}

Comment on lines -162 to -170
Copy link
Member Author

Choose a reason for hiding this comment

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

reasons are strings now.

/**
* Recursively convert protobuf structure to openfeature value.
*/
Expand Down Expand Up @@ -233,7 +221,7 @@ private Value convertProtobufMap(Map<String, com.google.protobuf.Value> map) {
com.google.protobuf.Value value = map.get(key);
values.put(key, this.convertAny(value));
});
return new Value(new Structure(values));
return new Value(new MutableStructure(values));
}

/**
Expand Down
39 changes: 21 additions & 18 deletions providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/FlagdProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@
import dev.openfeature.flagd.grpc.Schema.ResolveObjectResponse;
import dev.openfeature.flagd.grpc.Schema.ResolveStringResponse;
import dev.openfeature.flagd.grpc.ServiceGrpc.ServiceBlockingStub;
import dev.openfeature.javasdk.EvaluationContext;
import dev.openfeature.javasdk.FlagEvaluationDetails;
import dev.openfeature.javasdk.OpenFeatureAPI;
import dev.openfeature.javasdk.Reason;
import dev.openfeature.javasdk.Structure;
import dev.openfeature.javasdk.Value;
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FlagEvaluationDetails;
import dev.openfeature.sdk.MutableContext;
import dev.openfeature.sdk.MutableStructure;
import dev.openfeature.sdk.OpenFeatureAPI;
import dev.openfeature.sdk.Reason;
import dev.openfeature.sdk.Structure;
import dev.openfeature.sdk.Value;

class FlagdProviderTest {

Expand All @@ -40,7 +42,7 @@ class FlagdProviderTest {
static final Double DOUBLE_VALUE = .5d;
static final String INNER_STRUCT_KEY = "inner_key";
static final String INNER_STRUCT_VALUE = "inner_value";
static final Structure OBJECT_VALUE = new Structure() {{
static final Structure OBJECT_VALUE = new MutableStructure() {{
add(INNER_STRUCT_KEY, INNER_STRUCT_VALUE);
}};
static final com.google.protobuf.Struct PROTOBUF_STRUCTURE_VALUE = com.google.protobuf.Struct.newBuilder()
Expand Down Expand Up @@ -104,28 +106,28 @@ void resolvers_call_grpc_service_and_return_details() {
FlagEvaluationDetails<Boolean> booleanDetails = api.getClient().getBooleanDetails(FLAG_KEY, false);
assertTrue(booleanDetails.getValue());
assertEquals(BOOL_VARIANT, booleanDetails.getVariant());
assertEquals(DEFAULT, booleanDetails.getReason());
assertEquals(DEFAULT.toString(), booleanDetails.getReason());

FlagEvaluationDetails<String> stringDetails = api.getClient().getStringDetails(FLAG_KEY, "wrong");
assertEquals(STRING_VALUE, stringDetails.getValue());
assertEquals(STRING_VARIANT, stringDetails.getVariant());
assertEquals(DEFAULT, stringDetails.getReason());
assertEquals(DEFAULT.toString(), stringDetails.getReason());

FlagEvaluationDetails<Integer> intDetails = api.getClient().getIntegerDetails(FLAG_KEY, 0);
assertEquals(INT_VALUE, intDetails.getValue());
assertEquals(INT_VARIANT, intDetails.getVariant());
assertEquals(DEFAULT, intDetails.getReason());
assertEquals(DEFAULT.toString(), intDetails.getReason());

FlagEvaluationDetails<Double> floatDetails = api.getClient().getDoubleDetails(FLAG_KEY, 0.1);
assertEquals(DOUBLE_VALUE, floatDetails.getValue());
assertEquals(DOUBLE_VARIANT, floatDetails.getVariant());
assertEquals(DEFAULT, floatDetails.getReason());
assertEquals(DEFAULT.toString(), floatDetails.getReason());

FlagEvaluationDetails<Value> objectDetails = api.getClient().getObjectDetails(FLAG_KEY, new Value());
assertEquals(INNER_STRUCT_VALUE, objectDetails.getValue().asStructure()
.asMap().get(INNER_STRUCT_KEY).asString());
assertEquals(OBJECT_VARIANT, objectDetails.getVariant());
assertEquals(DEFAULT, objectDetails.getReason());
assertEquals(DEFAULT.toString(), objectDetails.getReason());
}

@Test
Expand All @@ -147,7 +149,7 @@ void context_is_parsed_and_passed_to_grpc_service() {
add(new Value(1));
}};
final String STRUCT_ATTR_INNER_VALUE = "struct-inner-value";
final Structure STRUCT_ATTR_VALUE = new Structure().add(STRUCT_ATTR_INNER_KEY, STRUCT_ATTR_INNER_VALUE);
final Structure STRUCT_ATTR_VALUE = new MutableStructure().add(STRUCT_ATTR_INNER_KEY, STRUCT_ATTR_INNER_VALUE);
final String DEFAULT_STRING = "DEFAULT";

ResolveBooleanResponse booleanResponse = ResolveBooleanResponse.newBuilder()
Expand All @@ -170,7 +172,7 @@ void context_is_parsed_and_passed_to_grpc_service() {

OpenFeatureAPI.getInstance().setProvider(new FlagdProvider(serviceBlockingStubMock));

EvaluationContext context = new EvaluationContext();
MutableContext context = new MutableContext();
context.add(BOOLEAN_ATTR_KEY, BOOLEAN_ATTR_VALUE);
context.add(INT_ATTR_KEY, INT_ATTR_VALUE);
context.add(DOUBLE_ATTR_KEY, DOUBLE_ATTR_VALUE);
Expand All @@ -181,15 +183,16 @@ void context_is_parsed_and_passed_to_grpc_service() {
FlagEvaluationDetails<Boolean> booleanDetails = api.getClient().getBooleanDetails(FLAG_KEY, false, context);
assertTrue(booleanDetails.getValue());
assertEquals(BOOL_VARIANT, booleanDetails.getVariant());
assertEquals(DEFAULT, booleanDetails.getReason()); // reason should be converted from STATIC -> DEFAULT
assertEquals(DEFAULT.toString(), booleanDetails.getReason());
}

//TODO: update this to be able unknown codes
@Test
void reason_mapped_correctly_if_unknown() {
ResolveBooleanResponse badReasonResponse = ResolveBooleanResponse.newBuilder()
.setValue(true)
.setVariant(BOOL_VARIANT)
.setReason("NOT_A_REAL_REASON") // set an invalid reason string
.setReason("UNKNOWN") // set an invalid reason string
.build();

ServiceBlockingStub serviceBlockingStubMock = mock(ServiceBlockingStub.class);
Expand All @@ -198,7 +201,7 @@ void reason_mapped_correctly_if_unknown() {
OpenFeatureAPI.getInstance().setProvider(new FlagdProvider(serviceBlockingStubMock));

FlagEvaluationDetails<Boolean> booleanDetails = api.getClient()
.getBooleanDetails(FLAG_KEY, false, new EvaluationContext());
assertEquals(Reason.UNKNOWN, booleanDetails.getReason()); // reason should be converted to UNKNOWN
.getBooleanDetails(FLAG_KEY, false, new MutableContext());
assertEquals(Reason.UNKNOWN.toString(), booleanDetails.getReason()); // reason should be converted to UNKNOWN
}
}
70 changes: 28 additions & 42 deletions .../src/main/java/dev/openfeature/contrib/providers/gofeatureflag/GoFeatureFlagProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
package dev.openfeature.contrib.providers.gofeatureflag;

import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;

import java.io.IOException;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;

import dev.openfeature.contrib.providers.gofeatureflag.bean.GoFeatureFlagRequest;
import dev.openfeature.contrib.providers.gofeatureflag.bean.GoFeatureFlagResponse;
import dev.openfeature.contrib.providers.gofeatureflag.bean.GoFeatureFlagUser;
import dev.openfeature.contrib.providers.gofeatureflag.exception.InvalidEndpoint;
import dev.openfeature.contrib.providers.gofeatureflag.exception.InvalidOptions;
import dev.openfeature.javasdk.ErrorCode;
import dev.openfeature.javasdk.EvaluationContext;
import dev.openfeature.javasdk.FeatureProvider;
import dev.openfeature.javasdk.Hook;
import dev.openfeature.javasdk.Metadata;
import dev.openfeature.javasdk.ProviderEvaluation;
import dev.openfeature.javasdk.Reason;
import dev.openfeature.javasdk.Structure;
import dev.openfeature.javasdk.Value;
import dev.openfeature.javasdk.exceptions.FlagNotFoundError;
import dev.openfeature.javasdk.exceptions.GeneralError;
import dev.openfeature.javasdk.exceptions.OpenFeatureError;
import dev.openfeature.javasdk.exceptions.TypeMismatchError;
import dev.openfeature.sdk.ErrorCode;
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.Hook;
import dev.openfeature.sdk.Metadata;
import dev.openfeature.sdk.MutableStructure;
import dev.openfeature.sdk.ProviderEvaluation;
import dev.openfeature.sdk.Reason;
import dev.openfeature.sdk.Structure;
import dev.openfeature.sdk.Value;
import dev.openfeature.sdk.exceptions.FlagNotFoundError;
import dev.openfeature.sdk.exceptions.GeneralError;
import dev.openfeature.sdk.exceptions.OpenFeatureError;
import dev.openfeature.sdk.exceptions.TypeMismatchError;
import okhttp3.ConnectionPool;
import okhttp3.HttpUrl;
import okhttp3.MediaType;
Expand All @@ -30,15 +41,6 @@
import okhttp3.Response;
import okhttp3.ResponseBody;

import java.io.IOException;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;

/**
* GoFeatureFlagProvider is the JAVA provider implementation for the feature flag solution GO Feature Flag.
*/
Expand Down Expand Up @@ -199,7 +201,8 @@ private <T> ProviderEvaluation<T> resolveEvaluationGoFeatureFlagProxy(
if (Reason.DISABLED.name().equalsIgnoreCase(goffResp.getReason())) {
// we don't set a variant since we are using the default value, and we are not able to know
// which variant it is.
return ProviderEvaluation.<T>builder().value(defaultValue).reason(Reason.DISABLED).build();
return ProviderEvaluation.<T>builder().value(defaultValue).reason(Reason.DISABLED.toString())
.build();
}

if (ErrorCode.FLAG_NOT_FOUND.name().equalsIgnoreCase(goffResp.getErrorCode())) {
Expand All @@ -215,8 +218,7 @@ private <T> ProviderEvaluation<T> resolveEvaluationGoFeatureFlagProxy(
}

return ProviderEvaluation.<T>builder()
.errorCode(goffResp.getErrorCode())
Copy link
Member Author

@toddbaert toddbaert Oct 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I removed the error code here. I think that if we got this far, we don't need the error? Otherwise we should probably throw.

I think this is the biggest GOFF change I made.

@thomaspoignant

.reason(mapReason(goffResp.getReason()))
.reason(goffResp.getReason())
.value(flagValue)
.variant(goffResp.getVariationType())
.build();
Expand All @@ -227,22 +229,6 @@ private <T> ProviderEvaluation<T> resolveEvaluationGoFeatureFlagProxy(
}
}


/**
* mapReason is mapping the reason in string received by the API to our internal SDK reason enum.
*
* @param reason - string of the reason received from the API
* @return an item from the enum
*/
private Reason mapReason(String reason) {
try {
return Reason.valueOf(reason);
} catch (IllegalArgumentException e) {
return Reason.UNKNOWN;
}
}


/**
* convertValue is converting the object return by the proxy response in the right type.
*
Expand Down Expand Up @@ -303,7 +289,7 @@ private Value objectToValue(Object object) {
* @return a Structure object in the SDK format
*/
private Structure mapToStructure(Map<String, Object> map) {
return new Structure(
return new MutableStructure(
map.entrySet().stream()
.filter(e -> e.getValue() != null)
.collect(Collectors.toMap(Map.Entry::getKey, e -> objectToValue(e.getValue()))));
Expand Down
4 changes: 2 additions & 2 deletions ...src/main/java/dev/openfeature/contrib/providers/gofeatureflag/bean/GoFeatureFlagUser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package dev.openfeature.contrib.providers.gofeatureflag.bean;

import dev.openfeature.contrib.providers.gofeatureflag.exception.InvalidTargetingKey;
import dev.openfeature.javasdk.EvaluationContext;
import dev.openfeature.javasdk.Value;
import dev.openfeature.sdk.EvaluationContext;
import dev.openfeature.sdk.Value;
import lombok.Builder;
import lombok.Getter;

Expand Down
4 changes: 2 additions & 2 deletions ...n/java/dev/openfeature/contrib/providers/gofeatureflag/exception/InvalidTargetingKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package dev.openfeature.contrib.providers.gofeatureflag.exception;

import dev.openfeature.javasdk.ErrorCode;
import dev.openfeature.javasdk.exceptions.OpenFeatureError;
import dev.openfeature.sdk.ErrorCode;
import dev.openfeature.sdk.exceptions.OpenFeatureError;
import lombok.experimental.StandardException;

/**
Expand Down
Loading