Convert Slack Communication from RTM to WebSocket

[huseyinbabal]

Description

Changes proposed in this pull request:

• Enabled socket mode and deprecated RTM
• Slack App-Level Token is injected into botkube docker image
• Added makefile entry for generating tester image for Apple M1

Related issue(s)

Fixes #631

Testing

Note: Since socketmode should be enabled on the slack app, I created new app (BotKubeV2) in CI Workspace, you can see it here. Please refer app page to get bot token and app token. bot token is already visible as you are familiar with current notation. For app level token, scroll down on app overview page and generate token as shown below.

The integration tests fails as it uses outdated settings from main. I tested that locally:

1. Environment setup

export SLACK_TESTER_APP_TOKEN="xoxb-..."
export SLACK_BOT_TOKEN="xoxb-..."
export SLACK_APP_TOKEN="xapp-..."
export IMAGE_REPOSITORY="kubeshop/pr/botkube"
export IMAGE_TAG="693-PR"
export TEST_IMAGE_REPOSITORY="kubeshop/pr/botkube-test"
export PR_NUMBER=693

export SLACK_TESTER_APP_TOKEN="xoxb-..." # Notice that this is the token for tester app
export SLACK_BOT_TOKEN="xoxb-..."
export SLACK_APP_TOKEN="xapp-1..."

# The image generated on PR build cannot be used since ldflags update also is in workflow files, so during pr build, slack app level token is not injected into docker image. I built my images locally, once you build yours, please update following env params according to your values, or you can use mine as follows.

export IMAGE_REPOSITORY="huseyinbabal/botkube"
export IMAGE_TAG="v9.99.26-dev"
export IMAGE_REGISTRY="docker.io"

# Tester image is not working on apple m1, I added a make file command for that `make container-image-test-single`. You can build your tester image or use mine as follows.
export TEST_IMAGE_REPOSITORY="huseyinbabal/botkube-test"
export TEST_IMAGE_TAG="v9.99.9-dev"
export TEST_IMAGE_REGISTRY="docker.io"
export PR_NUMBER=693

2. Install Botkube

helm install botkube --namespace botkube ./helm/botkube --wait --create-namespace \
    -f ./helm/botkube/e2e-test-values.yaml \
    --set settings.log.level="debug" \
	--set communications.default-group.slack.token="${SLACK_BOT_TOKEN}" \
    --set image.registry="${IMAGE_REGISTRY}" \
    --set image.repository="${IMAGE_REPOSITORY}" \
    --set image.tag="${IMAGE_TAG}" \
    --set e2eTest.image.registry="${TEST_IMAGE_REGISTRY}" \
    --set e2eTest.image.repository="${TEST_IMAGE_REPOSITORY}" \
    --set e2eTest.image.tag="${TEST_IMAGE_TAG}" \
    --set e2eTest.slack.testerAppToken="${SLACK_TESTER_APP_TOKEN}" \
	--set e2eTest.slack.botName="botkubev2" \
    --set e2eTest.slack.additionalContextMessage="Pull request: ${PR_NUMBER} - https://github.com/kubeshop/botkube/pull/${PR_NUMBER}"

3. Test

helm test botkube --namespace botkube --timeout=10m  --logs

4. Check Logs

kubectl logs -n botkube botkube-e2e-test -f

You can verify test results in our official CI workspace here

[huseyinbabal]

Will rebase and resolve conflicts after I got approvals

[ezodude]

Left a couple of comments, but they're not blockers.

The comment regarding websockets was a left as a pure "how does this work now" question.

Thx

[ezodude]

Curious, why did you think we should extract the dumper into its own file?

It's only used in the context of E2E tests and occupied 7 lines.

[huseyinbabal]

Actually, I have used it in also debug logs in slack response messages. builtin formatters are not good on printing nested fields all the time.

[ezodude]

Had a quick look around to understand how disconnects work in the context of websockets.

For my understanding only ... to confirm:
1 - disconnects are not predictable but they are handled by the Slack library.
2 - When we terminate BotKube we're assuming the server will terminate the connection?

[huseyinbabal]

Really good catch, please see my updated impl. I have used RunContext(ctx) instead of Run(), so that once ctx is done, it will also close connection on websocket.

[ezodude]

Easy to miss. I was trying to make sense of it myself having never used the library.

[ezodude]

In terms of code review, LGTM.

I'll need to manually test, prob after 0.13.0 release.

[mszostok]

I just want to let you know that I tested that as a part of #715 with own Socket Bot and it worked well 👍

I left really minor comments and I leave approving this PR for the first reviewer because I didn't run the e2e test.

[ezodude]

👍 Confirmed that Helm E2E tests ran successfully.