add prisma

src/modules/database/database.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { PrismaService } from './src/adapters/secondaries/prisma-service';
+import { UserRepository } from './src/domain/user-repository';
+
+@Module({
+  providers: [PrismaService, UserRepository],
+  exports: [PrismaService, UserRepository],
+})
+export class DatabaseModule {}

src/modules/database/src/adapters/secondaries/prisma-repository.abstract.ts

@@ -0,0 +1,163 @@
+import { ConsoleLogger, Injectable } from '@nestjs/common';
+import { PrismaClientKnownRequestError } from '@prisma/client/runtime';
+import { DatabaseException } from '../../exceptions/DatabaseException';
+import { IRepository } from '../../interfaces/repository.interface';
+import { PrismaService } from './prisma-service';
+
+/**
+ * Child classes MUST redefined _model property with appropriate model name
+ */
+@Injectable()
+export abstract class PrismaRepository<T> implements IRepository<T> {
+  protected _model: string;
+  protected _logger: ConsoleLogger = new ConsoleLogger(PrismaRepository.name);
+
+  constructor(protected readonly _prisma: PrismaService) {}
+
+  findAll(where?: any, include?: any): Promise<T[]> {
+    return this._prisma[this._model].findMany({ where, include });
+  }
+
+  async findOneById(id: number, include?: any): Promise<T> {
+    try {
+      const entity = await this._prisma[this._model].findUnique({
+        where: { id },
+      });
+
+      return entity;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(PrismaClientKnownRequestError.name, e.code);
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+
+  async findOneByUuid(uuid: string, include?: any): Promise<T> {
+    try {
+      const entity = await this._prisma[this._model].findUnique({
+        where: { uuid },
+      });
+
+      return entity;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(
+          PrismaClientKnownRequestError.name,
+          e.code,
+          e.message,
+        );
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+
+  async findOne(where: any, include?: any): Promise<T> {
+    try {
+      const entity = await this._prisma[this._model].findFirst({
+        where: where,
+        include: include,
+      });
+
+      return entity;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(PrismaClientKnownRequestError.name, e.code);
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+
+  // TODO : using any is not good, but needed for nested entities
+  // TODO : Refactor for good clean architecture ?
+  async create(entity: Partial<T> | any, include?: any): Promise<T> {
+    try {
+      const res = await this._prisma[this._model].create({
+        data: entity,
+        include: include,
+      });
+
+      return res;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(
+          PrismaClientKnownRequestError.name,
+          e.code,
+          e.message,
+        );
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+
+  async update(uuid: string, entity: Partial<T>, include?: any): Promise<T> {
+    try {
+      const updatedEntity = await this._prisma[this._model].update({
+        where: { uuid },
+        data: entity,
+      });
+
+      return updatedEntity;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(
+          PrismaClientKnownRequestError.name,
+          e.code,
+          e.message,
+        );
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+
+  async updateWhere(
+    where: any,
+    entity: Partial<T> | any,
+    include?: any,
+  ): Promise<T> {
+    try {
+      const updatedEntity = await this._prisma[this._model].update({
+        where: where,
+        data: entity,
+        include: include,
+      });
+
+      return updatedEntity;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(
+          PrismaClientKnownRequestError.name,
+          e.code,
+          e.message,
+        );
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+
+  async delete(uuid: string): Promise<void> {
+    try {
+      const entity = await this._prisma[this._model].delete({
+        where: { uuid },
+      });
+
+      return entity;
+    } catch (e) {
+      if (e instanceof PrismaClientKnownRequestError) {
+        throw new DatabaseException(
+          PrismaClientKnownRequestError.name,
+          e.code,
+          e.message,
+        );
+      } else {
+        throw new DatabaseException();
+      }
+    }
+  }
+}

src/modules/database/src/adapters/secondaries/prisma-service.ts

@@ -0,0 +1,15 @@
+import { INestApplication, Injectable, OnModuleInit } from '@nestjs/common';
+import { PrismaClient } from '@prisma/client';
+
+@Injectable()
+export class PrismaService extends PrismaClient implements OnModuleInit {
+  async onModuleInit() {
+    await this.$connect();
+  }
+
+  async enableShutdownHooks(app: INestApplication) {
+    this.$on('beforeExit', async () => {
+      await app.close();
+    });
+  }
+}

src/modules/database/src/domain/user-repository.ts

@@ -0,0 +1,3 @@
+import { PrismaRepository } from '../adapters/secondaries/prisma-repository.abstract';
+
+export class UserRepository<T> extends PrismaRepository<T> {}

src/modules/database/src/exceptions/DatabaseException.ts

@@ -0,0 +1,25 @@
+export class DatabaseException implements Error {
+  name: string;
+  message: string;
+
+  constructor(
+    private _type: string = 'unknown',
+    private _code: string = '',
+    message?: string,
+  ) {
+    this.name = 'DatabaseException';
+    this.message = message ?? 'An error occured with the database.';
+
+    if (this.message.includes('Unique constraint failed')) {
+      this.message = 'Already exists.';
+    }
+  }
+
+  get type(): string {
+    return this._type;
+  }
+
+  get code(): string {
+    return this._code;
+  }
+}

src/modules/database/src/interfaces/repository.interface.ts

@@ -0,0 +1,9 @@
+export interface IRepository<T> {
+  findAll(params?: any, include?: any): Promise<T[]>;
+  findOne(where: any, include?: any): Promise<T>;
+  findOneByUuid(uuid: string, include?: any): Promise<T>;
+  create(entity: Partial<T> | any, include?: any): Promise<T>;
+  update(uuid: string, entity: Partial<T>, include?: any): Promise<T>;
+  updateWhere(where: any, entity: Partial<T> | any, include?: any): Promise<T>;
+  delete(uuid: string): Promise<void>;
+}

src/modules/database/tests/unit/prisma-repository.spec.ts

@@ -0,0 +1,234 @@
+import { Injectable } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import { PrismaService } from '../../src/adapters/secondaries/prisma-service';
+import { PrismaRepository } from '../../src/adapters/secondaries/prisma-repository.abstract';
+import { DatabaseException } from '../../src/exceptions/DatabaseException';
+
+class FakeEntity {
+  id?: number;
+  uuid?: string;
+  name: string;
+}
+
+let entityId = 2;
+const entityUuid = 'uuid-';
+const entityName = 'name-';
+
+const createRandomEntity = (): FakeEntity => {
+  const entity: FakeEntity = {
+    id: entityId,
+    uuid: `${entityUuid}${entityId}`,
+    name: `${entityName}${entityId}`,
+  };
+
+  entityId++;
+
+  return entity;
+};
+
+const fakeEntityToCreate: FakeEntity = {
+  name: 'test',
+};
+
+const fakeEntityCreated: FakeEntity = {
+  ...fakeEntityToCreate,
+  id: 1,
+  uuid: 'some-uuid',
+};
+
+const fakeEntities: FakeEntity[] = [];
+Array.from({ length: 10 }).forEach(() => {
+  fakeEntities.push(createRandomEntity());
+});
+
+@Injectable()
+class FakePrismaRepository extends PrismaRepository<FakeEntity> {
+  protected _model = 'fake';
+}
+
+class FakePrismaService extends PrismaService {
+  fake: any;
+}
+
+const mockPrismaService = {
+  fake: {
+    findMany: jest.fn().mockImplementation((params?: any) => {
+      if (params?.where?.limit == 1) {
+        return Promise.resolve([fakeEntityCreated]);
+      }
+
+      return Promise.resolve(fakeEntities);
+    }),
+
+    create: jest.fn().mockResolvedValue(fakeEntityCreated),
+
+    findUnique: jest.fn().mockImplementation(async (params?: any) => {
+      let entity;
+
+      if (params?.where?.id) {
+        entity = fakeEntities.find((entity) => entity.id === params?.where?.id);
+      }
+
+      if (params?.where?.uuid) {
+        entity = fakeEntities.find(
+          (entity) => entity.uuid === params?.where?.uuid,
+        );
+      }
+
+      if (!entity) {
+        throw new Error('no entity');
+      }
+
+      return entity;
+    }),
+
+    findFirst: jest.fn().mockImplementation((params?: any) => {
+      if (params?.where?.name) {
+        return Promise.resolve(
+          fakeEntities.find((entity) => entity.name === params?.where?.name),
+        );
+      }
+    }),
+
+    update: jest.fn().mockImplementation((params: any) => {
+      const entity = fakeEntities.find(
+        (entity) => entity.uuid === params.where.uuid,
+      );
+      Object.entries(params.data).map(([key, value]) => {
+        entity[key] = value;
+      });
+
+      return Promise.resolve(entity);
+    }),
+
+    delete: jest.fn().mockImplementation((params: any) => {
+      let found = false;
+
+      fakeEntities.forEach((entity, index) => {
+        if (entity.uuid === params?.where?.uuid) {
+          found = true;
+          fakeEntities.splice(index, 1);
+        }
+      });
+
+      if (!found) {
+        throw new Error();
+      }
+    }),
+  },
+};
+
+describe('PrismaRepository', () => {
+  let fakeRepository: FakePrismaRepository;
+  let prisma: FakePrismaService;
+
+  beforeAll(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        FakePrismaRepository,
+        {
+          provide: PrismaService,
+          useValue: mockPrismaService,
+        },
+      ],
+    }).compile();
+
+    fakeRepository = module.get<FakePrismaRepository>(FakePrismaRepository);
+    prisma = module.get<PrismaService>(PrismaService) as FakePrismaService;
+  });
+
+  it('should be defined', () => {
+    expect(fakeRepository).toBeDefined();
+    expect(prisma).toBeDefined();
+  });
+
+  describe('findAll', () => {
+    it('should return an array of entities', async () => {
+      jest.spyOn(prisma.fake, 'findMany');
+
+      const entities = await fakeRepository.findAll();
+      expect(entities).toBe(fakeEntities);
+    });
+
+    it('should return an array containing only one entity', async () => {
+      jest.spyOn(prisma.fake, 'findMany');
+
+      const entities = await fakeRepository.findAll({ limit: 1 });
+
+      expect(prisma.fake.findMany).toHaveBeenCalledWith({
+        where: { limit: 1 },
+      });
+      expect(entities).toEqual([fakeEntityCreated]);
+    });
+  });
+
+  describe('create', () => {
+    it('should create an entity', async () => {
+      jest.spyOn(prisma.fake, 'create');
+
+      const newEntity = await fakeRepository.create(fakeEntityToCreate);
+      expect(newEntity).toBe(fakeEntityCreated);
+      expect(prisma.fake.create).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe('findOne', () => {
+    it('should find an entity by uuid', async () => {
+      const entity = await fakeRepository.findOneByUuid(fakeEntities[0].uuid);
+      expect(entity).toBe(fakeEntities[0]);
+    });
+
+    it('should throw a DatabaseException if uuid is not found', async () => {
+      await expect(
+        fakeRepository.findOneByUuid('wrong-uuid'),
+      ).rejects.toBeInstanceOf(DatabaseException);
+    });
+  });
+
+  describe('update', () => {
+    it('should update an entity', async () => {
+      const newName = 'random-name';
+
+      await fakeRepository.update(fakeEntities[0].uuid, {
+        name: newName,
+      });
+      expect(fakeEntities[0].name).toBe(newName);
+    });
+
+    it("should throw an exception if an entity doesn't exist", async () => {
+      await expect(
+        fakeRepository.update('fake-uuid', { name: 'error' }),
+      ).rejects.toBeInstanceOf(DatabaseException);
+    });
+  });
+
+  describe('delete', () => {
+    it('should delete an entity', async () => {
+      const savedUuid = fakeEntities[0].uuid;
+
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      const res = await fakeRepository.delete(savedUuid);
+
+      const deletedEntity = fakeEntities.find(
+        (entity) => entity.uuid === savedUuid,
+      );
+      expect(deletedEntity).toBeUndefined();
+    });
+
+    it("should throw an exception if an entity doesn't exist", async () => {
+      await expect(fakeRepository.delete('fake-uuid')).rejects.toBeInstanceOf(
+        DatabaseException,
+      );
+    });
+  });
+
+  describe('findOne', () => {
+    it('should find one entity', async () => {
+      const entity = await fakeRepository.findOne({
+        name: fakeEntities[0].name,
+      });
+
+      expect(entity.name).toBe(fakeEntities[0].name);
+    });
+  });
+});

src/modules/users/adapters/primaries/user.presenter.ts

@@ -0,0 +1,15 @@
+import { AutoMap } from '@automapper/classes';
+
+export class UserPresenter {
+  @AutoMap()
+  uuid: string;
+
+  @AutoMap()
+  firstName: string;
+
+  @AutoMap()
+  lastName: string;
+
+  @AutoMap()
+  email: string;
+}

src/modules/users/adapters/secondaries/users.repository.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+import { UserRepository } from 'src/modules/database/src/domain/user-repository';
+import { User } from '../../domain/entities/user';
+
+@Injectable()
+export class UsersRepository extends UserRepository<User> {
+  protected _model = 'user';
+}

src/modules/users/domain/entities/user.ts

@@ -0,0 +1,18 @@
+import { AutoMap } from '@automapper/classes';
+
+export class User {
+  @AutoMap()
+  uuid: string;
+
+  @AutoMap()
+  firstName: string;
+
+  @AutoMap()
+  lastName: string;
+
+  @AutoMap()
+  email: string;
+
+  @AutoMap()
+  password: string;
+}