gcp-ts-slackbot

Slackbot for Posting Slack Mention Notifications

A simple Slackbot (called '@mentionbot') that sends a message to specific channel to notifiy you any time you're @mentioned anywhere. Very helpful if you want a time-ordered list of @mentions to go through at a later point.

Slack users can subscribe/unsubscribe from notifications easily. Simply add @mentionbot to a channel you want to be notified in. Then send any message to @mentionbot to subscribe. To stop getting messages send a message to @mentionbot containing the word unsubscribe.

The example contains a few useful patterns that show how to build a good Slackbot while taking advantage of a lot of conveniences that Pulumi and the gcp package provide.

1. we set up an HttpCallbackFunction to receive push notifications from Slack whenever important events happen.
2. Slack has strict requirements on how quickly the push endpoint must respond with 200 notifications before they consider the message not-received, triggering back-off and resending of those same messages. Because of this, this example does not process Slack event messages as they come in. Instead, they are immediately added to an GCP PubSub Topic to be processed at a later point in time. This allows the ApiGateway call to return quickly, satisfying Slack's requirements.
3. Two GCP Cloud Functions are created naturally and simply using simple JavaScript functions. One javascript function is used to create the CloudFunction that is called when Slack pushes notifications. The other is used to specify the CloudFunction that will process the messages added to the Topic. These JavaScript functions can easily access the other Pulumi resources created, avoiding the need to figure out ways to pass Resource info to the CloudFunctions to ensure they can talk to the right resources. If these resources were swapped out in the future (for example, using BigTable instead of Firestore, or CloudTasks instead of PubSub), Pulumi would ensure the CloudFunctions were updated properly.
4. Pulumi Secrets provides a simple way to pass important credentials (like your Slack tokens) without having to directly embed them in your application code.

First, we'll setup the Pulumi App. Then, we'll go create and configure a Slack App and Bot to interact with our Pulumi App.

Deploying and running the Pulumi App

Note: some values in this example will be different from run to run. These values are indicated with ***.

1. Create a new stack:

   $ pulumi stack init mentionbot

2. Set the GCP region and project:

   $ pulumi config set gcp:region us-central1
   $ pulumi config set gcp:project <your project>
   

3. Restore NPM modules via npm install or yarn install.

4. Run pulumi up to preview and deploy changes:

   $ pulumi up
   Previewing update (mentionbot):
   ...
   
   Do you want to perform this update? yes
   Updating (mentionbot):
   
       Type                                        Name                       Status
   +   pulumi:pulumi:Stack                         gcp-ts-slack-mentionbot    created
   +   ├─ gcp:cloudfunctions:CallbackFunction      mentionbot                 created
   +-  │  ├─ gcp:storage:BucketObject              mentionbot                 created
   +   │  └─ gcp:cloudfunctions:Function           mentionbot                 created
   +   └─ gcp:pubsub:Topic                         messages                   created
   +       └─ gcp:cloudfunctions:CallbackFunction  processTopicMessage        created
   +          ├─ gcp:storage:BucketObject          processTopicMessage        created
   +          └─ gcp:cloudfunctions:Function       processTopicMessage        created
   
   Outputs:
       url: "https://us-central1-***.cloudfunctions.net/mentionbot-***"
   
   Resources:
       + 8 created
   
   Duration: 25s
   
   Permalink: https://app.pulumi.com/***/mentionbot/updates/1
   

Creating a new Slackbot

To create a new Slackbot, first go to https://api.slack.com/apps and create an account if necessary. Next, click on 'Create New App' here:

Pick your desired name for the app, and the Workspace the app belongs to. Here we choose MentionBot:

Once created, you will need to 'Add features and functionality' to your app. You'll eventually need all these configured:

First, we'll enable 'Incoming Webhooks'. This allows your Slack bot to post messages into Slack for you:

Next, create a bot user like so:

Next, we'll enable 'Event Subscriptions'. This will tell Slack to push events to your ApiGateway endpoint when changes happen. Note that we put the Stack-Output url shown above (along with the events suffix). This corresponds to the specific ApiGateway Route that was defined in the Pulumi app. Note that Slack will test this endpoint to ensure it is accepting Slack notifications and responding to them in a valid manner. We'll also setup notifications for the events we care about. Importantly, our bot will have to hear about when people mention it (for subscribing/unsubscribing), as well as hearing about all messages (so it can look for @-mentions):

Next, we'll go to 'Permissions'. Here, we can find the oauth tokens your Pulumi App will need. Specifically, we'll need the 'Bot User Oauth Token' listed here:

Underneath this, we'll set the following Scopes defining the permissions of the bot:

Now, we're almost done. The only thing left to do is supply your Pulumi App with the appropriate secrets/tokens. We'll need the Bot Oauth token (shown above), and the 'Verification Token' (found under 'Basic Information'):

Supply these both like so:

```
$ pulumi config set --secret mentionbot:slackToken xoxb-...
$ pulumi config set --secret mentionbot:verificationToken d...
```

Next, install the Slack App into your workspace:

And we're done!

Interacting with the Slack Bot

From Slack you can now create your own private channel:

Invite the bot to the channel:

Then send it a message. Note, it may take several seconds for the bot to respond due to Slack push notification delays, SNS Topic delays, and Slack incoming message delays.

And you're set! From now on when someone mentions you, you'll get a little message in your channel like so:

Clean up

1. Run pulumi destroy to tear down all resources.

2. To delete the stack itself, run pulumi stack rm. Note that this command deletes all deployment history from the Pulumi console.