Fix #525 by correcting the structure of details in LogsResponse (Audit Logs API) (#526)

* Fix #525 by correcting the structure of details in LogsResponse

* Make attachin raw body optional

* Adjust error messages

Author: seratch

json-logs/samples/audit/v1/logs.json

@@ -20,6 +20,51 @@
           "name": "",
           "email": "",
           "team": "E00000000"
+        },
+        "usergroup": {
+          "id": "S00000000",
+          "name": ""
+        },
+        "channel": {
+          "id": "C00000000",
+          "privacy": "",
+          "name": "",
+          "is_shared": false,
+          "is_org_shared": false,
+          "teams_shared_with": [
+            "T00000000",
+            ""
+          ]
+        },
+        "enterprise": {
+          "id": "E00000000",
+          "name": "",
+          "domain": ""
+        },
+        "workspace": {
+          "id": "T00000000",
+          "name": "",
+          "domain": ""
+        },
+        "file": {
+          "id": "F00000000",
+          "name": "",
+          "filetype": "",
+          "title": ""
+        },
+        "app": {
+          "id": "A00000000",
+          "name": "",
+          "is_distributed": false,
+          "is_directory_approved": false,
+          "is_workflow_app": false,
+          "scopes": [
+            ""
+          ]
+        },
+        "workflow": {
+          "id": "12345",
+          "name": ""
         }
       },
       "context": {
@@ -31,6 +76,73 @@
         },
         "ua": "",
         "ip_address": ""
+      },
+      "details": {
+        "channels": [
+          "C00000000"
+        ],
+        "type": "",
+        "is_workflow": false,
+        "shared_to": "T00000000",
+        "reason": "",
+        "mobile_only": false,
+        "web_only": false,
+        "expires_on": 12345,
+        "name": "",
+        "kicker": {
+          "id": "W00000000",
+          "name": "",
+          "email": "",
+          "team": "T00000000",
+          "type": "",
+          "user": {
+            "id": "W00000000",
+            "name": "",
+            "email": "",
+            "team": "E00000000"
+          }
+        },
+        "inviter": {
+          "id": "W00000000",
+          "name": "",
+          "email": "",
+          "team": "E00000000",
+          "type": "",
+          "user": {
+            "id": "W00000000",
+            "name": "",
+            "email": "",
+            "team": "E00000000"
+          }
+        },
+        "is_internal_integration": false,
+        "app_owner_id": "W00000000",
+        "bot_scopes": [
+          ""
+        ],
+        "new_version_id": "12345",
+        "trigger": "",
+        "new_scopes": [
+          ""
+        ],
+        "previous_scopes": [
+          ""
+        ],
+        "granular_bot_token": false,
+        "origin_team": "T00000000",
+        "target_team": "T00000000",
+        "scopes": [
+          ""
+        ],
+        "resolution": "",
+        "app_previously_resolved": false,
+        "admin_app_id": "",
+        "new_value": [
+          "C00000000"
+        ],
+        "previous_value": [
+          ""
+        ]
       }
     }
   ],

slack-api-client/src/main/java/com/slack/api/audit/AuditApiErrorResponse.java

@@ -6,6 +6,7 @@
 @Data
 @EqualsAndHashCode(callSuper = false)
 public class AuditApiErrorResponse implements AuditApiResponse {
+    private transient String rawBody;
 
     private boolean ok;
     private String warning;

slack-api-client/src/main/java/com/slack/api/audit/AuditApiException.java

@@ -44,6 +44,7 @@ private static AuditApiErrorResponse parse(SlackConfig config, String responseBo
         AuditApiErrorResponse parsedErrorResponse = null;
         try {
             parsedErrorResponse = GsonFactory.createSnakeCase(config).fromJson(responseBody, AuditApiErrorResponse.class);
+            parsedErrorResponse.setRawBody(responseBody);
         } catch (Exception e) {
             if (log.isDebugEnabled()) {
                 String responseToPrint = responseBody.length() > 1000 ? responseBody.subSequence(0, 1000) + " ..." : responseBody;

slack-api-client/src/main/java/com/slack/api/audit/AuditApiResponse.java

@@ -24,4 +24,7 @@ public interface AuditApiResponse {
 
     void setProvided(String provided);
 
+    String getRawBody();
+
+    void setRawBody(String rawBody);
 }

slack-api-client/src/main/java/com/slack/api/audit/AuditClient.java

@@ -25,6 +25,8 @@ public interface AuditClient {
 
     String ENDPOINT_URL_PREFIX = "https://api.slack.com/audit/v1/";
 
+    AuditClient attachRawBody(boolean attachRawBody);
+
     SchemasResponse getSchemas() throws IOException, AuditApiException;
 
     SchemasResponse getSchemas(SchemasRequest req) throws IOException, AuditApiException;

slack-api-client/src/main/java/com/slack/api/audit/impl/AuditClientImpl.java

@@ -3,6 +3,7 @@
 import com.slack.api.RequestConfigurator;
 import com.slack.api.audit.AuditApiException;
 import com.slack.api.audit.AuditApiRequest;
+import com.slack.api.audit.AuditApiResponse;
 import com.slack.api.audit.AuditClient;
 import com.slack.api.audit.request.ActionsRequest;
 import com.slack.api.audit.request.LogsRequest;
@@ -24,6 +25,7 @@ public class AuditClientImpl implements AuditClient {
 
     private final SlackHttpClient slackHttpClient;
     private final String token;
+    private boolean attachRawBody = false;
 
     public AuditClientImpl(SlackHttpClient slackHttpClient) {
         this(slackHttpClient, null);
@@ -42,6 +44,12 @@ public void setEndpointUrlPrefix(String endpointUrlPrefix) {
         this.endpointUrlPrefix = endpointUrlPrefix;
     }
 
+    @Override
+    public AuditClient attachRawBody(boolean attachRawBody) {
+        this.attachRawBody = attachRawBody;
+        return this;
+    }
+
     @Override
     public SchemasResponse getSchemas() throws IOException, AuditApiException {
         return getSchemas(SchemasRequest.builder().build());
@@ -114,16 +122,20 @@ private String getToken(AuditApiRequest req) {
         }
     }
 
-    private <T> T doGet(String url, Map<String, String> query, String token, Class<T> clazz) throws IOException, AuditApiException {
+    private <T extends AuditApiResponse> T doGet(String url, Map<String, String> query, String token, Class<T> clazz) throws IOException, AuditApiException {
         Response response = slackHttpClient.get(url, query, token);
         return parseJsonResponseAndRunListeners(response, clazz);
     }
 
-    private <T> T parseJsonResponseAndRunListeners(Response response, Class<T> clazz) throws IOException, AuditApiException {
+    private <T extends AuditApiResponse> T parseJsonResponseAndRunListeners(Response response, Class<T> clazz) throws IOException, AuditApiException {
         String body = response.body().string();
         slackHttpClient.runHttpResponseListeners(response, body);
         if (response.isSuccessful()) {
-            return GsonFactory.createSnakeCase(slackHttpClient.getConfig()).fromJson(body, clazz);
+            T apiResponse = GsonFactory.createSnakeCase(slackHttpClient.getConfig()).fromJson(body, clazz);
+            if (attachRawBody) {
+                apiResponse.setRawBody(body);
+            }
+            return apiResponse;
         } else {
             throw new AuditApiException(slackHttpClient.getConfig(), response, body);
         }

slack-api-client/src/main/java/com/slack/api/audit/response/ActionsResponse.java

@@ -9,6 +9,8 @@
 @Data
 @EqualsAndHashCode(callSuper = false)
 public class ActionsResponse implements AuditApiResponse {
+    private transient String rawBody;
+
     private boolean ok;
     private String warning;
     private String error;

slack-api-client/src/main/java/com/slack/api/audit/response/LogsResponse.java

@@ -7,10 +7,13 @@
 import lombok.EqualsAndHashCode;
 
 import java.util.List;
+import java.util.Map;
 
 @Data
 @EqualsAndHashCode(callSuper = false)
 public class LogsResponse implements AuditApiResponse {
+    private transient String rawBody;
+
     private boolean ok;
     private String warning;
     private String error;
@@ -56,6 +59,7 @@ public static class Entity {
         private Enterprise enterprise;
         private File file;
         private Channel channel;
+        private Workflow workflow;
     }
 
     @Data
@@ -66,6 +70,8 @@ public static class App {
         private Boolean distributed;
         @SerializedName("is_directory_approved")
         private Boolean directoryApproved;
+        @SerializedName("is_workflow_app")
+        private Boolean workflowApp;
         private List<String> scopes;
     }
 
@@ -109,6 +115,12 @@ public static class Channel {
         private List<String> teamsSharedWith;
     }
 
+    @Data
+    public static class Workflow {
+        private String id;
+        private String name;
+    }
+
     @Data
     public static class Context {
         private Location location;
@@ -124,40 +136,78 @@ public static class Location {
         private String domain;
     }
 
+    /**
+     * The data structure for new_value, previous_value is greatly flexible.
+     * This class supports multiple patterns for those.
+     */
+    @Data
+    public static class DetailsChangedValue {
+        // e.g., ["C111", "C222"]
+        private List<String> stringValues;
+        // e.g., {"type": ["TOPLEVEL_ADMINS_AND_OWNERS_AND_SELECTED"]}
+        private Map<String, List<String>> namedStringValues;
+    }
+
     @Data
     public static class Details {
-        @SerializedName("is_internal_integration")
-        private Boolean internalIntegration;
+        private String type;
         private String appOwnerId;
+        private List<String> scopes; // app_scopes_expanded
+        private List<String> botScopes;
         private List<String> newScopes;
         private List<String> previousScopes;
-        private String type;
         private Inviter inviter;
-        private String newValue;
-        private String previousValue;
+        private DetailsChangedValue newValue; // pref.who_can_manage_shared_channels etc
+        private DetailsChangedValue previousValue; // pref.who_can_manage_shared_channels etc
         private Kicker kicker;
         private String installerUserId;
         private Boolean appPreviouslyApproved;
         private List<String> oldScopes;
         private String name;
         private String botId;
+        private List<String> channels;
         private List<Permission> permissions;
+        private String sharedTo; // channel_workspaces_updated
+        private String reason;
+        @SerializedName("is_internal_integration")
+        private Boolean internalIntegration;
+        @SerializedName("is_workflow")
+        private Boolean workflow; // user_channel_join
+        private Boolean mobileOnly; // user_session_reset_by_admin
+        private Boolean webOnly; // user_session_reset_by_admin
+        private Integer expiresOn; // guest_expiration_set
+        private String newVersionId; // workflow_published
+        private String trigger; // workflow_published
+        private Boolean granularBotToken; // app_scopes_expanded
+        private String originTeam; // external_shared_channel_invite_approved
+        private String targetTeam; // external_shared_channel_invite_approved
+        private String resolution; // app_approved
+        private Boolean appPreviouslyResolved; // app_approved
+        private String adminAppId; // app_approved
     }
 
     @Data
     public static class Inviter {
         private String type;
+
         private User user;
+
         private String id;
         private String name;
         private String email;
+        private String team;
     }
 
     @Data
     public static class Kicker {
+        private String type;
+
+        private User user;
+
         private String id;
         private String name;
         private String email;
+        private String team;
     }
 
     @Data

slack-api-client/src/main/java/com/slack/api/audit/response/SchemasResponse.java

@@ -9,6 +9,8 @@
 @Data
 @EqualsAndHashCode(callSuper = false)
 public class SchemasResponse implements AuditApiResponse {
+    private transient String rawBody;
+
     private boolean ok;
     private String warning;
     private String error;