feat: allow filtering events by campus ID

package.json

@@ -23,6 +23,8 @@
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/schedule": "^4.0.2",
     "cache-manager": "^5.5.2",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "ical-generator": "^7.1.0",
     "parse-link-header": "^2.0.0",
     "reflect-metadata": "^0.2.0",

src/common/utils/filter-events-by-campus-ids.ts

@@ -0,0 +1,11 @@
+import { FindEventsResponseDto } from '../../ft-api/dto/find-events-response.dto';
+import { FindAllEventsDto } from '../../events/dto/find-all-events.dto';
+
+export function filterEventsByCampusIds(events: FindEventsResponseDto, campusIds: FindAllEventsDto['campusIds']) {
+  if (campusIds === undefined) {
+    return events;
+  }
+  return events.filter((event) => {
+    return event.campus_ids.some((campusId) => campusIds.includes(campusId));
+  });
+}

src/events/dto/find-all-events.dto.ts

@@ -0,0 +1,7 @@
+import { IsNumberString, IsOptional } from 'class-validator';
+
+export class FindAllEventsDto {
+  @IsOptional()
+  @IsNumberString({}, { each: true })
+  campusIds?: Array<number>;
+}

src/events/events.controller.ts

@@ -1,15 +1,18 @@
-import { Controller, Get, UseInterceptors } from '@nestjs/common';
+import { Controller, Get, ParseArrayPipe, Query, UseInterceptors } from '@nestjs/common';
 import { EventsService } from './events.service';
 import { EventsToIcsInterceptor } from '../events-to-ics/events-to-ics.interceptor';
 import { CALENDAR_NAME_ALL_EVENTS } from '../common/constants/calendars-name';
+import { FindAllEventsDto } from './dto/find-all-events.dto';
 
 @Controller('events')
 export class EventsController {
   constructor(private readonly eventsService: EventsService) {}
 
   @Get()
   @UseInterceptors(new EventsToIcsInterceptor({ name: CALENDAR_NAME_ALL_EVENTS }))
-  findAll() {
-    return this.eventsService.findAll();
+  findAll(
+    @Query('campusIds', new ParseArrayPipe({ items: Number, separator: ',' })) campusIds: FindAllEventsDto['campusIds'],
+  ) {
+    return this.eventsService.findAll({ campusIds });
   }
 }

src/events/events.http

@@ -1,2 +1,8 @@
 ### GET all events
 {{base_url}}/events
+
+### GET all events from Paris campus
+{{base_url}}/events?campusIds=1
+
+### GET all events from Paris and Málaga campuses
+{{base_url}}/events?campusIds=1,37

src/events/events.service.ts

@@ -9,6 +9,9 @@ import {
 } from '../common/constants/ft-api-cache';
 import { CACHE_MANAGER } from '@nestjs/cache-manager';
 import { Cache } from 'cache-manager';
+import { FindAllEventsDto } from './dto/find-all-events.dto';
+import { FindEventsResponseDto } from '../ft-api/dto/find-events-response.dto';
+import { filterEventsByCampusIds } from '../common/utils/filter-events-by-campus-ids';
 
 @Injectable()
 export class EventsService {
@@ -27,8 +30,11 @@ export class EventsService {
     await this.cacheManager.set(FT_CACHED_EVENTS_CACHE_KEY, events, FT_CACHED_EVENTS_TTL);
   }
 
-  async findAll() {
-    return (await this.cacheManager.get(FT_CACHED_EVENTS_CACHE_KEY)) ?? FT_DEFAULT_EVENTS_LIST;
+  async findAll({ campusIds }: FindAllEventsDto) {
+    return filterEventsByCampusIds(
+      (await this.cacheManager.get<FindEventsResponseDto>(FT_CACHED_EVENTS_CACHE_KEY)) ?? FT_DEFAULT_EVENTS_LIST,
+      campusIds,
+    );
   }
 
   async findAllFromDefaultCampus() {

src/ft-api/dto/find-events-response.dto.ts

@@ -3,6 +3,7 @@ import { z } from 'zod';
 export const findEventsResponseSchema = z.array(
   z.object({
     name: z.string(),
+    campus_ids: z.array(z.number()),
     description: z.string(),
     location: z.string(),
     begin_at: z.string(),

src/main.ts

@@ -1,8 +1,15 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
+import { ValidationPipe } from '@nestjs/common';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+  app.useGlobalPipes(
+    new ValidationPipe({
+      transform: true,
+      whitelist: true,
+    }),
+  );
   await app.listen(3000);
 }
 bootstrap();