xplorers-bot-go

README

Xplorers Bot

Slack bot written in Golang to make Xplorers Slack community fun and interactive :)

Xplorers Chatbot

OpenAI's ChatGpt provides an API which takes a prompt and returns a response accordingly. This feature has been integrated with Slack using slash commands which invokes an API Gateway. The API Gateway invokes a lambda function asynchronously responding to slack immediately with a 200 status to avoid Slack's 3 seconds timeout. The lambda function then queries ChatGpt's API with the user prompt and responds to the user in slack channel by making a POST request with Slack provided response_url.

Architecture Diagrams

Xplorers Bot

Xplorers ChatBot

Workflow Diagram

AWS Resources

An Amazon free tier account is required to deploy the infrastructure which includes,

• Serverless API - Receives slack request and triggers lambda with the payload.
• Go Lambda - Processes event sent from the API Gateway and responds to slack appropriately.
• Cloudwatch log group - Stores lambda invocation logs.
• IAM Role - IAM Role with policies necessary for lambda.
• Lambda resource policy - Allow API Gateway to invoke lambda.

Features

There are a million ways to use a slack bot make Slack fun. Current features of XplorersBot are,

• Welcome a new slack user - When a user joins a slack channel, XplorersBot crafts a welcome message and posts in the channel to welcome the user.
• React to slack posts with emojis - With every slack post, XplorersBot checks the text for any keyword matches and reacts to the post with appropriate emoji's. For example, for text This is a kubernetes environment, XplorersBot will react to the post with kubernetes emoji.
• /chatbot slash command - Interact with OpenApi's ChatGpt by typing /chatbot <prompt> where prompt can be anything from a question to code that we want ChatGpt to refactor.

As every slack organisation can have custom emojis added, the function GetKeyWordsMap in internal/xplorersbot/slack_emoji.go will need to be adjusted accordingly to fit your slack emoji set.

PreRequisites

Install the following dependencies,

• Go
• AWS CLI
• Make

Install Go Dependencies

Install go dependencies from go.mod,

go mod tidy

Unit tests

Run go unit tests and generate a coverage report,

make test

Populate SSM Parameters

The following SSM Parameters defined in settings/defaults.conf are required by XplorersBot,

• ARTIFACTS_BUCKET_SSM_PATH (/xplorers/artifacts/bucket/name) - Bucket to store artifacts
• SLACK_OAUTH_TOKEN_SSM_PATH [Defined in Makefile to create parameter based on git branch] (/xplorers/slack/bot/${GIT_BRANCH}/oauth/token) - Token used to interact with Slack.
• SENTRY_DSN_SSM_PATH (/xplorers/slack/bot/sentry/dsn) - Initialize Sentry with DSN
• CHATGPT_API_KEY_SSM_PATH (/xplorers/chatgpt/api/key) - Api key for interacting with OpenApi's ChatGpt
• XPLORERS_CHATBOT_SLACK_CHANNEL_ID_SSM_PATH (/xplorers/chatbot/slack/channel/id) - Slack channel ID where chatbot user is enabled

Populate the above in your AWS Account before deploying XplorersBot.

Deploy XplorersBot to AWS

Build go binary and deploy to AWS,

make deploy-xplorers-bot

The output section of cloudformation stack deployed contains the API Gateway endpoint required to setup Slack in the next step.

Slack setup

A Slack app event subscription with a bot user is required for Slack to send events to the API gateway endpoint.

After deploying the application to AWS, refer to the documentation on Slack Event Subscriptions to configure a slack app with an event subscription. Use XplorersBotServerlessApiUrl from cloudformation stack output to setup the event subscription url.

For chatbot functionality, setup a slash command /chatbot following slack's guide on slash commands. Use XplorersChatBotServerlessApiUrl from cloudformation stack output to setup the slash command.

The following scopes are required for bot user to interact with Slack,

• app_mentions:read - View messages that directly mention the bot user
• chat:write - Send messages as bot user
• reactions:read - View emoji reactions and their associated content in channels and conversations that bot user has been added to
• reactions:write - Add and edit emoji reactions
• channels:read - View basic information about public channels in a workspace
• channels:history - View messages and other content in public channels that bot user has been added to
• im:history - View messages and other content in direct messages that bot user has been added to
• commands - Add shortcuts and/or slash commands that people can use

CI/CD with Github Actions

Xplorersbot uses Github Actions for its CI/CD pipeline. With every push from every branch, unit tests will run and the workflow is defined in .github/workflows/run-tests.yml.

With every pull request merge to main branch, actions will automatically update the production environment by deploying to AWS (workflow .github/workflows/deploy-to-aws.yml)

Release tags

With the help of github actions and release drafter tool, a new release tag is created on every merge to main.