Resolve #1279 by adjusting the bolt internal logic (#1281)

Author: seratch

bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java

@@ -7,6 +7,7 @@
 import com.slack.api.bolt.request.Request;
 import com.slack.api.bolt.request.RequestHeaders;
 import com.slack.api.bolt.request.RequestType;
+import com.slack.api.model.event.MessageEvent;
 import com.slack.api.util.json.GsonFactory;
 import lombok.ToString;
 
@@ -133,7 +134,11 @@ public String getEventType() {
     }
 
     public String getEventTypeAndSubtype() {
-        if (eventSubtype == null) {
+        // Since the data structure of the "message" type event significantly varies among subtypes,
+        // This key string needs to consider the subtype for the event.
+        // Other events with subtypes (e.g., "app_mention") do not have such differences,
+        // so we can reuse the same data classes for them.
+        if (!eventType.equals(MessageEvent.TYPE_NAME) || eventSubtype == null) {
             return eventType;
         } else {
             return eventType + ":" + eventSubtype;

bolt/src/test/java/test_locally/app/EventTest.java

@@ -74,6 +74,28 @@ public void appMention() throws Exception {
         assertTrue(userMessageReceived.get());
     }
 
+    String appMentionPayload2 = "{\"token\":\"legacy-fixed-value\",\"team_id\":\"T123\",\"api_app_id\":\"A123\",\"event\":{\"client_msg_id\":\"3fd13273-5a6a-4b5c-bd6f-109fd697038c\",\"type\":\"app_mention\",\"subtype\": \"bot_message\",\"text\":\"<@U123> test\",\"bot_id\":\"B123\",\"ts\":\"1583636399.000700\",\"team\":\"T123\",\"blocks\":[{\"type\":\"rich_text\",\"block_id\":\"FMAzp\",\"elements\":[{\"type\":\"rich_text_section\",\"elements\":[{\"type\":\"user\",\"user_id\":\"U123\"},{\"type\":\"text\",\"text\":\" test\"}]}]}],\"channel\":\"C123\",\"event_ts\":\"1583636399.000700\"},\"type\":\"event_callback\",\"event_id\":\"EvV1KV8BM3\",\"event_time\":1583636399,\"authed_users\":[\"U123\"]}";
+
+    @Test
+    public void appMention2() throws Exception {
+        App app = buildApp();
+        AtomicBoolean userMessageReceived = new AtomicBoolean(false);
+        app.event(AppMentionEvent.class, (req, ctx) -> {
+            userMessageReceived.set(req.getEvent().getBotId().equals("B123"));
+            return ctx.ack();
+        });
+
+        Map<String, List<String>> rawHeaders = new HashMap<>();
+        String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
+        setRequestHeaders(appMentionPayload2, rawHeaders, timestamp);
+
+        EventRequest req = new EventRequest(appMentionPayload2, new RequestHeaders(rawHeaders));
+        Response response = app.run(req);
+        assertEquals(200L, response.getStatusCode().longValue());
+
+        assertTrue(userMessageReceived.get());
+    }
+
     String messagePayload = "{\"token\":\"legacy-fixed-value\",\"team_id\":\"T123\",\"api_app_id\":\"A123\",\"event\":{\"client_msg_id\":\"3fd13273-5a6a-4b5c-bd6f-109fd697038c\",\"type\":\"message\",\"text\":\"<@U123> test\",\"user\":\"U234\",\"ts\":\"1583636399.000700\",\"team\":\"T123\",\"blocks\":[{\"type\":\"rich_text\",\"block_id\":\"FMAzp\",\"elements\":[{\"type\":\"rich_text_section\",\"elements\":[{\"type\":\"user\",\"user_id\":\"U123\"},{\"type\":\"text\",\"text\":\" test\"}]}]}],\"channel\":\"C123\",\"event_ts\":\"1583636399.000700\",\"channel_type\":\"channel\"},\"type\":\"event_callback\",\"event_id\":\"EvV1KA7U3A\",\"event_time\":1583636399,\"authed_users\":[\"U123\"]}";
 
     @Test
@@ -425,4 +447,5 @@ public void retryHeaders() throws Exception {
         assertTrue(numReceived.get());
         assertTrue(reasonReceived.get());
     }
+
 }

json-logs/samples/events/AppMentionPayload.json

@@ -28,6 +28,7 @@
     "client_msg_id": "",
     "user": "",
     "username": "",
+    "app_id": "",
     "bot_id": "",
     "bot_profile": {
       "id": "",

slack-api-model/src/main/java/com/slack/api/model/event/AppMentionEvent.java

@@ -34,6 +34,7 @@ public class AppMentionEvent implements Event {
     private String clientMsgId;
     private String user;
     private String username;
+    private String appId;
     private String botId;
     private BotProfile botProfile;
     private String subtype;

slack-api-model/src/test/java/test_locally/api/model/event/AppMentionEventTest.java

@@ -6,6 +6,7 @@
 import test_locally.unit.GsonFactory;
 
 import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.nullValue;
 import static org.hamcrest.MatcherAssert.assertThat;
 
 public class AppMentionEventTest {
@@ -98,4 +99,43 @@ public void serialize() {
         assertThat(generatedJson, is(expectedJson));
     }
 
+    @Test
+    public void botMessage() {
+        String json = "{\n" +
+                "  \"type\": \"app_mention\",\n" +
+                "  \"subtype\": \"bot_message\",\n" +
+                "  \"text\": \"<@U111> hey\",\n" +
+                "  \"ts\": \"1707288078.718469\",\n" +
+                "  \"username\": \"Hey bot\",\n" +
+                "  \"bot_id\": \"B111\",\n" +
+                "  \"app_id\": \"A111\",\n" +
+                "  \"blocks\": [\n" +
+                "    {\n" +
+                "      \"type\": \"rich_text\",\n" +
+                "      \"block_id\": \"9fyvt\",\n" +
+                "      \"elements\": [\n" +
+                "        {\n" +
+                "          \"type\": \"rich_text_section\",\n" +
+                "          \"elements\": [\n" +
+                "            {\n" +
+                "              \"type\": \"user\",\n" +
+                "              \"user_id\": \"U111\"\n" +
+                "            },\n" +
+                "            {\n" +
+                "              \"type\": \"text\",\n" +
+                "              \"text\": \" hey\"\n" +
+                "            }\n" +
+                "          ]\n" +
+                "        }\n" +
+                "      ]\n" +
+                "    }\n" +
+                "  ],\n" +
+                "  \"channel\": \"C111\",\n" +
+                "  \"event_ts\": \"1707288078.718469\"\n" +
+                "}";
+        AppMentionEvent event = GsonFactory.createSnakeCase().fromJson(json, AppMentionEvent.class);
+        assertThat(event.getType(), is("app_mention"));
+        assertThat(event.getUser(), is(nullValue()));
+    }
+
 }