feat: add retrieve cars planning

src/core/domain/car/interfaces/repositories/read.ts

@@ -29,10 +29,12 @@ export default interface CarReadRepositoryInterface {
      * @param startDate
      * @param endDate
      * @param cursor
+     * @param limit
      */
     getCarsPlanning({
                         startDate,
                         endDate,
                         cursor,
-                    }: { startDate: Date, endDate: Date, cursor: DecodedCursor }): Promise<CarsPlanningDTO>;
+                        limit,
+                    }: { startDate: Date, endDate: Date, cursor: DecodedCursor, limit: number }): Promise<CarsPlanningDTO>;
 }

src/core/domain/car/outputBoundaries/outputBoundary.ts

@@ -5,12 +5,11 @@ export type CarRentalPlanningDTO = {
 }
 
 export type CarPlanningDTO = {
-    licensePlate: string;
     rentals: CarRentalPlanningDTO[];
 };
 
 type Cursor = {
-    nextPage: null;
+    nextPage: null | string;
 }
 
 type CarPlanningGroupType = {

src/core/useCases/car/query/retrieveCarsPlanning/authorizer.ts

@@ -1,7 +1,6 @@
 import UserIsNotAuthorizedToRetrieveCarsPlanningError
     from "src/core/useCases/car/query/retrieveCarsPlanning/exceptions/notAuthorized";
 import PermissionsGatewayInterface from "src/core/useCases/common/interfaces/gateways/permissions";
-import UserPermissionsProfile from "src/core/useCases/common/permissions/types/userPermissionsProfile";
 
 export default class RetrieveCarsPlanningAuthorizer {
     private readonly permissionsGateway: PermissionsGatewayInterface;
@@ -10,8 +9,9 @@ export default class RetrieveCarsPlanningAuthorizer {
         this.permissionsGateway = permissionsGateway;
     }
 
-    async userMayRetrieveCarsPlanning(): Promise<void> {
-        const permissions = await this.permissionsGateway.getUserPermissions();
+    async authorize({actorId}: { actorId: string }): Promise<void> {
+        const permissions = await this.permissionsGateway.getUserPermissions({userId: actorId});
+
         if (permissions.length === 0) {
             throw new UserIsNotAuthorizedToRetrieveCarsPlanningError();
         }

src/core/useCases/car/query/retrieveCarsPlanning/handler.ts

@@ -2,12 +2,12 @@ import CarsPlanningDTO from "src/core/domain/car/outputBoundaries/outputBoundary
 import CarReadRepositoryInterface from "src/core/domain/car/interfaces/repositories/read";
 import RetrieveCarsPlanningQuery from "src/core/useCases/car/query/retrieveCarsPlanning/types/query";
 import RetrieveCarsPlanningAuthorizer from "src/core/useCases/car/query/retrieveCarsPlanning/authorizer";
-import DecodedCursor from "src/core/domain/common/types/cursor";
+import {decodeCursor} from "src/core/useCases/common/cursors/encodeDecode";
 
 export default class RetrieveCarsPlanning {
-    private readonly carReadRepository;
+    private readonly carReadRepository: CarReadRepositoryInterface;
 
-    private readonly authorizer;
+    private readonly authorizer: RetrieveCarsPlanningAuthorizer;
 
     constructor({
                     carReadRepository,
@@ -18,27 +18,15 @@ export default class RetrieveCarsPlanning {
     }
 
     async execute(query: RetrieveCarsPlanningQuery): Promise<CarsPlanningDTO> {
-        await this.authorizer.userMayRetrieveCarsPlanning();
+        await this.authorizer.authorize({
+            actorId: query.actor.id,
+        });
 
         return await this.carReadRepository.getCarsPlanning({
             startDate: query.startDate,
             endDate: query.endDate,
-            cursor: this.decodeCursor(query.cursor),
+            limit: query.limit,
+            cursor: decodeCursor(query.cursor),
         });
     }
-
-    private decodeCursor(cursor: null | string): DecodedCursor {
-        if (cursor === null) {
-            return {
-                order: 'gte',
-                address: ''
-            }
-        }
-        const cursorMatch = atob(cursor).match(new RegExp('^(?<order>(next|prev)___)(?<address>[\\w\'-]+)$')) as RegExpMatchArray;
-        const groups = cursorMatch.groups as any;
-        return {
-            order: groups.order == 'next' ? 'gte' : 'lte',
-            address: groups.address as string,
-        }
-    }
 }

src/core/useCases/car/query/retrieveCarsPlanning/types/query.ts

@@ -1,8 +1,13 @@
+type Actor = {
+    id: string;
+}
+
 type RetrieveCarsPlanningQuery = {
     startDate: Date;
     endDate: Date;
     limit: number;
-    cursor: null | string;
+    cursor: string;
+    actor: Actor;
 };
 
 export default RetrieveCarsPlanningQuery;

src/core/useCases/common/cursors/encodeDecode.ts

@@ -0,0 +1,30 @@
+import DecodedCursor from "src/core/domain/common/types/cursor";
+
+/**
+ * Encodes a cursor address to a base64 format.
+ *
+ * @param cursor The cursor address to encode
+ * @param order The order of the cursor (gte for next, lte for prev)
+ */
+export const encodeCursor = (cursor: string, order: string): string => {
+    if (cursor === ''){
+        return '';
+    }
+    return btoa(`${order == 'gte' ? 'next' : 'prev'}___${cursor}`);
+}
+
+export const decodeCursor = (cursor: string): DecodedCursor => {
+    if (cursor === '') {
+        return {
+            order: 'gte',
+            address: ''
+        }
+    }
+    const cursorMatch = atob(cursor).match(new RegExp('^(?<order>(next|prev))___(?<address>[\\w\'-]+)$')) as RegExpMatchArray;
+    const groups = cursorMatch.groups as any;
+
+    return {
+        order: groups.order == 'next' ? 'gte' : 'lte',
+        address: groups.address as string,
+    }
+}

src/core/useCases/common/interfaces/gateways/permissions.ts

@@ -1,5 +1,5 @@
 import UserPermissionsProfile from "src/core/useCases/common/permissions/types/userPermissionsProfile";
 
 export default interface PermissionsGatewayInterface {
-    getUserPermissions(): Promise<UserPermissionsProfile[]>;
+    getUserPermissions({userId}: { userId: string }): Promise<UserPermissionsProfile[]>;
 }

src/driven/repositories/inMemory/car/read.ts

@@ -11,6 +11,7 @@ import InMemoryCarModel from '../carModel/carModel.entity';
 import UnavailableCarError from 'src/core/domain/car/errors/unavailable';
 import CarsPlanningDTO from "src/core/domain/car/outputBoundaries/outputBoundary";
 import DecodedCursor from "src/core/domain/common/types/cursor";
+import {encodeCursor} from "src/core/useCases/common/cursors/encodeDecode";
 
 @injectable()
 export default class InMemoryCarReadRepository implements CarReadRepositoryInterface {
@@ -74,44 +75,53 @@ export default class InMemoryCarReadRepository implements CarReadRepositoryInter
         })
     }
 
+    findNextCursor(cars: InMemoryCar[]): string {
+        const nextCar = _.find(
+            this.unitOfWork.cars,
+            inMemoryCar => inMemoryCar.licensePlate > cars[cars.length - 1].licensePlate
+        );
+        if (nextCar === undefined) {
+            return "";
+        }
+
+        return cars[cars.length - 1].licensePlate;
+    }
+
     async getCarsPlanning({
                               startDate,
                               endDate,
                               cursor,
-                          }: { startDate: Date, endDate: Date, cursor: DecodedCursor }): Promise<CarsPlanningDTO> {
-        const select = (cars: InMemoryCar[], limit: number, cursor: DecodedCursor): InMemoryCar[] => {
-            const results: InMemoryCar[] = [];
-            const sorted = _.orderBy(cars, ['licensePlate'], ['asc']);
-            const filtered = _.filter(
-                sorted,
-                inMemoryCar => cursor.order === 'gte' ? inMemoryCar.licensePlate >= cursor.address : inMemoryCar.licensePlate >= cursor.address
-            );
-            _.forEach(filtered, (car) => {
-                if (results.length === limit) {
-                    return false;
-                }
-                results.push(car);
-            });
-
-            return results;
-        }
-        const retrievedCars = select(this.unitOfWork.cars, 5, cursor);
+                              limit,
+                          }: { startDate: Date, endDate: Date, cursor: DecodedCursor, limit: number }): Promise<CarsPlanningDTO> {
+        const retrievedCars: InMemoryCar[] = [];
+        const sorted = _.orderBy(this.unitOfWork.cars, ['licensePlate'], ['asc']);
+        const filtered = _.filter(
+            sorted,
+            inMemoryCar => cursor.order === 'gte' ? inMemoryCar.licensePlate >= cursor.address : inMemoryCar.licensePlate >= cursor.address
+        );
+        _.forEach(filtered, (car) => {
+            if (retrievedCars.length === limit) {
+                return false;
+            }
+            retrievedCars.push(car);
+        });
         const planning = {
             cars: {},
             cursor: {
-                nextPage: null,
+                nextPage: encodeCursor(this.findNextCursor(retrievedCars), cursor.order),
             },
         } as CarsPlanningDTO;
         for (const retrievedCar of retrievedCars) {
             const retrievedCarRentals: InMemoryCarRental[] = _.filter(
                 this.unitOfWork.carRentals,
                 inMemoryCarRental =>
                     inMemoryCarRental.carId === retrievedCar.id
-                    && inMemoryCarRental.pickupDateTime >= startDate
-                    && inMemoryCarRental.pickupDateTime <= endDate,
+                    && (
+                        (inMemoryCarRental.pickupDateTime >= startDate && inMemoryCarRental.pickupDateTime <= endDate)
+                        || (inMemoryCarRental.dropOffDateTime > startDate && inMemoryCarRental.pickupDateTime <= startDate)
+                    )
             );
             planning.cars[retrievedCar.id] = {
-                licensePlate: retrievedCar.licensePlate,
                 rentals: []
             }
             for (const retrievedCarRental of retrievedCarRentals) {

tests/common/stubs/gateways/permissions/allow.ts

@@ -2,14 +2,14 @@ import PermissionsGatewayInterface from "src/core/useCases/common/interfaces/gat
 import UserPermissionsProfile from "src/core/useCases/common/permissions/types/userPermissionsProfile";
 
 export default class PermissionsStubGateway implements PermissionsGatewayInterface {
-    constructor(permissionsProfileToProvide: UserPermissionsProfile[]) {
+    private readonly permissionsToProvide: UserPermissionsProfile[];
+
+    constructor(permissionsToProvide: UserPermissionsProfile[]) {
+        this.permissionsToProvide = permissionsToProvide;
     }
 
-    // @ts-ignore
     async getUserPermissions(): Promise<UserPermissionsProfile[]> {
-        return [
-            {}
-        ]
+        return this.permissionsToProvide;
     }
 
 }

tests/unit/car/query/retrieveCarsPlanning/beforeEach.ts

@@ -3,17 +3,16 @@ import CarsPlanningDTO from "src/core/domain/car/outputBoundaries/outputBoundary
 import DateParser from "tests/utils/dateParser";
 import {CarTestCaseEntry} from "tests/unit/utils/testCase.types";
 
-export const buildExpectedCarsPlanning = (cars: CarTestCaseEntry[]): CarsPlanningDTO => {
+export const buildExpectedCarsPlanning = (cars: CarTestCaseEntry[], nextCursor: string, prevCursor: null | string): CarsPlanningDTO => {
     const dateParser: DateParser = container.resolve("DateParser");
     const expectedPlanning: CarsPlanningDTO = {
         cars: {},
         cursor: {
-            nextPage: null,
+            nextPage: nextCursor,
         }
     }
     for (const carTestCaseEntry of cars) {
         expectedPlanning.cars[carTestCaseEntry.id] = {
-            licensePlate: carTestCaseEntry.licensePlate !== undefined ? carTestCaseEntry.licensePlate : 'AA-123-AA',
             rentals: []
         }
         for (const rentalEntry of carTestCaseEntry.rentals) {