[CHA-0] Add getter methods, equals and hashCode to most request classes for better testability (#205)

* add getters and equals and hashCode to most request classes for
better testablity

also fixed getter missing in javadoc

* update deprecated code

* add @Getter and @EqualsAndHashCode to request classes

* remove callSuper from request objects

Author: shaljam

build.gradle

@@ -4,6 +4,7 @@ plugins {
 	id 'com.diffplug.spotless' version '6.25.0'
 	id 'org.barfuin.gradle.jacocolog' version '3.1.0'
 	id 'com.github.johnrengelman.shadow' version '8.1.1'
+	id 'io.freefair.lombok' version '8.4'
 }
 
 group = 'io.getstream'
@@ -39,12 +40,7 @@ dependencies {
 	runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.12.5'
 	testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
 	testImplementation 'org.apache.commons:commons-lang3:3.12.0'
-	compileOnly 'org.projectlombok:lombok:1.18.32'
-	annotationProcessor 'org.projectlombok:lombok:1.18.32'
 	compileOnly 'org.jetbrains:annotations:24.1.0'
-
-	testCompileOnly 'org.projectlombok:lombok:1.18.32'
-	testAnnotationProcessor 'org.projectlombok:lombok:1.18.32'
 }
 
 def localProperties = new Properties()
@@ -110,4 +106,11 @@ shadowJar {
 	mergeServiceFiles()
 }
 
+// Configure javadoc to use delomboked sources
+javadoc {
+	dependsOn delombok
+	source = delombok.target
+	options.addStringOption('Xdoclint:none', '-quiet')
+}
+
 apply from: "publish.gradle"

src/main/java/io/getstream/chat/java/models/App.java

@@ -27,7 +27,6 @@
 import java.security.InvalidKeyException;
 import java.security.Key;
 import java.security.NoSuchAlgorithmException;
-import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
@@ -586,7 +585,8 @@ public static class DeviceError {
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class AsyncModerationCallback {
     @Nullable
     @JsonProperty("mode")
@@ -598,7 +598,8 @@ public static class AsyncModerationCallback {
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class AsyncModerationConfigRequestObject {
     @Nullable
     @JsonProperty("callback")
@@ -610,7 +611,8 @@ public static class AsyncModerationConfigRequestObject {
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class FileUploadConfigRequestObject {
 
     @Nullable
@@ -641,7 +643,8 @@ public static FileUploadConfigRequestObject buildFrom(
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class APNConfigRequestObject {
     @Nullable
     @JsonProperty("development")
@@ -686,9 +689,9 @@ public static APNConfigRequestObject buildFrom(@Nullable APNConfig aPNConfig) {
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class FirebaseConfigRequestObject {
-
     @Nullable
     @JsonProperty("server_key")
     private String serverKey;
@@ -716,7 +719,8 @@ public static FirebaseConfigRequestObject buildFrom(@Nullable FirebaseConfig fir
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class HuaweiConfigRequestObject {
     @Nullable
     @JsonProperty("id")
@@ -728,7 +732,8 @@ public static class HuaweiConfigRequestObject {
   }
 
   @Builder
-  @Setter
+  @Getter
+  @EqualsAndHashCode
   public static class PushConfigRequestObject {
     @Nullable
     @JsonProperty("version")
@@ -758,6 +763,8 @@ protected Call<ListPushProviderResponse> generateCall(Client client) {
     }
   }
 
+  @Getter
+  @EqualsAndHashCode
   public static class DeletePushProviderRequest extends StreamRequest<StreamResponseObject> {
     private String providerType;
     private String name;
@@ -777,6 +784,8 @@ protected Call<StreamResponseObject> generateCall(Client client) {
       builderClassName = "AppUpdateRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class AppUpdateRequestData {
     @Nullable
     @JsonProperty("disable_auth_checks")
@@ -965,6 +974,11 @@ public boolean equals(Object o) {
     }
   }
 
+  @Builder
+  @Getter
+  @EqualsAndHashCode
+  @NoArgsConstructor
+  @AllArgsConstructor
   public static class AppGetRateLimitsRequest extends StreamRequest<AppGetRateLimitsResponse> {
     @Nullable private Boolean serverSide;
 
@@ -974,43 +988,7 @@ public static class AppGetRateLimitsRequest extends StreamRequest<AppGetRateLimi
 
     @Nullable private Boolean web;
 
-    @Nullable private List<String> endpoints = new ArrayList<>();
-
-    @NotNull
-    public AppGetRateLimitsRequest serverSide(@NotNull Boolean serverSide) {
-      this.serverSide = serverSide;
-      return this;
-    }
-
-    @NotNull
-    public AppGetRateLimitsRequest android(@NotNull Boolean android) {
-      this.android = android;
-      return this;
-    }
-
-    @NotNull
-    public AppGetRateLimitsRequest ios(@NotNull Boolean ios) {
-      this.ios = ios;
-      return this;
-    }
-
-    @NotNull
-    public AppGetRateLimitsRequest web(@NotNull Boolean web) {
-      this.web = web;
-      return this;
-    }
-
-    @NotNull
-    public AppGetRateLimitsRequest endpoints(@NotNull List<String> endpoints) {
-      this.endpoints = endpoints;
-      return this;
-    }
-
-    @NotNull
-    public AppGetRateLimitsRequest endpoint(@NotNull String endpoint) {
-      this.endpoints.add(endpoint);
-      return this;
-    }
+    @Singular @Nullable private List<String> endpoints;
 
     @Override
     protected Call<AppGetRateLimitsResponse> generateCall(Client client) {
@@ -1029,6 +1007,8 @@ protected Call<AppGetRateLimitsResponse> generateCall(Client client) {
       builderClassName = "AppCheckSqsRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class AppCheckSqsRequestData {
     @Nullable
     @JsonProperty("sqs_url")
@@ -1054,6 +1034,8 @@ protected Call<AppCheckSqsResponse> generateCall(Client client) {
       builderClassName = "AppCheckSnsRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class AppCheckSnsRequestData {
     @Nullable
     @JsonProperty("sns_topic_arn")
@@ -1079,6 +1061,8 @@ protected Call<AppCheckSnsResponse> generateCall(Client client) {
       builderClassName = "AppCheckPushRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class AppCheckPushRequestData {
     @Nullable
     @JsonProperty("message_id")
@@ -1125,6 +1109,8 @@ protected Call<AppCheckPushResponse> generateCall(Client client) {
   }
 
   @AllArgsConstructor
+  @Getter
+  @EqualsAndHashCode
   public static class AppRevokeTokensRequest extends StreamRequest<StreamResponseObject> {
     @Nullable private Date revokeTokensIssuedBefore;
 
@@ -1212,6 +1198,8 @@ public static class PushProvider {
       builderClassName = "PushProviderRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class PushProviderRequestData {
     @JsonProperty("push_provider")
     private PushProvider pushProvider;

src/main/java/io/getstream/chat/java/models/BlockUser.java

@@ -19,6 +19,8 @@ public class BlockUser {
       builderClassName = "BlockUserRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class BlockUserRequestData {
     @NotNull
     @JsonProperty("blocked_user_id")
@@ -41,6 +43,8 @@ protected Call<BlockUserResponse> generateCall(Client client) {
       builderClassName = "UnblockUserRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class UnblockUserRequestData {
     @NotNull
     @JsonProperty("blocked_user_id")
@@ -119,14 +123,14 @@ public static class BlockedUserResponse {
       builderClassName = "GetBlockedUsersRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class GetBlockedUsersRequestData {
     @NotNull
     @JsonProperty("user_id")
     private String blockedByUserID;
 
     public static class GetBlockedUsersRequest extends StreamRequest<GetBlockedUsersResponse> {
-      private String blockedByUserID;
-
       public GetBlockedUsersRequest(String blockedByUserID) {
         this.blockedByUserID = blockedByUserID;
       }

src/main/java/io/getstream/chat/java/models/Blocklist.java

@@ -37,6 +37,8 @@ public class Blocklist {
       builderClassName = "BlocklistCreateRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class BlocklistCreateRequestData {
     @Nullable
     @JsonProperty("name")
@@ -55,6 +57,8 @@ protected Call<StreamResponseObject> generateCall(Client client) {
   }
 
   @RequiredArgsConstructor
+  @Getter
+  @EqualsAndHashCode
   public static class BlocklistGetRequest extends StreamRequest<BlocklistGetResponse> {
     @NotNull private String name;
 
@@ -68,6 +72,8 @@ protected Call<BlocklistGetResponse> generateCall(Client client) {
       builderClassName = "BlocklistUpdateRequest",
       builderMethodName = "",
       buildMethodName = "internalBuild")
+  @Getter
+  @EqualsAndHashCode
   public static class BlocklistUpdateRequestData {
     @Nullable
     @JsonProperty("words")
@@ -88,6 +94,8 @@ protected Call<StreamResponseObject> generateCall(Client client) {
   }
 
   @RequiredArgsConstructor
+  @Getter
+  @EqualsAndHashCode
   public static class BlocklistDeleteRequest extends StreamRequest<StreamResponseObject> {
     @NotNull private String name;