MSPCA-11 Add POST /recommendations endpoint by Juwang110 · Pull Request #4 · Code-4-Community/mspca

Juwang110 · 2026-09-27T15:15:54Z

ℹ️ Issue

📝 Description

Adds POST /api/recommendations, which lets a foster coordinator recommend a Chameleon animal to a volunteer before a formal match exists. The body is { volunteerId, chameleonAnimalId }, and the endpoint returns 200 with the saved recommendation (isActive: true). It returns 400 when either ID is missing or isn't a positive integer, and 404 when the volunteer doesn't exist.

Changes:

Added CreateRecommendationDTO, RecommendationsService.create, and the controller route. The route uses @HttpCode(200) because the ticket asks for 200 and Nest's default for POST is 201.
Added VolunteersService.existsById for the 404 check. RecommendationsModule now imports VolunteersModule, and it's registered in AppModule.
create upserts on the (volunteer_id, chameleon_animal_id) primary key. Recommending the same animal twice reactivates the existing row instead of failing with a PK violation, even when two coordinators do it at the same time.
validateId now uses Number.isInteger, so 1.5 and undefined are rejected.
VolunteersModule now imports CoordinatorsModule. Without it, registering FosterVolunteer through autoLoadEntities made the app fail on boot with "Entity metadata for FosterVolunteer#assignedCoordinator was not found".

✔️ Verification

yarn test: all backend suites pass (20 suites, 160 tests). This covers new service and controller tests for success, the 404 case, each 400 case, and the 200 status code.
yarn lint:check, yarn format:check, and tsc --noEmit on the backend are clean.
To check by hand, start the backend and run:
```
curl -i -X POST localhost:3000/api/recommendations \
  -H 'Content-Type: application/json' \
  -d '{"volunteerId": 1, "chameleonAnimalId": 42}'
```
This should return 200 with isActive: true. A volunteer ID that doesn't exist should return 404, and a missing or non-integer ID should return 400.

🏕️ (Optional) Future Work / Notes

Lets foster coordinators recommend a Chameleon animal to a volunteer before a formal match exists. New recommendations default to isActive: true and the endpoint returns 200 with the created row. - CreateRecommendationDTO validates volunteerId and chameleonAnimalId as positive integers; the controller re-checks with validateId so the guard holds when the handler is called directly - 404 when the volunteer does not exist, via VolunteersService.existsById - validateId now rejects non-integers, which the "valid integer" rule needs - Registers RecommendationsModule on the app module Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

@httpcode

Code review caught that registering RecommendationsModule made the app fail to boot. It pulls in VolunteersModule, the first forFeature module reachable from AppModule, so autoLoadEntities handed TypeORM FosterVolunteer without FosterCoordinator - which its assignedCoordinator relation targets - and metadata building threw before app.listen. No test caught it because none stand up the module graph. - VolunteersModule now imports CoordinatorsModule, so it is self-contained wherever it is registered rather than relying on the app module - recommendations.module.spec asserts the entity graph reachable from the module is closed under relations; it fails without the fix above - Service upserts on the composite key instead of save(), so two coordinators recommending the same animal at once cannot race into a primary key violation surfacing as a 500 - Pin the 200 status the ticket requires, so dropping @httpcode fails Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

dburkhart07

some initial things but looks really good so far. learned a thing or to about repo commands from this one 🐢

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

pujitakalinadhabhotla · 2026-10-01T01:07:18Z

+    summary: 'Recommend a Chameleon Animal to an active Volunteer',
+  })
+  @ApiResponse({
+    status: HttpStatus.CREATED,


Should this endpoint be returning 200 OK instead of Nest’s default 201 Created? Since the ticket calls for POST /api/recommendations to return 200 with the saved recommendation

@dburkhart07 thoughts? after saying to drop the @httpcode(HttpStatus.OK) override

good callouts! i think the ticket was a mistake, we should be returning a 201 here for a created, since thats what all POST endpoints should have.

dburkhart07

could we also document all service functions using the following docstring format:

Summary line describing the function
Additional context about behavior or edge cases
@PARAM tags for parameters
@return tags for return value
@throw tags for any exceptions they throw

@PARAM

- Document RecommendationsService.create and VolunteersService.findActiveOrFail with summary, context, @PARAM, @returns and @throws - Assert findOneBy is called in the not-found and inactive findActiveOrFail tests - Drop controller tests for malformed IDs, which the DTO's class-validator decorators already cover - Replace the redundant "defaults to active" service test with one for reactivating an inactive recommendation Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…ations-endpoint # Conflicts: # apps/backend/src/app.module.ts # apps/backend/src/volunteers/volunteers.module.ts # apps/backend/src/volunteers/volunteers.service.spec.ts # apps/backend/src/volunteers/volunteers.service.ts

dburkhart07

all small things so ill approve! ty justin 🐯

dburkhart07 · 2026-10-03T19:35:07Z

@@ -0,0 +1,11 @@
+import { IsInt, IsPositive } from 'class-validator';


can we put this file in a dto directory within recommendations?

dburkhart07 · 2026-10-03T19:39:23Z

+    summary: 'Recommend a Chameleon Animal to an active Volunteer',
+  })
+  @ApiResponse({
+    status: HttpStatus.CREATED,


good callouts! i think the ticket was a mistake, we should be returning a 201 here for a created, since thats what all POST endpoints should have.

dburkhart07 · 2026-10-03T19:43:48Z

+      expect(recommendationsService.create).toHaveBeenCalledWith(body);
+    });
+
+    it.each([


i think we can just put this into one test and include both in the description (like 'does not create a recommendation when the volunteer does not exist or is not active'), since these are using the exact same mock

Juwang110 and others added 2 commits September 24, 2026 22:05

Juwang110 changed the title ~~Add POST /recommendations endpoint~~ MSPCA-11 Add POST /recommendations endpoint Sep 27, 2026

justin-wang110 and others added 3 commits September 27, 2026 13:38

Remove recommendations module spec

0919162

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Remove explanatory comments

e5d347e

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Restore example service functions in VolunteersService

1c7edd7

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Juwang110 marked this pull request as ready for review September 27, 2026 17:44

Respect @column names in PluralNamingStrategy

498dea5

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Juwang110 mentioned this pull request Sep 27, 2026

MSPCA-10 Add GET /volunteers/:id/matches endpoint #5

Merged

dburkhart07 requested review from dburkhart07 and pujitakalinadhabhotla September 28, 2026 18:53

dburkhart07 requested changes Sep 29, 2026

View reviewed changes

Respond to review comments

f3d9709

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Juwang110 requested a review from dburkhart07 September 29, 2026 21:51

dburkhart07 requested changes Sep 30, 2026

View reviewed changes

pujitakalinadhabhotla reviewed Oct 1, 2026

View reviewed changes

dburkhart07 requested changes Oct 1, 2026

View reviewed changes

Merge branch 'main' into jw/mspca-11-recommendations-endpoint

e725b6e

Juwang110 requested review from dburkhart07 and pujitakalinadhabhotla October 3, 2026 14:38

Juwang110 and others added 3 commits October 3, 2026 10:41

remove comment

5f15894

dburkhart07 approved these changes Oct 3, 2026

View reviewed changes

		@@ -0,0 +1,11 @@
		import { IsInt, IsPositive } from 'class-validator';

Conversation

Juwang110 commented Sep 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ℹ️ Issue

📝 Description

✔️ Verification

🏕️ (Optional) Future Work / Notes

Uh oh!

dburkhart07 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pujitakalinadhabhotla Oct 1, 2026

Choose a reason for hiding this comment

Uh oh!

Juwang110 Oct 3, 2026

Choose a reason for hiding this comment

Uh oh!

dburkhart07 Oct 3, 2026

Choose a reason for hiding this comment

Uh oh!

dburkhart07 left a comment

Choose a reason for hiding this comment

Uh oh!

dburkhart07 left a comment

Choose a reason for hiding this comment

Uh oh!

dburkhart07 Oct 3, 2026

Choose a reason for hiding this comment

Uh oh!

dburkhart07 Oct 3, 2026

Choose a reason for hiding this comment

Uh oh!

dburkhart07 Oct 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Juwang110 commented Sep 27, 2026 •

edited

Loading