gaoyunhaii commented on code in PR #19983: URL: https://github.com/apache/flink/pull/19983#discussion_r909442128
########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; Review Comment: `maxAttempts` and `backoffTimeMillis` could be marked as final. ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + private final long backoffTimeMillis; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private FixedDelayRetryStrategy( + int maxAttempts, + long backoffTimeMillis, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { + if (null == resultPredicate) { + return Optional.empty(); + } + return Optional.of(resultPredicate); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + if (null == exceptionPredicate) { + return Optional.empty(); + } + return Optional.of(exceptionPredicate); + } + }; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return backoffTimeMillis; + } + } + + /** FixedDelayRetryStrategyBuilder for building a FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategyBuilder<OUT> { + private int maxAttempts; + private long backoffTimeMillis; + private Predicate<Collection<OUT>> resultPredicate; + private Predicate<Throwable> exceptionPredicate; + + public FixedDelayRetryStrategyBuilder(int maxAttempts, long backoffTimeMillis) { + Preconditions.checkArgument( + maxAttempts > 0, "maxAttempts should be greater than zero."); + Preconditions.checkArgument( + backoffTimeMillis > 0, "backoffTimeMillis should be greater than zero."); + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + } + + public FixedDelayRetryStrategyBuilder ifResult( + @Nonnull Predicate<Collection<OUT>> resultRetryPredicate) { + this.resultPredicate = resultRetryPredicate; + return this; + } + + public FixedDelayRetryStrategyBuilder ifException( + @Nonnull Predicate<Throwable> exceptionRetryPredicate) { + this.exceptionPredicate = exceptionRetryPredicate; + return this; + } + + public FixedDelayRetryStrategy build() { + return new FixedDelayRetryStrategy( + maxAttempts, backoffTimeMillis, resultPredicate, exceptionPredicate); + } + } + + /** ExponentialBackoffDelayRetryStrategy. */ + public static class ExponentialBackoffDelayRetryStrategy<OUT> + implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + + private final long initialDelay; + private final long maxRetryDelay; + + private final double multiplier; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private long lastRetryDelay; + + public ExponentialBackoffDelayRetryStrategy( + int maxAttempts, + long initialDelay, + long maxRetryDelay, + double multiplier, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.initialDelay = initialDelay; + this.maxRetryDelay = maxRetryDelay; + this.multiplier = multiplier; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + this.lastRetryDelay = initialDelay; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + long backoff = Math.min((long) (lastRetryDelay * multiplier), maxRetryDelay); + this.lastRetryDelay = backoff; + return backoff; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { + if (null == resultPredicate) { + return Optional.empty(); + } + return Optional.of(resultPredicate); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + if (null == exceptionPredicate) { + return Optional.empty(); + } + return Optional.of(exceptionPredicate); + } + }; + } + } + + /** + * ExponentialBackoffDelayRetryStrategyBuilder for building a + * ExponentialBackoffDelayRetryStrategy. + */ + public static class ExponentialBackoffDelayRetryStrategyBuilder<OUT> { + private final int maxAttempts; + private final long initialDelay; + private final long maxRetryDelay; + private final double multiplier; + + private Predicate<Collection<OUT>> resultPredicate; + private Predicate<Throwable> exceptionPredicate; + + public ExponentialBackoffDelayRetryStrategyBuilder( + int maxAttempts, long initialDelay, long maxRetryDelay, double multiplier) { + this.maxAttempts = maxAttempts; + this.initialDelay = initialDelay; + this.maxRetryDelay = maxRetryDelay; + this.multiplier = multiplier; + } + + public ExponentialBackoffDelayRetryStrategyBuilder ifResult( Review Comment: Similarly `ExponentialBackoffDelayRetryStrategyBuilder` -> `ExponentialBackoffDelayRetryStrategyBuilder<OUT>`. ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + private final long backoffTimeMillis; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private FixedDelayRetryStrategy( + int maxAttempts, + long backoffTimeMillis, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { + if (null == resultPredicate) { + return Optional.empty(); + } + return Optional.of(resultPredicate); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + if (null == exceptionPredicate) { + return Optional.empty(); + } + return Optional.of(exceptionPredicate); + } + }; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return backoffTimeMillis; + } + } + + /** FixedDelayRetryStrategyBuilder for building a FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategyBuilder<OUT> { + private int maxAttempts; + private long backoffTimeMillis; + private Predicate<Collection<OUT>> resultPredicate; + private Predicate<Throwable> exceptionPredicate; + + public FixedDelayRetryStrategyBuilder(int maxAttempts, long backoffTimeMillis) { + Preconditions.checkArgument( + maxAttempts > 0, "maxAttempts should be greater than zero."); + Preconditions.checkArgument( + backoffTimeMillis > 0, "backoffTimeMillis should be greater than zero."); + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + } + + public FixedDelayRetryStrategyBuilder ifResult( Review Comment: `FixedDelayRetryStrategyBuilder` -> `FixedDelayRetryStrategyBuilder<OUT>`, similarly for the remaining ones ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + private final long backoffTimeMillis; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private FixedDelayRetryStrategy( + int maxAttempts, + long backoffTimeMillis, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { + if (null == resultPredicate) { + return Optional.empty(); + } + return Optional.of(resultPredicate); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + if (null == exceptionPredicate) { + return Optional.empty(); + } + return Optional.of(exceptionPredicate); + } + }; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return backoffTimeMillis; + } + } + + /** FixedDelayRetryStrategyBuilder for building a FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategyBuilder<OUT> { + private int maxAttempts; + private long backoffTimeMillis; + private Predicate<Collection<OUT>> resultPredicate; + private Predicate<Throwable> exceptionPredicate; + + public FixedDelayRetryStrategyBuilder(int maxAttempts, long backoffTimeMillis) { + Preconditions.checkArgument( + maxAttempts > 0, "maxAttempts should be greater than zero."); + Preconditions.checkArgument( + backoffTimeMillis > 0, "backoffTimeMillis should be greater than zero."); + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + } + + public FixedDelayRetryStrategyBuilder ifResult( + @Nonnull Predicate<Collection<OUT>> resultRetryPredicate) { + this.resultPredicate = resultRetryPredicate; + return this; + } + + public FixedDelayRetryStrategyBuilder ifException( + @Nonnull Predicate<Throwable> exceptionRetryPredicate) { + this.exceptionPredicate = exceptionRetryPredicate; + return this; + } + + public FixedDelayRetryStrategy build() { + return new FixedDelayRetryStrategy( Review Comment: `FixedDelayRetryStrategy` -> FixedDelayRetryStrategy<OUT>, also for the return type. ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + private final long backoffTimeMillis; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private FixedDelayRetryStrategy( + int maxAttempts, + long backoffTimeMillis, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { Review Comment: Might be simplified with `return Optional.ofNullable(resultPredicate);`. The same to the other methods. Also if not consider the possible changes to the API, I think we could extract a named inner `AsyncRetryPredicate` class that composes of two separate predicates. ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/RetryPredicates.java: ########## @@ -0,0 +1,85 @@ +/* + * 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.flink.streaming.util.retryable; + +import javax.annotation.Nonnull; + +import java.io.Serializable; +import java.util.Collection; +import java.util.function.Predicate; + +/** Utility class to create concrete retry predicates. */ +public class RetryPredicates { + + /** A predicate matches empty result which means an empty {@link Collection}. */ + public static final EmptyResultPredicate EMPTY_RESULT_PREDICATE = new EmptyResultPredicate(); + + /** A predicate matches any exception which means a non-null{@link Throwable}. */ + public static final HasExceptionPredicate HAS_EXCEPTION_PREDICATE = new HasExceptionPredicate(); + + /** + * Create a predicate on given exception type. Review Comment: `Create` -> `Creates`. ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + private final long backoffTimeMillis; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private FixedDelayRetryStrategy( + int maxAttempts, + long backoffTimeMillis, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { + if (null == resultPredicate) { + return Optional.empty(); + } + return Optional.of(resultPredicate); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + if (null == exceptionPredicate) { + return Optional.empty(); + } + return Optional.of(exceptionPredicate); + } + }; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return backoffTimeMillis; + } + } + + /** FixedDelayRetryStrategyBuilder for building a FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategyBuilder<OUT> { + private int maxAttempts; + private long backoffTimeMillis; + private Predicate<Collection<OUT>> resultPredicate; + private Predicate<Throwable> exceptionPredicate; + + public FixedDelayRetryStrategyBuilder(int maxAttempts, long backoffTimeMillis) { + Preconditions.checkArgument( + maxAttempts > 0, "maxAttempts should be greater than zero."); + Preconditions.checkArgument( + backoffTimeMillis > 0, "backoffTimeMillis should be greater than zero."); + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + } + + public FixedDelayRetryStrategyBuilder ifResult( + @Nonnull Predicate<Collection<OUT>> resultRetryPredicate) { + this.resultPredicate = resultRetryPredicate; + return this; + } + + public FixedDelayRetryStrategyBuilder ifException( + @Nonnull Predicate<Throwable> exceptionRetryPredicate) { + this.exceptionPredicate = exceptionRetryPredicate; + return this; + } + + public FixedDelayRetryStrategy build() { + return new FixedDelayRetryStrategy( + maxAttempts, backoffTimeMillis, resultPredicate, exceptionPredicate); + } + } + + /** ExponentialBackoffDelayRetryStrategy. */ + public static class ExponentialBackoffDelayRetryStrategy<OUT> + implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + + private final long initialDelay; + private final long maxRetryDelay; + + private final double multiplier; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private long lastRetryDelay; + + public ExponentialBackoffDelayRetryStrategy( + int maxAttempts, + long initialDelay, + long maxRetryDelay, + double multiplier, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.initialDelay = initialDelay; + this.maxRetryDelay = maxRetryDelay; + this.multiplier = multiplier; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + this.lastRetryDelay = initialDelay; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + long backoff = Math.min((long) (lastRetryDelay * multiplier), maxRetryDelay); Review Comment: Should the delay for the first time be the same with `initialDelay`? ########## flink-streaming-java/src/main/java/org/apache/flink/streaming/util/retryable/AsyncRetryStrategies.java: ########## @@ -0,0 +1,260 @@ +/* + * 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.flink.streaming.util.retryable; + +import org.apache.flink.streaming.api.functions.async.AsyncRetryPredicate; +import org.apache.flink.streaming.api.functions.async.AsyncRetryStrategy; +import org.apache.flink.util.Preconditions; + +import javax.annotation.Nonnull; + +import java.util.Collection; +import java.util.Optional; +import java.util.function.Predicate; + +/** Utility class to create concrete {@link AsyncRetryStrategy}. */ +public class AsyncRetryStrategies { + public static final NoRetryStrategy NO_RETRY_STRATEGY = new NoRetryStrategy(); + + /** NoRetryStrategy. */ + public static class NoRetryStrategy implements AsyncRetryStrategy { + private static final long serialVersionUID = 1L; + + private NoRetryStrategy() {} + + @Override + public boolean canRetry(int currentAttempts) { + return false; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return -1; + } + + @Override + public AsyncRetryPredicate getRetryPredicate() { + return new AsyncRetryPredicate() { + @Override + public Optional<Predicate<Collection>> resultPredicate() { + return Optional.empty(); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + return Optional.empty(); + } + }; + } + } + + /** FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategy<OUT> implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + private final long backoffTimeMillis; + private final Predicate<Collection<OUT>> resultPredicate; + private final Predicate<Throwable> exceptionPredicate; + + private FixedDelayRetryStrategy( + int maxAttempts, + long backoffTimeMillis, + Predicate<Collection<OUT>> resultPredicate, + Predicate<Throwable> exceptionPredicate) { + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + this.resultPredicate = resultPredicate; + this.exceptionPredicate = exceptionPredicate; + } + + @Override + public boolean canRetry(int currentAttempts) { + return currentAttempts <= maxAttempts; + } + + @Override + public AsyncRetryPredicate<OUT> getRetryPredicate() { + return new AsyncRetryPredicate<OUT>() { + @Override + public Optional<Predicate<Collection<OUT>>> resultPredicate() { + if (null == resultPredicate) { + return Optional.empty(); + } + return Optional.of(resultPredicate); + } + + @Override + public Optional<Predicate<Throwable>> exceptionPredicate() { + if (null == exceptionPredicate) { + return Optional.empty(); + } + return Optional.of(exceptionPredicate); + } + }; + } + + @Override + public long getBackoffTimeMillis(int currentAttempts) { + return backoffTimeMillis; + } + } + + /** FixedDelayRetryStrategyBuilder for building a FixedDelayRetryStrategy. */ + public static class FixedDelayRetryStrategyBuilder<OUT> { + private int maxAttempts; + private long backoffTimeMillis; + private Predicate<Collection<OUT>> resultPredicate; + private Predicate<Throwable> exceptionPredicate; + + public FixedDelayRetryStrategyBuilder(int maxAttempts, long backoffTimeMillis) { + Preconditions.checkArgument( + maxAttempts > 0, "maxAttempts should be greater than zero."); + Preconditions.checkArgument( + backoffTimeMillis > 0, "backoffTimeMillis should be greater than zero."); + this.maxAttempts = maxAttempts; + this.backoffTimeMillis = backoffTimeMillis; + } + + public FixedDelayRetryStrategyBuilder ifResult( + @Nonnull Predicate<Collection<OUT>> resultRetryPredicate) { + this.resultPredicate = resultRetryPredicate; + return this; + } + + public FixedDelayRetryStrategyBuilder ifException( + @Nonnull Predicate<Throwable> exceptionRetryPredicate) { + this.exceptionPredicate = exceptionRetryPredicate; + return this; + } + + public FixedDelayRetryStrategy build() { + return new FixedDelayRetryStrategy( + maxAttempts, backoffTimeMillis, resultPredicate, exceptionPredicate); + } + } + + /** ExponentialBackoffDelayRetryStrategy. */ + public static class ExponentialBackoffDelayRetryStrategy<OUT> + implements AsyncRetryStrategy<OUT> { + private static final long serialVersionUID = 1L; + private final int maxAttempts; + + private final long initialDelay; Review Comment: `initialDelay` is not necessary as a class variable? -- 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]
