feat: refactor stats API to use schema validation and improve query handling

Author: yvalentin

apps/nuxt/src/server/api/stats/index.get.ts

@@ -1,25 +1,20 @@
-import { defineEventHandler, getQuery } from 'h3'
+import { defineEventHandler } from 'h3'
 import { Monitor, StatisticsService } from '@tee/backend-ddd'
-import { StatsPeriodicity } from '@tee/common'
+import { statQueryParamsSchema } from '@tee/backend-ddd'
 
 export default defineEventHandler(async (event) => {
   try {
-    const query = getQuery(event)
+    const statsQuery = await getValidatedQuery(event, statQueryParamsSchema.parse)
 
-    const periodicity = ['day', 'week', 'month', 'year'].includes(query.periodicity as StatsPeriodicity)
-      ? (query.periodicity as StatsPeriodicity)
-      : undefined
-    const since = typeof query.since === 'string' ? query.since : undefined
-    const to = typeof query.to === 'string' ? query.to : undefined
-
-    const statsResult = await new StatisticsService().getNorthStarStats({ periodicity, since, to })
+    const statsResult = await new StatisticsService().getNorthStarStats(statsQuery)
 
     return statsResult
   } catch (error: any) {
     Monitor.error('Error in /api/stats', { error })
     throw createError({
       statusCode: 500,
-      statusMessage: `Server internal error: ${error.message}`
+      statusMessage: `Server internal error`,
+      message: error.message
     })
   }
 })

libs/backend-ddd/src/statistics/application/statisticsService.ts

@@ -1,5 +1,5 @@
-import { StatOutput, StatQueryParams } from '@tee/common'
 import StatisticsFeatures from '../domain/statisticsFeatures'
+import { StatOutput, StatQueryParams } from '../domain/types'
 
 export class StatisticsService {
   public async getNorthStarStats(params: StatQueryParams): Promise<StatOutput> {

libs/backend-ddd/src/statistics/domain/schemaValidator.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod'
+import { StatsPeriodicity } from './types'
+
+const statsPeriodicitySchema = z.nativeEnum(StatsPeriodicity)
+
+export const statQueryParamsSchema = z.object({
+  periodicity: statsPeriodicitySchema.optional(),
+  since: z.coerce.date().optional(),
+  to: z.coerce.date().optional()
+})

libs/backend-ddd/src/statistics/domain/statisticsFeatures.ts

@@ -1,66 +1,73 @@
-import { Stat, StatOutput, StatQueryParams } from '@tee/common'
+import { Stat, StatOutput, StatQueryParams, StatsPeriodicity } from './types'
 
 export default class StatisticsFeatures {
   async fetchNorthStarStats(params: StatQueryParams): Promise<StatOutput> {
     const METABASE_URL = 'http://tee-metabase.osc-fr1.scalingo.io/public/question/6969b2ab-ec49-44a0-9db8-3e2f9afbcf29.json'
 
-    const periodicity = params.periodicity || 'month'
-
-    const today = new Date()
-    const since = params.since ? new Date(params.since) : new Date(today.getFullYear(), 0, 1)
-    const to = params.to ? new Date(params.to) : new Date(today.getFullYear(), today.getMonth(), today.getDate() - 1)
-
     const response = await fetch(METABASE_URL)
     if (!response.ok) {
       throw new Error('Stats API: Failed to fetch Metabase data')
     }
 
-    const rawData: { week_start_date: string; total_2_3: number }[] = await response.json()
-    const filtered = rawData
-      .map((row) => ({
-        date: this.toLocalDateOnly(new Date(row.week_start_date)), // week_start_date is a metabase variable that is poorly named and that is simply the statistic date
-        value: row.total_2_3
+    const data: { week_start_date: string; total_2_3: number }[] = await response.json()
+    if (data.length === 0) {
+      return {
+        description: `Entreprises bénéficiaires`,
+        stats: []
+      }
+    }
+
+    const periodicity = params.periodicity || StatsPeriodicity.Month
+    const today = new Date()
+    const since = params.since ?? new Date(today.getFullYear(), 0, 1)
+    const to = params.to ?? new Date(today.getFullYear(), today.getMonth(), today.getDate() - 1)
+
+    const filtered = data
+      .map((datum) => ({
+        date: new Date(datum.week_start_date), // week_start_date is a metabase variable that is poorly named and that is simply the statistic date
+        value: datum.total_2_3
       }))
-      .filter((row) => row.date >= since && row.date <= to)
+      .filter((datum) => {
+        return datum.date >= since && datum.date <= to
+      })
 
-    const grouped: Record<string, { date: Date; value: number }> = {}
+    const statsByPeriodicity: Record<string, Stat> = {}
 
     filtered.forEach(({ date, value }) => {
-      const d = new Date(date)
-      if (d < since || d > to) return
-
       let keyStatDate = today
 
       switch (periodicity) {
-        case 'day':
-          keyStatDate = new Date(d.getFullYear(), d.getMonth(), d.getDate())
+        case StatsPeriodicity.Day:
+          // Set to the start of the day
+          keyStatDate = new Date(Date.UTC(date.getFullYear(), date.getMonth(), date.getDate(), 0, 0, 0, 0))
           break
-        case 'week': {
-          const weekStart = new Date(d.getFullYear(), d.getMonth(), d.getDate() - ((d.getDay() + 6) % 7))
-          keyStatDate = weekStart
+        case StatsPeriodicity.Week: {
+          // Set to the start of the week (Monday)
+          keyStatDate = new Date(Date.UTC(date.getFullYear(), date.getMonth(), date.getDate() - ((date.getDay() + 6) % 7), 0, 0, 0, 0))
           break
         }
-        case 'month':
-          keyStatDate = new Date(d.getFullYear(), d.getMonth(), 1)
+        case StatsPeriodicity.Month:
+          // Set to the start of the month
+          keyStatDate = new Date(Date.UTC(date.getFullYear(), date.getMonth(), 1, 0, 0, 0, 0))
           break
-        case 'year':
-          keyStatDate = new Date(d.getFullYear(), 0, 1)
+        case StatsPeriodicity.Year:
+          // Set to the start of the year
+          keyStatDate = new Date(Date.UTC(date.getFullYear(), 0, 1, 0, 0, 0, 0))
           break
       }
 
-      keyStatDate.setHours(keyStatDate.getHours() + 15) // To compensate for UTC hours and locales that can cause issues
-      const key = keyStatDate.toISOString().slice(0, 10)
-      if (!grouped[key]) {
-        grouped[key] = { date: keyStatDate, value: 0 }
+      const key = keyStatDate.toISOString()
+      if (!statsByPeriodicity[key]) {
+        statsByPeriodicity[key] = { date: keyStatDate.toISOString(), value: 0 }
       }
-      grouped[key].value += value
+      statsByPeriodicity[key].value += value
     })
 
-    const stats: Stat[] = Object.values(grouped)
-      .sort((a, b) => a.date.getTime() - b.date.getTime())
+    const stats: Stat[] = Object.values(statsByPeriodicity)
+      .sort((a, b) => new Date(a.date).getTime() - new Date(b.date).getTime())
       .map((stat) => ({
         ...stat,
-        date: stat.date.toISOString().split('T')[0]
+        date: stat.date.split('T')[0]
       }))
 
     return {

libs/common/src/stats/types.ts renamed to libs/backend-ddd/src/statistics/domain/types.ts

@@ -1,9 +1,14 @@
-export type StatsPeriodicity = 'day' | 'week' | 'month' | 'year'
+export enum StatsPeriodicity {
+  Day = 'day',
+  Week = 'week',
+  Month = 'month',
+  Year = 'year'
+}
 
 export interface StatQueryParams {
   periodicity?: StatsPeriodicity
-  since?: string
-  to?: string
+  since?: Date
+  to?: Date
 }
 
 export interface Stat {

libs/backend-ddd/src/statistics/index.ts

@@ -1 +1,2 @@
 export * from './application/statisticsService'
+export * from './domain/schemaValidator'

libs/common/src/index.ts

@@ -4,5 +4,5 @@ export * from './establishment'
 export * from './geoSearch/types'
 export * from './opportunity'
 export * from './questionnaire'
-export * from './stats/types'
+export * from '../../backend-ddd/src/statistics/domain/types'
 export * from './validator'