Mobicoop V3 user service
Go to file
Romain Thouvenin 0a92d93949 Add REPL bootstrapper and associated npm command 2024-02-14 12:25:17 +01:00
.gitlab/merge_request_templates copy file from v3 gitlab template repo 2024-02-05 19:15:57 +01:00
ci use node lts image for docker 2024-01-22 16:57:44 +01:00
prisma fix prisma schema & generate 2023-10-17 16:15:17 +02:00
src Add REPL bootstrapper and associated npm command 2024-02-14 12:25:17 +01: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 secure broker 2023-12-18 16:08:26 +01: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 Improve security : add sast and secret detection in gitlab ci 2023-11-06 08:59:15 +01:00
.prettierignore copy file from v3 gitlab template repo 2024-02-05 19:15:57 +01:00
.prettierrc.json lint pretty 2023-03-30 10:57:22 +02:00
Dockerfile use node lts image for docker 2024-01-22 16:57:44 +01:00
LICENSE initial commit 2022-12-13 13:39:06 +01:00
README.md find all users by ids 2023-11-22 16:21:10 +01: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.5.2 2024-01-16 14:38:27 +01:00
package.json Add REPL bootstrapper and associated npm command 2024-02-14 12:25:17 +01: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"
    }
    
  • FindAllByIds : find all users for the given ids

    {
        "ids": [
            "80126a61-d128-4f96-afdb-92e33c75a3e1",
            "80126a61-d128-4f96-afdb-92e33c75a3e2",
            "80126a61-d128-4f96-afdb-92e33c75a3e3"
        ]
    }
    
  • 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.