detailed route provider

src/modules/ad/ad.di-tokens.ts

@@ -4,6 +4,9 @@ export const AD_MESSAGE_PUBLISHER = Symbol('AD_MESSAGE_PUBLISHER');
 export const AD_GET_BASIC_ROUTE_CONTROLLER = Symbol(
   'AD_GET_BASIC_ROUTE_CONTROLLER',
 );
+export const AD_GET_DETAILED_ROUTE_CONTROLLER = Symbol(
+  'AD_GET_DETAILED_ROUTE_CONTROLLER',
+);
 export const AD_ROUTE_PROVIDER = Symbol('AD_ROUTE_PROVIDER');
 export const PARAMS_PROVIDER = Symbol('PARAMS_PROVIDER');
 export const TIMEZONE_FINDER = Symbol('TIMEZONE_FINDER');

src/modules/ad/ad.module.ts

@@ -10,6 +10,7 @@ import {
   TIMEZONE_FINDER,
   TIME_CONVERTER,
   INPUT_DATETIME_TRANSFORMER,
+  AD_GET_DETAILED_ROUTE_CONTROLLER,
 } from './ad.di-tokens';
 import { MessageBrokerPublisher } from '@mobicoop/message-broker-module';
 import { AdRepository } from './infrastructure/ad.repository';
@@ -27,6 +28,7 @@ import { DefaultParamsProvider } from './infrastructure/default-params-provider'
 import { TimezoneFinder } from './infrastructure/timezone-finder';
 import { TimeConverter } from './infrastructure/time-converter';
 import { InputDateTimeTransformer } from './infrastructure/input-datetime-transformer';
+import { GetDetailedRouteController } from '@modules/geography/interface/controllers/get-detailed-route.controller';
 
 const grpcControllers = [MatchGrpcController];
 
@@ -67,6 +69,10 @@ const adapters: Provider[] = [
     provide: AD_GET_BASIC_ROUTE_CONTROLLER,
     useClass: GetBasicRouteController,
   },
+  {
+    provide: AD_GET_DETAILED_ROUTE_CONTROLLER,
+    useClass: GetDetailedRouteController,
+  },
   {
     provide: PARAMS_PROVIDER,
     useClass: DefaultParamsProvider,

src/modules/ad/core/application/ports/route-provider.port.ts

@@ -3,7 +3,17 @@ import { Point } from '../types/point.type';
 
 export interface RouteProviderPort {
   /**
-   * Get a basic route with points and overall duration / distance
+   * Get a basic route :
+   * - simple points (coordinates only)
+   * - overall duration
+   * - overall distance
    */
   getBasic(waypoints: Point[]): Promise<Route>;
+  /**
+   * Get a detailed route :
+   * - detailed points (coordinates and time / distance to reach the point)
+   * - overall duration
+   * - overall distance
+   */
+  getDetailed(waypoints: Point[]): Promise<Route>;
 }

src/modules/ad/core/application/queries/match/completer/route.completer.ts

@@ -15,12 +15,31 @@ export class RouteCompleter extends Completer {
   ): Promise<CandidateEntity[]> => {
     await Promise.all(
       candidates.map(async (candidate: CandidateEntity) => {
-        const candidateRoute = await this.query.routeProvider.getBasic(
+        switch (this.type) {
-          (candidate.getProps().carpoolSteps as WayStep[]).map(
+          case RouteCompleterType.BASIC:
-            (wayStep: WayStep) => wayStep.point,
+            const basicCandidateRoute = await this.query.routeProvider.getBasic(
-          ),
+              (candidate.getProps().carpoolSteps as WayStep[]).map(
-        );
+                (wayStep: WayStep) => wayStep.point,
-        candidate.setMetrics(candidateRoute.distance, candidateRoute.duration);
+              ),
+            );
+            candidate.setMetrics(
+              basicCandidateRoute.distance,
+              basicCandidateRoute.duration,
+            );
+            break;
+          case RouteCompleterType.DETAILED:
+            const detailedCandidateRoute =
+              await this.query.routeProvider.getBasic(
+                (candidate.getProps().carpoolSteps as WayStep[]).map(
+                  (wayStep: WayStep) => wayStep.point,
+                ),
+              );
+            candidate.setMetrics(
+              detailedCandidateRoute.distance,
+              detailedCandidateRoute.duration,
+            );
+            break;
+        }
         return candidate;
       }),
     );

src/modules/ad/infrastructure/route-provider.ts

@@ -1,6 +1,6 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { RouteProviderPort } from '../core/application/ports/route-provider.port';
-import { GetBasicRouteControllerPort } from '@modules/geography/core/application/ports/get-basic-route-controller.port';
+import { GetRouteControllerPort } from '@modules/geography/core/application/ports/get-route-controller.port';
 import { AD_GET_BASIC_ROUTE_CONTROLLER } from '../ad.di-tokens';
 import { Point, Route } from '@modules/geography/core/domain/route.types';
 
@@ -8,11 +8,16 @@ import { Point, Route } from '@modules/geography/core/domain/route.types';
 export class RouteProvider implements RouteProviderPort {
   constructor(
     @Inject(AD_GET_BASIC_ROUTE_CONTROLLER)
-    private readonly getBasicRouteController: GetBasicRouteControllerPort,
+    private readonly getBasicRouteController: GetRouteControllerPort,
   ) {}
 
   getBasic = async (waypoints: Point[]): Promise<Route> =>
     await this.getBasicRouteController.get({
       waypoints,
     });
+
+  getDetailed = async (waypoints: Point[]): Promise<Route> =>
+    await this.getBasicRouteController.get({
+      waypoints,
+    });
 }

src/modules/ad/tests/unit/core/create-ad.service.spec.ts

@@ -93,6 +93,7 @@ const mockRouteProvider: RouteProviderPort = {
         },
       ],
     })),
+  getDetailed: jest.fn(),
 };
 
 describe('create-ad.service', () => {

src/modules/ad/tests/unit/core/match.query-handler.spec.ts

@@ -92,6 +92,7 @@ const mockRouteProvider: RouteProviderPort = {
     distanceAzimuth: 336544,
     points: [],
   })),
+  getDetailed: jest.fn(),
 };
 
 describe('Match Query Handler', () => {

src/modules/ad/tests/unit/core/match.query.spec.ts

@@ -104,6 +104,7 @@ const mockRouteProvider: RouteProviderPort = {
     .mockImplementationOnce(() => {
       throw new Error();
     }),
+  getDetailed: jest.fn(),
 };
 
 describe('Match Query', () => {

src/modules/ad/tests/unit/core/passenger-oriented-algorithm.spec.ts

@@ -46,6 +46,7 @@ const matchQuery = new MatchQuery(
       duration: 6500,
       distance: 89745,
     })),
+    getDetailed: jest.fn(),
   },
 );
 

src/modules/ad/tests/unit/core/passenger-oriented-carpool-path-completer.spec.ts

@@ -42,6 +42,7 @@ const matchQuery = new MatchQuery(
   },
   {
     getBasic: jest.fn(),
+    getDetailed: jest.fn(),
   },
 );
 

src/modules/ad/tests/unit/core/passenger-oriented-geo-filter.spec.ts

@@ -42,6 +42,7 @@ const matchQuery = new MatchQuery(
   },
   {
     getBasic: jest.fn(),
+    getDetailed: jest.fn(),
   },
 );
 

src/modules/ad/tests/unit/core/passenger-oriented-selector.spec.ts

@@ -49,6 +49,7 @@ const matchQuery = new MatchQuery(
   },
   {
     getBasic: jest.fn(),
+    getDetailed: jest.fn(),
   },
 );
 matchQuery.driverRoute = {

src/modules/ad/tests/unit/infrastructure/ad.repository.spec.ts

@@ -75,6 +75,7 @@ const mockDirectionEncoder: DirectionEncoderPort = {
 
 const mockRouteProvider: RouteProviderPort = {
   getBasic: jest.fn(),
+  getDetailed: jest.fn(),
 };
 
 const mockPrismaService = {

src/modules/ad/tests/unit/infrastructure/route-provider.spec.ts

@@ -1,7 +1,7 @@
 import { AD_GET_BASIC_ROUTE_CONTROLLER } from '@modules/ad/ad.di-tokens';
 import { Point } from '@modules/ad/core/application/types/point.type';
 import { RouteProvider } from '@modules/ad/infrastructure/route-provider';
-import { GetBasicRouteControllerPort } from '@modules/geography/core/application/ports/get-basic-route-controller.port';
+import { GetRouteControllerPort } from '@modules/geography/core/application/ports/get-route-controller.port';
 import { Route } from '@modules/geography/core/domain/route.types';
 import { Test, TestingModule } from '@nestjs/testing';
 
@@ -14,7 +14,7 @@ const destinationPoint: Point = {
   lon: 2.3522,
 };
 
-const mockGetBasicRouteController: GetBasicRouteControllerPort = {
+const mockGetBasicRouteController: GetRouteControllerPort = {
   get: jest.fn().mockImplementationOnce(() => ({
     distance: 350101,
     duration: 14422,
@@ -59,7 +59,7 @@ describe('Route provider', () => {
     expect(routeProvider).toBeDefined();
   });
 
-  it('should provide a route', async () => {
+  it('should provide a basic route', async () => {
     const route: Route = await routeProvider.getBasic([
       originPoint,
       destinationPoint,

src/modules/ad/tests/unit/interface/match.grpc.controller.spec.ts

@@ -66,6 +66,7 @@ const mockQueryBus = {
 
 const mockRouteProvider: RouteProviderPort = {
   getBasic: jest.fn(),
+  getDetailed: jest.fn(),
 };
 
 describe('Match Grpc Controller', () => {

src/modules/geography/core/application/ports/get-route-controller.port.ts

@@ -1,6 +1,6 @@
 import { GetRouteRequestDto } from '@modules/geography/interface/controllers/dtos/get-route.request.dto';
 import { RouteResponseDto } from '@modules/geography/interface/dtos/route.response.dto';
 
-export interface GetBasicRouteControllerPort {
+export interface GetRouteControllerPort {
   get(data: GetRouteRequestDto): Promise<RouteResponseDto>;
 }

src/modules/geography/core/application/queries/get-route/get-route.query.ts

@@ -6,7 +6,14 @@ export class GetRouteQuery extends QueryBase {
   readonly waypoints: Point[];
   readonly georouterSettings: GeorouterSettings;
 
-  constructor(waypoints: Point[], georouterSettings: GeorouterSettings) {
+  constructor(
+    waypoints: Point[],
+    georouterSettings: GeorouterSettings = {
+      detailedDistance: false,
+      detailedDuration: false,
+      points: true,
+    },
+  ) {
     super();
     this.waypoints = waypoints;
     this.georouterSettings = georouterSettings;

src/modules/geography/interface/controllers/get-basic-route.controller.ts

@@ -5,10 +5,10 @@ import { RouteEntity } from '@modules/geography/core/domain/route.entity';
 import { GetRouteQuery } from '@modules/geography/core/application/queries/get-route/get-route.query';
 import { RouteMapper } from '@modules/geography/route.mapper';
 import { Controller } from '@nestjs/common';
-import { GetBasicRouteControllerPort } from '@modules/geography/core/application/ports/get-basic-route-controller.port';
+import { GetRouteControllerPort } from '@modules/geography/core/application/ports/get-route-controller.port';
 
 @Controller()
-export class GetBasicRouteController implements GetBasicRouteControllerPort {
+export class GetBasicRouteController implements GetRouteControllerPort {
   constructor(
     private readonly queryBus: QueryBus,
     private readonly mapper: RouteMapper,
@@ -16,11 +16,7 @@ export class GetBasicRouteController implements GetBasicRouteControllerPort {
 
   async get(data: GetRouteRequestDto): Promise<RouteResponseDto> {
     const route: RouteEntity = await this.queryBus.execute(
-      new GetRouteQuery(data.waypoints, {
+      new GetRouteQuery(data.waypoints),
-        detailedDistance: false,
-        detailedDuration: false,
-        points: true,
-      }),
     );
     return this.mapper.toResponse(route);
   }

src/modules/geography/interface/controllers/get-detailed-route.controller.ts

@@ -0,0 +1,27 @@
+import { QueryBus } from '@nestjs/cqrs';
+import { RouteResponseDto } from '../dtos/route.response.dto';
+import { GetRouteRequestDto } from './dtos/get-route.request.dto';
+import { RouteEntity } from '@modules/geography/core/domain/route.entity';
+import { GetRouteQuery } from '@modules/geography/core/application/queries/get-route/get-route.query';
+import { RouteMapper } from '@modules/geography/route.mapper';
+import { Controller } from '@nestjs/common';
+import { GetRouteControllerPort } from '@modules/geography/core/application/ports/get-route-controller.port';
+
+@Controller()
+export class GetDetailedRouteController implements GetRouteControllerPort {
+  constructor(
+    private readonly queryBus: QueryBus,
+    private readonly mapper: RouteMapper,
+  ) {}
+
+  async get(data: GetRouteRequestDto): Promise<RouteResponseDto> {
+    const route: RouteEntity = await this.queryBus.execute(
+      new GetRouteQuery(data.waypoints, {
+        detailedDistance: true,
+        detailedDuration: true,
+        points: true,
+      }),
+    );
+    return this.mapper.toResponse(route);
+  }
+}