Fix #968 Message metadata support (#980)

Author: seratch

bolt-servlet/src/test/java/samples/MessageMetadataSample.java

@@ -0,0 +1,93 @@
+package samples;
+
+import com.slack.api.bolt.App;
+import com.slack.api.bolt.AppConfig;
+import com.slack.api.methods.MethodsClient;
+import com.slack.api.methods.response.chat.ChatPostMessageResponse;
+import com.slack.api.model.Message;
+import com.slack.api.model.event.*;
+import lombok.extern.slf4j.Slf4j;
+import util.ResourceLoader;
+import util.TestSlackAppServer;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@Slf4j
+public class MessageMetadataSample {
+    /*
+settings:
+  event_subscriptions:
+    request_url: https://{your domain}/slack/events
+    bot_events:
+      - message_metadata_deleted
+      - message_metadata_posted
+      - message_metadata_updated
+    metadata_subscriptions:
+      - app_id: "*"
+        event_type: java-sdk-test-example
+     */
+
+    public static void main(String[] args) throws Exception {
+        AppConfig config = ResourceLoader.loadAppConfig();
+        App app = new App(config);
+
+        app.event(MessageMetadataPostedEvent.class, (event, ctx) -> {
+            ctx.logger.info("MessageMetadataPostedEvent - {}", event);
+            return ctx.ack();
+        });
+        app.event(MessageMetadataUpdatedEvent.class, (event, ctx) -> {
+            ctx.logger.info("MessageMetadataUpdatedEvent - {}", event);
+            return ctx.ack();
+        });
+        app.event(MessageMetadataDeletedEvent.class, (event, ctx) -> {
+            ctx.logger.info("MessageMetadataDeletedEvent - {}", event);
+            return ctx.ack();
+        });
+
+        app.event(AppHomeOpenedEvent.class, (event, ctx) -> ctx.ack());
+        app.event(AppMentionEvent.class, (event, ctx) -> ctx.ack());
+        app.event(MessageEvent.class, (event, ctx) -> ctx.ack());
+        app.event(MessageChangedEvent.class, (event, ctx) -> ctx.ack());
+        app.event(MessageDeletedEvent.class, (event, ctx) -> ctx.ack());
+
+        app.executorService().submit(() -> {
+            Map<String, Object> metadataPayload = new HashMap<>();
+            metadataPayload.put("state", "initial");
+            try {
+                Thread.sleep(5000L);
+                MethodsClient client = app.client();
+                ChatPostMessageResponse newMessage = client.chatPostMessage(r -> r
+                        .channel("#random")
+                        .text("message with metadata")
+                        .metadata(Message.Metadata.builder()
+                                .eventType("java-sdk-test-example")
+                                .eventPayload(metadataPayload)
+                                .build())
+                );
+
+                Thread.sleep(3000L);
+                metadataPayload.put("state", "modified");
+                client.chatUpdate(r -> r
+                        .channel(newMessage.getChannel())
+                        .ts(newMessage.getTs())
+                        .text("message with metadata (modified)")
+                        .metadata(Message.Metadata.builder()
+                                .eventType("java-sdk-test-example")
+                                .eventPayload(metadataPayload)
+                                .build())
+                );
+
+                Thread.sleep(3000L);
+                client.chatDelete(r -> r.channel(newMessage.getChannel()).ts(newMessage.getTs()));
+
+            } catch (Exception e) {
+                log.error("Failed", e);
+            }
+        });
+
+        TestSlackAppServer server = new TestSlackAppServer(app);
+        server.start();
+    }
+
+}

json-logs/samples/api/chat.postMessage.json

@@ -65,18 +65,12 @@
           "type": "",
           "image_url": "https://www.example.com/",
           "alt_text": "",
-          "action_id": "",
-          "initial_time": "",
-          "placeholder": {
-            "type": "",
-            "text": "",
-            "emoji": false
-          },
           "text": {
             "type": "",
             "text": "",
             "emoji": false
           },
+          "action_id": "",
           "url": "",
           "value": "",
           "style": "",
@@ -151,6 +145,11 @@
             },
             "url": ""
           },
+          "placeholder": {
+            "type": "",
+            "text": "",
+            "emoji": false
+          },
           "initial_channel": "",
           "response_url_enabled": false,
           "initial_channels": [
@@ -170,6 +169,7 @@
             ""
           ],
           "initial_date": "",
+          "initial_time": "",
           "min_query_length": 12345,
           "fallback": "",
           "image_width": 12345,
@@ -215,8 +215,8 @@
               "emoji": false
             },
             "value": "",
-            "verbatim": false,
             "emoji": false,
+            "verbatim": false,
             "url": "",
             "style": "",
             "confirm": {
@@ -528,10 +528,10 @@
             "date_start": 12345,
             "active_participants": [
               {
-                "slack_id": "U00000000",
                 "external_id": "",
                 "avatar_url": "https://www.example.com/",
-                "display_name": ""
+                "display_name": "",
+                "slack_id": "U00000000"
               },
               {
                 "slack_id": "",
@@ -542,10 +542,10 @@
             ],
             "all_participants": [
               {
-                "slack_id": "U00000000",
                 "external_id": "",
                 "avatar_url": "https://www.example.com/",
-                "display_name": ""
+                "display_name": "",
+                "slack_id": "U00000000"
               },
               {
                 "slack_id": "",
@@ -9259,18 +9259,22 @@
           "thumb_64": false,
           "thumb_80": false,
           "thumb_160": false,
-          "original_w": 12345,
-          "original_h": 12345,
-          "thumb_360_w": 12345,
-          "thumb_360_h": 12345,
+          "original_w": 123,
+          "original_h": 123,
+          "thumb_360_w": 123,
+          "thumb_360_h": 123,
           "format": "",
           "extension": "",
-          "rotation": 12345,
+          "rotation": 123,
           "thumb_tiny": ""
         }
       }
     ],
-    "app_id": "A00000000"
+    "app_id": "A00000000",
+    "metadata": {
+      "event_payload": {},
+      "event_type": ""
+    }
   },
   "error": "",
   "deprecated_argument": "",