gnodet-bot commented on code in PR #26603:
URL: https://github.com/apache/camel/pull/26603#discussion_r4048440311
##########
core/camel-api/src/main/java/org/apache/camel/spi/CircuitBreakerConstants.java:
##########
@@ -27,13 +27,17 @@ public interface CircuitBreakerConstants {
@Metadata(label = "circuitBreaker",
description = "Whether the exchange was processed by the
onFallback by the circuit breaker", javaType = "boolean")
String RESPONSE_FROM_FALLBACK = "CamelCircuitBreakerResponseFromFallback";
- @Metadata(label = "circuitBreaker", description = "Whether the exchange
was short circuited by the breaker",
+ @Metadata(label = "circuitBreaker",
+ description = "Whether the call did not complete normally and
the circuit breaker short circuited the exchange, to the onFallback if there is
one."
+ + " This is true for a failed call, a timeout and
a rejected call alike; use CamelCircuitBreakerResponseRejected to know whether
the call was attempted.",
javaType = "boolean")
String RESPONSE_SHORT_CIRCUITED =
"CamelCircuitBreakerResponseShortCircuited";
@Metadata(label = "circuitBreaker", description = "Whether the exchange
timed out during processing by the circuit breaker",
javaType = "boolean")
String RESPONSE_TIMED_OUT = "CamelCircuitBreakerResponseTimedOut";
- @Metadata(label = "circuitBreaker", description = "Whether the circuit
breaker rejected processing the exchange",
+ @Metadata(label = "circuitBreaker",
+ description = "Whether the circuit breaker rejected the call
without attempting it, because the breaker is open or the bulkhead is full."
+ + " Also set inside the onFallback, where it tells
a dead service apart from a single failed call.",
javaType = "boolean")
String RESPONSE_REJECTED = "CamelCircuitBreakerResponseRejected";
@Metadata(label = "circuitBreaker", description = "Whether the circuit
breaker ignored an exception during processing",
Review Comment:
The description says `RESPONSE_REJECTED` is now "also set inside the
onFallback", but it doesn't call out the breaking semantics for existing users:
**previously this property was `null` (unset) inside the `onFallback`; now it
is always set to `true` or `false`**.
Any user who tested `== null` to detect "call was attempted" will see
different behavior. Worth adding a brief note, e.g.:
```
+ " Prior to Camel 4.X this property was not set inside the onFallback; it
is now always present."
```
Not a blocker, just a migration callout for the upgrade notes.
--
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]
