https://github.com/felipeoriani/nodejs-typescript-express-rest-api
Sample NodeJs, Typescript and Express REST / Graphql API service used to manage and handle Tasks by User. Deploy is build on the top of AWS ECS, AWS ECR and AWS RDS with Github Actions workflows.
https://github.com/felipeoriani/nodejs-typescript-express-rest-api
apollo apollo-server apollo-server-express clean-architecture clean-code docker express express-middleware expressjs graphql node-test-runner nodejs postgresql prisma prisma-client prisma-orm rest-api typescript unit-test
Last synced: 8 months ago
JSON representation
Sample NodeJs, Typescript and Express REST / Graphql API service used to manage and handle Tasks by User. Deploy is build on the top of AWS ECS, AWS ECR and AWS RDS with Github Actions workflows.
- Host: GitHub
- URL: https://github.com/felipeoriani/nodejs-typescript-express-rest-api
- Owner: felipeoriani
- Created: 2024-04-05T16:34:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T23:26:26.000Z (over 1 year ago)
- Last Synced: 2025-03-30T21:33:17.637Z (9 months ago)
- Topics: apollo, apollo-server, apollo-server-express, clean-architecture, clean-code, docker, express, express-middleware, expressjs, graphql, node-test-runner, nodejs, postgresql, prisma, prisma-client, prisma-orm, rest-api, typescript, unit-test
- Language: TypeScript
- Homepage:
- Size: 431 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Service
Task Service is a sample application used to handle Tasks by User. The goal here is to show in a simple project how I enjoy desigin and implementing the solutions I have creates after a few yeras of experience working with NodeJs. I am always open mind to change it since there is no silver bullet from my perspective.
The base structure of a `Task` is:
```typescript
{
id: string
title: string
description: string
status: 'todo' | 'inProgress' | 'done' | 'archived'
createdAt: Date
userId: string
}
```
The REST API / GraphQL API is protected by user authentication using a `bearer` token (JWT). Before consuming it, you must first authenticate using the `POST /api/v1/auth` endpoint passing the user credentials and a token will be generated. Use it on the `authorization` http request header attribute. Use POSTMAN collection available on the docs folder.
⚠️ **Important**: There is 2 types of user. A `super` user that can handle all the tasks and a `non-super` user which can only handle its own tasks. You may get some `401` or `403` errors if you try to acccess wrong IDs.
Here is a structure of a `User`:
```typescript
{
id: string
name: string
username: string
password: string
email: string
createdAt: Date
super: boolean
}
```
## 💻 Stack
The following list represents the main stack and its dependencies:
- NodeJs 20
- Node Test Runner
- Typescript 5.x
- Express
- PostgreSQL database
- Prisma ORM
- Apollo Server (`apollo-server-express`)
- eslint
- jsonwebtoken
- pino (logging)
## 🥇 Architecture
The design was made on the top of `Clean Architecture`, where there are well-separated layers for `Domain` which holds all the abstractions for the domain of the application (Tasks and Users), `Infrastructure` (I/O bound operations) and `UseCases` (business rules). The components of each layer depends on the abstractions of the domain which allows us to inject any derived instance for the abstractions and mock at unit testing level.
## ☁️ Scalability
To emulate the scalability, you can run it on your machine:
```
docker-compose -f docker-compose-test.yml up -d
```
It will up database, two instances of the container app and a `nginx` as a load balancer which will distribute the requests across the containers emulating a situation where we have more than a single instance running for the application. The image for the container app is ready and published on docker hub, you can check it here: https://hub.docker.com/r/felipeoriani/tasks-api-nodejs-typescript
```mermaid
flowchart TD
G(Client) -.loadBalancer:4000.-> LB(Nginx Load Balancer)
subgraph Backend App
LB -.api01:3000.-> API1(NodeJs API - instance 01)
LB -.api02:3000.-> API2(NodeJs API - instance 02)
API1 -.-> Db[(PostgreSql Database)]
API2 -.-> Db[(PostgreSql Database)]
end
```
You also can see how the image was build at `Dockerfile`.
But from this repository you will need to run:
```
yarn prisma:reset
```
To migrate and seed the database. Then you can load the postman collection available on the `docs` folder and use it.
Once it is up, the endpoint to consume the api via load balancer is: `http://localhost:4000`.
Finally when you are done, just destroy the environment:
```
docker compose -f docker-compose-test.yml down
```
## ✔️ Tests
It uses the native Node Test Runner as tooling for testing. The tests covers the use cases layer mocks are created using objects and injected on the useCases, specially the `TaskUseCases`.
## 📊 CI/CD
There is a initial workflow on the `./github/workflows` folder that run a few steps to check the project source code including lint, typescript, build (transpilation process of typescript) and tests.
You can see the workflow results at `Actions` tab here: https://github.com/felipeoriani/task-service/actions
## 📓 Improvements
There are space for improvements in this project considering coding, architecture, deployment, automation:
- Implement integration tests to cover the infrastructure layer and api layer;
- Custom error messages for schema validators, maybe considering globalization;
- Implement hashing strategy for user password (security issue);
- Standardize the http response messages using the Problem Details;
- GraphQL configurations, it was my first time dealing with it, I would investigate how to implement the `Mutation` and maybe consider it just a GraphQL API instead of a Mix of REST and GraphQL;
- Improve the test coverage, currently using the `c8` package since node test runner is not able yet (hope in node 22 it will);
- Improve the route configuration on the API level with the express framework;
- Configure CORS properly;
- Configure Rate limiting on the API / Cloud service infrastructure;
- Move environment variables to AWS Secrets Manager and adapt the application to read from there;
- Deploy at AWS ECS (Fargate - serverless) and configure the Task Definitions properly to run and scale the container;
- Use AWS RDS (Aurora) to run the PostgreSQL database;
- Use AWS Elasticache (Redis) to implement some caching strategy;
- Use IaC tool (Terraform or AWS Cloud Formation) to provision the infrastructure and automate it for dev/staging/prod;
- Improve the CI/CD workflows with Github Actions to deploy it into a Cloud Service (currently just doing the basics with CI).
## Endpoints
Method
Endpoint
Description
Status
GET
/
Base endpoint
200 - OK
GET
/health
Healthcheck for the API returning which can be configured on a container orchestration tool.
200 - OK
GraphQL
POST
/api/v1/graphql
Endpoint to get tasks using Apollo Server. You can read all the tasks, a single task by the id or all the tasks filtered by status.
200 - OK
401 - Unauthorized
User
POST
/api/v1/auth
Authenticate a user using credentials and database users.
200 - OK
404 - Not Found
Tasks
GET
/api/v1/tasks
Returns all the tasks for the authenticated user. In case it's a super user request, return all the tasks.
200 - OK
GET
/api/v1/tasks/:id
Return a specific task by the given id and authenticated user. In case it's a super user, ignore the authenticated user.
200 - OK
404 - Not Found
POST
/api/v1/tasks
Save a new task for the authenticated user considering a valid request body.
201 - Created
400 - Bad Request
422 - Unprocessable Entity
PATCH
/api/v1/tasks/:id
Partially update an existing task for the authenticated user considering a valid request body. Only the title and description.
200 - OK
400 - Bad Request
422 - Unprocessable Entity
PATCH
/api/v1/tasks/:id/status
Change the status of a given task for the authenticated user considering a valid request body.
A task can be moved to any status but once it is in the Archive status, it can't be moved anymore.
200 - OK
400 - Bad Request
422 - Unprocessable Entity
DELETE
/api/v1/tasks/:id
Delete a task by the given id for the authenticated user.
It's a hard delete, the data will be lost once it succeed.
204 - No Content
400 - Bad Request
404 - Not Found