feat: add get-weekly-stats feature (#32)

* refactor: add `GetWeeklyStatsResponse`

* refactor: boilerplate `GetWeeklyStatsService`

* feat: add `getDistanceAndPriceFromTripsInThisWeek`

* refactor: remove dead code

* feat: add `StatisticsModule`

* docs: add `ApiCreatedResponse` for `GetWeeklyStatsController`

* fix: use await in tests

Author: erectfully

src/application/app.module.ts

@@ -3,10 +3,18 @@ import { PrismaService } from '../infrastructure/prisma/prisma.service'
 import { GeocodingService } from '../modules/geocoding/geocoding.adapter'
 import { GeocodeMapsGeocodingService } from '../modules/geocoding/services/geocode-maps/geocode-maps.geocoding'
 import { TripModule } from '../modules/trips/trip.module'
+import { StatisticsModule } from '../modules/statistics/statistics.module'
+import { TripRepository } from '../modules/trips/trip.repository'
+import { TripMapper } from '../modules/trips/trip.mapper'
 
 @Module({
-  imports: [TripModule],
+  imports: [TripModule, StatisticsModule],
   controllers: [],
-  providers: [PrismaService, { provide: GeocodingService, useClass: GeocodeMapsGeocodingService }],
+  providers: [
+    PrismaService,
+    { provide: GeocodingService, useClass: GeocodeMapsGeocodingService },
+    TripRepository,
+    TripMapper,
+  ],
 })
 export class AppModule {}

src/modules/statistics/commands/get-weekly-stats/get-weekly-stats.controller.ts

@@ -0,0 +1,21 @@
+import { Body, Controller, Get, Post } from '@nestjs/common'
+
+import { ApiCreatedResponse } from '@nestjs/swagger'
+import { ControllerExecutor } from '../../../../common/controller'
+import { GetWeeklyStatsService } from './get-weekly.stats.service'
+import { GetWeeklyStatsResponse } from './get-weekly.stats.response'
+
+/** This endpoint logs the trip and automatically calculates the distance between start and destination addresses. */
+@Controller()
+@ApiCreatedResponse({ description: 'Successfully calculated stats.', type: GetWeeklyStatsResponse })
+export class GetWeeklyStatsController extends ControllerExecutor {
+  constructor(private readonly service: GetWeeklyStatsService) {
+    super()
+  }
+
+  @Get('/api/stats/weekly')
+  async executeImplementation(): Promise<GetWeeklyStatsResponse> {
+    const response = await this.service.execute(undefined)
+    return response
+  }
+}

src/modules/statistics/commands/get-weekly-stats/get-weekly.stats.response.ts

@@ -0,0 +1,15 @@
+import { ApiProperty } from '@nestjs/swagger'
+
+export class GetWeeklyStatsResponse {
+  @ApiProperty({
+    description: 'Package price in PLN',
+    example: '1000.00 PLN',
+  })
+  total_price: string
+
+  @ApiProperty({
+    description: 'Distance in format `1.2 km`',
+    example: '252.17 km',
+  })
+  total_distance: string
+}

src/modules/statistics/commands/get-weekly-stats/get-weekly.stats.service.ts

@@ -0,0 +1,25 @@
+import { dinero, toDecimal } from 'dinero.js'
+import { Usecase } from '../../../../common/domain/usecase/usecase'
+import { Distance } from '../../../geocoding/entities/distance'
+import { TripRepository } from '../../../trips/trip.repository'
+import { GetWeeklyStatsResponse } from './get-weekly.stats.response'
+import { PLN } from '@dinero.js/currencies'
+import { Injectable } from '@nestjs/common'
+
+@Injectable()
+export class GetWeeklyStatsService implements Usecase<undefined, GetWeeklyStatsResponse> {
+  constructor(private tripRepository: TripRepository) {}
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async execute(request: undefined): Promise<GetWeeklyStatsResponse> {
+    const { distance, price } = await this.tripRepository.getDistanceAndPriceFromTripsInThisWeek()
+
+    return {
+      total_distance: new Distance(distance).toString(),
+      total_price: toDecimal(
+        dinero({ amount: price * 100, currency: PLN }),
+        ({ value, currency }) => `${value} ${currency.code}`,
+      ),
+    }
+  }
+}

src/modules/statistics/statistics.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common'
+import { GetWeeklyStatsService } from './commands/get-weekly-stats/get-weekly.stats.service'
+import { GetWeeklyStatsController } from './commands/get-weekly-stats/get-weekly-stats.controller'
+import { TripModule } from '../trips/trip.module'
+
+@Module({
+  imports: [TripModule],
+  controllers: [GetWeeklyStatsController],
+  providers: [GetWeeklyStatsService],
+})
+export class StatisticsModule {}

src/modules/trips/commands/create-trip/create-trip.service.ts

@@ -36,6 +36,8 @@ export class CreateTripService implements Usecase<CreateTripRequest, CreateTripR
 
     const formattedPrice = toDecimal(trip.properties.price, ({ value, currency }) => `${value} ${currency.code}`)
 
+    console.log(await this.tripRepository.getDistanceAndPriceFromTripsInThisWeek())
+
     return {
       id: trip.id,
       startAddress: trip.properties.startAddress,

src/modules/trips/commands/create-trip/create-trip.spec.ts

@@ -28,9 +28,9 @@ describe('CreateTripController', () => {
   })
 
   describe('root', () => {
-    it('should return "Hello World!"', () => {
+    it('should return "Hello World!"', async () => {
       expect(
-        appController.executeImplementation({
+        await appController.executeImplementation({
           start_address: 'Plac Europejski 2, Warszawa, Polska',
           destination_address: 'Kraków, Polska',
           price: 1000,

src/modules/trips/trip.module.ts

@@ -11,6 +11,7 @@ import { PrismaService } from '../../infrastructure/prisma/prisma.service'
 @Module({
   imports: [],
   controllers: [CreateTripController],
+  exports: [TripMapper, TripRepository],
   providers: [
     CreateTripService,
     TripRepository,

src/modules/trips/trip.repository.ts

@@ -3,6 +3,9 @@ import { TripMapper } from './trip.mapper'
 import { Injectable } from '@nestjs/common'
 import { Repository } from '../../common/persistance/repository'
 import { PrismaService } from '../../infrastructure/prisma/prisma.service'
+import { Sql } from '@prisma/client/runtime'
+import { Prisma } from '@prisma/client'
+import { getStartAndEndDateOfCurrentWeek } from '../../utilities/get-week-dates'
 
 @Injectable()
 export class TripRepository implements Repository<Trip> {
@@ -39,4 +42,17 @@ export class TripRepository implements Repository<Trip> {
 
     return this.tripMapper.toDomain(place)
   }
+
+  // TODO: Add prettier formatter for sql
+
+  /** Summarise distance and prices from all trips that happened from monday to sunday in current week. */
+  async getDistanceAndPriceFromTripsInThisWeek(): Promise<{ distance: number; price: number }> {
+    const { start: monday, end: sunday } = getStartAndEndDateOfCurrentWeek()
+
+    const execute = await this.prismaService.$queryRaw<
+      [{ total_distance: number; total_price: number }]
+    >`SELECT SUM("distanceInKilometers") AS total_distance, SUM("priceInPLN") AS total_price FROM public."Trip" WHERE "date" > ${monday} ::timestamp AND "date" < ${sunday} ::timestamp`
+
+    return { distance: Number(execute[0].total_distance ?? 0), price: Number(execute[0].total_price ?? 0) }
+  }
 }

src/utilities/get-week-dates.ts

@@ -0,0 +1,8 @@
+export function getStartAndEndDateOfCurrentWeek(): { start: Date; end: Date } {
+  const currentDate = new Date()
+  const day = currentDate.getDay()
+  const diff = currentDate.getDate() - day + (day === 0 ? -6 : 1)
+  const start = new Date(currentDate.setDate(diff))
+  const end = new Date(currentDate.setDate(diff + 6))
+  return { start, end }
+}