https://github.com/rafaelpadovezi/bookmark-manager
A simple bookmark manager written in C#
https://github.com/rafaelpadovezi/bookmark-manager
aspnet-core csharp
Last synced: 10 months ago
JSON representation
A simple bookmark manager written in C#
- Host: GitHub
- URL: https://github.com/rafaelpadovezi/bookmark-manager
- Owner: rafaelpadovezi
- License: mit
- Created: 2021-01-23T19:34:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T17:36:30.000Z (over 1 year ago)
- Last Synced: 2025-04-03T08:22:20.295Z (over 1 year ago)
- Topics: aspnet-core, csharp
- Language: HTML
- Homepage:
- Size: 201 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bookmark Manager
A simple bookmark manager written in C#
## Technologies
- `aspnet core 5`
- `sql server`
- `ef core 5`
- `rabbit mq`
## Architecture
Adding a bookmark to Bookmark Manager is executed in two steps:
1. Saves the provided URL on the DB and sends a message to RabbitMQ
1. A consumer process the message fetching the url details from the site response
To make sure that bookmarks saved on te DB are always processed by the consumer it is used the [Outbox Pattern](https://microservices.io/patterns/data/transactional-outbox.html).
In this implementation of the outbox pattern messages to be sent to RabbitMQ are saved on the DB and processed by a background service periodically. `OutboxSendingService` gets the messages not sent and publish them to the queue updating their status. This way is guaranteed that each message is sent at least one time.
For this reason, to the outbox pattern work is important that the consumer is [idempotent](https://microservices.io/patterns/communication-style/idempotent-consumer.html). In this example, a separated table is used the store the processed messages. When commiting the transaction afer making changes to other entities the violation of the unique constraint error will occur and none of the change will be stored.
## Running locally
```sh
# start dependencies
docker-compose up -d db queue
# see help
dotnet run -- -h
# run api
dotnet run -- api
# run consumer
dotnet run -- bookmark-inserted-consumer
```
## References
- https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-5.0&tabs=visual-studio
- https://medium.com/@sergiobarriel/how-to-automatically-validate-a-model-with-mvc-filter-and-fluent-validation-package-ae51098bcf5b
- https://www.rabbitmq.com/dotnet-api-guide.html#connection-and-channel-lifspan
- https://github.com/Tyrrrz/CliFx
- https://devblogs.microsoft.com/aspnet/improvements-in-net-core-3-0-for-troubleshooting-and-monitoring-distributed-apps/
- https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-5.0&tabs=visual-studio#timed-background-tasks
- https://github.com/davidfowl/AspNetCoreDiagnosticScenarios/blob/master/AsyncGuidance.md#timer-callbacks
- https://altkomsoftware.pl/en/blog/microservices-outbox-rabbitmq/
- https://chrisrichardson.net/post/microservices/patterns/2020/10/16/idempotent-consumer.html
- https://cap.dotnetcore.xyz/user-guide/en/cap/idempotence/
- https://www.thereformedprogrammer.net/entity-framework-core-validating-data-and-catching-sql-errors/
- https://github.com/willianantunes/tutorials/tree/master/2021/XX/ef-core-how-to-handle-migrations-in-production