[LOCKLITE-104] Refactor error handling

eslint.config.mjs

@@ -111,6 +111,8 @@ export default tseslint.config(
         ],
 
         /* TypeScript strictness */
+        '@typescript-eslint/no-use-before-define': ['error'],
+        '@typescript-eslint/no-unnecessary-condition': ['error'],
         '@typescript-eslint/adjacent-overload-signatures': 'warn',
         '@typescript-eslint/class-literal-property-style': ['warn', 'fields'],
         '@typescript-eslint/consistent-type-imports': [

src/app/api/layout.tsx

@@ -1,7 +1,7 @@
 import type { JSX } from 'react';
 import React from 'react';
 import type { Metadata } from 'next';
-import type { SharedLayoutProps } from '@shared/types/props/SharedLayoutProps';
+import type { SharedLayoutProps } from '@shared/props/SharedLayoutProps';
 
 export const metadata: Metadata = {
   title: 'LockLite API',

src/app/api/vaults/[id]/route.ts

@@ -1,7 +1,7 @@
 import 'reflect-metadata';
 import type { NextRequest, NextResponse } from 'next/server';
 import { container } from 'tsyringe';
-import { handleApiRequest } from '@api/helpers/handle-api-request';
+import { handleApiRequest } from '@api/helpers/api/handle-api-request';
 import { StatusCodes } from 'http-status-codes';
 import { DeleteVaultUseCase } from '@api/usecases/vaults/delete-vault.usecase';
 import type { CreateVaultParams } from '@shared/dto/input/params/create-vault.params';

src/app/api/vaults/route.ts

@@ -1,7 +1,7 @@
 import 'reflect-metadata';
 import type { NextRequest, NextResponse } from 'next/server';
 import { container } from 'tsyringe';
-import { handleApiRequest } from '@api/helpers/handle-api-request';
+import { handleApiRequest } from '@api/helpers/api/handle-api-request';
 import type { VaultModelDto } from '@shared/dto/models/vault.model.dto';
 import { CreateVaultUseCase } from '@api/usecases/vaults/create-vault.usecase';
 import { GetMyVaultsUseCase } from '@api/usecases/vaults/get-my-vaults.usecase';
@@ -64,8 +64,14 @@ export async function GET(): Promise<
  *           application/json:
  *             schema:
  *               $ref: '#/components/schemas/CreateVaultBodyDto'
- *       400:
- *         description: One of the requested values is too long
+ *       409:
+ *         description: Vault already exists
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/HttpErrorDto'
+ *       422:
+ *         description: The vault label must not exceed 255 characters
  *         content:
  *           application/json:
  *             schema:

src/app/ui/layout.tsx

@@ -4,7 +4,7 @@ import React from 'react';
 import ThemeRegistry from '@ui/providers/ThemeRegistry';
 import { AppBar, Container, Toolbar, Typography } from '@mui/material';
 import PageContainer from '@ui/components/common/PageContainer';
-import type { SharedLayoutProps } from '@shared/types/props/SharedLayoutProps';
+import type { SharedLayoutProps } from '@shared/props/SharedLayoutProps';
 
 export const metadata: Metadata = {
   title: {

src/app/ui/workspace/layout.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import type { JSX } from 'react';
-import type { SharedLayoutProps } from '@shared/types/props/SharedLayoutProps';
+import type { SharedLayoutProps } from '@shared/props/SharedLayoutProps';
 
 export default function WorkspaceLayout(props: SharedLayoutProps): JSX.Element {
   return <>{props.children}</>;

src/modules/api/errors/business/vaults/vault-already-exists.error.ts

@@ -0,0 +1,13 @@
+import { StatusCodes } from 'http-status-codes';
+import { BusinessError } from '@shared/errors/business-error';
+import { BusinessErrorCodeEnumDto } from '@shared/dto/output/errors/business-error-code.enum.dto';
+
+export class VaultAlreadyExistsError extends BusinessError {
+  public constructor(label: string) {
+    super(
+      `Vault with label '${label}' already exists`,
+      StatusCodes.CONFLICT,
+      BusinessErrorCodeEnumDto.VAULT_ALREADY_EXISTS
+    );
+  }
+}

src/modules/api/errors/business/vaults/vault-label-too-long.error.ts

@@ -0,0 +1,13 @@
+import { StatusCodes } from 'http-status-codes';
+import { BusinessError } from '@shared/errors/business-error';
+import { BusinessErrorCodeEnumDto } from '@shared/dto/output/errors/business-error-code.enum.dto';
+
+export class VaultLabelTooLongError extends BusinessError {
+  public constructor() {
+    super(
+      `The vault label must not exceed 255 characters`,
+      StatusCodes.UNPROCESSABLE_ENTITY,
+      BusinessErrorCodeEnumDto.VAULT_LABEL_TOO_LONG
+    );
+  }
+}

src/modules/api/errors/internal-server.error.ts → src/modules/api/errors/http/internal-server.error.ts

@@ -1,4 +1,4 @@
-import { HttpError } from '@api/errors/abstract/http-error';
+import { HttpError } from '@shared/errors/http-error';
 import { StatusCodes } from 'http-status-codes';
 
 export class InternalServerError extends HttpError {

src/modules/api/errors/prisma/invalid-request-data.error.ts → src/modules/api/errors/http/prisma/invalid-request-data.error.ts

@@ -1,4 +1,4 @@
-import { HttpError } from '@api/errors/abstract/http-error';
+import { HttpError } from '@shared/errors/http-error';
 import { StatusCodes } from 'http-status-codes';
 
 export class InvalidRequestDataError extends HttpError {

src/modules/api/errors/prisma/requested-value-too-long.error.ts → src/modules/api/errors/http/prisma/requested-value-too-long.error.ts

@@ -1,4 +1,4 @@
-import { HttpError } from '@api/errors/abstract/http-error';
+import { HttpError } from '@shared/errors/http-error';
 import { StatusCodes } from 'http-status-codes';
 
 export class RequestedValueTooLongError extends HttpError {

src/modules/api/errors/prisma/resource-already-exists.error.ts → src/modules/api/errors/http/prisma/resource-already-exists.error.ts

@@ -1,4 +1,4 @@
-import { HttpError } from '@api/errors/abstract/http-error';
+import { HttpError } from '@shared/errors/http-error';
 import { StatusCodes } from 'http-status-codes';
 
 export class ResourceAlreadyExistsError extends HttpError {

src/modules/api/errors/prisma/resource-not-found.error.ts → src/modules/api/errors/http/prisma/resource-not-found.error.ts

@@ -1,4 +1,4 @@
-import { HttpError } from '@api/errors/abstract/http-error';
+import { HttpError } from '@shared/errors/http-error';
 import { StatusCodes } from 'http-status-codes';
 
 export class ResourceNotFoundError extends HttpError {

src/modules/api/helpers/handle-api-request.ts → src/modules/api/helpers/api/handle-api-request.ts

@@ -1,8 +1,10 @@
-import { HttpError } from '@api/errors/abstract/http-error';
+import { HttpError } from '@shared/errors/http-error';
 import { StatusCodes } from 'http-status-codes';
 import { NextResponse } from 'next/server';
 import type { HttpResponseDto } from '@shared/dto/output/responses/abstract/http.response.dto';
 import { ApiLogger } from '@api/logs/api.logger';
+import { InternalServerError } from '@api/errors/http/internal-server.error';
+import { BusinessError } from '@shared/errors/business-error';
 
 export async function handleApiRequest<Data>(
   callback: () => Promise<Data>,
@@ -22,17 +24,22 @@ export async function handleApiRequest<Data>(
       }
     );
   } catch (error: unknown) {
+    let httpError: HttpError;
     if (error instanceof HttpError) {
-      return NextResponse.json(
-        { error: error.message },
-        { status: error.status }
-      );
+      httpError = error;
+      if (error instanceof BusinessError) {
+        return NextResponse.json(
+          { error: { message: httpError.message, code: error.code } },
+          { status: httpError.status }
+        );
+      }
+    } else {
+      ApiLogger.error('Error while handling API errors: ', error);
+      httpError = new InternalServerError();
     }
-
-    ApiLogger.error('Error while handling API errors: ', error);
     return NextResponse.json(
-      { error: 'Internal Server Error' },
-      { status: StatusCodes.INTERNAL_SERVER_ERROR }
+      { error: { message: httpError.message } },
+      { status: httpError.status }
     );
   }
 }

src/modules/api/helpers/prisma/handle-prisma-errors.ts

@@ -1,10 +1,10 @@
 import type { PrismaErrorLike } from '@api/types/prisma-error-like.type';
-import type { HttpError } from '@api/errors/abstract/http-error';
-import { InternalServerError } from '@api/errors/internal-server.error';
-import { ResourceAlreadyExistsError } from '@api/errors/prisma/resource-already-exists.error';
-import { ResourceNotFoundError } from '@api/errors/prisma/resource-not-found.error';
-import { RequestedValueTooLongError } from '@api/errors/prisma/requested-value-too-long.error';
-import { InvalidRequestDataError } from '@api/errors/prisma/invalid-request-data.error';
+import type { HttpError } from '@shared/errors/http-error';
+import { InternalServerError } from '@api/errors/http/internal-server.error';
+import { ResourceAlreadyExistsError } from '@api/errors/http/prisma/resource-already-exists.error';
+import { ResourceNotFoundError } from '@api/errors/http/prisma/resource-not-found.error';
+import { RequestedValueTooLongError } from '@api/errors/http/prisma/requested-value-too-long.error';
+import { InvalidRequestDataError } from '@api/errors/http/prisma/invalid-request-data.error';
 import { ApiLogger } from '@api/logs/api.logger';
 
 export function handlePrismaError(error: PrismaErrorLike): HttpError {

src/modules/api/usecases/vaults/create-vault.usecase.ts

@@ -5,7 +5,9 @@ import { Vault } from '@prisma/generated';
 import { VaultAdapter } from '@api/adapters/vault.adapter';
 import { VaultsRepository } from '@api/repositories/vaults.repository';
 import { CreateVaultRequestDto } from '@shared/dto/input/requests/create-vault.request.dto';
-import { VaultAlreadyExistsError } from '@api/errors/vault-already-exists.error';
+import { VaultAlreadyExistsError } from '@api/errors/business/vaults/vault-already-exists.error';
+import { RequestedValueTooLongError } from '@api/errors/http/prisma/requested-value-too-long.error';
+import { VaultLabelTooLongError } from '@api/errors/business/vaults/vault-label-too-long.error';
 
 @injectable()
 export class CreateVaultUseCase
@@ -25,7 +27,14 @@ export class CreateVaultUseCase
     if (vaultsFound > 0) {
       throw new VaultAlreadyExistsError(input.label);
     }
-    const vaultCreated: Vault = await this._vaultsRepository.create(input);
+    let vaultCreated: Vault;
+    try {
+      vaultCreated = await this._vaultsRepository.create(input);
+    } catch (error: unknown) {
+      if (error instanceof RequestedValueTooLongError)
+        throw new VaultLabelTooLongError();
+      throw error;
+    }
     return this._vaultAdapter.getDtoFromEntity(vaultCreated);
   }
 }

src/modules/shared/dto/output/errors/business-error-code.enum.dto.ts

@@ -0,0 +1,4 @@
+export enum BusinessErrorCodeEnumDto {
+  VAULT_ALREADY_EXISTS = 'L-409-VAE',
+  VAULT_LABEL_TOO_LONG = 'L-422-VLTL',
+}

src/modules/shared/dto/output/errors/http.error.dto.ts

@@ -1,3 +1,5 @@
+import type { BusinessErrorCodeEnumDto } from '@shared/dto/output/errors/business-error-code.enum.dto';
+
 /**
  * @swagger
  * components:
@@ -6,8 +8,16 @@
  *       type: object
  *       properties:
  *         error:
- *           type: string
+ *           type: object
+ *           properties:
+ *             message:
+ *               type: string
+ *             code:
+ *               type: string
  */
 export type HttpErrorDto = {
-  error: string;
+  error: {
+    message: string;
+    code?: BusinessErrorCodeEnumDto;
+  };
 };

src/modules/shared/errors/business-error.ts

@@ -0,0 +1,20 @@
+import { HttpError } from '@shared/errors/http-error';
+import type { BusinessErrorCodeEnumDto } from '@shared/dto/output/errors/business-error-code.enum.dto';
+
+export class BusinessError extends HttpError {
+  public readonly code: BusinessErrorCodeEnumDto;
+
+  public constructor(
+    message: string,
+    status: number,
+    code: BusinessErrorCodeEnumDto
+  ) {
+    super(message, status);
+    this.code = code;
+    this.name = this.constructor.name;
+  }
+
+  public override toString(): string {
+    return `[${this.code}] ${this.message}`;
+  }
+}

src/modules/shared/errors/http-error.ts

@@ -0,0 +1,13 @@
+export class HttpError extends Error {
+  public readonly status: number;
+
+  public constructor(message: string, status: number) {
+    super(message);
+    this.status = status;
+    this.name = this.constructor.name;
+  }
+
+  public override toString(): string {
+    return `(${this.status}) ${this.message}`;
+  }
+}

src/modules/shared/props/SharedLayoutProps.ts

@@ -0,0 +1,3 @@
+import type { SharedChildrenProps } from '@shared/props/SharedChildrenProps';
+
+export type SharedLayoutProps = SharedChildrenProps;