refactor: Refactor backend (#63)

* refactor: clean legacy error handler

* refactor: rename utils folder to helpers

* feat: implement handlePrismaError

* fix: type error

* fix: remove dots

* docs: update delete api doc

* docs: update delete api doc

* fix: handle not handled prisma errors

* feat: add P2000 error

* docs: update create vault doc

* refactor: use StatusCodes

* refactor: move errors into shared

* refactor: add typing for handleApiRequest

* revert: re-move HttpError in backend

* revert: re-move HttpError in backend

* feat: create InternalServerError

* feat: implement new error handling

* docs: add doc comment

* refactor: rewrite errors dto

* feat: Rewrite DTO (bodies, data, responses, errors)

* fix: data doc

* fix: api typing

* fix: api docs typing

* fix: api docs typing

* feat: implement new error handling in ui

* fix: error message display in modal

* refactor: improve requests services

* refactor: improve requests services

* fix: body already consumed

* Revert "fix: body already consumed"

This reverts commit 683dc05.

* Revert "refactor: improve requests services"

This reverts commit 548de72.

* Revert "refactor: improve requests services"

This reverts commit c40df33.

* fix: json parsing error while deleting

* fix: remove length limit on secret on db

* feat: implement VaultAlreadyExistsError

* fix: async on parsing json on request service

* refactor: get status of response in frontend

* refactor: define options and params

* refactor: tidy up dto by input or output

* chore(linter): improve 'no-restricted-imports'

* feat: add createdAt in vault table

* feat: order the vaults list by creation date

* feat: create Logger

* feat: make Logger static

* fix: set LoggerTagEnum to string

* refactor: use Logger in api

* refactor: use Logger in UI

* refactor: create ApiLogger & UiLogger

* refactor: add error objects in console errors

* style: remove prefix in ui logger

* fix: linter

* fix: error message tests

* fix: handleApiRequest tests

* fix: useApi tests

* fix: RequestService tests

* test: Create Logger tests

* fix: Rename utils to helpers in tests

* fix: Move request.service.test.ts to abstract folder in tests

* test: Create ApiLogger

* test: Create UiLogger tests

* fix: linter

* fix: linter

* fix: linter in request service test

* fix: linter in request logger

* fix: linter in api logger

* fix: linter in handleApiRequest

* fix: typo

* fix: useless tag

* fix: logger tests

* fix: api logger tests

* fix: ui logger tests

* fix: handleApiRequest tests

* fix: ApiLogger tests

* fix: handleApiRequest tests

* style: Format ESLint

Author: vbetsch

eslint.config.mjs

@@ -169,7 +169,7 @@ export default tseslint.config(
         'no-restricted-imports': [
           'error',
           {
-            patterns: ['@api/*'],
+            patterns: ['@api/*', '@prisma/*'],
           },
         ],
       },
@@ -187,6 +187,18 @@ export default tseslint.config(
       },
     },
 
+    {
+      files: ['src/modules/shared/**/*.{ts,tsx}'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          {
+            patterns: ['@api/*', '@ui/*', '@prisma/*'],
+          },
+        ],
+      },
+    },
+
     {
       files: ['**/*.test.ts', '**/*.spec.ts', '**/*.test.tsx', '**/*.spec.tsx'],
       plugins: { jest: eslintPluginJest },

prisma/migrations/20250802221429_remove_secret_length_limit/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Vault" ALTER COLUMN "secret" SET DATA TYPE TEXT;

prisma/migrations/20250802234042_add_vault_creation_date/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Vault" ADD COLUMN     "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;

prisma/schema.prisma

@@ -9,7 +9,8 @@ datasource db {
 }
 
 model Vault {
-  uuid   String @id @default(uuid())
-  label  String @db.VarChar(255)
-  secret String @db.VarChar(255)
+  uuid      String   @id @default(uuid())
+  label     String   @db.VarChar(255)
+  secret    String
+  createdAt DateTime @default(now())
 }

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

@@ -1,10 +1,11 @@
 import 'reflect-metadata';
 import type { NextRequest, NextResponse } from 'next/server';
-import type { IdParam } from '@shared/dto/params/id.param';
 import { container } from 'tsyringe';
-import { handleApiRequest } from '@api/utils/handle-api-request';
+import { handleApiRequest } from '@api/helpers/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';
+import type { HttpOptions } from '@shared/dto/input/options/abstract/http-options';
 
 /**
  * @swagger
@@ -24,22 +25,26 @@ import { DeleteVaultUseCase } from '@api/usecases/vaults/delete-vault.usecase';
  *       204:
  *         description: The vault has been successfully deleted
  *       404:
- *         description: Vault not found
+ *         description: Resource not found
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/HttpErrorDto'
  *       500:
  *         description: Internal Server Error
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/HttpResponseDto'
+ *               $ref: '#/components/schemas/HttpErrorDto'
  */
 export async function DELETE(
   request: NextRequest,
-  params: IdParam
+  options: HttpOptions<CreateVaultParams>
 ): Promise<NextResponse> {
   const deleteVaultUseCase: DeleteVaultUseCase =
     container.resolve(DeleteVaultUseCase);
-  return await handleApiRequest(
-    () => deleteVaultUseCase.handle(params),
+  return await handleApiRequest<void>(
+    async () => deleteVaultUseCase.handle(await options.params),
     StatusCodes.NO_CONTENT
   );
 }

src/app/api/vaults/route.ts

@@ -1,14 +1,15 @@
 import 'reflect-metadata';
 import type { NextRequest, NextResponse } from 'next/server';
 import { container } from 'tsyringe';
-import { handleApiRequest } from '@api/utils/handle-api-request';
+import { handleApiRequest } from '@api/helpers/handle-api-request';
 import type { VaultModelDto } from '@shared/dto/models/vault.model.dto';
-import type { CreateVaultResponseDto } from '@shared/dto/responses/create-vault.response.dto';
 import { CreateVaultUseCase } from '@api/usecases/vaults/create-vault.usecase';
-import type { GetMyVaultsResponseDto } from '@shared/dto/responses/get-my-vaults.response.dto';
 import { GetMyVaultsUseCase } from '@api/usecases/vaults/get-my-vaults.usecase';
-import type { CreateVaultRequestDto } from '@shared/dto/requests/create-vault.request.dto';
+import type { CreateVaultRequestDto } from '@shared/dto/input/requests/create-vault.request.dto';
 import { StatusCodes } from 'http-status-codes';
+import type { CreateVaultDataDto } from '@shared/dto/output/data/create-vault.data.dto';
+import type { GetMyVaultsDataDto } from '@shared/dto/output/data/get-my-vaults.data.dto';
+import type { HttpResponseDto } from '@shared/dto/output/responses/abstract/http.response.dto';
 
 /**
  * @swagger
@@ -23,20 +24,22 @@ import { StatusCodes } from 'http-status-codes';
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/GetMyVaultsResponseDto'
+ *               $ref: '#/components/schemas/GetMyVaultsBodyDto'
  *       500:
  *         description: Internal Server Error
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/HttpResponseDto'
+ *               $ref: '#/components/schemas/HttpErrorDto'
  */
-export async function GET(): Promise<NextResponse> {
+export async function GET(): Promise<
+  NextResponse<HttpResponseDto<GetMyVaultsDataDto>>
+> {
   const getMyVaultsUseCase: GetMyVaultsUseCase =
     container.resolve(GetMyVaultsUseCase);
-  return await handleApiRequest(async () => {
+  return await handleApiRequest<GetMyVaultsDataDto>(async () => {
     const myVaults: VaultModelDto[] = await getMyVaultsUseCase.handle();
-    const response: GetMyVaultsResponseDto = { myVaults };
+    const response: GetMyVaultsDataDto = { myVaults };
     return response;
   });
 }
@@ -60,21 +63,29 @@ export async function GET(): Promise<NextResponse> {
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/CreateVaultResponseDto'
+ *               $ref: '#/components/schemas/CreateVaultBodyDto'
+ *       400:
+ *         description: One of the requested values is too long
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/HttpErrorDto'
  *       500:
  *         description: Internal Server Error
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/HttpResponseDto'
+ *               $ref: '#/components/schemas/HttpErrorDto'
  */
-export async function POST(request: NextRequest): Promise<NextResponse> {
+export async function POST(
+  request: NextRequest
+): Promise<NextResponse<HttpResponseDto<CreateVaultDataDto>>> {
   const params: CreateVaultRequestDto = await request.json();
   const createVaultUseCase: CreateVaultUseCase =
     container.resolve(CreateVaultUseCase);
-  return await handleApiRequest(async () => {
+  return await handleApiRequest<CreateVaultDataDto>(async () => {
     const vaultCreated: VaultModelDto = await createVaultUseCase.handle(params);
-    const response: CreateVaultResponseDto = { vaultCreated };
+    const response: CreateVaultDataDto = { vaultCreated };
     return response;
   }, StatusCodes.CREATED);
 }

src/app/ui/workspace/page.tsx

@@ -8,7 +8,6 @@ import ErrorMessage from '@ui/components/common/ErrorMessage';
 import CircularLoader from '@ui/components/common/CircularLoader';
 import { VaultsGateway } from '@ui/gateways/vaults.gateway';
 import { container } from 'tsyringe';
-import type { GetMyVaultsResponseDto } from '@shared/dto/responses/get-my-vaults.response.dto';
 import { useApi } from '@ui/hooks/useApi';
 import {
   Box,
@@ -23,6 +22,8 @@ import {
   Typography,
 } from '@mui/material';
 import AddVaultModal from '@ui/components/modals/AddVaultModal';
+import type { GetMyVaultsDataDto } from '@shared/dto/output/data/get-my-vaults.data.dto';
+import { UiLogger } from '@ui/logs/ui.logger';
 
 export default function WorkspacePage(): JSX.Element {
   const [vaults, setVaults] = useState<VaultModelDto[]>([]);
@@ -31,7 +32,7 @@ export default function WorkspacePage(): JSX.Element {
   const [deleteLoading, setDeleteLoading] = useState(false);
   const vaultsGateway: VaultsGateway = container.resolve(VaultsGateway);
 
-  const { loading } = useApi<GetMyVaultsResponseDto>({
+  const { loading } = useApi<GetMyVaultsDataDto>({
     request: () => vaultsGateway.getMyVaults(),
     onSuccess: data => setVaults(data.myVaults),
     onError: error => setError(error),
@@ -53,7 +54,7 @@ export default function WorkspacePage(): JSX.Element {
       await vaultsGateway.deleteVault(id);
     } catch (error) {
       if (error instanceof Error) setError(error);
-      else console.error('Unhandled API error:', error);
+      else UiLogger.error('Unhandled API error: ', error);
     } finally {
       setDeleteLoading(false);
     }

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

@@ -0,0 +1,8 @@
+import { HttpError } from '@api/errors/abstract/http-error';
+import { StatusCodes } from 'http-status-codes';
+
+export class InternalServerError extends HttpError {
+  public constructor() {
+    super('Internal Server Error', StatusCodes.INTERNAL_SERVER_ERROR);
+  }
+}

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

@@ -0,0 +1,8 @@
+import { HttpError } from '@api/errors/abstract/http-error';
+import { StatusCodes } from 'http-status-codes';
+
+export class InvalidRequestDataError extends HttpError {
+  public constructor() {
+    super('Invalid request data', StatusCodes.BAD_REQUEST);
+  }
+}

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

@@ -0,0 +1,8 @@
+import { HttpError } from '@api/errors/abstract/http-error';
+import { StatusCodes } from 'http-status-codes';
+
+export class RequestedValueTooLongError extends HttpError {
+  public constructor() {
+    super('One of the requested values is too long', StatusCodes.BAD_REQUEST);
+  }
+}