hrvadl/goweekly

Application for querying top articles from https://golangweekly.com/, translating them to Ukrainian and sending to the telegram channel

Go weekly 🤓

Quick start 🚀

Run app 😬

Make sure you have docker & docker compose tools installed. Then, copy contents of .env.example to .env and populate it with values. Finally, in the root of the directory run:

docker compose up

Architecture

App consists of 4 microservices:

1. Crawler - is responsible for obtaining articles and publishing them to the RabbitMQ. Should be run as a cron/scheduled job (to be done).
2. Core - core service, responsible for listening to RabbitMQ queue and calling other services.
3. Translator - service, used for translation. Uses lingva under the hood.
4. Sender - service, used to distribute translated messages to Telegram channel.

Local software development 👷🏻

Code quality 💅🏻

Make sure you have pre-commit installed and added to your $PATH. Then run following command from the root of the repo:

pre-commit install

Now, you must install golangci-lint and include it to your path as well.

Congrats, now pre-commit will run before your commits. Also, in case you're using VSCode linting on save should be integrated into your editor.

What's the purpose? 🥸

I like Go and I like reading tech articles. I appreciate work from admins of go-weekly website. But, I don't like to be notified about fresh weekly digest by mail. I'd like receive weekly digest directly in the telegram, because ... Because, why not? Also, I'd like to contribute to the Ukrainian golang community and make summaries translated to ukrainian language. 🇺🇦

Contributors 🏋🏻

• Alex 🤓
• Vadym 💅🏻

TODO

1. Run Crawler as a Cron job in Kubernetes
2. Add grpc logger & other useful interceptors
3. Add Helm chart?
4. Deploy it somewhere?
5. Add graceful shutdowns

goweekly's Issues

Parse fetched articles

AC:

• All fetched articles are parsed correctly.
• Logic to filter out the sponsored articles is implemented
• Errors are handled correctly

Implement fetching articles from golangweekly

AC:

• Function to fetch articles from https://golangweekly.com/issues/latest is implemented
• Retries are implemented

Provide unit tests for the DI

DoD:
Unit tests for all DI cases are implemented

Integrate DI to Translator GRPC server

DoD:

1. Translator interface is defined
2. Translator interface and it's corresponding implementation is provided to Translator GRPC server

Create unit tests for Consumer struct

DoD:

1. Mocks for the ArticleProcessor interface are generated.
2. Tests are written for Consumer struct and processUpdates func

Create unit tests for the Processor struct

DoD:

1. Mocks are generated for the Translator, Sender, and ArticleFormatter interfaces.
2. Tests are written for the struct Processor and Process func

Create a test plan

We need to create test plan. It should answer following cases:

• Which edge cases does our application have?
• Which coverage should be enough for our code?
• Write some sample unit test. The one would be enough for now.

Create skeleton tests for the Processor and Consumer structs

DoD:
basic table test skeletons are created for the following tasks:
#18
#17

Integrate DI to Processor struct

DoD:
Formatter, Translator, Sender interfaces are defined and provided as DI to Processor struct