find all ads by ids

src/modules/ad/ad.module.ts

@@ -21,8 +21,14 @@ import { PrismaService } from './infrastructure/prisma.service';
 import { MessageBrokerPublisher } from '@mobicoop/message-broker-module';
 import { InputDateTimeTransformer } from './infrastructure/input-datetime-transformer';
 import { OutputDateTimeTransformer } from './infrastructure/output-datetime-transformer';
+import { FindAdsByIdsGrpcController } from './interface/grpc-controllers/find-ads-by-ids.grpc.controller';
+import { FindAdsByIdsQueryHandler } from './core/application/queries/find-ads-by-ids/find-ads-by-ids.query-handler';
 
-const grpcControllers = [CreateAdGrpcController, FindAdByIdGrpcController];
+const grpcControllers = [
+  CreateAdGrpcController,
+  FindAdByIdGrpcController,
+  FindAdsByIdsGrpcController,
+];
 
 const eventHandlers: Provider[] = [
   PublishMessageWhenAdIsCreatedDomainEventHandler,
@@ -30,7 +36,10 @@ const eventHandlers: Provider[] = [
 
 const commandHandlers: Provider[] = [CreateAdService];
 
-const queryHandlers: Provider[] = [FindAdByIdQueryHandler];
+const queryHandlers: Provider[] = [
+  FindAdByIdQueryHandler,
+  FindAdsByIdsQueryHandler,
+];
 
 const mappers: Provider[] = [AdMapper];
 

src/modules/ad/core/application/queries/find-ads-by-ids/find-ads-by-ids.query-handler.ts

@@ -0,0 +1,20 @@
+import { IQueryHandler, QueryHandler } from '@nestjs/cqrs';
+import { AD_REPOSITORY } from '@modules/ad/ad.di-tokens';
+import { AdRepositoryPort } from '../../ports/ad.repository.port';
+import { Inject } from '@nestjs/common';
+import { AdEntity } from '../../../domain/ad.entity';
+import { FindAdsByIdsQuery } from './find-ads-by-ids.query';
+
+@QueryHandler(FindAdsByIdsQuery)
+export class FindAdsByIdsQueryHandler implements IQueryHandler {
+  constructor(
+    @Inject(AD_REPOSITORY)
+    private readonly repository: AdRepositoryPort,
+  ) {}
+  async execute(query: FindAdsByIdsQuery): Promise<AdEntity[]> {
+    return await this.repository.findAllByIds(query.ids, {
+      waypoints: true,
+      schedule: true,
+    });
+  }
+}

src/modules/ad/core/application/queries/find-ads-by-ids/find-ads-by-ids.query.ts

@@ -0,0 +1,10 @@
+import { QueryBase } from '@mobicoop/ddd-library';
+
+export class FindAdsByIdsQuery extends QueryBase {
+  readonly ids: string[];
+
+  constructor(ids: string[]) {
+    super();
+    this.ids = ids;
+  }
+}

src/modules/ad/interface/dtos/ads.response.dto.ts

@@ -0,0 +1,5 @@
+import { AdResponseDto } from './ad.response.dto';
+
+export class AdsResponseDto {
+  readonly ads: readonly AdResponseDto[];
+}

src/modules/ad/interface/grpc-controllers/ad.proto

@@ -4,7 +4,7 @@ package ad;
 
 service AdService {
   rpc FindOneById(AdById) returns (Ad);
-  rpc FindAll(AdFilter) returns (Ads);
+  rpc FindAllByIds(AdsById) returns (Ads);
   rpc Create(Ad) returns (AdById);
   rpc Update(Ad) returns (Ad);
   rpc Delete(AdById) returns (Empty);
@@ -14,6 +14,10 @@ message AdById {
   string id = 1;
 }
 
+message AdsById {
+  repeated string ids = 1;
+}
+
 message Ad {
   string id = 1;
   string userId = 2;
@@ -52,14 +56,8 @@ enum Frequency {
   RECURRENT = 2;
 }
 
-message AdFilter {
-  int32 page = 1;
-  int32 perPage = 2;
-}
-
 message Ads {
-  repeated Ad data = 1;
-  int32 total = 2;
+  repeated Ad ads = 1;
 }
 
 message Empty {}

src/modules/ad/interface/grpc-controllers/dtos/find-ads-by-ids.request.dto.ts

@@ -0,0 +1,7 @@
+import { ArrayMinSize, IsArray } from 'class-validator';
+
+export class FindAdsByIdsRequestDto {
+  @IsArray()
+  @ArrayMinSize(1)
+  ids: string[];
+}

src/modules/ad/interface/grpc-controllers/find-ads-by-ids.grpc.controller.ts

@@ -0,0 +1,42 @@
+import { Controller, UsePipes } from '@nestjs/common';
+import { QueryBus } from '@nestjs/cqrs';
+import { GrpcMethod, RpcException } from '@nestjs/microservices';
+import { AdEntity } from '@modules/ad/core/domain/ad.entity';
+import { AdMapper } from '@modules/ad/ad.mapper';
+import { RpcExceptionCode } from '@mobicoop/ddd-library';
+import { RpcValidationPipe } from '@mobicoop/ddd-library';
+import { GRPC_SERVICE_NAME } from '@src/app.constants';
+import { FindAdsByIdsRequestDto } from './dtos/find-ads-by-ids.request.dto';
+import { AdsResponseDto } from '../dtos/ads.response.dto';
+import { FindAdsByIdsQuery } from '@modules/ad/core/application/queries/find-ads-by-ids/find-ads-by-ids.query';
+
+@UsePipes(
+  new RpcValidationPipe({
+    whitelist: false,
+    forbidUnknownValues: false,
+  }),
+)
+@Controller()
+export class FindAdsByIdsGrpcController {
+  constructor(
+    protected readonly mapper: AdMapper,
+    private readonly queryBus: QueryBus,
+  ) {}
+
+  @GrpcMethod(GRPC_SERVICE_NAME, 'FindAllByIds')
+  async findAllByIds(data: FindAdsByIdsRequestDto): Promise<AdsResponseDto> {
+    try {
+      const ads: AdEntity[] = await this.queryBus.execute(
+        new FindAdsByIdsQuery(data.ids),
+      );
+      return {
+        ads: ads.map((ad: AdEntity) => this.mapper.toResponse(ad)),
+      };
+    } catch (e) {
+      throw new RpcException({
+        code: RpcExceptionCode.UNKNOWN,
+        message: e.message,
+      });
+    }
+  }
+}

src/modules/ad/tests/unit/core/find-ads-by-ids.query-handler.spec.ts

@@ -0,0 +1,105 @@
+import { AD_REPOSITORY } from '@modules/ad/ad.di-tokens';
+import { AdEntity } from '@modules/ad/core/domain/ad.entity';
+import { CreateAdProps, Frequency } from '@modules/ad/core/domain/ad.types';
+import { WaypointProps } from '@modules/ad/core/domain/value-objects/waypoint.value-object';
+import { Test, TestingModule } from '@nestjs/testing';
+import { FindAdsByIdsQueryHandler } from '@modules/ad/core/application/queries/find-ads-by-ids/find-ads-by-ids.query-handler';
+import { FindAdsByIdsQuery } from '@modules/ad/core/application/queries/find-ads-by-ids/find-ads-by-ids.query';
+
+const originWaypointProps: WaypointProps = {
+  position: 0,
+  address: {
+    houseNumber: '5',
+    street: 'Avenue Foch',
+    locality: 'Nancy',
+    postalCode: '54000',
+    country: 'France',
+    coordinates: {
+      lat: 48.689445,
+      lon: 6.17651,
+    },
+  },
+};
+const destinationWaypointProps: WaypointProps = {
+  position: 1,
+  address: {
+    locality: 'Paris',
+    postalCode: '75000',
+    country: 'France',
+    coordinates: {
+      lat: 48.8566,
+      lon: 2.3522,
+    },
+  },
+};
+const baseCreateAdProps = {
+  userId: 'e8fe64b1-4c33-49e1-9f69-4db48b21df36',
+  seatsProposed: 3,
+  seatsRequested: 1,
+  strict: false,
+  waypoints: [originWaypointProps, destinationWaypointProps],
+};
+const punctualCreateAdProps = {
+  fromDate: '2023-06-22',
+  toDate: '2023-06-22',
+  schedule: [
+    {
+      time: '08:30',
+    },
+  ],
+  frequency: Frequency.PUNCTUAL,
+};
+const punctualPassengerCreateAdProps: CreateAdProps = {
+  ...baseCreateAdProps,
+  ...punctualCreateAdProps,
+  driver: false,
+  passenger: true,
+};
+
+const ads: AdEntity[] = [
+  AdEntity.create(punctualPassengerCreateAdProps),
+  AdEntity.create(punctualPassengerCreateAdProps),
+  AdEntity.create(punctualPassengerCreateAdProps),
+];
+
+const mockAdRepository = {
+  findAllByIds: jest.fn().mockImplementation(() => ads),
+};
+
+describe('Find Ads By Ids Query Handler', () => {
+  let findAdsByIdsQueryHandler: FindAdsByIdsQueryHandler;
+
+  beforeAll(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        {
+          provide: AD_REPOSITORY,
+          useValue: mockAdRepository,
+        },
+        FindAdsByIdsQueryHandler,
+      ],
+    }).compile();
+
+    findAdsByIdsQueryHandler = module.get<FindAdsByIdsQueryHandler>(
+      FindAdsByIdsQueryHandler,
+    );
+  });
+
+  it('should be defined', () => {
+    expect(findAdsByIdsQueryHandler).toBeDefined();
+  });
+
+  describe('execution', () => {
+    it('should return an ad', async () => {
+      const findAdsByIdsQuery = new FindAdsByIdsQuery([
+        'dd264806-13b4-4226-9b18-87adf0ad5dd1',
+        'dd264806-13b4-4226-9b18-87adf0ad5dd2',
+        'dd264806-13b4-4226-9b18-87adf0ad5dd3',
+      ]);
+      const ads: AdEntity[] =
+        await findAdsByIdsQueryHandler.execute(findAdsByIdsQuery);
+      expect(ads).toHaveLength(3);
+      expect(ads[1].getProps().fromDate).toBe('2023-06-22');
+    });
+  });
+});

src/modules/ad/tests/unit/interface/find-ads-by-ids.grpc.controller.spec.ts

@@ -0,0 +1,132 @@
+import { RpcExceptionCode } from '@mobicoop/ddd-library';
+import { AdMapper } from '@modules/ad/ad.mapper';
+import { Frequency } from '@modules/ad/core/domain/ad.types';
+import { FindAdsByIdsGrpcController } from '@modules/ad/interface/grpc-controllers/find-ads-by-ids.grpc.controller';
+import { QueryBus } from '@nestjs/cqrs';
+import { RpcException } from '@nestjs/microservices';
+import { Test, TestingModule } from '@nestjs/testing';
+
+const mockQueryBus = {
+  execute: jest
+    .fn()
+    .mockImplementationOnce(() => [
+      '200d61a8-d878-4378-a609-c19ea71633d2',
+      '200d61a8-d878-4378-a609-c19ea71633d3',
+      '200d61a8-d878-4378-a609-c19ea71633d4',
+    ])
+    .mockImplementationOnce(() => {
+      throw new Error();
+    }),
+};
+
+const mockAdMapper = {
+  toResponse: jest.fn().mockImplementationOnce(() => ({
+    userId: '8cc90d1a-4a59-4289-a7d8-078f9db7857f',
+    driver: true,
+    passenger: true,
+    frequency: Frequency.PUNCTUAL,
+    fromDate: '2023-06-27',
+    toDate: '2023-06-27',
+    schedule: {
+      tue: '07:15',
+    },
+    marginDurations: {
+      mon: 900,
+      tue: 900,
+      wed: 900,
+      thu: 900,
+      fri: 900,
+      sat: 900,
+      sun: 900,
+    },
+    seatsProposed: 3,
+    seatsRequested: 1,
+    waypoints: [
+      {
+        position: 0,
+        lat: 48.689445,
+        lon: 6.17651,
+        houseNumber: '5',
+        street: 'Avenue Foch',
+        locality: 'Nancy',
+        postalCode: '54000',
+        country: 'France',
+      },
+      {
+        position: 1,
+        lat: 48.8566,
+        lon: 2.3522,
+        locality: 'Paris',
+        postalCode: '75000',
+        country: 'France',
+      },
+    ],
+  })),
+};
+
+describe('Find Ads By Ids Grpc Controller', () => {
+  let findAdsByIdsGrpcController: FindAdsByIdsGrpcController;
+
+  beforeAll(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        {
+          provide: QueryBus,
+          useValue: mockQueryBus,
+        },
+        {
+          provide: AdMapper,
+          useValue: mockAdMapper,
+        },
+        FindAdsByIdsGrpcController,
+      ],
+    }).compile();
+
+    findAdsByIdsGrpcController = module.get<FindAdsByIdsGrpcController>(
+      FindAdsByIdsGrpcController,
+    );
+  });
+
+  afterEach(async () => {
+    jest.clearAllMocks();
+  });
+
+  it('should be defined', () => {
+    expect(findAdsByIdsGrpcController).toBeDefined();
+  });
+
+  it('should return ads', async () => {
+    jest.spyOn(mockQueryBus, 'execute');
+    jest.spyOn(mockAdMapper, 'toResponse');
+    const response = await findAdsByIdsGrpcController.findAllByIds({
+      ids: [
+        '200d61a8-d878-4378-a609-c19ea71633d2',
+        '200d61a8-d878-4378-a609-c19ea71633d3',
+        '200d61a8-d878-4378-a609-c19ea71633d4',
+      ],
+    });
+    expect(response.ads).toHaveLength(3);
+    expect(mockQueryBus.execute).toHaveBeenCalledTimes(1);
+    expect(mockAdMapper.toResponse).toHaveBeenCalledTimes(3);
+  });
+
+  it('should throw a generic RpcException', async () => {
+    jest.spyOn(mockQueryBus, 'execute');
+    jest.spyOn(mockAdMapper, 'toResponse');
+    expect.assertions(4);
+    try {
+      await findAdsByIdsGrpcController.findAllByIds({
+        ids: [
+          '200d61a8-d878-4378-a609-c19ea71633d2',
+          '200d61a8-d878-4378-a609-c19ea71633d3',
+          '200d61a8-d878-4378-a609-c19ea71633d4',
+        ],
+      });
+    } catch (e: any) {
+      expect(e).toBeInstanceOf(RpcException);
+      expect(e.error.code).toBe(RpcExceptionCode.UNKNOWN);
+    }
+    expect(mockQueryBus.execute).toHaveBeenCalledTimes(1);
+    expect(mockAdMapper.toResponse).toHaveBeenCalledTimes(0);
+  });
+});