davsclaus commented on code in PR #27440: URL: https://github.com/apache/camel/pull/27440#discussion_r4220014577
########## components/camel-openfeature/src/main/java/org/apache/camel/component/openfeature/OpenFeatureEndpoint.java: ########## @@ -0,0 +1,447 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.openfeature; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.time.Instant; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import dev.openfeature.contrib.providers.flagd.Config; +import dev.openfeature.contrib.providers.flagd.FlagdOptions; +import dev.openfeature.contrib.providers.flagd.FlagdProvider; +import dev.openfeature.sdk.Client; +import dev.openfeature.sdk.FeatureProvider; +import dev.openfeature.sdk.FlagEvaluationDetails; +import dev.openfeature.sdk.MutableContext; +import dev.openfeature.sdk.MutableStructure; +import dev.openfeature.sdk.Value; +import org.apache.camel.Category; +import org.apache.camel.Consumer; +import org.apache.camel.Exchange; +import org.apache.camel.Processor; +import org.apache.camel.Producer; +import org.apache.camel.spi.Metadata; +import org.apache.camel.spi.UriEndpoint; +import org.apache.camel.spi.UriParam; +import org.apache.camel.spi.UriPath; +import org.apache.camel.support.DefaultEndpoint; +import org.apache.camel.support.ResourceHelper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** Evaluate feature flags using the OpenFeature specification with flagd. */ +@UriEndpoint(firstVersion = "4.23.0", scheme = "openfeature", title = "OpenFeature", + syntax = "openfeature:domain/evaluationType", + producerOnly = true, category = { Category.CLOUD }, headersClass = OpenFeatureConstants.class) +public class OpenFeatureEndpoint extends DefaultEndpoint { + + private static final Logger LOG = LoggerFactory.getLogger(OpenFeatureEndpoint.class); + private static final String DEFAULT_PROVIDER_BEAN = "flags"; + + @UriPath + @Metadata(required = true, description = "The OpenFeature domain to bind the provider to.") + private String domain; + + @UriPath(enums = "boolean,variant,isEnabled", + description = "The evaluation type. 'boolean' and 'isEnabled' use boolean evaluation (getBooleanValue)." + + " 'variant' uses string evaluation (getStringValue)." + + " When not set, the type is inferred from defaultValue.") + private String evaluationType; + + @UriParam + private OpenFeatureConfiguration configuration; + + private volatile Client client; + + public OpenFeatureEndpoint(String uri, OpenFeatureComponent component, String domain, String evaluationType, + OpenFeatureConfiguration configuration) { + super(uri, component); + this.domain = domain; + this.evaluationType = evaluationType; + this.configuration = configuration; + } + + @Override + public OpenFeatureComponent getComponent() { + return (OpenFeatureComponent) super.getComponent(); + } + + public String getEvaluationType() { + return evaluationType; + } + + public void setEvaluationType(String evaluationType) { + this.evaluationType = evaluationType; + } + + @Override + public Producer createProducer() { + return new OpenFeatureProducer(this); + } + + @Override + public Consumer createConsumer(Processor processor) { + throw new UnsupportedOperationException("OpenFeature is producer only"); + } + + @Override + protected void doStart() throws Exception { + super.doStart(); + configuration.validate(); + + if (domain == null || domain.isBlank()) { + throw new IllegalArgumentException("domain must not be blank"); + } + + client = getComponent().acquireOrRegister(domain, this::resolveProvider); + } + + @Override + protected void doStop() throws Exception { + if (client != null) { + client = null; + getComponent().unregisterEndpoint(domain); + } + super.doStop(); + } + + /** + * Evaluate a flag from the producer path. Reads flag key, evaluation type, targeting key and context from exchange + * headers/properties/configuration. Sets result detail headers on the exchange. + */ + public Object evaluate(Exchange exchange) { + String flagKey = resolveFlagKey(exchange); + String evalType = resolveEvaluationType(exchange); + MutableContext ctx = buildContext(exchange); + FlagEvaluationDetails<?> details = evaluateDetails(flagKey, evalType, ctx); + setResultHeaders(exchange, details); + return details.getValue(); + } + + /** + * Evaluate a flag from the language path with explicit parameters. Does not read from or write to the exchange — no + * side effects on headers or properties. + */ + public Object evaluate(String flagKey, String evaluationType, String targetingKey, Map<String, Object> contextMap) { + MutableContext ctx = buildMutableContext(targetingKey, contextMap); + return evaluateDetails(flagKey, evaluationType, ctx).getValue(); + } + + private FlagEvaluationDetails<?> evaluateDetails(String flagKey, String evaluationType, MutableContext ctx) { + Client c = client; + if (c == null) { + throw new IllegalStateException("OpenFeature endpoint is not started"); + } + + FlagEvaluationDetails<?> details; + if (isBooleanEvaluation(evaluationType)) { + boolean defaultVal = Boolean.parseBoolean(configuration.getDefaultValue()); + details = c.getBooleanDetails(flagKey, defaultVal, ctx); + } else { + details = c.getStringDetails(flagKey, configuration.getDefaultValue(), ctx); + } + + if (details.getErrorCode() != null) { + LOG.warn("OpenFeature evaluation error for flag '{}': {} - {}", + flagKey, details.getErrorCode(), details.getErrorMessage()); + } Review Comment: Optional: this logs one WARN per evaluation. A flag-key typo, or a provider that isn't ready, inside a `filter` on a busy route then logs on every message. Logging only the first error per flag key at WARN, or a later one at DEBUG, would keep the signal without flooding the logs. Fine to leave as is if you prefer. ########## components/camel-openfeature/src/main/java/org/apache/camel/component/openfeature/OpenFeatureEndpoint.java: ########## @@ -0,0 +1,447 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.openfeature; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.time.Instant; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import dev.openfeature.contrib.providers.flagd.Config; +import dev.openfeature.contrib.providers.flagd.FlagdOptions; +import dev.openfeature.contrib.providers.flagd.FlagdProvider; +import dev.openfeature.sdk.Client; +import dev.openfeature.sdk.FeatureProvider; +import dev.openfeature.sdk.FlagEvaluationDetails; +import dev.openfeature.sdk.MutableContext; +import dev.openfeature.sdk.MutableStructure; +import dev.openfeature.sdk.Value; +import org.apache.camel.Category; +import org.apache.camel.Consumer; +import org.apache.camel.Exchange; +import org.apache.camel.Processor; +import org.apache.camel.Producer; +import org.apache.camel.spi.Metadata; +import org.apache.camel.spi.UriEndpoint; +import org.apache.camel.spi.UriParam; +import org.apache.camel.spi.UriPath; +import org.apache.camel.support.DefaultEndpoint; +import org.apache.camel.support.ResourceHelper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** Evaluate feature flags using the OpenFeature specification with flagd. */ +@UriEndpoint(firstVersion = "4.23.0", scheme = "openfeature", title = "OpenFeature", + syntax = "openfeature:domain/evaluationType", + producerOnly = true, category = { Category.CLOUD }, headersClass = OpenFeatureConstants.class) +public class OpenFeatureEndpoint extends DefaultEndpoint { + + private static final Logger LOG = LoggerFactory.getLogger(OpenFeatureEndpoint.class); + private static final String DEFAULT_PROVIDER_BEAN = "flags"; + + @UriPath + @Metadata(required = true, description = "The OpenFeature domain to bind the provider to.") + private String domain; + + @UriPath(enums = "boolean,variant,isEnabled", + description = "The evaluation type. 'boolean' and 'isEnabled' use boolean evaluation (getBooleanValue)." + + " 'variant' uses string evaluation (getStringValue)." + + " When not set, the type is inferred from defaultValue.") + private String evaluationType; + + @UriParam + private OpenFeatureConfiguration configuration; + + private volatile Client client; + + public OpenFeatureEndpoint(String uri, OpenFeatureComponent component, String domain, String evaluationType, + OpenFeatureConfiguration configuration) { + super(uri, component); + this.domain = domain; + this.evaluationType = evaluationType; + this.configuration = configuration; + } + + @Override + public OpenFeatureComponent getComponent() { + return (OpenFeatureComponent) super.getComponent(); + } + + public String getEvaluationType() { + return evaluationType; + } + + public void setEvaluationType(String evaluationType) { + this.evaluationType = evaluationType; + } + + @Override + public Producer createProducer() { + return new OpenFeatureProducer(this); + } + + @Override + public Consumer createConsumer(Processor processor) { + throw new UnsupportedOperationException("OpenFeature is producer only"); + } + + @Override + protected void doStart() throws Exception { + super.doStart(); + configuration.validate(); + + if (domain == null || domain.isBlank()) { + throw new IllegalArgumentException("domain must not be blank"); + } + + client = getComponent().acquireOrRegister(domain, this::resolveProvider); + } + + @Override + protected void doStop() throws Exception { + if (client != null) { + client = null; + getComponent().unregisterEndpoint(domain); + } + super.doStop(); + } + + /** + * Evaluate a flag from the producer path. Reads flag key, evaluation type, targeting key and context from exchange + * headers/properties/configuration. Sets result detail headers on the exchange. + */ + public Object evaluate(Exchange exchange) { + String flagKey = resolveFlagKey(exchange); + String evalType = resolveEvaluationType(exchange); + MutableContext ctx = buildContext(exchange); + FlagEvaluationDetails<?> details = evaluateDetails(flagKey, evalType, ctx); + setResultHeaders(exchange, details); + return details.getValue(); + } + + /** + * Evaluate a flag from the language path with explicit parameters. Does not read from or write to the exchange — no + * side effects on headers or properties. + */ + public Object evaluate(String flagKey, String evaluationType, String targetingKey, Map<String, Object> contextMap) { + MutableContext ctx = buildMutableContext(targetingKey, contextMap); + return evaluateDetails(flagKey, evaluationType, ctx).getValue(); + } + + private FlagEvaluationDetails<?> evaluateDetails(String flagKey, String evaluationType, MutableContext ctx) { + Client c = client; + if (c == null) { + throw new IllegalStateException("OpenFeature endpoint is not started"); + } + + FlagEvaluationDetails<?> details; + if (isBooleanEvaluation(evaluationType)) { + boolean defaultVal = Boolean.parseBoolean(configuration.getDefaultValue()); + details = c.getBooleanDetails(flagKey, defaultVal, ctx); + } else { + details = c.getStringDetails(flagKey, configuration.getDefaultValue(), ctx); + } + + if (details.getErrorCode() != null) { + LOG.warn("OpenFeature evaluation error for flag '{}': {} - {}", + flagKey, details.getErrorCode(), details.getErrorMessage()); + } + return details; + } + + @SuppressWarnings("unchecked") + MutableContext buildContext(Exchange exchange) { + Map<String, Object> contextMap = null; + + Object contextHeader = exchange.getMessage().getHeader(OpenFeatureConstants.EVALUATION_CONTEXT); + if (contextHeader == null) { + contextHeader = exchange.getProperty(OpenFeatureConstants.EVALUATION_CONTEXT); + } + if (contextHeader instanceof Map) { + contextMap = (Map<String, Object>) contextHeader; + } else if (configuration.isContextFromBody()) { + Object body = exchange.getMessage().getBody(); + if (body instanceof Map) { + contextMap = (Map<String, Object>) body; + } + } + + String targetingKey = exchange.getMessage().getHeader(OpenFeatureConstants.TARGETING_KEY, String.class); + if (targetingKey == null) { + targetingKey = exchange.getProperty(OpenFeatureConstants.TARGETING_KEY, String.class); + } + + return buildMutableContext(targetingKey, contextMap); + } + + static MutableContext buildMutableContext(String targetingKey, Map<String, Object> contextMap) { + if (contextMap == null || contextMap.isEmpty()) { + if (targetingKey != null) { + return new MutableContext(targetingKey); + } + return new MutableContext(); + } + + Map<String, Value> attributes = new HashMap<>(); + String tk = targetingKey; + for (Map.Entry<String, Object> entry : contextMap.entrySet()) { + if ("targetingKey".equals(entry.getKey())) { + if (tk == null && entry.getValue() != null) { + tk = String.valueOf(entry.getValue()); + } + } else { + attributes.put(entry.getKey(), toValue(entry.getValue())); + } + } + + if (tk != null) { + return new MutableContext(tk, attributes); + } + return new MutableContext(attributes); + } + + @SuppressWarnings("unchecked") + private static Value toValue(Object obj) { + if (obj == null) { + return new Value(); + } + if (obj instanceof Boolean) { + return new Value((Boolean) obj); + } + if (obj instanceof String) { + return new Value((String) obj); + } + if (obj instanceof Integer) { + return new Value((Integer) obj); + } + if (obj instanceof Long) { + return new Value((Long) obj); + } + if (obj instanceof Double) { + return new Value((Double) obj); + } + if (obj instanceof Number) { + return new Value(((Number) obj).doubleValue()); + } + if (obj instanceof Instant) { + return new Value((Instant) obj); + } + if (obj instanceof Map) { + Map<String, Value> attributes = new HashMap<>(); + for (Map.Entry<?, ?> entry : ((Map<?, ?>) obj).entrySet()) { + attributes.put(String.valueOf(entry.getKey()), toValue(entry.getValue())); + } + return new Value(new MutableStructure(attributes)); + } + if (obj instanceof List) { + List<Value> values = new ArrayList<>(); + for (Object item : (List<?>) obj) { + values.add(toValue(item)); + } + return new Value(values); + } + return new Value(String.valueOf(obj)); + } + + String resolveFlagKey(Exchange exchange) { + String key = exchange.getMessage().getHeader(OpenFeatureConstants.FLAG_KEY, String.class); + if (key == null) { + key = exchange.getProperty(OpenFeatureConstants.FLAG_KEY, String.class); + } + if (key == null) { + key = configuration.getFlagKey(); + } + if (key == null || key.isBlank()) { + throw new IllegalArgumentException( + "No flag key specified. Set flagKey on the endpoint or provide it via the " + + OpenFeatureConstants.FLAG_KEY + " header."); + } + return key; + } + + private String resolveEvaluationType(Exchange exchange) { + String evalType = exchange.getMessage().getHeader(OpenFeatureConstants.EVALUATION_TYPE, String.class); + if (evalType == null) { + evalType = exchange.getProperty(OpenFeatureConstants.EVALUATION_TYPE, String.class); + } + if (evalType == null) { + evalType = evaluationType; + } + if (evalType == null) { + evalType = configuration.getEvaluationType(); + } + return evalType; + } + + private boolean isBooleanEvaluation(String evalType) { + if ("boolean".equalsIgnoreCase(evalType) || "isEnabled".equalsIgnoreCase(evalType)) { + return true; + } + if ("variant".equalsIgnoreCase(evalType)) { + return false; + } + String dv = configuration.getDefaultValue(); + return "true".equalsIgnoreCase(dv) || "false".equalsIgnoreCase(dv); + } Review Comment: Optional: the path parameter and the option are limited to `boolean,variant,isEnabled`, but a value from the `CamelOpenFeatureEvaluationType` header is never checked. A typo such as `booleen` falls through to guessing the type from `defaultValue` in `isBooleanEvaluation`, with nothing logged. Rejecting values outside the three known ones (an `IllegalArgumentException`, like the missing-flag-key case) would make that kind of mistake visible. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
