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

Implement string type feature flag client #9

Merged
merged 6 commits into from
May 6, 2024
Merged

Implement string type feature flag client #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2cd9b9
Add AppConfigValue impl for String
lavenderses May 6, 2024
d25424c
Add fixture
lavenderses May 6, 2024
65b953e
Add parser implementation for String
lavenderses May 6, 2024
bb593ef
Add test
lavenderses May 6, 2024
3119290
Use String parser
lavenderses May 6, 2024
bd0f538
Add test
lavenderses May 6, 2024
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
28 changes: 26 additions & 2 deletions .../io/github/lavenderses/aws_app_config_openfeature_provider/AwsAppConfigClientService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import io.github.lavenderses.aws_app_config_openfeature_provider.evaluation_value.EvaluationValue;
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.BooleanAttributeParser;
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.ObjectAttributeParser;
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.StringAttributeParser;
import io.github.lavenderses.aws_app_config_openfeature_provider.utils.AwsAppConfigClientBuilder;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.NotNull;
Expand Down Expand Up @@ -54,6 +55,9 @@ final class AwsAppConfigClientService {
@NotNull
private final BooleanAttributeParser booleanAttributeParser;

@NotNull
private final StringAttributeParser stringAttributeParser;

@NotNull
private final ObjectAttributeParser objectAttributeParser;

Expand All @@ -69,13 +73,15 @@ final class AwsAppConfigClientService {
@NotNull final AwsAppConfigParser awsAppConfigParser,
@NotNull final AppConfigValueConverter appConfigValueConverter,
@NotNull final BooleanAttributeParser booleanAttributeParser,
@NotNull final StringAttributeParser stringAttributeParser,
@NotNull final ObjectAttributeParser objectAttributeParser
) {
this.client = requireNonNull(client, "AppConfigDataClient");
this.options = requireNonNull(options, "AwsAppConfigClientOptions");
this.awsAppConfigParser = requireNonNull(awsAppConfigParser, "AwsAppConfigParse");
this.appConfigValueConverter = requireNonNull(appConfigValueConverter, "appConfigValueConverter");
this.booleanAttributeParser = requireNonNull(booleanAttributeParser, "booleanAttributeParser");
this.stringAttributeParser = requireNonNull(stringAttributeParser, "stringAttributeParser");
this.objectAttributeParser = requireNonNull(objectAttributeParser, "objectAttributeParser");
}

Expand All @@ -95,6 +101,7 @@ final class AwsAppConfigClientService {
awsAppConfigParser = new AwsAppConfigParser();
appConfigValueConverter = new AppConfigValueConverter();
booleanAttributeParser = new BooleanAttributeParser();
stringAttributeParser = new StringAttributeParser();
objectAttributeParser = new ObjectAttributeParser();
}

Expand Down Expand Up @@ -129,8 +136,25 @@ EvaluationValue<Boolean> getBoolean(
}

@NotNull
EvaluationValue<String> getString(@NotNull final String key) {
return null;
EvaluationValue<String> getString(
@NotNull final String key,
@NotNull final String defaultValue
) {
try {
return getInternal(
/* key = */ key,
/* defaultValue = */ defaultValue,
/* asPrimitive = */ true,
/* parseFromResponseBody = */ (@Language("json") final String responseBody) -> awsAppConfigParser.parse(
/* key = */ key,
/* value = */ responseBody,
/* buildAppConfigValue = */ stringAttributeParser
)
);
} catch (final AppConfigValueParseException e) {
log.error("Failed to parseFromResponseBody object from AWS AppConfig response. Fall back to default flag value", e);
return e.asErrorEvaluationResult();
}
}

@NotNull
Expand Down
5 changes: 4 additions & 1 deletion ...o/github/lavenderses/aws_app_config_openfeature_provider/AwsAppConfigFeatureProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,10 @@ public ProviderEvaluation<String> getStringEvaluation(
requireNonNull(defaultValue, "defaultValue");

// Get boolean value from AppConfig by key
final EvaluationValue<String> evaluationValue = awsAppConfigClientService.getString(key);
final EvaluationValue<String> evaluationValue = awsAppConfigClientService.getString(
/* key = */ key,
/* defaultValue = */ defaultValue
);

return evaluationValue.providerEvaluation();
}
Expand Down
31 changes: 31 additions & 0 deletions ...avenderses/aws_app_config_openfeature_provider/app_config_model/AppConfigStringValue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.NotNull;

import static java.util.Objects.requireNonNull;

/**
* String type in AWS AppConfig's Attribute.<br/>
* This feature flag will be mapped as string in OpenFeature requirements.
*/
@Getter
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
public final class AppConfigStringValue extends AppConfigValue<String> {

public AppConfigStringValue(
@NotNull Boolean enabled,
@NotNull String value,
@Language("json") @NotNull String jsonFormat
) {
super(
/* enabled = */ requireNonNull(enabled, "enabled"),
/* value = */ requireNonNull(value, "value"),
/* jsonFormat = */ requireNonNull(jsonFormat, "jsonFormat")
);
}
}
37 changes: 37 additions & 0 deletions .../github/lavenderses/aws_app_config_openfeature_provider/parser/StringAttributeParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package io.github.lavenderses.aws_app_config_openfeature_provider.parser;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.JsonNodeType;
import io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model.AppConfigBooleanValue;
import io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model.AppConfigStringValue;
import org.jetbrains.annotations.NotNull;

/**
* Parser implementation for boolean-type feature flag value.
*/
public final class StringAttributeParser extends AbstractAttributeParser<String, AppConfigStringValue> {

/**
* Extract "Attribute" as Boolean in JSON response from AWS AppConfig.
*
* @param keyNode a response JSON string from AWS AppConfig
* @return {@link AppConfigBooleanValue} if the response schema is valid
* @throws AppConfigValueParseException when {@param keyNode} is invalid schema
*/
@Override
public AppConfigStringValue apply(
@NotNull JsonNode responseNode,
@NotNull JsonNode keyNode
) {
final JsonNode flagValueNode = getValidFlagValueNode(
/* keyNode = */ keyNode,
/* expectedNodeType = */ JsonNodeType.STRING
);

return new AppConfigStringValue(
/* enabled = */ enabled(keyNode),
/* value = */ flagValueNode.asText(),
/* responseNode = */ responseNode.toString()
);
}
}
186 changes: 186 additions & 0 deletions ...o/github/lavenderses/aws_app_config_openfeature_provider/AwsAppConfigClientServiceTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import dev.openfeature.sdk.Reason
import dev.openfeature.sdk.Value
import io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model.AppConfigBooleanValue
import io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model.AppConfigObjectValue
import io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model.AppConfigStringValue
import io.github.lavenderses.aws_app_config_openfeature_provider.app_config_model.fixture
import io.github.lavenderses.aws_app_config_openfeature_provider.converter.AppConfigValueConverter
import io.github.lavenderses.aws_app_config_openfeature_provider.evaluation_value.ErrorEvaluationValue
Expand All @@ -17,6 +18,7 @@ import io.github.lavenderses.aws_app_config_openfeature_provider.parser.AppConfi
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.AwsAppConfigParser
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.BooleanAttributeParser
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.ObjectAttributeParser
import io.github.lavenderses.aws_app_config_openfeature_provider.parser.StringAttributeParser
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
Expand Down Expand Up @@ -59,6 +61,9 @@ class AwsAppConfigClientServiceTest {
@Mock
private lateinit var booleanAttributeParser: BooleanAttributeParser

@Mock
private lateinit var stringAttributeParser: StringAttributeParser

@Mock
private lateinit var objectAttributeParser: ObjectAttributeParser

Expand Down Expand Up @@ -121,6 +126,187 @@ class AwsAppConfigClientServiceTest {
}
}

@Nested
inner class GetString {

@Test
fun normal() {
// prepare
val key = "key"
val defaultValue = "defaultValue"
val request = GetLatestConfigurationRequest.builder()
.configurationToken("token")
.build()
val configuration = mock<SdkBytes> {
on { asByteArray() } doReturn """{ "foo": "bar" }""".toByteArray()
on { asUtf8String() } doReturn """{ "foo": "bar" }"""
}
val response = mock<GetLatestConfigurationResponse> {
on { configuration() } doReturn configuration
}
val flagValue = AppConfigStringValue::class.fixture()
val expected = PrimitiveEvaluationValue<String>(
/* rawValue = */ "test",
/* reason = */ Reason.TARGETING_MATCH,
)

doReturn(response)
.whenever(client)
.getLatestConfiguration(
/* getLatestConfigurationRequest = */ request,
)
doReturn(flagValue)
.whenever(awsAppConfigParser)
.parse(
/* key = */ key,
/* value = */ """{ "foo": "bar" }""",
/* buildAppConfigValue = */ stringAttributeParser,
)
doReturn(
PrimitiveEvaluationValue<String>(
/* rawValue = */ "test",
/* reason = */ Reason.TARGETING_MATCH,
),
)
.whenever(appConfigValueConfigValueConverter)
.toEvaluationValue(
/* defaultValue = */ defaultValue,
/* appConfigValue = */ flagValue,
/* asPrimitive = */ true,
)

// do & verify
assertThat(
awsAppConfigClientService.getString(
/* key = */ key,
/* defaultValue = */ defaultValue,
),
).isEqualTo(expected)
}

@Test
fun `failed to request to AWS AppConfig`() {
// prepare
val key = "key"
val defaultValue = "defaultValue"
val request = GetLatestConfigurationRequest.builder()
.configurationToken("token")
.build()
val expected = ErrorEvaluationValue<Value>(
/* errorCode = */ ErrorCode.FLAG_NOT_FOUND,
/* errorMessage = */ null,
/* reason = */ Reason.DEFAULT,
)

doThrow(RuntimeException("error"))
.whenever(client)
.getLatestConfiguration(
/* getLatestConfigurationRequest = */ request,
)

// do
assertThat(
awsAppConfigClientService.getString(
/* key = */ key,
/* defaultValue = */ defaultValue,
),
).isEqualTo(expected)

// verify
verifyNoInteractions(awsAppConfigParser, appConfigValueConfigValueConverter)
}

@Test
fun `response body is null`() {
// prepare
val key = "key"
val defaultValue = "defaultValue"
val request = GetLatestConfigurationRequest.builder()
.configurationToken("token")
.build()
val configuration = mock<SdkBytes> {
on { asByteArray() } doReturn "".toByteArray()
}
val response = mock<GetLatestConfigurationResponse> {
on { configuration() } doReturn configuration
}
val expected = ErrorEvaluationValue<Value>(
/* errorCode = */ ErrorCode.PARSE_ERROR,
/* errorMessage = */ null,
/* reason = */ Reason.ERROR,
)

doReturn(response)
.whenever(client)
.getLatestConfiguration(
/* getLatestConfigurationRequest = */ request,
)

// do
assertThat(
awsAppConfigClientService.getString(
/* key = */ key,
/* defaultValue = */ defaultValue,
),
).isEqualTo(expected)

// verify
verifyNoInteractions(awsAppConfigParser, appConfigValueConfigValueConverter)
}

@Test
fun `failed to call parse`() {
// prepare
val key = "key"
val defaultValue = "defaultValue"
val request = GetLatestConfigurationRequest.builder()
.configurationToken("token")
.build()
val configuration = mock<SdkBytes> {
on { asByteArray() } doReturn """{ "foo": "bar" }""".toByteArray()
on { asUtf8String() } doReturn """{ "foo": "bar" }"""
}
val response = mock<GetLatestConfigurationResponse> {
on { configuration() } doReturn configuration
}
val expected = ErrorEvaluationValue<Value>(
/* errorCode = */ ErrorCode.PARSE_ERROR,
/* errorMessage = */ """errorMessage. Response from AWS AppConfig: { "foo": "bar" }""",
/* reason = */ Reason.ERROR,
)

doReturn(response)
.whenever(client)
.getLatestConfiguration(
/* getLatestConfigurationRequest = */ request,
)
doThrow(
AppConfigValueParseException(
/* response = */ """{ "foo": "bar" }""",
/* errorMessage = */ "errorMessage",
/* evaluationResult = */ EvaluationResult.INVALID_ATTRIBUTE_FORMAT,
),
)
.whenever(awsAppConfigParser)
.parse(
/* key = */ key,
/* value = */ """{ "foo": "bar" }""",
/* buildAppConfigValue = */ stringAttributeParser,
)

// do
assertThat(
awsAppConfigClientService.getString(
/* key = */ key,
/* defaultValue = */ defaultValue,
),
).isEqualTo(expected)

// verify
verifyNoInteractions(appConfigValueConfigValueConverter)
}
}

@Nested
inner class GetObject {

Expand Down
Loading
Loading