Initial commit

Author: WilliamBergamin

README.md

@@ -1,8 +1,20 @@
 # Bolt for Java Template App
 
-This is a generic Bolt for Java template app used to build out Slack apps.
+This is a Bolt for Java template app used to build custom steps for use in
+[Workflow Builder](https://api.slack.com/start#workflow-builder).
 
-Before getting started, make sure you have a development workspace where you have permissions to install apps. If you don’t have one setup, go ahead and [create one](https://slack.com/create).
+## Setup
+
+Before getting started, first make sure you have a development workspace where
+you have permission to install apps. **Please note that the features in this
+project require that the workspace be part of
+[a Slack paid plan](https://slack.com/pricing).**
+
+### Developer Program
+
+Join the [Slack Developer Program](https://api.slack.com/developer-program) for
+exclusive access to sandbox environments for building and testing your apps,
+tooling, and resources created to help developers build and grow.
 
 ## Installation
 
@@ -31,7 +43,7 @@ export SLACK_APP_TOKEN=<your-app-token>
 
 ```zsh
 # Clone this project onto your machine
-git clone https://github.com/slack-samples/bolt-java-starter-template.git
+git clone https://github.com/WilliamBergamin/bolt-java-custom-step-template.git
 
 # Change into this project directory
 cd bolt-java-template
@@ -78,6 +90,16 @@ gradle run
 
 **NOTE**: If you chose to use Gradle as your build tool you can remove the `pom.xml` file from this project.
 
+## Using Steps in Workflow Builder
+
+With your server running, the `Sample step` is now ready for use in
+[Workflow Builder](https://api.slack.com/start#workflow-builder)! Add it as a
+custom step in a new or existing workflow, then run the workflow while your app
+is running.
+
+For more information on creating workflows and adding custom steps, read more
+[here](https://slack.com/help/articles/17542172840595-Create-a-new-workflow-in-Slack).
+
 ## Project Structure
 
 ### `manifest.json`
@@ -90,7 +112,7 @@ gradle run
 
 ### `/listeners`
 
-Every incoming request is routed to a "listener". Inside this directory, we group each listener based on the Slack Platform feature used, so `/listeners/shortcuts` handles incoming [Shortcuts](https://api.slack.com/interactivity/shortcuts) requests, `/listeners/views` handles [View submissions](https://api.slack.com/reference/interaction-payloads/views#view_submission), and so on.
+Every incoming request is routed to a "listener". Inside this directory, we group each listener based on the Slack Platform feature used, so `/listeners/actions` handles incoming [Actions](https://docs.slack.dev/reference/interaction-payloads/block_actions-payload) requests and `/listeners/functions` handles [Workflow Steps](https://docs.slack.dev/workflows/workflow-steps).
 
 ### `/logback.xml`
 
@@ -99,29 +121,3 @@ Every incoming request is routed to a "listener". Inside this directory, we grou
 ### Tests
 
 This project provides some sample unit tests. They can be found in `src/test`. They are to be used as examples to show how unit tests can be implemented. **As you modify this project don't hesitate to modify, add, or remove these tests.**
-
-## App Distribution / OAuth
-
-Only implement OAuth if you plan to distribute your application across multiple workspaces. A separate `OAuthMain.java` file can be found with relevant OAuth settings.
-
-When using OAuth, Slack requires a public URL where it can send requests. In this template app, we've used [`ngrok`](https://ngrok.com/download). Checkout [this guide](https://ngrok.com/docs#getting-started-expose) for setting it up.
-
-Start `ngrok` to access the app on an external network and create a redirect URL for OAuth.
-
-```
-ngrok http 3000
-```
-
-This output should include a forwarding address for `http` and `https` (we'll use `https`). It should look something like the following:
-
-```
-Forwarding   https://3cb89939.ngrok.io -> http://localhost:3000
-```
-
-Navigate to **OAuth & Permissions** in your app configuration and click **Add a Redirect URL**. The redirect URL should be set to your `ngrok` forwarding address with the `slack/oauth/callback` path appended. For example:
-
-```
-https://3cb89939.ngrok.io/slack/oauth/callback
-```
-
-*NOTE:* if you do not require OAuth you can remove all `OAUTH DEPENDENCIES` in the `pom.xml` or `build.gradle` files, along with `src/main/java/OAuthMain.java`

manifest.json

@@ -1,54 +1,63 @@
 {
   "display_information": {
-    "name": "Bolt Template App"
+    "name": "Bolt Workflow Step"
   },
   "features": {
     "app_home": {
-      "home_tab_enabled": true,
-      "messages_tab_enabled": false,
+      "home_tab_enabled": false,
+      "messages_tab_enabled": true,
       "messages_tab_read_only_enabled": true
     },
     "bot_user": {
-      "display_name": "Bolt Template App",
-      "always_online": false
-    },
-    "shortcuts": [
-      {
-        "name": "Run sample shortcut",
-        "type": "global",
-        "callback_id": "sample-shortcut-id",
-        "description": "Runs a sample shortcut"
-      }
-    ],
-    "slash_commands": [
-      {
-        "command": "/sample-command",
-        "description": "Runs a sample command",
-        "should_escape": false
-      }
-    ]
+      "display_name": "Bolt Workflow Step",
+      "always_online": true
+    }
   },
   "oauth_config": {
     "scopes": {
       "bot": [
-        "channels:history",
-        "chat:write",
-        "commands"
+        "chat:write"
       ]
     }
   },
   "settings": {
     "event_subscriptions": {
       "bot_events": [
-        "app_home_opened",
-        "message.channels"
+        "function_executed"
       ]
     },
     "interactivity": {
       "is_enabled": true
     },
-    "org_deploy_enabled": false,
+    "org_deploy_enabled": true,
     "socket_mode_enabled": true,
-    "token_rotation_enabled": false
+    "token_rotation_enabled": false,
+    "hermes_app_type": "remote",
+    "function_runtime": "remote"
+  },
+  "functions": {
+    "sample-step": {
+      "title": "Sample step",
+      "description": "Runs sample step",
+      "input_parameters": {
+        "user_id": {
+          "type": "slack#/types/user_id",
+          "title": "User",
+          "description": "Message recipient",
+          "is_required": true,
+          "hint": "Select a user in the workspace",
+          "name": "user_id"
+        }
+      },
+      "output_parameters": {
+        "user_id": {
+          "type": "slack#/types/user_id",
+          "title": "User",
+          "description": "User that completed the step",
+          "is_required": true,
+          "name": "user_id"
+        }
+      }
+    }
   }
 }

src/main/java/OAuthMain.java

@@ -2,11 +2,7 @@
 
 import com.slack.api.bolt.App;
 import listeners.actions.ActionListeners;
-import listeners.commands.CommandListeners;
-import listeners.events.EventListeners;
-import listeners.messages.MessageListeners;
-import listeners.shortcuts.ShortcutListeners;
-import listeners.views.ViewListeners;
+import listeners.functions.FunctionListeners;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -22,13 +18,6 @@ public static void register(App app) {
     }
 
     private static ListenerProvider[] getAllListeners() {
-        return new ListenerProvider[] {
-            new ActionListeners(),
-            new CommandListeners(),
-            new EventListeners(),
-            new MessageListeners(),
-            new ShortcutListeners(),
-            new ViewListeners()
-        };
+        return new ListenerProvider[] {new ActionListeners(), new FunctionListeners()};
     }
 }

src/main/java/listeners/Listeners.java

@@ -7,6 +7,6 @@
 public class ActionListeners implements ListenerProvider {
     @Override
     public void register(App app) {
-        app.blockAction(Constants.ActionIds.CATEGORY, new SampleBlockActionListener(app));
+        app.blockAction(Constants.ActionIds.WORKFLOW_STEP_BUTTON, new CustomStepButtonActionListener(app));
     }
 }

src/main/java/listeners/actions/ActionListeners.java

@@ -0,0 +1,46 @@
+package listeners.actions;
+
+import com.slack.api.bolt.App;
+import com.slack.api.bolt.context.builtin.ActionContext;
+import com.slack.api.bolt.handler.builtin.BlockActionHandler;
+import com.slack.api.bolt.request.builtin.BlockActionRequest;
+import com.slack.api.bolt.response.Response;
+import com.slack.api.methods.SlackApiException;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+public class CustomStepButtonActionListener implements BlockActionHandler {
+    private final App app;
+
+    public CustomStepButtonActionListener(App app) {
+        this.app = app;
+    }
+
+    @Override
+    public Response apply(BlockActionRequest req, ActionContext ctx) throws IOException, SlackApiException {
+        this.app.executorService().submit(() -> {
+            Map<String, Object> outputs = new HashMap<>();
+            outputs.put(
+                    "user_id",
+                    req.getPayload()
+                            .getFunctionData()
+                            .getInputs()
+                            .get("user_id")
+                            .asString());
+            try {
+                ctx.client().functionsCompleteSuccess(r -> r.functionExecutionId(
+                                req.getPayload().getFunctionData().getExecutionId())
+                        .outputs(outputs));
+                ctx.client().chatUpdate(r -> r.channel(
+                                req.getPayload().getContainer().getChannelId())
+                        .ts(req.getPayload().getContainer().getMessageTs())
+                        .text("Thank you :heart_hands: for clicking a button!"));
+            } catch (Exception e) {
+                ctx.logger.error(
+                        "Failed to call functionsCompleteSuccess or views.update API (error: {})", e.getMessage(), e);
+            }
+        });
+        return ctx.ack();
+    }
+}