Implement Vulcain directly in API Platform Core
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- php
- Domain
- api, backend-api-design, performance
Research direction
Start by reviewing the API Platform providers and the existing "property" filter, since the issue identifies them as the relevant entry points. Done would mean Vulcain-style early hints and filtering are implemented directly in API Platform Core, but the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Description
The API Platform distribution has been including the Vulcain Gateway server for some time now.
Since API Platform 3.2, the API Platform distribution also uses FrankenPHP, which allows the HTTP status code "103 Early Hints" to be used directly from PHP.
Although the Vulcain Gateway server now supports the sending of 103 Early Hints in addition to HTTP/2 Server Push, this is almost useless do that in the gateway server: the Gateway server must retrieve the full JSON response from the upstream PHP server before it can calculate which resources to send. If the response is already in the cache of a reverse proxy, sending 103 is useless (the final response containing Preload hints added by the gateway server will be sent immediately). Otherwise, the proxy will have to wait for the JSON to be generated by the PHP server before calculating the 103 links, so we're in the same situation.
What would be better - in case the response is not already in the reverse proxy cache - would be for the PHP server to send the 103 response as soon as possible: ideally, in Platform API providers, when the data has been retrieved from the persistence layer, but before serialization generation (which is known to be a tedious task).
In addition to preloading, it would be interesting to also implement the filtering part of Vulcain (building on the existing "property" filter). This would not be very useful for responses that can be cached (it's better to store the complete response in the cache, and let the proxy do the filtering), but it will prevent some useless work when the response isn't cacheable.
- Dominant language
- PHP
- Stars
- 2.6k
- Forks
- 989
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 102
Getting set up
- No Dockerfile or Docker Compose file
- Has a 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 api-platform/core
-
JSON:API: resource schemas (`*.jsonapi`) have `properties` but no `type: object`Possibly taken @ousamabenyounes claimed this 1 day ago. Open
Difficulty 2/5 Under an hour Newbie friendliness 80/100
api-platform/core#8701 ·
Maintainers usually reply within 1 day
-
JSON:API: `JsonApiCollectionBaseSchemaNoPagination` declares `data` as `type: array` without `items`Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
api-platform/core#8699 ·
Maintainers usually reply within 1 day
-
api:openapi:export --spec-version=3.0.0 outputs `webhooks`, which is invalid in OpenAPI 3.0Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
api-platform/core#8690 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
api-platform/core#8680 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
api-platform/core#8725 ·
Maintainers usually reply within 1 day
All issues in api-platform/core
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
grokability/snipe-it#19857 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
Authentication / Authorization Feature: Volunteer
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
WordPress/mcp-adapter#399 ·
Maintainers usually reply within 1 day