Mobicoop V3 user service
Go to file
Sylvain Briat 4a8460318e Merge branch 'fixTests' into 'main'
Fix tests

See merge request v3/service/user!47
2023-10-19 12:28:18 +00:00
ci lint pretty 2023-03-30 10:57:22 +02:00
prisma fix prisma schema & generate 2023-10-17 16:15:17 +02:00
src fix bad domain event test 2023-10-19 14:24:59 +02:00
.dockerignore remove pgadmin 2022-12-26 09:45:20 +01:00
.editorconfig initial commit 2022-12-13 13:39:06 +01:00
.env.dist update packages, clean code 2023-10-17 11:41:12 +02:00
.env.test change test db 2023-03-20 10:36:53 +01:00
.eslintrc.js lint pretty 2023-03-30 10:57:22 +02:00
.gitignore remove tools --check 2023-03-17 10:22:03 +01:00
.gitlab-ci.yml update ci to push version and latest 2023-04-05 12:20:19 +02:00
.prettierignore lint pretty 2023-03-30 10:57:22 +02:00
.prettierrc.json lint pretty 2023-03-30 10:57:22 +02:00
Dockerfile clean using es6 2023-05-05 16:56:30 +02:00
LICENSE initial commit 2022-12-13 13:39:06 +01:00
README.md update readme 2023-07-24 15:48:03 +02:00
docker-compose.ci.service.yml clean compose 2023-02-28 11:19:28 +01:00
docker-compose.ci.tools.yml simplify test ci --check 2023-03-17 11:03:08 +01:00
docker-compose.yml improve tests 2023-04-04 10:17:57 +02:00
jest-e2e.json initial commit 2022-12-13 13:39:06 +01:00
nest-cli.json prsima, grpc 2022-12-13 18:00:07 +01:00
package-lock.json 1.3.1 2023-10-19 14:25:05 +02:00
package.json 1.3.1 2023-10-19 14:25:05 +02:00
tsconfig.build.json initial commit 2022-12-13 13:39:06 +01:00
tsconfig.json update packages, clean code 2023-10-17 11:41:12 +02:00

README.md

Mobicoop V3 - User Service

User-related data management.

Requirements

You need Docker and its compose plugin.

You also need NodeJS installed locally : we strongly advise to install Node Version Manager and use the latest LTS version of Node (check that your local version matches with the one used in the Dockerfile).

The API will run inside a docker container, but the install itself is made outside the container, because during development we need tools that need to be available locally (eg. ESLint, Prettier...).

A RabbitMQ instance is also required to send / receive messages when data has been inserted/updated/deleted.

Installation

  • copy .env.dist to .env :

    cp .env.dist .env
    

    Modify it if needed.

  • install the dependencies :

    npm install
    
  • start the containers :

    docker compose up -d
    

    The app runs automatically on port 5001.

Database migration

Before using the app, you need to launch the database migration (it will be launched inside the container) :

npm run migrate

Usage

The app exposes the following gRPC services :

  • FindById : find a user by its id

    {
        "id": "80126a61-d128-4f96-afdb-92e33c75a3e1"
    }
    
  • Create : create a user

    {
        "email": "jezabel.doe@email.com",
        "firstName": "Jezabel",
        "lastName": "Doe",
        "phone": "+33611223344"
    }
    
  • Update : update a user

    {
        "firstName": "Jezabel-Katarina",
        "email": "jezabel-katarina.doe@email.com",
        "id": "30f49838-3f24-42bb-a489-8ffb480173ae"
    }
    
  • Delete : delete a user by its id

    {
        "id": "80126a61-d128-4f96-afdb-92e33c75a3e1"
    }
    

Messages

As mentionned earlier, RabbitMQ messages are sent after these events :

  • Create (message : the created user informations)

  • Update (message : the updated user informations)

  • Delete (message : the id of the deleted user)

Various messages are also sent for logging purpose.

Tests / ESLint / Prettier

Tests are run outside the container for ease of use (switching between different environments inside containers using prisma is complicated and error prone). The integration tests use a dedicated database (see db-test section of docker-compose.yml).

# run all tests (unit + integration)
npm run test

# unit tests only
npm run test:unit

# integration tests only
npm run test:integration

# coverage
npm run test:cov

# ESLint
npm run lint

# Prettier
npm run pretty

License

Mobicoop V3 - User Service is AGPL licensed.