슬랙 챗봇(slack chatbot) 만들기

3 분 소요

0. 들어가면서

토이 프로젝트로 간단한 애플리케이션을 만들고 싶었다. 백엔드(backend) 관련된 기술만 다룰 줄 아는 탓에 간단한 애플리케이션 기능을 만들어 보는 것도 쉽지 않다. 그러던 중 일일커밋 알림봇 개발기에 대한 글을 보게 되었다. 해당 글이나 대부분의 레퍼런스들이 파이썬(python)으로 개발되어 있기 때문에 이를 자바(Java)로 만들어보았다.

1. Prepare slack bot

우선 슬랙 봇(bot)이 하나 필요하다. 슬랙 API 요청을 수행할 땐 토큰(token) 정보가 필요하다. 자세한 설명은 이 링크를 참조하길 바란다.

2. Test slack API

슬랙 봇이 등록되었다면 간단한 API 요청 기능을 테스트한다. RestTemplate 클래스를 사용하여 API 요청을 수행한다. 요청 자체는 매우 단순하기 때문에 해당 기능을 구현하면서 만난 문제들에 대해 정리했다. Slack API 관련된 문서를 살펴보면 다음과 같은 내용이 있다.

헤더 인가(Authorization) 항목에 Bearer를 추가하고, 토큰을 함께 전달한다.
WRITE 기능을 수행하는 메서드에 application/json 타입을 사용한다.
토큰을 쿼리 파라미터로 바디(body)에 담아 던지고 싶으면 application/x-www-form-urlencoded을 사용한다.

위 내용을 바탕으로 채널에 글 작성을 위한 API 요청 코드를 아래와 같이 작성한다.

    @SuppressWarnings({ "unchecked", "rawtypes" })
    @Test
    void postSomeMessage() {

        HttpHeaders headers = new HttpHeaders();
        headers.set("Content-Type", "application/json");
        headers.set("Authorization", "Bearer " + slackToken);

        HttpEntity<Map<String, Object>> entity = new HttpEntity<Map<String, Object>>(headers);

        RestTemplate restTemplate = new RestTemplate();

        Map<String, Object> response = restTemplate.exchange("https://slack.com/api/conversations.history?channel=C01TD73AZEF", HttpMethod.GET, entity, Map.class).getBody();
        List<Map<String, Object>> messages = (List) response.get("messages");
        if (messages == null || messages.isEmpty()) {
            return;
        }

        Map<String, Object> body = new HashMap<>();
        body.put("text", "Hello slack-chatbot");
        body.put("reply_broadcast", true);
        // body.put("thread_ts", messages.get(0).get("ts"));
        body.put("channel", "C01TD73AZEF");

        headers = new HttpHeaders();
        headers.set("Content-Type", "application/json");
        headers.set("Authorization", "Bearer " + slackToken);

        entity = new HttpEntity<Map<String, Object>>(body, headers);

        log.info("result: " + restTemplate.exchange("https://slack.com/api/chat.postMessage", HttpMethod.POST, entity, Map.class).getBody());
    }

위 코드를 실행하면 다음과 같이 채널에 메시지가 전달되는 것을 확인할 수 있다.

3. Test GitHub API

슬랙에 필요한 API 요청은 모두 확인했다. 이번엔 깃허브(github) API 요청을 테스트해보자. 자바를 사용한 애플리케이션은 주로 github-api 라이브러리를 사용하는 것으로 보인다. 찾아보니 해당 라이브러리에서 필요한 기능을 따로 제공하지 않는 것으로 보여 직접 구현하기로 결정했다.

다음과 같은 기능이 필요했다.

특정 사용자의 저장소(repository) 정보들과 해당 저장소에 오늘 푸시(push)한 이력을 확인한다.

API 문서를 찾아보니 원하는 기능을 제공하는 엔드포인트(endpoint)가 있었다. 해당 API를 사용하기로 결정했다.

/users/{username}/repos 경로를 GET 요청
다음과 같은 파라미터가 필요하다.
- accept
- username
- type
- sort
- direction
- per_page

아래와 같이 코드를 작성한다.

API 요청을 통해 다음과 같은 데이터를 추출한다.
저장소 이름과 푸시 시간을 확인한다.

    @SuppressWarnings({ "unchecked" })
    @Test
    void test() throws IOException {

        HttpHeaders headers = new HttpHeaders();
        headers.set("Content-Type", "application/json");

        HttpEntity<Map<String, Object>> entity = new HttpEntity<Map<String, Object>>(headers);

        RestTemplate restTemplate = new RestTemplate();
        List<Map<String, Object>> repoList = restTemplate.exchange("https://api.github.com/users/junhyunny/repos", HttpMethod.GET, entity, List.class).getBody();
        for (Map<String, Object> repo : repoList) {
            log.info("repo url: " + repo.get("name"));
            log.info("pushed_at: " + repo.get("pushed_at"));
            String time = (String) repo.get("pushed_at");
            time = time.replace("T", " ");
            time = time.replace("Z", "");
            log.info(Timestamp.valueOf(time));
        }
    }

4. AWS Lambda

AWS(Amazon Web Service)는 많이 사용해보지 않아서 어려웠다. 이번에 사용한 AWS 람다(lambda)는 특정 시간마다 트리거를 통해 필요한 로직이 수행된다. 자바 애플리케이션을 람다에서 실행하려면 다음과 같은 과정을 거쳐야 한다.

RequestStreamHandler 인터페이스를 구현한 코드를 살펴보자. 전체 코드는 이 레포지토리에서 확인할 수 있다.

미리 AWS 람다에 등록한 토큰이나 사용자 정보를 추출한다.
추출한 정보에 해당하는 깃허브 레포지토리 정보를 가져온다.
커밋 이력이 없다면 슬랙으로 메시지를 전송한다.

package io.junhyunny.chatbot;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

import io.junhyunny.chatbot.github.Github;
import io.junhyunny.chatbot.slack.Slack;
import lombok.extern.log4j.Log4j2;

@Log4j2
public class LambdaSlackChatBot implements RequestStreamHandler {

    public LambdaSlackChatBot() {}

    @SuppressWarnings("unchecked")
    @Override
    public void handleRequest(InputStream inputStream, OutputStream outputStream, Context context) throws IOException {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("US-ASCII")))) {
            Map<String, Object> event = gson.fromJson(reader, HashMap.class);
            log.info("event: " + event);
            String owner = (String) event.get("owner");
            String slackToken = (String) event.get("slackToken");
            String channelName = (String) event.get("channelName");
            Github github = new Github(owner);
            if (!github.doCommitToday()) {
                Slack slack = new Slack(slackToken);
                slack.sendPushMessage(channelName);
            }
        } catch (Exception exception) {
            log.info(exception.toString(), exception);
        }
    }
}

메이븐(maven) 프로젝트이므로 mvn package 등의 명령어를 통해 jar 파일을 만들 수 있다. 빌드한 jar 파일을 배포하는 과정을 위주로 정리했다. 주기적으로 애플리케이션을 동작시키는 EventBridge(CloudWatch Events) 트리거를 연결한다.

빌드된 jar 파일을 업로드하고, RequestStreamHandler 인터페이스를 구현한 클래스를 등록한다.

주기적으로 애플리케이션을 동작시키는 EventBridge(CloudWatch Events) 트리거를 연결했다. 애플리케이션이 동작할 때 필요한 특정 파라미터와 트리거 주기를 설정하기 위한 화면으로 이동한다.

크론 잡(cron job)을 통해 이벤트 트리거 주기를 설정한다. GTM 시간으로 9시부터 14시까지 59분마다 실행되도록 크론 잡을 지정한다.

코드에 공개하고 싶지 않은 값들은 람다의 파라미터로 등록한다.

{
  "owner": "your github repository user name",
  "slackToken": "your slack token",
  "channelName": "your slack channel"
}

5. Check Application

정상적으로 배포가 되었다면 슬랙 챗 봇은 18시 59분부터 23시 59분까지 푸시 이력이 없는 경우 1시간 간격으로 메시지를 전달한다.

TEST CODE REPOSITORY

https://github.com/Junhyunny/slack-chatbot

REFERENCE

Twitter Facebook LinkedIn

강준현 (Junhyunny)

슬랙 챗봇(slack chatbot) 만들기

0. 들어가면서

1. Prepare slack bot

2. Test slack API

3. Test GitHub API

4. AWS Lambda

5. Check Application

TEST CODE REPOSITORY

REFERENCE

공유하기

댓글남기기

참고

에이전트 스킬(SKILL.md)

ReAct 에이전트 Playwright를 사용한 브라우저 조작 및 웹 검색

ReAct(Reasoning and Acting) 에이전트

일렉트론(electron) 프레임워크의 프로세스 모델(process model)