feat: add loading messages to assistant threads set status

Author: zimeg

bolt-socket-mode/src/test/java/samples/AssistantEventListenerApp.java

@@ -7,6 +7,7 @@
 import com.slack.api.model.event.*;
 
 import java.util.Collections;
+import java.util.List;
 
 public class AssistantEventListenerApp {
 
@@ -96,13 +97,14 @@ public static void main(String[] args) throws Exception {
                         ctx.client().assistantThreadsSetStatus(r -> r
                                 .channelId(channelId)
                                 .threadTs(threadTs)
-                                .status("is analyzing the files...")
+                                .status("is downloading the files...")
                         );
                         Thread.sleep(500L);
                         ctx.client().assistantThreadsSetStatus(r -> r
                                 .channelId(channelId)
                                 .threadTs(threadTs)
-                                .status("is still checking the files...")
+                                .status("is analyzing the files...")
+                                .loadingMessages(List.of("Reading bytes...", "Confirming hashes..."))
                         );
                         Thread.sleep(500L);
                         ctx.client().chatPostMessage(r -> r

bolt-socket-mode/src/test/java/samples/AssistantInteractionApp.java

@@ -35,7 +35,7 @@ public static void main(String[] args) throws Exception {
                 ctx.say(r -> r
                         .text("Hi, how can I help you today?")
                         .blocks(Arrays.asList(
-                                section(s -> s.text(plainText("Hi, how I can I help you today?"))),
+                                section(s -> s.text(plainText("Hi, how can I help you today?"))),
                                 actions(a -> a.elements(Collections.singletonList(
                                         button(b -> b.actionId("assistant-generate-numbers").text(plainText("Generate numbers")))
                                 )))
@@ -105,7 +105,7 @@ public static void main(String[] args) throws Exception {
         });
 
         app.event(AppMentionEvent.class, (req, ctx) -> {
-            ctx.say("You can help you at our 1:1 DM!");
+            ctx.say("I can help you at our 1:1 DM!");
             return ctx.ack();
         });
 

bolt-socket-mode/src/test/java/samples/AssistantSimpleApp.java

@@ -9,6 +9,7 @@
 import com.slack.api.model.event.MessageEvent;
 
 import java.util.Collections;
+import java.util.List;
 
 public class AssistantSimpleApp {
 
@@ -37,9 +38,9 @@ public static void main(String[] args) throws Exception {
                 // ctx.setStatus(r -> r.status("is typing...")); works too
                 ctx.setStatus("is typing...");
                 Thread.sleep(500L);
-                if (ctx.getThreadContext() != null) {
+                if (ctx.getThreadContext() != null && ctx.getThreadContext().getChannelId() != null) {
                     String contextChannel = ctx.getThreadContext().getChannelId();
-                    ctx.say("I am ware of the channel context: <#" + contextChannel + ">");
+                    ctx.say("I am aware of the channel context: <#" + contextChannel + ">");
                 } else {
                     ctx.say("Here you are!");
                 }
@@ -55,9 +56,9 @@ public static void main(String[] args) throws Exception {
 
         assistant.userMessageWithFiles((req, ctx) -> {
             try {
-                ctx.setStatus("is analyzing the files...");
+                ctx.setStatus("is downloading the files...");
                 Thread.sleep(500L);
-                ctx.setStatus("is still checking the files...");
+                ctx.setStatus("is analyzing the files...", List.of("Reading bytes...", "Confirming hashes..."));
                 Thread.sleep(500L);
                 ctx.say("Your files do not have any issues!");
             } catch (Exception e) {
@@ -77,7 +78,7 @@ public static void main(String[] args) throws Exception {
         });
 
         app.event(AppMentionEvent.class, (req, ctx) -> {
-            ctx.say("You can help you at our 1:1 DM!");
+            ctx.say("I can help you at our 1:1 DM!");
             return ctx.ack();
         });
 

bolt/src/main/java/com/slack/api/bolt/context/builtin/EventContext.java

@@ -116,6 +116,19 @@ public AssistantThreadsSetStatusResponse setStatus(String status) throws IOExcep
         }
     }
 
+    public AssistantThreadsSetStatusResponse setStatus(String status, List<String> loadingMessages) throws IOException, SlackApiException {
+        if (isAssistantThreadEvent()) {
+            return this.client().assistantThreadsSetStatus(r -> r
+                    .channelId(this.getChannelId())
+                    .threadTs(this.getThreadTs())
+                    .status(status)
+                    .loadingMessages(loadingMessages)
+            );
+        } else {
+            throw new IllegalStateException("This utility is only available for Assistant feature enabled app!");
+        }
+    }
+
     public AssistantThreadsSetStatusResponse setStatus(RequestConfigurator<AssistantThreadsSetStatusRequest.AssistantThreadsSetStatusRequestBuilder> req) throws IOException, SlackApiException {
         if (isAssistantThreadEvent()) {
             return this.client().assistantThreadsSetStatus(req.configure(AssistantThreadsSetStatusRequest.builder()

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

@@ -56,6 +56,10 @@ public void test() throws Exception {
                 ctx.setTitle("title");
                 ctx.setTitle(r -> r.title("title"));
                 ctx.setStatus("is typing...");
+                ctx.setStatus(
+                    "is typing...",
+                    List.of("Teaching hamsters...", "Untangling cables...")
+                );
                 ctx.setStatus(r -> r.status("is typing..."));
                 ctx.setSuggestedPrompts(new ArrayList<>());
                 ctx.setSuggestedPrompts(r -> r.prompts(new ArrayList<>()));

slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java

@@ -1133,6 +1133,9 @@ public static FormBody.Builder toForm(AssistantThreadsSetStatusRequest req) {
         setIfNotNull("channel_id", req.getChannelId(), form);
         setIfNotNull("thread_ts", req.getThreadTs(), form);
         setIfNotNull("status", req.getStatus(), form);
+        if (req.getLoadingMessages() != null) {
+            setIfNotNull("loading_messages", req.getLoadingMessages().stream().collect(joining(",")), form);
+        }
         return form;
     }
 

slack-api-client/src/main/java/com/slack/api/methods/request/assistant/threads/AssistantThreadsSetStatusRequest.java

@@ -4,6 +4,8 @@
 import lombok.Builder;
 import lombok.Data;
 
+import java.util.List;
+
 /**
  * https://docs.slack.dev/reference/methods/assistant.threads.setStatus
  */
@@ -27,4 +29,9 @@ public class AssistantThreadsSetStatusRequest implements SlackApiRequest {
      * Status of the specified bot user, e.g. 'is thinking...'
      */
     private String status;
-}
+
+    /**
+     * The list of messages to rotate through as a loading indicator.
+     */
+    private List<String> loadingMessages;
+}