From d1eb247d8c8c8920363f6f638765840a6a7797d6 Mon Sep 17 00:00:00 2001
From: Jon Chambers <jon@signal.org>
Date: Fri, 7 Apr 2023 11:21:17 -0400
Subject: [PATCH] Clarify the purpose of an `addListener` method

---
 .../textsecuregcm/websocket/AuthenticatedConnectListener.java | 4 ++--
 .../textsecuregcm/websocket/ProvisioningConnectListener.java  | 2 +-
 .../textsecuregcm/websocket/WebSocketConnectionTest.java      | 2 +-
 .../websocket/session/WebSocketSessionContext.java            | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/websocket/AuthenticatedConnectListener.java b/service/src/main/java/org/whispersystems/textsecuregcm/websocket/AuthenticatedConnectListener.java
index 4569f6b14..6e835a362 100644
--- a/service/src/main/java/org/whispersystems/textsecuregcm/websocket/AuthenticatedConnectListener.java
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/websocket/AuthenticatedConnectListener.java
@@ -116,7 +116,7 @@ public class AuthenticatedConnectListener implements WebSocketConnectListener {
 
       final AtomicReference<ScheduledFuture<?>> renewPresenceFutureReference = new AtomicReference<>();
 
-      context.addListener((closingContext, statusCode, reason) -> {
+      context.addWebsocketClosedListener((closingContext, statusCode, reason) -> {
         openWebsocketAtomicInteger.decrementAndGet();
         openWebsocketCounter.dec();
 
@@ -160,7 +160,7 @@ public class AuthenticatedConnectListener implements WebSocketConnectListener {
       }
     } else {
       final Timer.Context timer = unauthenticatedDurationTimer.time();
-      context.addListener((context1, statusCode, reason) -> timer.stop());
+      context.addWebsocketClosedListener((context1, statusCode, reason) -> timer.stop());
     }
   }
 
diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/websocket/ProvisioningConnectListener.java b/service/src/main/java/org/whispersystems/textsecuregcm/websocket/ProvisioningConnectListener.java
index 4be1431e1..3817155be 100644
--- a/service/src/main/java/org/whispersystems/textsecuregcm/websocket/ProvisioningConnectListener.java
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/websocket/ProvisioningConnectListener.java
@@ -25,7 +25,7 @@ public class ProvisioningConnectListener implements WebSocketConnectListener {
   @Override
   public void onWebSocketConnect(WebSocketSessionContext context) {
     final ProvisioningAddress provisioningAddress = ProvisioningAddress.generate();
-    context.addListener((context1, statusCode, reason) -> provisioningManager.removeListener(provisioningAddress));
+    context.addWebsocketClosedListener((context1, statusCode, reason) -> provisioningManager.removeListener(provisioningAddress));
 
     provisioningManager.addListener(provisioningAddress, message -> {
       assert message.getType() == PubSubProtos.PubSubMessage.Type.DELIVER;
diff --git a/service/src/test/java/org/whispersystems/textsecuregcm/websocket/WebSocketConnectionTest.java b/service/src/test/java/org/whispersystems/textsecuregcm/websocket/WebSocketConnectionTest.java
index 473a9cfe7..be377cecc 100644
--- a/service/src/test/java/org/whispersystems/textsecuregcm/websocket/WebSocketConnectionTest.java
+++ b/service/src/test/java/org/whispersystems/textsecuregcm/websocket/WebSocketConnectionTest.java
@@ -136,7 +136,7 @@ class WebSocketConnectionTest {
 
     connectListener.onWebSocketConnect(sessionContext);
 
-    verify(sessionContext).addListener(any(WebSocketSessionContext.WebSocketEventListener.class));
+    verify(sessionContext).addWebsocketClosedListener(any(WebSocketSessionContext.WebSocketEventListener.class));
 
     when(upgradeRequest.getParameterMap()).thenReturn(Map.of(
         "login", List.of(INVALID_USER),
diff --git a/websocket-resources/src/main/java/org/whispersystems/websocket/session/WebSocketSessionContext.java b/websocket-resources/src/main/java/org/whispersystems/websocket/session/WebSocketSessionContext.java
index 93205e8f9..b5298ef3a 100644
--- a/websocket-resources/src/main/java/org/whispersystems/websocket/session/WebSocketSessionContext.java
+++ b/websocket-resources/src/main/java/org/whispersystems/websocket/session/WebSocketSessionContext.java
@@ -38,7 +38,7 @@ public class WebSocketSessionContext {
     return authenticated;
   }
 
-  public synchronized void addListener(WebSocketEventListener listener) {
+  public synchronized void addWebsocketClosedListener(WebSocketEventListener listener) {
     if (!closed) this.closeListeners.add(listener);
     else         listener.onWebSocketClose(this, 1000, "Closed");
   }