휴가 알림 Slack Bot 제작기

2024/01/21

18 min read

DEVELOPMENT

개발의 모든 부분을 설명하지 않습니다

개발 계기

현재 다니고 있는 회사에서 휴가 관리를 Flex 서비스를 통해서 관리를 하고 있습니다.

휴가를 요청하고 승인이 되면 Slack 채널에 당사자의 이름과 휴가 일정이 메세지로 전송이 됩니다. 하지만 이건 승인이 되었을 때 메세지가 전송이 되어서 휴가 당일인지 알 수 없습니다. 그래서 동료분을 찾다가 “맞다 오늘 휴가신가?” 라는 생각이 들 때가 있습니다.

휴가자의 휴가 당일과 그 전날에 알림이 왔으면 좋겠다라고 팀원이 요청을 했습니다. 그렇게 오래 걸리진 않겠다고 생각이 되어 바로 개발에 들어갔습니다.

필요 기능과 기술 찾기

먼저 슬랙페이지를 접속해 보았습니다. 많은 봇들이 있었고 쉽게 슬랙 봇을 제작할 수 있는 Bolt라는 도구가 있었습니다 다행히 JS를 지원해서 해당 도구를 통해서 개발을 하기로 하였습니다.

Flex에서 보내는 메세지를 휴가 일정에 보내지도록 등록해야합니다. Slack에서 제공하는 예약 메세지를 이용하여 메세지를 등록하기로 하였습니다. 하지만 예약 메세지는 수정이 불가능 해서 메세지를 삭제 후 재등록 해야했습니다. 그래서 메세지를 관리하는 스토어가 필요할 것 같습니다

개발 시작

이름 작명하기

휴가에 대해서 알림을 주는 봇이고 평범한 이름 말고 스토리를 넣어 재미있게 만들고 싶었습니다.

휴가를 가지못해 원한이 남은 유령이 휴가자들을 찾아 부러움에 알리고 다니는 유령이다 라는 봇의 스토리를 만들었고 해당 봇의 이름은 휴가 유령이라고 명명하였습니다.

휴가유령이니까 메세지는 어떻게 보내면 좋을까 고민하다가 다음과 같이 정하였습니다.

공통적인 알림 메세지의 제목은 “휴가 유령이 찾아왔어요!!”라고 하였습니다. 이전날의 메세지의 제목은 무슨 일이 벌어질 것 같은 분위기 연출을 위해

이전 날 제목
“내일 무슨일이 일어날 것 같은 으스스한 느낌이 옵니다”

당일 날 제목
“오늘 휴가자들이 나타났어요!!”

셋팅하기

Bolt 문서가 잘 되어있어 보고 쉽게 따라할 수 있습니다.

Tip
디버그를 위해서 Bolt App생성시에 옵션으로 logLevel: LogLevel.DEBUG 넣으면 자세히 볼 수 있습니다.

저는 Flex에서 보내는 알림을 트리거해야하기 때문에 Event기반으로 동작하도록 하였습니다. Slack에 생성한 APP에 가보시면 Event Subscriptions가 있습니다.

이 것을 활성화 시켜주고 그러면 원하는 이벤트 발생시 설정한 URL로 POST request를 보낼 수 있습니다.

저는 채널에 메세지가 오는것을 알기위해 message.channels를 추가 하였습니다.

메세지 등록하기

먼저 Flex가 보내는 메세지일 때 동작해야하기 때문에 Flex가 보냈을 때 정보를 파악하고 Flex bot의 고유의 ID값을 찾아서 해당 ID값을 가진 유저의 메세지가 아니라면 동작하지 않도록 하였습니다.

Flex에서 보내주는 메세지는 여러개의 메세지가 존재합니다. 왜냐하면 하루종일 휴가 이거나 반차 등 다양한 변수가 있었습니다.

하지만 메세지에는 동일한 부분이 있었는데 바로 이름과 휴가 일자였습니다.

동일한 구조로 메세지가 오고 뒷 부분만 변경이 되는 형식이여서 메세지를 가져오고 정규식을 통해 이름값과 일자 값을 가져왔습니다.

Date로 일자를 계산하여 이전날과 당일날 오전 8시로 맞추어 놓았습니다.

그리고 스토어에 Date.getTime()을 하여 스토어에 메세지와 저장하였습니다. Slack API를 통해 메세지를 예약해 줍니다.

1
const result = await app.client.chat.scheduleMessage({
2
  channel: channelId,
3
  text: 'Looking towards the future',
4
  // Time to post message, in Unix Epoch timestamp format
5
  post_at: CurrentDate.getTime() / 1000,
6
});

Bolt app에 이벤트 부분에 들어오는 인자값인 context와 payload를 살펴보면

메세지가 온 채널 정보와 셋팅할 때 발급받은 Token값이 있어 활용하면 됩니다.

예약 메세지에 대한 API정보는 다음 링크에 잘 나와있습니다

예약 메세지 API 보러가기

테스트 하기

처음엔 글리치라는 서비스를 통해 배포를 하였습니다

Slack Event Subscription에 URL을 설정해주었습니다

테스트를 진행해 보았는데 문제가 생기었습니다.

무료 버전 글리치는 몇 분이상 요청이없으면 꺼지게 되어 요청을 받지 못한다 (Lambda 처럼 동작하는지 정확히는 모르겠다...)

종료가 되다보니 Class instance로 스토어를 작업하던 데이터가 날아간다

휴가를 정정 혹은 취소할 수 없다.

메세지가 한국시간으로 발송되지 않는다.

해결책

AWS Lambda를 통해 배포를 진행한다.

AWS DynamoDB를 이용하여 데이터를 저장한다.

취소 기능을 추가한다

한국시간을 위해 9시간을 빼주고 예약한다

회사에서 AWS를 사용하고 있었기 때문에 AWS를 이용하기로 했습니다

리팩토링

AWS Lambda로 배포를 하기 위해 Serverless라는 프레임워크를 사용하기로 했습니다.

그래서 일자를 계산하는 로직에 한국시간으로 설정해주어야 하기 때문에 -9시간 해주었습니다.

취소시 메세지를 보니 등록되었을 때와 구조가 같고 뒤에 “취소 되었습니다” 라는 문구가 추가되는 것을 보고 “취소” 라는 단어가 들어간다면 취소 로직을 실행시키도록 하였습니다.

Slack Message 구조

하나의 메세지에서 제목과 여러개의 값을 넣어야하기 때문에 Slack에서 제공하는 Block Kit을 이용하여 메세지를 생성했습니다

데이터 베이스 등록/삭제

등록

DB에 예약일자에 값이 있는지 확인한다
있다면 값을 가져와 추가한 뒤 저장한다, 없다면 값을 저장한다.

취소

DB에 예약일자에 값이 있는지 확인한다.
있다면 삭제한다.
삭제 후 예약 메세지가 0이라면 row를 삭제한다

배포/테스트

친절하게 Bolt문서에 Lambda 배포 방법이 적혀져 있습니다

Bolt Lambda 배포방법

1
service: serverless-bolt-js
2
frameworkVersion: '3'
3
provider:
4
  name: aws
5
  region: ap-northeast-2
6
  runtime: nodejs18.x
7
  deploymentMethod: direct
8
  environment:
9
    SLACK_SIGNING_SECRET: ${env:SLACK_SIGNING_SECRET}
10
    SLACK_BOT_TOKEN: ${env:SLACK_BOT_TOKEN}
11
functions:
12
  slack:
13
    handler: app.handler
14
    events:
15
      - http:
16
          path: slack/events
17
          method: post
18
plugins:
19
  - serverless-offline
20

21
  - serverless-dotenv-plugin
22

23
useDotenv: true
24
custom:
25
  serverless-offline:
26
    noPrependStageInUrl: true
27
  dotenv:
28
    exclude:
29
      - GITHUB_TOKEN

serverless.yml 파일입니다

저는 serverless-dotenv-plugin과, serverless-offline을 설치해주었습니다.

dotenv plugin으로 .env파일에 Slack관련 키를 작성하여 사용할 수 있습니다.

serverless-offline은 로컬에서 테스트할 수 있도록 도와줍니다.

ngrok서비스를 이용하여 로컬에 접속할 수 있도록 주소를 받아 Slack Event-Subscription URL에 붙여넣어주고 serverlss offline 명령어를 통해 로컬에서 봇을 테스트 할 수 있습니다.

AWS DynamoDB

DynamoDB를 사용하기 위해 먼저 DynamoDB에 저장할 테이블을 만들어 줍니다.

저는 이전날과 당일에 대한 테이블을 두개 만들었습니다

테이블 이름과 값을 분리하기 위한 파티션 키의 이름을 정해주고 해당 값은 number타입으로 정했습니다. 정렬키의 경우에는 사용하지 않았습니다.

다시 코드로 돌아와서

@aws-sdk/client-dynamodb 해당 라이브러리를 설치해줍니다.

1
const client = new DynamoDBClient({ region: 'ap-northeast-2' });

region에 있는 DynamoDB에 접근할 수 있는 client를 만들어줍니다

DynamoDB의 사용법을 간단하게 알려드리겠습니다.

저 또한 많은 삽질을 했기에…

많은 커멘드가 있지만 저는 아래 커멘드만 사용했습니다

PutItemCommand
GetItemCommand
DeleteItemCommand

커멘드를 만들고 client에 send하는 방식입니다.

PutCommand

1
const putItemCommand = new PutItemCommand({
2
  TableName: tableName,
3
  Item: {
4
    day: { N: String(day) },
5
    message: { SS: message },
6
  },
7
});

값을 넣을 때 사용합니다 저장할 Table의 이름을 넣고 넣을 Item을 정해줍니다

위의 값을 토대로 설명드리겠습니다

day ⇒ 위에서 설정한 파티션 키를 정해주기 위해 해당 이름으로 넣어줍니다. number 형식이여도 필수적으로 string값을 넣어야합니다

message ⇒ 저장할 속성의 이름입니다

SS ⇒ 저의 경우에는 해당일자에 중복으로 휴가인원이 있기 때문에 문자열 집합 형태로 넣어야해서 SS 할당했습니다

속성값은 원하는대로 추가가 가능합니다

N, SS 무슨 의미인지 궁금하시다면 찾아보기

GetCommand

1
const curGetItemCommand = new GetItemCommand({
2
  TableName: tableName,
3
  Key: {
4
    day: { N: String(day) },
5
  },
6
});

찾고자 하는 TableName입력하고

아까 파티션키를 토대로 찾기 때문에 Key에 day속성 값으로 찾고자하는 값을 넣어줍니다

DeleteCommand

1
const curDeleteItemCommand = new DeleteItemCommand({
2
  TableName: tableName,
3
  Key: {
4
    day: { N: String(day) },
5
  },
6
});

Get과 같이 값을 입력해주면 됩니다

전체적인 흐름

두 번째 배포

Serverless Deploy를 통해 배포를 시작했습니다. 하지만 바로 오류가 발생했습니다

한 번에 될리가 없지...

원인은 IAM의 권한의 부족이였습니다.

부족한 권한을 하나하나 넣고보니 꽤 많은 권한이 들어갑니다.

FullAccess는 자제하라고 들었지만 serverless에서 어떤 작업을 하는지 몰라 우선 이렇게 두고 나중에 차차 변경하기로 했습니다.

다시 Serverless Deploy를 통해 배포를 시도했습니다.

성공적으로 배포가 완료되었고 AWS를 살펴보니 AWS Lambda, AWS GateWay, AWS S3 3개를 사용하여 한 번에 배포가 되었습니다. (정말 신기했습니다 ㅎㅎ)

마침 팀원 중 한 분이 휴가를 신청하셔서 Lambda가 동작하게 되었습니다.

잘 돌아가나 확인을 해보았는데 또 다시 Error를 마주하게 되었습니다.

원인은 DynamoDB에 대해서 권한이 없다는 것이였습니다.

Lambda에 권한을 어떻게 주지 계속해서 AWS를 뒤적거리다보니 자동으로 생성된 Lambda에 연결된 IAM 역할이 있었습니다.

해당 역할에 dynamoDB의 권한을 주고, 다시 배포를 시작하였습니다.

또 다시 마주한 에러

역시나 만만하지 않습니다. 또 에러라니 CloudWatch를 통해 어디에서 오류가 났는지 살펴봅니다.

예약 메세지의 시간이 올바르지 않다고 합니다. 로컬로 돌려서 테스트를 시작했습니다. 날짜의 변환의 문제인지, 넘기어줄때 문자열로 주어야하는지 여러가지 테스트를 해보았지만 같은 에러가 발생했습니다. 다시 생각해보았습니다 시간이 올바르지 않다는건, 해당일자에 예약을 하지 못 한다는 것, 이미 지난 날짜이지 않을까?

당장 내일 휴가를 낸다면 이전 날인 오늘 메세지를 예약해야하는데 오전 8시 발송이니 예약할 수 없다

테스트를 통해 해당 문제인 것으로 판정이 났고 바로 문제 해결에 돌입했다
이전 날에 메세지를 등록하는 로직에 오늘보다 적거나 같은날은 예약을 하지 않고 넘어가는 분기처리를 작성했다.

또 다시 배포를 진행했고, 테스트를 진행해보았다.

제공하는 서비스는 잘 동작했다👏🏻👏🏻
하지만 로그를 살펴보니 error라고 빨간 글씨가 있었다. 로그를 살펴보니 Lambda함수 호출을 2번을 하고 있었다. 왜 두 번 호출을 할 까 찾아보니 Lambda 설정에 시간내에 응답이 없다면 최대 2회까지 재시도하는 옵션값으로 설정 되어있었다. 정상 동작을 했지만 응답값이 없어 호출을 두 번 했나보다 판단을 했다. 해당 옵션을 1회로 수정하는 방법도 있지만 응답값을 주기로 했다.

그런데 bolt app에서 무슨 응답값을 주어야하는지 모르겠다.
일단 상태코드라도 줘보자 하고

1
return {
2
  statusCode: 200,
3
};

을 주고 있다. 혹시나해서 Gateway에서 주는건지 살펴보았지만 Response값을 설정을 할 수 있지만 할당하는 방법을 몰라 아직 해결하지 못 했다

혹시 이런 문제를 겪으셨거나, 방안을 아신다면 알려주세요 ㅎㅎ

결과물

한동룡

휴가 알림 Slack Bot 제작기

필요 기능과 기술 찾기#

개발 시작#

이름 작명하기#

셋팅하기#

메세지 등록하기#

테스트 하기#

리팩토링#

Slack Message 구조#

데이터 베이스 등록/삭제#

배포/테스트#

AWS DynamoDB#

PutCommand#

GetCommand#

DeleteCommand#

전체적인 흐름#

두 번째 배포#

또 다시 마주한 에러#

결과물#