nestjs-prisma-postgres-sandbox
Toying with nest and prisma.
You can find the deployed app here.
⚡ What is this repo about?
This is a sandbox to evaluate nestjs and dig how fun it is to implement typical requirements for a backend, with an enphasis on testing, given how dearly missed this requirement can be in 'real world' examples found here and there.
⚡ Usage
🔶 run locally
👇 Since our prisma schemas are split within modules, we will have to merge them all in one file prisma can understand. Let's do just that
yarn prisma-merge👇 Now, we need to tell prisma to generate in node_modules the code actually allowing us to interact with the database
yarn prisma-gen👇 You will need docker and docker-compose to get the postgres database up and running. You can use this command to launch the database container
yarn docker👇 Then, let's inject some data in our dev database using
yarn prisma-seed👇 We can now launch the backend in dev
yarn dev😵 You can do the merge, gen & seed steps all at once using the following command
yarn dev-db🔶 test all the things
yarn test-dev⚡ Guidelines
🔶 Schema splitting
We do not want a huge prisma schema. We want to isolate each model (table or set of tables) in its own file.
🔶 Well documented routes
Let's have a swagger documenting properly exposed routes, that is mainly for each route:
- a description.
- the list of possible responses.
- a definition of the inputs and outputs.
🔶 Full testing coverage
We want to test everything to learn how to properly test, and to face every single difficulty that comes with testing. We will at very least do end to end using superagent, controllers testing, service testing.
🔶 No testing against the database
All tests should run without any interaction with a database.
⚡ Database Schema
⚡ Subjects
🔶 Authentication
Let's use passport to setup jwt based authentication.
🚀 Routes
Two routes were defined to demonstrate the use case:
| Route | Description | Documentation |
|---|---|---|
| POST /users/login | The login route | Link |
| GET /users/profile | Logged user profile retrieval | Link |
📚 Mock data
We have two users in database to play with the routes:
- alice@cool.org / alice
- bob@cool.org / bob
🧪 Tests
✅ e2e✅ controllers✅ services✅ local passport strategy
🔶 CRUD
Let's create CRUD routes to manage a list of books. We want to make sure to give a proper feedback when foreign keys violations do occur (when we try to delete an entry whose key is referenced in another table or when we try to update an entry with a foreign key that does not exist). Let's use filters for that!
🚀 Routes
| Route | Description | Documentation |
|---|---|---|
| GET /books | Retrieves all books | Link |
| GET /authors | Retrieves all authors | Link |
| GET /authors/{id}/books | Retrieves the book written by an author | Link |
| POST /books | Creates a book | Link |
| POST /authors | Creates an author | Link |
| PUT /books/{id} | Updates a book | Link |
| PUT /authors/{id} | Updates an author | Link |
| DELETE /books/{id} | Deletes a book | Link |
| DELETE /authors/{id} | Deletes an author | Link |
🧪 Tests
✅ e2e✅ controllers (turns out these are pretty much useless since we mock the service)✅ services✅ validation pipe✅ filters