Merge pull request #130 from upskill-team/feature/appeal-search-endpoint

Feature: Appeal search with filters endpoint

Author: carlex74

pnpm-lock.yaml

@@ -7,6 +7,8 @@ import { NextFunction, Request, Response } from 'express'
 import { orm } from '../../shared/db/orm.js'
 import { AppealService } from './appeal.service.js'
 import { HttpResponse } from '../../shared/response/http.response.js'
+import * as v from 'valibot'
+import { SearchAppealsSchema } from './appeal.schemas.js'
 
 /**
  * Handles the creation of a new appeal.
@@ -39,18 +41,32 @@ async function add(req: Request, res: Response, next: NextFunction) {
 }
 
 /**
- * Handles the retrieval of all appeals.
- * @param {Request} req The Express request object.
+ * Handles the retrieval of all appeals with filtering, sorting, and pagination.
+ * @param {Request} req The Express request object, containing query parameters.
  * @param {Response} res The Express response object.
  * @param {NextFunction} next The next middleware function.
- * @returns {Promise<Response>} A list of all appeals.
+ * @returns {Promise<Response>} A paginated list of appeals.
  */
 async function findAll(req: Request, res: Response, next: NextFunction) {
   try {
+    const validatedQuery = v.parse(SearchAppealsSchema, req.query);
+    
     const appealService = new AppealService(orm.em.fork(), req.log)
-    const appeals = await appealService.findAll()
-    return HttpResponse.Ok(res, appeals)
+    const result = await appealService.findAll(validatedQuery)
+    
+    return HttpResponse.Ok(res, result)
+
   } catch (error) {
+    if (error instanceof v.ValiError) {
+      const errorDetails = error.issues.map(issue => ({
+        field: issue.path?.map((p: { key: any; }) => p.key).join('.'),
+        message: issue.message,
+      }));
+      return HttpResponse.BadRequest(res, {
+        message: 'Parámetros de consulta inválidos.',
+        errors: errorDetails,
+      });
+    }
     next(error)
   }
 }

src/models/appeal/appeal.controller.ts

@@ -5,6 +5,12 @@
 
 import * as v from 'valibot';
 
+const NumericString = v.pipe(
+  v.string('El valor debe ser un string.'),
+  v.regex(/^\d+$/, 'Debe contener solo dígitos.'),
+  v.transform(Number)
+);
+
 /**
  * Schema for creating a new appeal. Validates the required fields for submitting a professor application.
  */
@@ -36,5 +42,29 @@ export const UpdateAppealSchema = v.object({
   ),
 });
 
+/**
+ * Schema for searching/filtering appeals via query parameters.
+ * Valida y transforma los parámetros de la URL para la búsqueda.
+ */
+export const SearchAppealsSchema = v.object({
+
+  status: v.optional(v.picklist(['pending', 'accepted', 'rejected'])),
+  q: v.optional(v.string()),
+
+  limit: v.optional(NumericString, '10'),
+  offset: v.optional(NumericString, '0'), 
+
+  sortBy: v.optional(v.string(), 'date'),
+  sortOrder: v.optional(
+    v.pipe(
+      v.string(),
+      v.regex(/^(ASC|DESC)$/i, 'sortOrder debe ser "ASC" o "DESC".'),
+      v.transform(val => val.toUpperCase() as 'ASC' | 'DESC')
+    ),
+    'DESC'
+  ),
+});
+
 export type CreateAppealType = v.InferOutput<typeof CreateAppealSchema>;
 export type UpdateAppealType = v.InferOutput<typeof UpdateAppealSchema>;
+export type SearchAppealsQuery = v.InferOutput<typeof SearchAppealsSchema>;

src/models/appeal/appeal.schemas.ts

@@ -3,9 +3,9 @@
  * @remarks Encapsulates the business logic for managing professor appeals.
  */
 
-import { EntityManager } from '@mikro-orm/core'
+import { EntityManager, FilterQuery } from '@mikro-orm/core'
 import { Appeal } from './appeal.entity.js'
-import { CreateAppealType, UpdateAppealSchema, UpdateAppealType } from './appeal.schemas.js'
+import { CreateAppealType, SearchAppealsQuery, UpdateAppealSchema, UpdateAppealType } from './appeal.schemas.js'
 import { User } from '../user/user.entity.js'
 import { ProfessorService } from '../professor/professor.services.js'
 import { ObjectId } from '@mikro-orm/mongodb'
@@ -58,13 +58,37 @@ export class AppealService {
   }
 
   /**
-   * Retrieves all appeals, populating the associated user information.
-   * @returns {Promise<Appeal[]>} A promise that resolves to an array of all appeals.
+   * Retrieves all appeals based on filter, sort, and pagination parameters.
+   * @param {SearchAppealsQuery} query - The validated query parameters.
+   * @returns {Promise<{appeals: Appeal[], total: number}>} An object with the list of appeals and the total count.
    */
-  public async findAll(): Promise<Appeal[]> {
-    this.logger.info('Fetching all appeals.')
+  public async findAll(query: SearchAppealsQuery): Promise<{ appeals: Appeal[], total: number }> {
+    this.logger.info({ query }, 'Fetching all appeals with filters.')
 
-    return this.em.find(Appeal, {}, { populate: ['user'] })
+    const where: FilterQuery<Appeal> = {};
+
+    if (query.status) {
+      where.state = query.status;
+    }
+
+    if (query.q) {
+      const searchQuery = { $ilike: `%${query.q}%` };
+      where.user = {
+        $or: [
+          { name: searchQuery },
+          { surname: searchQuery }
+        ]
+      };
+    }
+
+    const [appeals, total] = await this.em.findAndCount(Appeal, where, {
+      populate: ['user'],
+      orderBy: { [query.sortBy]: query.sortOrder },
+      limit: query.limit,
+      offset: query.offset,
+    });
+
+    return { appeals, total };
   }
 
   /**
@@ -74,7 +98,6 @@ export class AppealService {
    */
   public async findOne(id: string): Promise<Appeal | null> {
     this.logger.info({ appealId: id }, 'Fetching appeal.')
-
     const objectId = new ObjectId(id);
     return this.em.findOne(Appeal, { _id: objectId }, { populate: ['user'] })
   }