Removing client param from callbacks

Author: LikeTheSalad

opamp-client/src/main/java/io/opentelemetry/opamp/client/internal/OpampClient.java

@@ -20,8 +20,7 @@ static OpampClientBuilder builder() {
   /**
    * Starts the client and begin attempts to connect to the Server. Once connection is established
    * the client will attempt to maintain it by reconnecting if the connection is lost. All failed
-   * connection attempts will be reported via {@link Callbacks#onConnectFailed(OpampClient,
-   * Throwable)} callback.
+   * connection attempts will be reported via {@link Callbacks#onConnectFailed(Throwable)} callback.
    *
    * <p>This method does not wait until the connection to the Server is established and will likely
    * return before the connection attempts are even made.
@@ -45,7 +44,7 @@ static OpampClientBuilder builder() {
    * the Server. When called after {@link #start(Callbacks)}, the attributes will be included in the
    * next outgoing status report. This is typically used by Agents which allow their
    * AgentDescription to change dynamically while the OpAMPClient is started. May be also called
-   * from {@link Callbacks#onMessage(OpampClient, MessageData)}.
+   * from {@link Callbacks#onMessage(MessageData)}.
    *
    * @param agentDescription The new agent description.
    */
@@ -64,31 +63,27 @@ interface Callbacks {
      * {@link #start(Callbacks)} is called and every time a connection is established to the Server.
      * For WebSocket clients this is called after the handshake is completed without any error. For
      * HTTP clients this is called for any request if the response status is OK.
-     *
-     * @param client The relevant {@link OpampClient} instance.
      */
-    void onConnect(OpampClient client);
+    void onConnect();
 
     /**
      * Called when the connection to the Server cannot be established. May be called after {@link
      * #start(Callbacks)} is called and tries to connect to the Server. May also be called if the
      * connection is lost and reconnection attempt fails.
      *
-     * @param client The relevant {@link OpampClient} instance.
      * @param throwable The exception.
      */
-    void onConnectFailed(OpampClient client, @Nullable Throwable throwable);
+    void onConnectFailed(@Nullable Throwable throwable);
 
     /**
      * Called when the Server reports an error in response to some previously sent request. Useful
      * for logging purposes. The Agent should not attempt to process the error by reconnecting or
      * retrying previous operations. The client handles the ErrorResponse_UNAVAILABLE case
      * internally by performing retries as necessary.
      *
-     * @param client The relevant {@link OpampClient} instance.
      * @param errorResponse The error returned by the Server.
      */
-    void onErrorResponse(OpampClient client, ServerErrorResponse errorResponse);
+    void onErrorResponse(ServerErrorResponse errorResponse);
 
     /**
      * Called when the Agent receives a message that needs processing. See {@link MessageData}
@@ -99,9 +94,8 @@ interface Callbacks {
      * onMessage returns. This is advisable if processing can take a long time. In that case
      * returning quickly is preferable to avoid blocking the {@link OpampClient}.
      *
-     * @param client The relevant {@link OpampClient} instance.
      * @param messageData The server response data that needs processing.
      */
-    void onMessage(OpampClient client, MessageData messageData);
+    void onMessage(MessageData messageData);
   }
 }

opamp-client/src/main/java/io/opentelemetry/opamp/client/internal/impl/OpampClientImpl.java

@@ -154,12 +154,12 @@ public void setRemoteConfigStatus(@Nonnull RemoteConfigStatus remoteConfigStatus
 
   @Override
   public void onConnectionSuccess() {
-    getCallbacks().onConnect(this);
+    getCallbacks().onConnect();
   }
 
   @Override
   public void onConnectionFailed(Throwable throwable) {
-    getCallbacks().onConnectFailed(this, throwable);
+    getCallbacks().onConnectFailed(throwable);
   }
 
   @Override
@@ -176,7 +176,7 @@ public void onRequestFailed(Throwable throwable) {
     preserveFailedRequestRecipe();
     if (throwable instanceof OpampServerResponseException) {
       ServerErrorResponse errorResponse = ((OpampServerResponseException) throwable).errorResponse;
-      getCallbacks().onErrorResponse(this, errorResponse);
+      getCallbacks().onErrorResponse(errorResponse);
     }
   }
 
@@ -203,7 +203,7 @@ private void handleResponsePayload(ServerToAgent response) {
     }
 
     if (notifyOnMessage) {
-      getCallbacks().onMessage(this, messageBuilder.build());
+      getCallbacks().onMessage(messageBuilder.build());
     }
   }
 

opamp-client/src/test/java/io/opentelemetry/opamp/client/internal/impl/OpampClientImplTest.java

@@ -211,8 +211,7 @@ void onSuccess_withChangesToReport_notifyCallbackOnMessage() {
     // Await for onMessage call
     await().atMost(Duration.ofSeconds(1)).until(() -> callbacks.onMessageCalls.get() == 1);
 
-    verify(callbacks)
-        .onMessage(client, MessageData.builder().setRemoteConfig(remoteConfig).build());
+    verify(callbacks).onMessage(MessageData.builder().setRemoteConfig(remoteConfig).build());
   }
 
   @Test
@@ -227,7 +226,7 @@ void onSuccess_withNoChangesToReport_doNotNotifyCallbackOnMessage() {
     // Giving some time for the callback to get called
     await().during(Duration.ofSeconds(1));
 
-    verify(callbacks, never()).onMessage(any(), any());
+    verify(callbacks, never()).onMessage(any());
   }
 
   @Test
@@ -270,8 +269,8 @@ void onConnectionSuccessful_notifyCallback() {
 
     await().atMost(Duration.ofSeconds(1)).until(() -> callbacks.onConnectCalls.get() == 1);
 
-    verify(callbacks).onConnect(client);
-    verify(callbacks, never()).onConnectFailed(any(), any());
+    verify(callbacks).onConnect();
+    verify(callbacks, never()).onConnectFailed(any());
   }
 
   @Test
@@ -314,8 +313,8 @@ void onFailedResponse_withServerErrorData_notifyCallback() {
 
     await().atMost(Duration.ofSeconds(1)).until(() -> callbacks.onErrorResponseCalls.get() == 1);
 
-    verify(callbacks).onErrorResponse(client, errorResponse);
-    verify(callbacks, never()).onMessage(any(), any());
+    verify(callbacks).onErrorResponse(errorResponse);
+    verify(callbacks, never()).onMessage(any());
   }
 
   @Test
@@ -325,7 +324,7 @@ void onConnectionFailed_notifyCallback() {
 
     client.onConnectionFailed(throwable);
 
-    verify(callbacks).onConnectFailed(client, throwable);
+    verify(callbacks).onConnectFailed(throwable);
   }
 
   @Test
@@ -464,22 +463,22 @@ private static class TestCallbacks implements OpampClient.Callbacks {
     private final AtomicInteger onMessageCalls = new AtomicInteger();
 
     @Override
-    public void onConnect(OpampClient client) {
+    public void onConnect() {
       onConnectCalls.incrementAndGet();
     }
 
     @Override
-    public void onConnectFailed(OpampClient client, @Nullable Throwable throwable) {
+    public void onConnectFailed(@Nullable Throwable throwable) {
       onConnectFailedCalls.incrementAndGet();
     }
 
     @Override
-    public void onErrorResponse(OpampClient client, ServerErrorResponse errorResponse) {
+    public void onErrorResponse(ServerErrorResponse errorResponse) {
       onErrorResponseCalls.incrementAndGet();
     }
 
     @Override
-    public void onMessage(OpampClient client, MessageData messageData) {
+    public void onMessage(MessageData messageData) {
       onMessageCalls.incrementAndGet();
     }
   }