Slack Api를 이용한 42Alert 프로젝트

🤔 만들게 된 이유

42 과정에는 유튜브 미팅, 멘토특강, 본과정 시험, 라피신 봉사, 42 굿즈(옷, 스티커 등등..)나 여러 제품을 파는 월렛마켓 등등 여러 이벤트를 자체 인트라넷에 알려주는 알림 서비스가 있다.

라피신 봉사나 멘토특강 등 특정 이벤트는 선착순이라 빠르면 1분안에 자리가 꽉찬다
42 월렛마켓에는 AWS $1000 Credit, 학장님과의 식사(학장님이 사주신다ㅋ) 등 재미난 상품들이 많다

현재 존재하는 이벤트 알림이 있지만 지금 본과정에 들어온지 8개월 가량이 지났는데 선별과정(2월)부터 항상 인트라 알림 서비스에 불만이 있었다.
자체 API를 사용하지 않는이상 알림을 메일 또는 메신저로 받을 방법이 없고, 직접 사이트에 접속해서 확인을 해야 이벤트 등록이 가능하다보니 선착순으로 진행되는 이벤트는 놓치기 부지기수였다.

그렇게 내가 편해지기 위해 언제 한번 슬랙이나 이메일로 새로운 이벤트를 알려주는 서비스를 개발해야겠다! 다짐을 한 뒤 반년이 넘는 시간이 지나고 어느날 갑자기 새벽감성에 젖어 개발에 시작하게 되었다 ..🤣

👨‍💻 개발 시작

이번 프로젝트의 개발환경

일단 요즘 정말 맘에들어 배우는 중인 Node.js를 이용해 제작을 하였다.
그리고 배포 서버에 굉장히 많은 고민을 하였는데 AWS, GCP, Naver Cloud Platform 등등 여러 고민 끝에 Heroku를 선택하게 되었다.

💻 Heroku 사용 이유

깃과 연동이 잘 되는점이 정말 맘에 들었고
손쉬운 DB 추가기능이 진입장벽을 좀 낮춘것 같다.
그리고 문서화가 정말 잘되었으며 한글 문서도 굉장히 많아서 좋았다.
마지막으로 서비스 배포가 너무 쉬워서 Heroku를 선택하였다.

그 뒤 Heroku의 ClearDB를 통해 MySQL설정까지 모두 끝냈다.

Heroku ClearDB 설정

https://devcenter.heroku.com/articles/cleardb

💾 데이터베이스 사용 이유

GMT +09:00 기준 08:00 ~ 24:00 동안 서버가 켜져있고
3초 간격으로 42 API를 호출하여 Event 항목을 확인한다.

운영진 분들이 퇴근하시기 때문에 새벽엔 Heroku 서버를 재워준다.

그 때 생각한 개발 방향이 두가지로 나뉘었는데

데이터베이스를 사용하지 않고 이벤트 등록 시간과 현재 시간을 비교해 시간 차이가 n초 이내일 경우

장점
1. DB 연산이 빠져 성능상 이점이 있다.
2. 데이터베이스 설정을 할 필요가 없다.
단점
1. 이전 API 호출에서 새로운 이벤트가 발생하였을때 다음 API 호출에서 이전 이벤트가 슬랙에 전송 되었는지 알 수 없어 중복 전송 가능성이 크다.
2. 위 문제를 해결하려 스택에 이전 이벤트의 PK를 갖고있자니 서버가 다운되면 이전 PK를 알 수 없으니 이미 전송된 이벤트가 한번 더 전송된다.
3. 스택에 계속 저장하기도 사실 힘들며 여러개의 이벤트가 동시에 등록이 된다면 처리하기 곤란해진다.
4. 42 API 응답 오류인 경우 에러 핸들링이 귀찮아진다.

모든 이벤트를 DB에 저장하며 저장된 이벤트의 PK와 새로운 이벤트의 PK를 비교하는 경우

장점
1. DB속 기존 이벤트와 비교를 하니 중복 전송 될 일이 없다.
2. 서버가 다운돼도 다시 실행됐을 때 문제가 없다.
단점
1. 서버 비용이 더 들어간다. (사실 무료 한도 내에서 사용중이다 🤣)
2. 언제나 그렇지만 Node.js 내 ORM 설정이 정말 귀찮다.

전자를 선택할 경우 서비스 상 심각한 문제가 생길 것 같아 결국 후자 방법을 선택하게 되었다 😝

⌨️ 개발 로직

프로세스 Flow Chart

3초 간격으로 Interval실행

42 Auth Token 발급

import env from "@modules/env";

const eventToken = await axios({
         method: "post",
        url: env.ftConfig.apiUrl + "/oauth/token",
        params: {
            grant_type: "client_credentials",
            client_id: env.ftConfig.eventId,
            client_secret: env.ftConfig.eventSecret,
        },
    });

인트라넷에서 미리 API 사용 등록을 하여 UID와 SECRET KEY를 발급받자

eventToken에 42 Authorization Token이 담긴다.

Event API 호출

import env from "@modules/env";

axios({
        method: "get",
        url: env.ftConfig.apiUrl + "/campus/29/events",
        headers: { Authorization: `Bearer ${token.eventToken}` },
    })
        .then((value) => checkData(value.data, "event"))
        .catch((err) => {
            console.log(err);
            console.log("\x1b[31m[Event] - 42 API 호출에 실패하였습니다.\x1b[m");
        });

axios 호출이 완료되면 checkData 함수에서 DB 검증을 통해 새로운 이벤트인 경우 저장 후 슬랙에 전송해준다.

최신 이벤트인지 비교

import { eventType } from "eventType";

const cursusValid = (event: eventType, flag: string) => {
    // 테스트 목적으로 등록한 이벤트인지 확인하는 함수
    if (flag === "event") {
        return (
            event["cursus_ids"][0] === 21 &&
            event["campus_ids"][0] === 29 &&
            event.name.indexOf("test") === -1 &&
            event.description.indexOf("test") === -1 &&
            event.location.indexOf("test") === -1
        );
    }

    return event.cursus[0].slug === "42cursus" && event.name.indexOf("test") === -1 && event.location.indexOf("test") === -1;
};

const isNewEvent = (recentEvent: Array<eventType>, nowEvent: Events | Exams, flag: string) => {
    return recentEvent.filter((event) => cursusValid(event, flag) && event.id > nowEvent.id);
};

const newEvent = async (data: Array<eventType>, flag: string) => {
    const recentEvent = data.sort((a: eventType, b: eventType) => b.id - a.id);
    const eventRepo = getCustomRepository(EventRepo);
    const examRepo = getCustomRepository(ExamRepo);
    const nowEvent = flag === "event" ? await eventRepo.findOneEvent() : await examRepo.findOneExam();

    return isNewEvent(recentEvent, nowEvent, flag);
};

export default newEvent;

DB에서 PK값 기준 기존 이벤트를 가져온 후 새로운 이벤트와 PK 비교한다.
새로운 이벤트들은 배열에 담아 반환해준다.

최신 이벤트 Slack 전송

import { WebClient } from "@slack/web-api";
import content from "@modules/content";
import env from "@modules/env";
import { eventType } from "eventType";

const slack = (event: eventType, flag: string) => {
    const web = new WebClient(env.slackConfig.token);
    const channelName = env.slackConfig.channel;

    web.chat
        .postMessage({
            username: "42Alert",
            channel: channelName,
            // content 함수는 직접 만들었는데 Slack에 이쁘게 전송하기 위해 문자열을 꾸며주는 함수다
            text: content(event, flag),
        })
}

export default slack;

사실 슬랙으로 전송하는 로직은 간단하다.
나중에 슬랙 API 사용법 포스팅을 해야것다

📨 완성된 모습

새로운 이벤트가 등록되면 위 사진과 같이 슬랙에 전송이 된다!!
아주 성공적으로 개발이 되었고 Heroku도 처음 사용해 봤고 Node.js도 입문자 수준이라 4일 밤낮으로 아주 개고생을 하였다..😩

📝 프로젝트 후기

원래 본과정 워크스페이스에 등록하려 했던 앱..

한가지 아쉬웠던 점은 본과정 워크스페이스 42born2code에는 이 앱을 42 Paris 관리자가 거절하여 등록을 못하였고, 허광남멘토님과 여러 멘토님의 도움으로 멘토님들이 운영하시는 42seoul_cuckoo 워크스페이스에 등록을 했다…😩

TMI ⭐️ 허광남 멘토님은 https://okky.kr 개발자이시다..! (대단하신분 😮)

사실 여기 작성하진 않았지만 개발이 끝나고 서비스 배포까지 아주 고단했다..

아마 처음이라 힘들었던것 같다

지금은 모두 끝나고 개운하긴 하지만 3개월이 지난 지금 다시 코드를 돌아보니 고칠 부분히 상당히 많은것 같다…
처음 배우며 시작했던 프로젝트라 그런지 현재 하나도 마음에 들지 않는다ㅠ
~~현재 하고있는 프로젝트가 마무리 되거나 도중에 시간이 나면 TypeScript를 적용해 전체 리팩토링을 해보려 한다 🤩~~

2022년 1월 1일 기념으로 리팩토링을 완료했다

# 다음은 TS로 리팩토링을 하며 수정한 내용이다

- 42 OAuth Token 조건부 발급 오류 처리
- 핵심 로직 비동기 처리
- 중복 코드 모듈화
- 파일명 명시적으로 변경
- ORM 변경 Sequelize -> Typeorm
- import 절대경로 지정

멘토님이 42 Alert 서비스를 위해 만들어주신 채널 #agenda-alert

개발이 끝나고 3개월 후 현재 224명의 본과정 분들이 사용해 주시고 있다!!
이분들도 현재 인트라넷 알림 서비스의 불편함을 느끼고 내가 만든 서비스를 사용해주시는게 감사할 따름이다 🙏

사실 엄청난 기술이 들어가고 기능이 있는건 아니지만..
없던 기능, 필요한 기능을 제작하는 일은 재밌고 제작 후 매우 뿌듯한 것 같다!

물론 사용해주는 분들이 계셔서 더 그런것 같다

📚 Github 주소

https://github.com/nfl1ryxditimo12/42Notifier

🤔 만들게 된 이유
👨‍💻 개발 시작
- 💻 Heroku 사용 이유
- 💾 데이터베이스 사용 이유
⌨️ 개발 로직
📨 완성된 모습
📝 프로젝트 후기
📚 Github 주소