Autowiring: resolve union and intersection parameter types in DiContainer
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
Research direction
Start by reading resolveParameter() in src/Di/DiContainer.php and note where it only handles ReflectionNamedType; also read autowire() since it shares that path. Add the new named constructor and message template in src/Di/Enums/ExceptionMessages.php, then write failing cases in tests/Unit/Di/ for each scenario listed in Acceptance. Done means those tests pass, ambiguous unions are not guessed, unsatisfied intersections are rejected, and CHANGELOG.md records the behavior change.
Written by the indexing model from the issue text.
Description
Problem
Quantum\Di\DiContainer::resolveParameter() reads a parameter type only when it is a ReflectionNamedType. For a union (A|B) or an intersection (Reader&Writer) type the type is ignored, so the parameter falls through to the passed arguments, then the default value, then null.
Result (checked on PHP 8.1):
public function __construct(A|B $dep)fails with aTypeErrorthat gives no hint about the container.public function __construct(A|B|null $dep)silently receivesnull, even whenAis registered in the container.Reader&Writeris never resolved, even when an implementing class is registered.
Proposal
Resolve a union or intersection parameter only when the choice is unambiguous. Never guess from the declaration order and never pass null silently.
- Union: drop
nulland builtin members. If exactly one remaining member can be resolved (it is registered in the container, or it is an instantiable class), use it. If several can, do not pick one. - Intersection: use a registered or instantiable member and check that the result satisfies every part of the type (
instanceoffor each). A result that does not satisfy all parts is not used. - Otherwise: keep the existing order (passed argument, default value). If neither exists, throw a
DiExceptionwith a clear message (new named constructor and message template insrc/Di/Enums/ExceptionMessages.php) that names the class, the parameter and the type, instead of aTypeErroror a silentnull. - The same rules apply to
autowire()of a closure, which sharesresolveParameter().
Why not the order of declaration
Other containers differ: one rejects union types (Marko, a clear exception), one tries members in declaration order (Tempest, which also does not check that an intersection is satisfied as a whole), one tries each branch and verifies it (Canvas). Declaration order makes A|B and B|A behave differently, so it is not used here.
Acceptance
- Tests in
tests/Unit/Di/for: union with one registered member, union with none, union with several resolvable members,A|B|nullwith and without a default, intersection with a registered implementation that satisfies all parts, intersection that does not, closure autowiring. CHANGELOG.mdentry. A parameter that failed before with aTypeErrornow resolves or throws aDiException; the exception type changes, so it is noted as a behavior change.
Milestone 3.2.0 (a different exception type on a path that used to throw TypeError).
- Dominant language
- PHP
- Stars
- 43
- Forks
- 22
- Avg merge
- 54m
- Merged PRs (30d)
- 57
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quantum-php/framework
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
quantum-php/framework#692 ·
Maintainers usually reply within 1 day
-
routing testing
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
quantum-php/framework#547 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 72/100
quantum-php/framework#694 ·
Maintainers usually reply within 1 day
-
refactoring tech debt
Difficulty 5/5 Over a week Newbie friendliness 20/100
quantum-php/framework#693 ·
Maintainers usually reply within 1 day
-
install:debugbar reads the package folder from the working directory and uses the default storage adapterPossibly taken @armanist claimed this today. Openbug console debugbar good first issue
quantum-php/framework#691 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in quantum-php/framework
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
dependencies enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day
-
bug origin:interactive status:available
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Ultimate-Multisite/ultimate-multisite#2131 ·
Maintainers usually reply within 1 day
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day