Fix #1373 LogsResponse in AuditClient returns "ok: false" when request was a success (#1374)

seratch · web-flow · commit 8b5b30edf28c · 2024-09-17T21:57:28.000+09:00
* Fix #1373 LogsResponse in AuditClient returns "ok: false" when request was a success * Fix
diff --git a/json-logs/raw/audit/v1/actions.json b/json-logs/raw/audit/v1/actions.json
@@ -323,7 +323,9 @@
       "external_shared_channel_invite_request_approved",
       "external_shared_channel_invite_request_denied",
       "channel_tab_added",
-      "channel_tab_removed"
+      "channel_tab_removed",
+      "external_shared_channel_host_transferred",
+      "channel_template_provisioned"
     ],
     "app": [
       "app_installed",
@@ -502,6 +504,11 @@
       "native_dlp_rule_reactivated",
       "native_dlp_rule_edited",
       "native_dlp_rule_action_applied"
+    ],
+    "template": [
+      "template_created",
+      "template_deleted",
+      "template_provisioned"
     ]
   }
 }
diff --git a/json-logs/raw/audit/v1/schemas.json b/json-logs/raw/audit/v1/schemas.json
@@ -142,6 +142,13 @@
         "template_id": "string",
         "step_configuration": "vec\u003cdict\u003cstring, mixed\u003e\u003e"
       }
+    },
+    {
+      "type": "template",
+      "template": {
+        "id": "string",
+        "template_name": "string"
+      }
     }
   ]
 }
diff --git a/json-logs/samples/audit/v1/actions.json b/json-logs/samples/audit/v1/actions.json
@@ -59,6 +59,9 @@
     ],
     "native_dlp": [
       ""
+    ],
+    "template": [
+      ""
     ]
   },
   "ok": false,
diff --git a/json-logs/samples/audit/v1/logs.json b/json-logs/samples/audit/v1/logs.json
@@ -1,5 +1,5 @@
 {
-  "ok": false,
+  "ok": true,
   "warning": "",
   "error": "",
   "needed": "",
diff --git a/json-logs/samples/audit/v1/schemas.json b/json-logs/samples/audit/v1/schemas.json
@@ -84,6 +84,10 @@
         "updated_by": "",
         "step_configuration": "",
         "template_id": ""
+      },
+      "template": {
+        "id": "",
+        "template_name": ""
       }
     }
   ],
diff --git a/slack-api-client/src/main/java/com/slack/api/audit/Actions.java b/slack-api-client/src/main/java/com/slack/api/audit/Actions.java
@@ -347,6 +347,8 @@ private Channel() {
         public static final String external_shared_channel_invite_request_denied = "external_shared_channel_invite_request_denied";
         public static final String channel_tab_added = "channel_tab_added";
         public static final String channel_tab_removed = "channel_tab_removed";
+        public static final String external_shared_channel_host_transferred = "external_shared_channel_host_transferred";
+        public static final String channel_template_provisioned = "channel_template_provisioned";
     }
 
     public static class App {
@@ -591,4 +593,13 @@ private NativeDlp() {
         public static final String native_dlp_rule_edited = "native_dlp_rule_edited";
         public static final String native_dlp_rule_action_applied = "native_dlp_rule_action_applied";
     }
+
+    public static class Template {
+        private Template() {
+        }
+
+        public static final String template_created = "template_created";
+        public static final String template_deleted = "template_deleted";
+        public static final String template_provisioned = "template_provisioned";
+    }
 }
diff --git a/slack-api-client/src/main/java/com/slack/api/audit/response/ActionsResponse.java b/slack-api-client/src/main/java/com/slack/api/audit/response/ActionsResponse.java
@@ -12,10 +12,15 @@
 public class ActionsResponse implements AuditApiResponse {
     private transient String rawBody;
 
-    private boolean ok;
+    @Deprecated // when an error is returned, it will be an exception instead
+    private boolean ok = true;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String warning;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String error;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String needed;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String provided;
 
     private Actions actions;
@@ -43,5 +48,6 @@ public static class Actions {
         private List<String> function;
         private List<String> salesElevate;
         private List<String> nativeDlp;
+        private List<String> template;
     }
 }
diff --git a/slack-api-client/src/main/java/com/slack/api/audit/response/LogsResponse.java b/slack-api-client/src/main/java/com/slack/api/audit/response/LogsResponse.java
@@ -14,10 +14,15 @@
 public class LogsResponse implements AuditApiResponse {
     private transient String rawBody;
 
-    private boolean ok;
+    @Deprecated // when an error is returned, it will be an exception instead
+    private boolean ok = true;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String warning;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String error;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String needed;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String provided;
 
     private ResponseMetadata responseMetadata;
diff --git a/slack-api-client/src/main/java/com/slack/api/audit/response/SchemasResponse.java b/slack-api-client/src/main/java/com/slack/api/audit/response/SchemasResponse.java
@@ -11,10 +11,15 @@
 public class SchemasResponse implements AuditApiResponse {
     private transient String rawBody;
 
-    private boolean ok;
+    @Deprecated // when an error is returned, it will be an exception instead
+    private boolean ok = true;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String warning;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String error;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String needed;
+    @Deprecated // when an error is returned, it will be an exception instead
     private String provided;
 
     private List<Schema> schemas;
@@ -36,6 +41,7 @@ public static class Schema {
         private Barrier barrier;
         private Canvas canvas;
         private WorkflowV2 workflowV2;
+        private Template template;
     }
 
     @Data
@@ -148,4 +154,10 @@ public static class WorkflowV2 {
         private String stepConfiguration;
         private String templateId;
     }
+
+    @Data
+    public static class Template {
+        private String id;
+        private String templateName;
+    }
 }
diff --git a/slack-api-client/src/test/java/test_locally/api/util/json/GsonAuditLogsDetailsChangedValueFactoryTest.java b/slack-api-client/src/test/java/test_locally/api/util/json/GsonAuditLogsDetailsChangedValueFactoryTest.java
@@ -231,7 +231,7 @@ public void serialize_array() {
         List<LogsResponse.Entry> entries = Arrays.asList(entry);
         response.setEntries(entries);
         String json = gson.toJson(response);
-        assertThat(json, is("{\"ok\":false,\"entries\":[{\"details\":{" +
+        assertThat(json, is("{\"ok\":true,\"entries\":[{\"details\":{" +
                 "\"new_value\":[\"C111\",\"C222\"]," +
                 "\"previous_value\":[\"C111\",\"C222\"]" +
                 "}}]}"));
@@ -254,7 +254,7 @@ public void serialize_object() {
         List<LogsResponse.Entry> entries = Arrays.asList(entry);
         response.setEntries(entries);
         String json = gson.toJson(response);
-        assertThat(json, is("{\"ok\":false,\"entries\":[{\"details\":{" +
+        assertThat(json, is("{\"ok\":true,\"entries\":[{\"details\":{" +
                 "\"new_value\":{\"type\":[\"TOPLEVEL_ADMINS_AND_OWNERS_AND_SELECTED\"]}," +
                 "\"previous_value\":{\"type\":[\"TOPLEVEL_ADMINS_AND_OWNERS_AND_SELECTED\"]}" +
                 "}}]}"));
diff --git a/slack-api-client/src/test/java/test_with_remote_apis/audit/ApiTest.java b/slack-api-client/src/test/java/test_with_remote_apis/audit/ApiTest.java
@@ -281,6 +281,12 @@ public void getActions_detectingNewOnes() throws IOException, AuditApiException
                 fail("Unknown action detected - " + action);
             }
         }
+        List<String> templateNames = getAllPublicStaticFieldValues(Actions.Template.class);
+        for (String action : actions.getTemplate()) {
+            if (!templateNames.contains(action)) {
+                fail("Unknown action detected - " + action);
+            }
+        }
     }
 
     @Test
@@ -329,6 +335,7 @@ public void getLogs_paginated() throws IOException, AuditApiException {
             );
             assertThat(cursor, not(equalTo(response.getResponseMetadata().getNextCursor())));
             assertThat(response, is(notNullValue()));
+            assertThat(response.isOk(), is(true));
         }
     }
 
@@ -368,6 +375,7 @@ static void verifyAllActions(String token, Class<?> clazz) throws Exception {
             try {
                 LogsResponse response = slack.auditAsync(token).getLogs(req -> req.limit(500).action(action)).get();
                 assertThat(response.getError(), is(nullValue()));
+                assertThat(response.isOk(), is(true));
             } catch (ExecutionException e) {
                 if (e.getCause() != null && e.getCause() instanceof AuditApiCompletionException) {
                     AuditApiCompletionException apiEx = ((AuditApiCompletionException) e.getCause());

Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,13 @@`
`142`	`142`	`"template_id": "string",`
`143`	`143`	`"step_configuration": "vec\u003cdict\u003cstring, mixed\u003e\u003e"`
`144`	`144`	`}`
	`145`	`+ },`
	`146`	`+ {`
	`147`	`+ "type": "template",`
	`148`	`+ "template": {`
	`149`	`+ "id": "string",`
	`150`	`+ "template_name": "string"`
	`151`	`+ }`
`145`	`152`	`}`
`146`	`153`	`]`
`147`	`154`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "ok": false,`
	`2`	`+ "ok": true,`
`3`	`3`	`"warning": "",`
`4`	`4`	`"error": "",`
`5`	`5`	`"needed": "",`
Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,10 @@`
`84`	`84`	`"updated_by": "",`
`85`	`85`	`"step_configuration": "",`
`86`	`86`	`"template_id": ""`
	`87`	`+ },`
	`88`	`+ "template": {`
	`89`	`+ "id": "",`
	`90`	`+ "template_name": ""`
`87`	`91`	`}`
`88`	`92`	`}`
`89`	`93`	`],`