Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
@ConfigurationParameter(key = OBJECT_FACTORY_PROPERTY_NAME, value = "io.cucumber.picocontainer.PicoFactory")
@IncludeTags("in-process")
// large-integers reads 2^53-1 via 32-bit getInteger; Long scenarios: open-feature/flagd-testbed#379
@ExcludeTags({"unixsocket", "fractional-v1", "fractional-v2", "deprecated", "large-integers"})
// the test harness image has no "resolve" launchpad config yet
@ExcludeTags({"unixsocket", "fractional-v1", "fractional-v2", "deprecated", "large-integers", "resolve"})
@Testcontainers
public class RunInProcessTest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
@ConfigurationParameter(key = OBJECT_FACTORY_PROPERTY_NAME, value = "io.cucumber.picocontainer.PicoFactory")
@IncludeTags({"rpc"})
// large-integers reads 2^53-1 via 32-bit getInteger; Long scenarios: open-feature/flagd-testbed#379
@ExcludeTags({"unixsocket", "fractional-v1", "fractional-v2", "deprecated", "large-integers"})
// flagd in the test harness image does not support resolve yet
@ExcludeTags({"unixsocket", "fractional-v1", "fractional-v2", "deprecated", "large-integers", "resolve"})
@Testcontainers
public class RunRpcTest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,17 @@ public void setupProvider(String providerType) throws InterruptedException {
flagdConfig = "ssl";
break;
case "metadata":
flagdConfig = "metadata";
case "resolve":
if (State.resolverType == Config.Resolver.FILE) {
// file mode reads the harness flag file directly, so it doesn't need a flagd config
FlagdOptions build = state.builder.build();
String selector = build.getSelector();
String replace = selector.replace("rawflags/", "");
state.builder
.port(UNAVAILABLE_PORT)
.offlineFlagSourcePath(new File("test-harness/flags/" + replace).getAbsolutePath());
} else {
flagdConfig = providerType;
state.builder.port(ContainerUtil.getPort(container, State.resolverType));
}
break;
Expand Down
2 changes: 1 addition & 1 deletion providers/flagd/test-harness
2 changes: 1 addition & 1 deletion tools/flagd-core/schemas
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import dev.openfeature.contrib.tools.flagd.core.model.FlagParser;
import dev.openfeature.contrib.tools.flagd.core.model.FlagParsingResult;
import dev.openfeature.contrib.tools.flagd.core.targeting.Operator;
import dev.openfeature.contrib.tools.flagd.core.targeting.ResolveResult;
import dev.openfeature.contrib.tools.flagd.core.targeting.TargetingRuleException;
import dev.openfeature.sdk.ErrorCode;
import dev.openfeature.sdk.EvaluationContext;
Expand All @@ -23,6 +24,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock;
import java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock;
Expand Down Expand Up @@ -208,7 +210,7 @@ private <T> ProviderEvaluation<T> resolve(Class<T> type, String key, T defaultVa
return ProviderEvaluation.<T>builder()
.errorMessage("flag: " + key + " not found")
.errorCode(ErrorCode.FLAG_NOT_FOUND)
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, null))
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, null, null))
.build();
}

Expand All @@ -217,12 +219,13 @@ private <T> ProviderEvaluation<T> resolve(Class<T> type, String key, T defaultVa
return ProviderEvaluation.<T>builder()
.value(defaultValue)
.reason(Reason.DISABLED.toString())
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, flag))
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, flag, null))
.build();
}

final String resolvedVariant;
final String reason;
Map<String, Object> ruleMetadata = null;

if (EMPTY_TARGETING_STRING.equals(flag.getTargeting())) {
resolvedVariant = flag.getDefaultVariant();
Expand All @@ -233,6 +236,11 @@ private <T> ProviderEvaluation<T> resolve(Class<T> type, String key, T defaultVa
if (jsonResolved == null) {
resolvedVariant = flag.getDefaultVariant();
reason = Reason.DEFAULT.toString();
} else if (jsonResolved instanceof ResolveResult) {
final ResolveResult resolved = (ResolveResult) jsonResolved;
resolvedVariant = resolved.getVariant();
reason = resolved.getReason() != null ? resolved.getReason() : Reason.TARGETING_MATCH.toString();
ruleMetadata = resolved.getMetadata();
} else {
resolvedVariant = jsonResolved.toString(); // convert to string to support shorthand
reason = Reason.TARGETING_MATCH.toString();
Expand All @@ -251,7 +259,7 @@ private <T> ProviderEvaluation<T> resolve(Class<T> type, String key, T defaultVa
return ProviderEvaluation.<T>builder()
.value(defaultValue)
.reason(Reason.DEFAULT.toString())
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, flag))
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, flag, null))
.build();
}

Expand All @@ -278,7 +286,7 @@ private <T> ProviderEvaluation<T> resolve(Class<T> type, String key, T defaultVa
.value((T) value)
.variant(resolvedVariant)
.reason(reason)
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, flag))
.flagMetadata(getFlagMetadata(currentFlagSetMetadata, flag, ruleMetadata))
.build();
}

Expand Down Expand Up @@ -339,21 +347,14 @@ private static TypeMismatchError mismatch(String key, double value, String why)
return new TypeMismatchError(message);
}

private static ImmutableMetadata getFlagMetadata(Map<String, Object> currentFlagSetMetadata, FeatureFlag flag) {
// later sources overwrite earlier ones: flag set, then flag, then the resolve rule
private static ImmutableMetadata getFlagMetadata(
Map<String, Object> currentFlagSetMetadata, FeatureFlag flag, Map<String, Object> ruleMetadata) {
ImmutableMetadata.ImmutableMetadataBuilder metadataBuilder = ImmutableMetadata.builder();

if (currentFlagSetMetadata != null) {
for (Map.Entry<String, Object> entry : currentFlagSetMetadata.entrySet()) {
addEntryToMetadataBuilder(metadataBuilder, entry.getKey(), entry.getValue());
}
}

if (flag != null && flag.getMetadata() != null) {
for (Map.Entry<String, Object> entry : flag.getMetadata().entrySet()) {
addEntryToMetadataBuilder(metadataBuilder, entry.getKey(), entry.getValue());
}
}

Stream.of(currentFlagSetMetadata, flag != null ? flag.getMetadata() : null, ruleMetadata)
.filter(Objects::nonNull)
.flatMap(metadata -> metadata.entrySet().stream())
.forEach(entry -> addEntryToMetadataBuilder(metadataBuilder, entry.getKey(), entry.getValue()));
return metadataBuilder.build();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,14 +208,19 @@ protected final void finalize() {
throw new JsonLogicException("Fraction property needs at least one element", jsonPath);
}

// variant must be a primitive (string, number, boolean) or null;
// variant must be a primitive (string, number, boolean), null, or a resolve result;
// nested JSONLogic expressions are pre-evaluated to these types
Object first = array.get(0);
if (first instanceof String || first instanceof Number || first instanceof Boolean || first == null) {
if (first instanceof String
|| first instanceof Number
|| first instanceof Boolean
|| first instanceof ResolveResult
|| first == null) {
variant = first;
} else {
throw new JsonLogicException(
"First element of the fraction property must resolve to a string, number, boolean, or null",
"First element of the fraction property must resolve to a string, number, boolean, null, "
+ "or resolve",
jsonPath);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ public Operator(boolean compileExpressions) {
jsonLogicHandler.addOperation(new SemVer());
jsonLogicHandler.addOperation(new StringComp(StringComp.Type.STARTS_WITH));
jsonLogicHandler.addOperation(new StringComp(StringComp.Type.ENDS_WITH));
jsonLogicHandler.addOperation(new Resolve());
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
package dev.openfeature.contrib.tools.flagd.core.targeting;

import io.github.jamsesso.jsonlogic.evaluator.expressions.PreEvaluatedArgumentsExpression;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import lombok.extern.slf4j.Slf4j;

/**
* Terminal {@code resolve} operation: {@code ["variant", "reason"?, [["key", value], ...]?]}.
* Selects a variant and optionally overrides the reason and adds rule metadata. Placement is enforced by the
* targeting schema; malformed computed arguments return null, so the flag falls back to its default variant.
*/
@Slf4j
class Resolve implements PreEvaluatedArgumentsExpression {

// flag set metadata keys a rule can't override; the schema only catches literal keys
private static final Set<String> RESERVED_KEYS = Set.of("flagSetId", "version");

@Override
public String key() {
return "resolve";
}

@Override
public Object evaluate(List arguments, Object data, String jsonPath) {
if (arguments.isEmpty() || arguments.size() > 3) {
log.debug("resolve takes 1 to 3 arguments");
return null;
}

// coerce like a plain targeting result
final Object variant = arguments.get(0);
if (!(variant instanceof String || variant instanceof Boolean || variant instanceof Number)) {
log.debug("resolve variant must be a string, boolean, or number");
return null;
}

final Object reason = arguments.size() > 1 ? arguments.get(1) : null;
if (reason != null && !(reason instanceof String)) {
log.debug("resolve reason must be a string or null");
return null;
}

final Map<String, Object> metadata = new HashMap<>();
final Object pairs = arguments.size() > 2 ? arguments.get(2) : null;
if (pairs != null && !addMetadata(pairs, metadata)) {
return null;
}

return new ResolveResult(variant.toString(), (String) reason, metadata);
}

private static boolean addMetadata(Object pairs, Map<String, Object> metadata) {
if (!(pairs instanceof List)) {
log.debug("resolve metadata must be an array of [key, value] pairs");
return false;
}
for (Object pair : (List<?>) pairs) {
final List<?> entry = pair instanceof List ? (List<?>) pair : List.of();
if (entry.size() != 2 || !(entry.get(0) instanceof String)) {
log.debug("resolve metadata pair must be a [string, value] array");
return false;
}
final Object value = entry.get(1);
final Object metadataValue = value instanceof Number ? metadataNumber((Number) value) : value;
if (!(metadataValue instanceof String
|| metadataValue instanceof Boolean
|| metadataValue instanceof Number)) {
log.debug("resolve metadata value must be a string, finite number, or boolean");
return false;
}
final String key = (String) entry.get(0);
if (!RESERVED_KEYS.contains(key)) {
metadata.put(key, metadataValue);
}
}
return true;
}

/**
* JsonLogic yields doubles, so whole numbers become ints like they are in flag metadata.
* NaN and Infinity (e.g. a computed 1/0) can't be encoded as JSON, so they return null.
*/
private static Object metadataNumber(Number value) {
final double number = value.doubleValue();
if (!Double.isFinite(number)) {
return null;
}
final boolean wholeInt =
number == Math.rint(number) && number >= Integer.MIN_VALUE && number <= Integer.MAX_VALUE;
return wholeInt ? (Object) (int) number : number;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package dev.openfeature.contrib.tools.flagd.core.targeting;

import java.util.Collections;
import java.util.Map;
import lombok.Getter;

/**
* Result of the terminal {@code resolve} operation. No JSON input decodes to this type, so evaluation
* context data cannot forge one.
*/
@Getter
public final class ResolveResult {
private final String variant;
/** Overrides the evaluation reason; {@code null} keeps {@code TARGETING_MATCH}. */
private final String reason;
/** Rule metadata, merged over flag-set and flag metadata. */
private final Map<String, Object> metadata;

ResolveResult(String variant, String reason, Map<String, Object> metadata) {
this.variant = variant;
this.reason = reason;
this.metadata = Collections.unmodifiableMap(metadata);
}
}
Loading
Loading