Home music library

Downloading

git clone [email protected]:bitbybit/nodejs2024Q3-service.git

Set ENV variables

cp .env.example .env

Log level

LOG_LEVEL=debug

Possible values: log, error, warn, debug, verbose

Running application

docker-compose up -d
docker-compose exec app npm run migration:run

After starting the app on port (4000 as default) you can open in your browser OpenAPI documentation by typing http://localhost:4000/doc/. For more information about OpenAPI/Swagger please visit https://swagger.io/.

Vulnerabilities scanning

docker-compose exec app npm audit

Testing

After application running open new terminal and enter:

To run all tests without authorization

docker-compose exec app npm run test

To run only one of all test suites

docker-compose exec app npm run test -- <path to suite>

To run all test with authorization

docker-compose exec app npm run test:auth

To run only specific test suite with authorization

docker-compose exec app npm run test:auth -- <path to suite>

Auto-fix and format

docker-compose exec app npm run lint

docker-compose exec app npm run format

Description

Users can create, read, update, delete data about Artists, Tracks and Albums, add them to Favorites.

• User:

  interface User {
    id: string; // uuid v4
    login: string;
    password: string;
    version: number; // integer number, increments on update
    createdAt: number; // timestamp of creation
    updatedAt: number; // timestamp of last update
  }

• Artist:

  interface Artist {
    id: string; // uuid v4
    name: string;
    grammy: boolean;
  }

• Track:

  interface Track {
    id: string; // uuid v4
    name: string;
    artistId: string | null; // refers to Artist
    albumId: string | null; // refers to Album
    duration: number; // integer number
  }

• Album:

  interface Album {
    id: string; // uuid v4
    name: string;
    year: number;
    artistId: string | null; // refers to Artist
  }

• Favorites:

  interface Favorites {
    artists: string[]; // favorite artists ids
    albums: string[]; // favorite albums ids
    tracks: string[]; // favorite tracks ids
  }

Details:

1. For Users, Artists, Albums, Tracks and Favorites REST endpoints with separate router paths

• Users (/user route)

  • GET /user - get all users
    • Server answer with status code 200 and all users records
  • GET /user/:id - get single user by id
    • Server answer with status code 200 and record with id === userId if it exists
    • Server answer with status code 400 and corresponding message if userId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === userId doesn't exist
  • POST /user - create user CreateUserDto

        interface CreateUserDto {
          login: string;
          password: string;
        }

    • Server answer with status code 201 and newly created record if request is valid
    • Server answer with status code 400 and corresponding message if request body does not contain required fields
  • PUT /user/:id - update user's password UpdatePasswordDto:

    interface UpdatePasswordDto {
      oldPassword: string; // previous password
      newPassword: string; // new password
    }

    • Server answer with status code 200 and updated record if request is valid
    • Server answer with status code 400 and corresponding message if userId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === userId doesn't exist
    • Server answer with status code 403 and corresponding message if oldPassword is wrong
  • DELETE /user/:id - delete user
    • Server answer with status code 204 if the record is found and deleted
    • Server answer with status code 400 and corresponding message if userId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === userId doesn't exist

• Tracks (/track route)

  • GET /track - get all tracks
    • Server answer with status code 200 and all tracks records
  • GET /track/:id - get single track by id
    • Server answer with status code 200 and record with id === trackId if it exists
    • Server answer with status code 400 and corresponding message if trackId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === trackId doesn't exist
  • POST /track - create new track
    • Server answer with status code 201 and newly created record if request is valid
    • Server answer with status code 400 and corresponding message if request body does not contain required fields
  • PUT /track/:id - update track info
    • Server answer with status code 200 and updated record if request is valid
    • Server answer with status code 400 and corresponding message if trackId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === trackId doesn't exist
  • DELETE /track/:id - delete track
    • Server answer with status code 204 if the record is found and deleted
    • Server answer with status code 400 and corresponding message if trackId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === trackId doesn't exist

• Artists (/artist route)

  • GET /artist - get all artists
    • Server answer with status code 200 and all artists records
  • GET /artist/:id - get single artist by id
    • Server answer with status code 200 and record with id === artistId if it exists
    • Server answer with status code 400 and corresponding message if artistId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === artistId doesn't exist
  • POST /artist - create new artist
    • Server answer with status code 201 and newly created record if request is valid
    • Server answer with status code 400 and corresponding message if request body does not contain required fields
  • PUT /artist/:id - update artist info
    • Server answer with status code 200 and updated record if request is valid
    • Server answer with status code 400 and corresponding message if artist is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === artistId doesn't exist
  • DELETE /artist/:id - delete album
    • Server answer with status code 204 if the record is found and deleted
    • Server answer with status code 400 and corresponding message if artistId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === artistId doesn't exist

• Albums (/album route)

  • GET /album - get all albums
    • Server answer with status code 200 and all albums records
  • GET /album/:id - get single album by id
    • Server answer with status code 200 and record with id === albumId if it exists
    • Server answer with status code 400 and corresponding message if albumId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === albumId doesn't exist
  • POST /album - create new album
    • Server answer with status code 201 and newly created record if request is valid
    • Server answer with status code 400 and corresponding message if request body does not contain required fields
  • PUT /album/:id - update album info
    • Server answer with status code 200 and updated record if request is valid
    • Server answer with status code 400 and corresponding message if albumId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === albumId doesn't exist
  • DELETE /album/:id - delete album
    • Server answer with status code 204 if the record is found and deleted
    • Server answer with status code 400 and corresponding message if albumId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if record with id === albumId doesn't exist

• Favorites

  • GET /favs - get all favorites
    • Server answer with status code 200 and all favorite records (not their ids), split by entity type:

    interface FavoritesResponse{
      artists: Artist[];
      albums: Album[];
      tracks: Track[];
    }

  • POST /favs/track/:id - add track to the favorites
    • Server answer with status code 201 and corresponding message if track with id === trackId exists
    • Server answer with status code 400 and corresponding message if trackId is invalid (not uuid)
    • Server answer with status code 422 and corresponding message if track with id === trackId doesn't exist
  • DELETE /favs/track/:id - delete track from favorites
    • Server answer with status code 204 if the track was in favorites and now it's deleted id is found and deleted
    • Server answer with status code 400 and corresponding message if trackId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if corresponding track is not favorite
  • POST /favs/album/:id - add album to the favorites
    • Server answer with status code 201 and corresponding message if album with id === albumId exists
    • Server answer with status code 400 and corresponding message if albumId is invalid (not uuid)
    • Server answer with status code 422 and corresponding message if album with id === albumId doesn't exist
  • DELETE /favs/album/:id - delete album from favorites
    • Server answer with status code 204 if the album was in favorites and now it's deleted id is found and deleted
    • Server answer with status code 400 and corresponding message if albumId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if corresponding album is not favorite
  • POST /favs/artist/:id - add artist to the favorites
    • Server answer with status code 201 and corresponding message if artist with id === artistId exists
    • Server answer with status code 400 and corresponding message if artistId is invalid (not uuid)
    • Server answer with status code 422 and corresponding message if artist with id === artistId doesn't exist
  • DELETE /favs/artist/:id - delete artist from favorites
    • Server answer with status code 204 if the artist was in favorites and now it's deleted id is found and deleted
    • Server answer with status code 400 and corresponding message if artistId is invalid (not uuid)
    • Server answer with status code 404 and corresponding message if corresponding artist is not favorite

• Signup (auth/signup route)

  • POST auth/signup - send login and password to create a new user
    • Server answer with status code 201 and corresponding message if dto is valid
    • Server answer with status code 400 and corresponding message if dto is invalid (no login or password, or they are not a strings)

• Login (auth/login route)

  • POST auth/login - send login and password to get Access token and Refresh token (optionally)
    • Server answer with status code 200 and tokens if dto is valid
    • Server answer with status code 400 and corresponding message if dto is invalid (no login or password, or they are not a strings)
    • Server answer with status code 403 and corresponding message if authentication failed (no user with such login, password doesn't match actual one, etc.)

• Refresh (auth/refresh route)

  • POST auth/refresh - send refresh token in body as { refreshToken } to get a new pair of Access token and Refresh token
    • Server answer with status code 200 and tokens in body if dto is valid
    • Server answer with status code 401 and corresponding message if dto is invalid (no refreshToken in body)
    • Server answer with status code 403 and corresponding message if authentication failed (Refresh token is invalid or expired)