BenMakesGames/PoppySeedPets

controllers should use bespoke request DTOs instead of the `Request` service

Open

#18 opened on Apr 5, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)PHP (6 forks)auto 404
good first issuetech debt

Repository metrics

Stars
 (14 stars)
PR merge metrics
 (PR metrics pending)

Description

Symfony added this feature a bit ago: https://symfony.com/blog/new-in-symfony-6-3-mapping-request-data-to-typed-objects

the LogInController uses it, but few other endpoints do. upgrade all controllers that handle requests to use them.

other notes:

  • if you find a controller that really feels like "nah, it should keep using Request", add a comment explaining why Request is being used instead of a request DTO
  • request DTOs must live in the same file as the controller that uses them
    • do not fall for the trap of "false sameness" - 99%+ of request DTOs have no business being shared between multiple endpoints

it's totally legit to upgrade just one endpoint or a small group of endpoints in a PR; this issue will be closed when no controllers remain which are using Request.

Contributor guide

Research direction
Pick a controller that uses the Request object, create a DTO class in the same file, and map the request data to it using Symfony's ValueResolver.
Tech stack
php
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHPSymfony
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65