Mobicoop V3 - User Service

User-related data management.

Requirements

You need Docker and Docker-compose.

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

and modify it to suit your needs.

Then execute :

docker-compose up -d

The app runs automatically on the port defined in SERVICE_PORT of .env file (default : 5001).

Database migration

Before using the app, you need to launch the database migration :

docker exec v3-user sh -c "npx prisma migrate dev"

Usage

The app exposes the following gRPC services :

• FindByUuid : find a user by its uuid

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

• FindAll : find all users; you can use pagination with page (default:1) and perPage (default:10)

  {
      "page": 1,
      "perPage": 10
  }
  

• Create : create a user (note that uuid is optional, a uuid will be automatically attributed if it is not provided)

  {
      "email": "jezabel.doe@email.com",
      "firstName": "Jezabel",
      "lastName": "Doe",
      "phone": "+33611223344"
  }
  

• Update : update a user

  {
      "firstName": "Jezabel-Katarina",
      "email": "jezabel-katarina.doe@email.com",
      "uuid": "30f49838-3f24-42bb-a489-8ffb480173ae"
  }
  

• Delete : delete a user by its uuid

  {
      "uuid": "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 uuid of the deleted user)

Various messages are also sent for logging purpose.

Test

# unit tests
docker exec v3-user sh -c "npm run test"

# test coverage
docker exec v3-user sh -c "npm run test:cov"

Note : you can run all npm commands directly outside the container (see scripts section of package.json for available commands), but you need NodeJS installed locally. We strongly advise to install Node Version Manager and use the latest LTS version of Node.

License

Mobicoop V3 - User Service is AGPL licensed.