feat: add perMethod, perHost, perPath to RetryConfigMapping

schiemon · schiemon · commit b63e552dea5d · 2025-05-17T13:58:23.000+02:00
diff --git a/core/src/main/java/com/linecorp/armeria/client/circuitbreaker/KeyedCircuitBreakerMapping.java b/core/src/main/java/com/linecorp/armeria/client/circuitbreaker/KeyedCircuitBreakerMapping.java
@@ -1,7 +1,7 @@
 /*
- * Copyright 2016 LINE Corporation
+ * Copyright 2025 LY Corporation
  *
- * LINE Corporation licenses this file to you under the Apache License,
+ * LY Corporation 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:
  *
@@ -16,9 +16,9 @@
 
 package com.linecorp.armeria.client.circuitbreaker;
 
-import static com.linecorp.armeria.internal.common.circuitbreaker.CircuitBreakerMappingUtil.host;
-import static com.linecorp.armeria.internal.common.circuitbreaker.CircuitBreakerMappingUtil.method;
-import static com.linecorp.armeria.internal.common.circuitbreaker.CircuitBreakerMappingUtil.path;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.host;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.method;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.path;
 import static java.util.Objects.requireNonNull;
 import static java.util.stream.Collectors.joining;
 
diff --git a/core/src/main/java/com/linecorp/armeria/client/retry/KeyedRetryConfigMapping.java b/core/src/main/java/com/linecorp/armeria/client/retry/KeyedRetryConfigMapping.java
@@ -1,7 +1,7 @@
 /*
- * Copyright 2020 LINE Corporation
+ * Copyright 2025 LY Corporation
  *
- * LINE Corporation licenses this file to you under the Apache License,
+ * LY Corporation 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:
  *
@@ -16,11 +16,17 @@
 
 package com.linecorp.armeria.client.retry;
 
+import static com.linecorp.armeria.internal.common.RequestContextUtil.host;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.method;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.path;
 import static java.util.Objects.requireNonNull;
+import static java.util.stream.Collectors.joining;
 
+import java.util.Objects;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.function.BiFunction;
+import java.util.stream.Stream;
 
 import com.linecorp.armeria.client.ClientRequestContext;
 import com.linecorp.armeria.common.Request;
@@ -38,6 +44,27 @@ final class KeyedRetryConfigMapping<T extends Response> implements RetryConfigMa
         this.retryConfigFactory = requireNonNull(retryConfigFactory, "retryConfigFactory");
     }
 
+    KeyedRetryConfigMapping(
+            boolean perHost, boolean perMethod, boolean perPath, RetryConfigFactory retryConfigFactory) {
+        requireNonNull(retryConfigFactory, "retryConfigFactory");
+
+        keyFactory = (ctx, req) -> {
+            final String host = perHost ? host(ctx) : null;
+            final String method = perMethod ? method(ctx) : null;
+            final String path = perPath ? path(ctx) : null;
+            return Stream.of(host, method, path)
+                         .filter(Objects::nonNull)
+                         .collect(joining("#"));
+        };
+
+        this.retryConfigFactory = (ctx, req) -> {
+            final String host = perHost ? host(ctx) : null;
+            final String method = perMethod ? method(ctx) : null;
+            final String path = perPath ? path(ctx) : null;
+            return retryConfigFactory.apply(host, method, path);
+        };
+    }
+
     @Override
     public RetryConfig<T> get(ClientRequestContext ctx, Request req) {
         final String key = keyFactory.apply(ctx, req);
diff --git a/core/src/main/java/com/linecorp/armeria/client/retry/RetryConfigFactory.java b/core/src/main/java/com/linecorp/armeria/client/retry/RetryConfigFactory.java
@@ -1,7 +1,7 @@
 /*
- * Copyright 2022 LINE Corporation
+ * Copyright 2025 LY Corporation
  *
- * LINE Corporation licenses this file to you under the Apache License,
+ * LY Corporation 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:
  *
@@ -14,11 +14,12 @@
  * under the License.
  */
 
-/**
- * CircuitBreaker related classes used internally.
- * Anything in this package can be changed or removed at any time.
- */
-@NonNullByDefault
-package com.linecorp.armeria.internal.common.circuitbreaker;
+package com.linecorp.armeria.client.retry;
+
+import com.linecorp.armeria.common.Response;
+import com.linecorp.armeria.common.annotation.Nullable;
 
-import com.linecorp.armeria.common.annotation.NonNullByDefault;
+@FunctionalInterface
+public interface RetryConfigFactory<T extends Response> {
+    RetryConfig<T> apply(@Nullable String host, @Nullable String method, @Nullable String path);
+}
diff --git a/core/src/main/java/com/linecorp/armeria/client/retry/RetryConfigMapping.java b/core/src/main/java/com/linecorp/armeria/client/retry/RetryConfigMapping.java
@@ -1,7 +1,7 @@
 /*
- * Copyright 2020 LINE Corporation
+ * Copyright 2025 LY Corporation
  *
- * LINE Corporation licenses this file to you under the Apache License,
+ * LY Corporation 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:
  *
@@ -16,15 +16,18 @@
 
 package com.linecorp.armeria.client.retry;
 
+import static java.util.Objects.requireNonNull;
+
 import java.util.function.BiFunction;
+import java.util.function.Function;
 
 import com.linecorp.armeria.client.ClientRequestContext;
 import com.linecorp.armeria.common.Request;
 import com.linecorp.armeria.common.Response;
 
 /**
  * Returns a {@link RetryConfig} given the {@link ClientRequestContext}.
- * Allows users to change retry behavior according to any context element, like host, method, path ...etc.
+ * Allows users to change retry behavior according to any context element, like host, method, path, etc.
  */
 @FunctionalInterface
 public interface RetryConfigMapping<T extends Response> {
@@ -49,13 +52,57 @@ public interface RetryConfigMapping<T extends Response> {
      * };
      * RetryConfigMapping mapping = RetryConfigMapping.of(keyFactory, configFactory);
      * } </pre>
+     *
+     * @deprecated Use {@link #perRequestAndContext(BiFunction, BiFunction)} instead.
      */
+    @Deprecated
     static <T extends Response> RetryConfigMapping<T> of(
             BiFunction<? super ClientRequestContext, Request, String> keyFactory,
             BiFunction<? super ClientRequestContext, Request, RetryConfig<T>> retryConfigFactory) {
         return new KeyedRetryConfigMapping<>(keyFactory, retryConfigFactory);
     }
 
+    static <T extends Response> RetryConfigMapping<T> perRequestAndContext(
+            BiFunction<? super ClientRequestContext, Request, String> keyFactory,
+            BiFunction<? super ClientRequestContext, Request, RetryConfig<T>> retryConfigFactory
+    ) {
+        return new KeyedRetryConfigMapping<>(keyFactory, retryConfigFactory);
+    }
+
+    static <T extends Response> RetryConfigMappingBuilder<T> builder() {
+        return new RetryConfigMappingBuilder<>();
+    }
+
+    static <T extends Response> RetryConfigMapping<T> perMethod(Function<String, RetryConfig<T>> factory) {
+        requireNonNull(factory, "factory");
+        return RetryConfigMapping.<T>builder()
+                                 .perMethod()
+                                 .build((host, method, path) -> factory.apply(method));
+    }
+
+    static <T extends Response> RetryConfigMapping<T> perHost(Function<String, RetryConfig<T>> factory) {
+        requireNonNull(factory, "factory");
+        return RetryConfigMapping.<T>builder()
+                                 .perHost()
+                                 .build((host, method, path) -> factory.apply(host));
+    }
+
+    static <T extends Response> RetryConfigMapping<T> perPath(Function<String, RetryConfig<T>> factory) {
+        requireNonNull(factory, "factory");
+        return RetryConfigMapping.<T>builder()
+                                 .perPath()
+                                 .build((host, method, path) -> factory.apply(path));
+    }
+
+    static <T extends Response> RetryConfigMapping<T> perHostAndMethod(
+            BiFunction<String, String, RetryConfig<T>> factory) {
+        requireNonNull(factory, "factory");
+        return RetryConfigMapping.<T>builder()
+                                 .perHost()
+                                 .perMethod()
+                                 .build((host, method, path) -> factory.apply(host, method));
+    }
+
     /**
      * Returns the {@link RetryConfig} that maps to the given {@link ClientRequestContext} and {@link Request}.
      */
diff --git a/core/src/main/java/com/linecorp/armeria/client/retry/RetryConfigMappingBuilder.java b/core/src/main/java/com/linecorp/armeria/client/retry/RetryConfigMappingBuilder.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2025 LY Corporation
+ *
+ * LY Corporation 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:
+ *
+ *   https://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 com.linecorp.armeria.client.retry;
+
+import com.linecorp.armeria.common.Response;
+
+public final class RetryConfigMappingBuilder<T extends Response> {
+    private boolean perHost;
+    private boolean perMethod;
+    private boolean perPath;
+
+    public RetryConfigMappingBuilder<T> perHost() {
+        perHost = true;
+        return this;
+    }
+
+    public RetryConfigMappingBuilder<T> perMethod() {
+        perMethod = true;
+        return this;
+    }
+
+    public RetryConfigMappingBuilder<T> perPath() {
+        perPath = true;
+        return this;
+    }
+
+    private boolean validateMappingKeys() {
+        return perHost || perMethod || perPath;
+    }
+
+    public RetryConfigMapping<T> build(RetryConfigFactory retryConfigFactory) {
+        if (!validateMappingKeys()) {
+            throw new IllegalStateException(
+                    "A RetryConfigMapping created by this builder must be per host, method and/or path");
+        }
+
+        return new KeyedRetryConfigMapping<>(
+                perHost, perMethod, perPath, retryConfigFactory
+        );
+    }
+}
diff --git a/core/src/main/java/com/linecorp/armeria/internal/common/RequestContextUtil.java b/core/src/main/java/com/linecorp/armeria/internal/common/RequestContextUtil.java
@@ -1,7 +1,7 @@
 /*
- * Copyright 2019 LINE Corporation
+ * Copyright 2025 LY Corporation
  *
- * LINE Corporation licenses this file to you under the Apache License,
+ * LY Corporation 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:
  *
@@ -30,12 +30,15 @@
 import com.google.common.collect.MapMaker;
 import com.google.errorprone.annotations.MustBeClosed;
 
+import com.linecorp.armeria.client.ClientRequestContext;
+import com.linecorp.armeria.client.Endpoint;
 import com.linecorp.armeria.common.ContextHolder;
 import com.linecorp.armeria.common.Flags;
 import com.linecorp.armeria.common.HttpRequest;
 import com.linecorp.armeria.common.RequestContext;
 import com.linecorp.armeria.common.RequestContextStorage;
 import com.linecorp.armeria.common.RequestContextStorageProvider;
+import com.linecorp.armeria.common.RpcRequest;
 import com.linecorp.armeria.common.annotation.Nullable;
 import com.linecorp.armeria.common.util.SafeCloseable;
 import com.linecorp.armeria.common.util.Sampler;
@@ -267,5 +270,29 @@ public static void ensureSameCtx(RequestContext ctx, ContextHolder contextHolder
         }
     }
 
+    public static String host(ClientRequestContext ctx) {
+        final Endpoint endpoint = ctx.endpoint();
+        if (endpoint == null) {
+            return "UNKNOWN";
+        } else {
+            final String ipAddr = endpoint.ipAddr();
+            if (ipAddr == null || endpoint.isIpAddrOnly()) {
+                return endpoint.authority();
+            } else {
+                return endpoint.authority() + '/' + ipAddr;
+            }
+        }
+    }
+
+    public static String method(ClientRequestContext ctx) {
+        final RpcRequest rpcReq = ctx.rpcRequest();
+        return rpcReq != null ? rpcReq.method() : ctx.method().name();
+    }
+
+    public static String path(ClientRequestContext ctx) {
+        final HttpRequest request = ctx.request();
+        return request == null ? "" : request.path();
+    }
+
     private RequestContextUtil() {}
 }
diff --git a/core/src/main/java/com/linecorp/armeria/internal/common/circuitbreaker/CircuitBreakerMappingUtil.java b/core/src/main/java/com/linecorp/armeria/internal/common/circuitbreaker/CircuitBreakerMappingUtil.java
diff --git a/resilience4j2/src/main/java/com/linecorp/armeria/resilience4j/circuitbreaker/client/KeyedResilience4jCircuitBreakerMapping.java b/resilience4j2/src/main/java/com/linecorp/armeria/resilience4j/circuitbreaker/client/KeyedResilience4jCircuitBreakerMapping.java
@@ -1,7 +1,7 @@
 /*
- * Copyright 2022 LINE Corporation
+ * Copyright 2025 LY Corporation
  *
- * LINE Corporation licenses this file to you under the Apache License,
+ * LY Corporation 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:
  *
@@ -16,9 +16,9 @@
 
 package com.linecorp.armeria.resilience4j.circuitbreaker.client;
 
-import static com.linecorp.armeria.internal.common.circuitbreaker.CircuitBreakerMappingUtil.host;
-import static com.linecorp.armeria.internal.common.circuitbreaker.CircuitBreakerMappingUtil.method;
-import static com.linecorp.armeria.internal.common.circuitbreaker.CircuitBreakerMappingUtil.path;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.host;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.method;
+import static com.linecorp.armeria.internal.common.RequestContextUtil.path;
 
 import com.google.common.base.MoreObjects;
 
