NotifierBot - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #typescript #golang #go #machine-learning #deep-learning #linux #macos #awesome #security #ios #mcp #openai

NotifierBot

(★ 120)

Telegram/Slack notification system that creates small but important reports for employees

파일 탐색기

최종 버전 다운로드 (.zip)

- - cd.yml
  - ci.yml
  - deploy.yml
- flow.png
- flow.puml
- lombok.config
docker-compose.yml
Dockerfile
pom.xml
Procfile
README.md
system.properties

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/whiskels/NotifierBot

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd NotifierBot

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker-compose up

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Maven (Java)

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java 프로젝트를 빌드/실행하려면 필요합니다.
Maven mvn 명령어를 쓰기 위한 빌드 도구입니다.

mvn package -DskipTests=true

Maven으로 의존성 설치와 빌드를 진행합니다.

✅ BUILD SUCCESS 메시지가 뜨면 성공입니다. target/ 폴더에 결과물이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Notifier 
#### ...with Telegram Admin panel

![CI](https://github.com/whiskels/NotifierBot/actions/workflows/ci.yml/badge.svg)
[![CD](https://github.com/whiskels/NotifierBot/actions/workflows/cd.yml/badge.svg)](https://github.com/whiskels/NotifierBot/actions/workflows/cd.yml)
[![codecov](https://codecov.io/gh/whiskels/NotifierBot/graph/badge.svg?token=F51GAFZ63Q)](https://codecov.io/gh/whiskels/NotifierBot)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/307f26a176cd4488b19db004f6705254)](https://www.codacy.com/gh/whiskels/TelegramNotifierBot/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=whiskels/TelegramNotifierBot&amp;utm_campaign=Badge_Grade)
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fwhiskels%2FTelegramNotifierBot&count_bg=%2379C83D&title_bg=%23555555&icon=telegram.svg&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
[![Known Vulnerabilities](https://snyk.io/test/github/whiskels/telegramnotifierbot/badge.svg)](https://snyk.io/test/github/whiskels/telegramnotifierbot)

___
## Trivia
Employees of the company perform some routine tasks on the daily basis. The business need for this application is to be able to have something that can automate these routine tasks and prepare reports that are sent to Slack on a daily basis.

These reports are gathered from internal systems as well as Google Sheets.

Telegram admin panel is added to provide easy access to logs or to retry report generation in case of exceptions.

Initially it was supposed to be a Telegram-only bot with role-based access, but over time end users decided to switch to Slack, which is why Telegram authorization was replaced with a simple chat id check.

## Stack
Java 21, Spring Boot, Feign, AOP, Postgres, Testcontainers, Flyway and a bunch of APIs (Slack, Telegram, Google Sheets).
### Heroku-specific tools
- Papertrail - provides service logs
- Fixie - provides static IP address to access internal systems

### Out of scope
- Caching - reports are served once a day and on Heroku services are restarted each 24 hours, so caching doesn't add any value

## Local run
You can play with the app on your machine if you'd like to.
There is a mock profile you can use for that

Firstly build the JAR file using Java 21

```console
mvn package -DskipTests=true
```

Then run docker-compose with environment variables
```console
TELEGRAM_BOT_TOKEN=${YOUR_TOKEN} \                                     
TELEGRAM_BOT_ADMIN=${YOUR_TELEGRAM_ID}  \
WEBHOOK_URL=${WEBHOOK_URL} \
docker-compose up
```

Or if you don't want to use telegram:

Adjust application-mock with report.parameters.schedule to send reports to slack
Adjust SPRING_PROFILES_ACTIVE in docker-compose to "mock" and run docker-compose with your webhook

```console
WEBHOOK_URL=${WEBHOOK_URL} \
docker-compose up
```

## Flow
![img.png](https://raw.githubusercontent.com/whiskels/NotifierBot/master/screenshots/flow.png)

### Initialization

- Cron Jobs: These are created from report context (cron, type) provided by configs
- Task Scheduler schedules report execution

### Report Processing

- Report Service:
  - The Report Service propagates the report context to the Generic Report Service.

- Generic Report Service:
  - Requests report data from the Data Fetch Service.
  - If there's an exception in the Data Fetch Service, the Generic Report Service informs the Report Service, which then sends an exception message to the admin via the Messaging Service.
  - On successful data fetch, the Generic Report Service sends this data to the Message Conversion Service.
  - The Message Conversion Service returns an iterable set of messages back to the Generic Report Service.
  - Finally, the Generic Report Service sends this iterable set of messages back to the Report Service.

- Payload Executor:
  - The Report Service passes the iterable messages to the Executor.
  - The Executor then sends these messages to Slack.
  - If Slack returns an exception, the Executor Service sends an exception message to the admin.

### Admin Intervention

If exceptions arise during the report processing:

- Retry Report:
  - The admin can ask the Command Handler to retry the report.
  - The Command Handler will request the Report Service to retry the report, repeating the report processing flow.

- Request pod logs:
  - The admin can also ask the Command Handler for the logs.
  - The Command Handler requests these logs from the Log Service.
  - The Log Service returns the logs to the Command Handler.
  - The Command Handler then sends the logs message to the Messaging Service, which sends the logs message to the admin.

### Deployment
Deployment using Maven plugin:

<code>mvn clean heroku:deploy</code>

Starting up:

<code>heroku ps:scale worker=1 -a *app_name*</code>
worker type is required, so application is not scaled down to 0 instances after idle time

Retrieving logs using Heroku CLI:

<code>heroku logs -a *app_name*</code>