feat: add get-monthly-stats feature (#34)

* feat: add `GetMonthlyStatsService`

* test: adjust test to new distance format

* test: adjust test to new distance format

* test: add `CreateTripController` e2e boilerplate

* test: add `create-trip` e2e

* test: add `get-monthly-stats` e2e

* test: add `get-weekly-stats` e2e

* ci: run e2e tests in pipeline

* test: describe `getStartAndEndDateOfCurrentWeek`

* test: improve coverage config

Author: erectfully

.github/workflows/main.yml

@@ -62,8 +62,8 @@ jobs:
           curl -Os https://uploader.codecov.io/latest/linux/codecov && chmod +x codecov && ./codecov -t ${{
           secrets.CODECOV_TOKEN }} -n "GitHub Actions" -F unit
 
-      # - name: Test E2E
-      #   run: yarn test:e2e
+      - name: Test E2E
+        run: yarn test:e2e
 
   build:
     runs-on: ubuntu-latest

README.md

@@ -62,6 +62,7 @@ available PostgresSql database, additionally your machine should contain the sof
 cp example.env .env
 yarn install
 yarn build
+yarn db:push
 node dist/main.js
 # Voila! Application is running at http://localhost:1337
 ```

jest.config.ts

@@ -0,0 +1,30 @@
+import type { Config } from 'jest'
+
+const config: Config = {
+  verbose: true,
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: 'src',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  collectCoverageFrom: [
+    '**/*.(t|j)s',
+    // Do not expect coverage from modules, controllers and responses
+    '!**/*.module.(t|j)s',
+    '!**/*.response.(t|j)s',
+    '!**/*.controller.(t|j)s',
+    // Do not expect coverage from main.ts
+    '!**/main.(t|j)s',
+    // Do not expect coverage from prisma service
+    '!**/prisma.service.(t|j)s',
+    // Do not expect coverage from common files as they are just generics
+    '!**/common/*.ts',
+  ],
+  coveragePathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/test/', '<rootDir>/dist/'],
+  coverageDirectory: '../coverage',
+  coverageReporters: ['clover', 'json', 'lcov', 'text-summary', 'html'],
+  testEnvironment: 'node',
+}
+
+export default config

package.json

@@ -1,30 +1,30 @@
 {
   "name": "bikeramp",
   "version": "0.0.1",
-  "description": "",
-  "author": "",
   "private": true,
+  "description": "",
   "license": "UNLICENSED",
+  "author": "",
   "scripts": {
     "build": "nest build",
+    "db:generate": "prisma generate",
+    "db:migrate:deploy": "prisma migrate deploy",
+    "db:migrate:dev": "prisma migrate dev",
+    "db:push": "prisma db push",
+    "db:push:force": "prisma db push --accept-data-loss",
+    "db:studio": "prisma studio",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "postinstall": "prisma generate",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "start": "nest start",
-    "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
+    "start:dev": "nest start --watch",
     "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
-    "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
-    "db:generate": "prisma generate",
-    "db:migrate:deploy": "prisma migrate deploy",
-    "db:migrate:dev": "prisma migrate dev",
-    "db:push": "prisma db push",
-    "db:push:force": "prisma db push --accept-data-loss",
-    "db:studio": "prisma studio",
-    "postinstall": "prisma generate"
+    "test:watch": "jest --watch"
   },
   "dependencies": {
     "@dinero.js/currencies": "^2.0.0-alpha.13",
@@ -69,23 +69,6 @@
     "tsconfig-paths": "4.1.1",
     "typescript": "^4.7.4"
   },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  },
   "volta": {
     "node": "18.13.0",
     "yarn": "1.19.2"

src/modules/geocoding/entities/distance.spec.ts

@@ -13,6 +13,6 @@ describe('Distance', () => {
 
   it('should return distance in kilometers', () => {
     const distance = Distance.fromMeters(1000)
-    expect(distance.toString()).toBe('1.00 km')
+    expect(distance.toString()).toBe('1km')
   })
 })

src/modules/geocoding/entities/distance.ts

@@ -10,7 +10,7 @@ export class Distance {
   }
 
   toString() {
-    return `${this.baseScalar.toFixed(2)} km`
+    return `${this.baseScalar.toFixed(0)}km`
   }
 
   toMeters() {

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

@@ -0,0 +1,24 @@
+import { Controller, Get } from '@nestjs/common'
+
+import { ApiCreatedResponse } from '@nestjs/swagger'
+import { ControllerExecutor } from '../../../../common/controller'
+import { GetMonthlyStatsService } from './get-monthly-stats.service'
+import { GetMonthlyStatsResponse } from './get-monthly-stats.response'
+
+@Controller()
+export class GetMonthlyStatsController extends ControllerExecutor {
+  constructor(private readonly service: GetMonthlyStatsService) {
+    super()
+  }
+
+  @Get('/api/stats/monthly')
+  @ApiCreatedResponse({
+    description: 'Get monthly stats',
+    isArray: true,
+    type: GetMonthlyStatsResponse,
+  })
+  async executeImplementation(): Promise<GetMonthlyStatsResponse[]> {
+    const response = await this.service.execute()
+    return response
+  }
+}

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

@@ -0,0 +1,26 @@
+import { ApiProperty } from '@nestjs/swagger'
+
+export class GetMonthlyStatsResponse {
+  @ApiProperty({
+    example: 'July, 4th',
+  })
+  day: string
+
+  @ApiProperty({
+    description: 'Distance in format `1.2 km`',
+    example: '252.17 km',
+  })
+  total_distance: string
+
+  @ApiProperty({
+    description: 'Average ride distance',
+    example: '1.22 km',
+  })
+  avg_ride: string
+
+  @ApiProperty({
+    description: 'Average price.',
+    example: '1000.00 PLN',
+  })
+  avg_price: string
+}

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

@@ -0,0 +1,31 @@
+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 { PLN } from '@dinero.js/currencies'
+import { Injectable } from '@nestjs/common'
+import { GetMonthlyStatsResponse } from './get-monthly-stats.response'
+import { Formatter } from '../../../../utilities/formatter'
+
+@Injectable()
+export class GetMonthlyStatsService implements Usecase<undefined, GetMonthlyStatsResponse[]> {
+  constructor(private tripRepository: TripRepository) {}
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async execute(): Promise<GetMonthlyStatsResponse[]> {
+    const summarised = await this.tripRepository.getDistanceAndAveragePriceAndAverageDistanceFromTripsInThisMonth()
+
+    const response: GetMonthlyStatsResponse[] = []
+
+    summarised.map((summarised) => {
+      response.push({
+        day: Formatter.formatDateToMonthAndDayOfMonthFormat(summarised.day),
+        total_distance: Formatter.formatDistance(summarised.totalDistance),
+        avg_ride: Formatter.formatDistance(summarised.averageDistance),
+        avg_price: Formatter.formatFiat(summarised.averagePrice),
+      })
+    })
+
+    return response
+  }
+}

src/modules/statistics/statistics.module.ts

@@ -2,10 +2,12 @@ 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'
+import { GetMonthlyStatsController } from './commands/get-monthly-stats/get-monthly-stats.controller'
+import { GetMonthlyStatsService } from './commands/get-monthly-stats/get-monthly-stats.service'
 
 @Module({
   imports: [TripModule],
-  controllers: [GetWeeklyStatsController],
-  providers: [GetWeeklyStatsService],
+  controllers: [GetWeeklyStatsController, GetMonthlyStatsController],
+  providers: [GetWeeklyStatsService, GetMonthlyStatsService],
 })
 export class StatisticsModule {}