-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #232 from Proximyst/mariellh/log-cause-on-reconnect
feat: introduce a ReconnectionListener
- Loading branch information
Showing
9 changed files
with
444 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
folsom/src/main/java/com/spotify/folsom/reconnect/AbstractReconnectionListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright (c) 2023 Spotify AB | ||
| * | ||
| * Licensed 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 com.spotify.folsom.reconnect; | ||
|
|
||
| import com.spotify.folsom.guava.HostAndPort; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * A listener for each reconnection event. This will be called more often than the {@link | ||
| * com.spotify.folsom.ConnectionChangeListener ConnectionChangeListener}s. For more information on | ||
| * this, see {@link ReconnectionListener}. | ||
| * | ||
| * <p>This class acts as a stable interface for {@link ReconnectionListener}. While {@link | ||
| * ReconnectionListener} can have source-incompatible changes in minor versions, this cannot do | ||
| * that. | ||
| * | ||
| * @see ReconnectionListener | ||
| */ | ||
| public abstract class AbstractReconnectionListener implements ReconnectionListener { | ||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void connectionFailure(final Throwable cause) { | ||
| // No-op. | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void connectionLost(final @Nullable Throwable cause, final HostAndPort address) { | ||
| // No-op. | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void reconnectionSuccessful( | ||
| final HostAndPort address, final int attempt, final boolean willStayConnected) { | ||
| // No-op. | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void reconnectionCancelled() { | ||
| // No-op. | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void reconnectionQueuedFromError( | ||
| final Throwable cause, | ||
| final HostAndPort address, | ||
| final long backOffMillis, | ||
| final int attempt) { | ||
| // No-op. | ||
| } | ||
| } |
127 changes: 127 additions & 0 deletions
127
folsom/src/main/java/com/spotify/folsom/reconnect/CatchingReconnectionListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * Copyright (c) 2023 Spotify AB | ||
| * | ||
| * Licensed 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 com.spotify.folsom.reconnect; | ||
|
|
||
| import com.spotify.folsom.guava.HostAndPort; | ||
| import java.util.Objects; | ||
| import javax.annotation.Nullable; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * A {@link ReconnectionListener} which ensures the methods never throw {@link Exception} (though | ||
| * {@link Error} and {@link Throwable} are not caught). | ||
| * | ||
| * <p>This should wrap any untrusted {@link ReconnectionListener}. | ||
| * | ||
| * <p>This class should be regarded as <b>internal API</b>. We recognise it may be useful outside | ||
| * internals, to which end it is exposed. The constructor is <b>stable</b>. All methods are | ||
| * <b>unstable</b> and can change with breakage in patch versions. If you want a stable interface, | ||
| * wrap your own reconnection listener in this, instead of extending it (and instead extend {@link | ||
| * AbstractReconnectionListener}). | ||
| */ | ||
| public class CatchingReconnectionListener implements ReconnectionListener { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(CatchingReconnectionListener.class); | ||
|
|
||
| private final ReconnectionListener delegate; | ||
|
|
||
| public CatchingReconnectionListener(final ReconnectionListener delegate) { | ||
| this.delegate = Objects.requireNonNull(delegate, "delegate must not be null"); | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void connectionFailure(final Throwable cause) { | ||
| try { | ||
| delegate.connectionFailure(cause); | ||
| } catch (final Exception ex) { | ||
| log.warn("Delegate ReconnectionListener threw on #connectionFailure: {}", this.delegate, ex); | ||
| } | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void reconnectionCancelled() { | ||
| try { | ||
| delegate.reconnectionCancelled(); | ||
| } catch (final Exception ex) { | ||
| log.warn( | ||
| "Delegate ReconnectionListener threw on #reconnectionCancelled: {}", this.delegate, ex); | ||
| } | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void reconnectionSuccessful( | ||
| final HostAndPort address, final int attempt, final boolean willStayConnected) { | ||
| try { | ||
| delegate.reconnectionSuccessful(address, attempt, willStayConnected); | ||
| } catch (final Exception ex) { | ||
| log.warn( | ||
| "Delegate ReconnectionListener threw on #reconnectionSuccessful: {}", this.delegate, ex); | ||
| } | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void connectionLost(final @Nullable Throwable cause, final HostAndPort address) { | ||
| try { | ||
| delegate.connectionLost(cause, address); | ||
| } catch (final Exception ex) { | ||
| log.warn("Delegate ReconnectionListener threw on #connectionLost: {}", this.delegate, ex); | ||
| } | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public void reconnectionQueuedFromError( | ||
| final Throwable cause, | ||
| final HostAndPort address, | ||
| final long backOffMillis, | ||
| final int attempt) { | ||
| try { | ||
| delegate.reconnectionQueuedFromError(cause, address, backOffMillis, attempt); | ||
| } catch (final Exception ex) { | ||
| log.warn( | ||
| "Delegate ReconnectionListener threw on #reconnectionQueuedFromError: {}", | ||
| this.delegate, | ||
| ex); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(final Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (!(o instanceof CatchingReconnectionListener)) { | ||
| return false; | ||
| } | ||
| final CatchingReconnectionListener that = (CatchingReconnectionListener) o; | ||
| return this.delegate.equals(that.delegate); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(this.delegate); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "CatchingReconnectionListener{delegate=" + this.delegate + '}'; | ||
| } | ||
| } |
Oops, something went wrong.