fix(openapi): entrypoint text/html 200 (#5868)

Author: soyuka

features/hydra/entrypoint.feature

@@ -4,6 +4,7 @@ Feature: Entrypoint support
   I need to access to an entrypoint listing top-level resources
 
   Scenario: Retrieve the Entrypoint
+    When I add "Accept" header equal to "application/ld+json"
     When I send a "GET" request to "/"
     Then the response status code should be 200
     And the response should be in JSON

features/openapi/docs.feature

@@ -362,3 +362,9 @@ Feature: Documentation support
     And I send a "GET" request to "/docs"
     Then the response status code should be 200
     And the header "Content-Type" should be equal to "application/vnd.openapi+yaml; charset=utf-8"
+
+    Scenario: Retrieve the OpenAPI documentation
+    Given I add "Accept" header equal to "text/html"
+    And I send a "GET" request to "/"
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "text/html; charset=utf-8"

src/Documentation/Action/EntrypointAction.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Documentation\Entrypoint;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Metadata\Resource\ResourceNameCollection;
 use ApiPlatform\State\ProcessorInterface;
 use ApiPlatform\State\ProviderInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -27,6 +28,8 @@
  */
 final class EntrypointAction
 {
+    private static ResourceNameCollection $resourceNameCollection;
+
     public function __construct(
         private readonly ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory,
         private readonly ProviderInterface $provider,
@@ -35,12 +38,21 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Request $request = null)
+    public function __invoke(Request $request)
     {
+        static::$resourceNameCollection = $this->resourceNameCollectionFactory->create();
         $context = ['request' => $request];
-        $operation = new Get(outputFormats: $this->documentationFormats, read: true, serialize: true, class: Entrypoint::class, provider: fn () => new Entrypoint($this->resourceNameCollectionFactory->create()));
+        $request->attributes->set('_api_platform_disable_listeners', true);
+        $operation = new Get(outputFormats: $this->documentationFormats, read: true, serialize: true, class: Entrypoint::class, provider: [self::class, 'provide']);
+        $request->attributes->set('_api_operation', $operation);
         $body = $this->provider->provide($operation, [], $context);
+        $operation = $request->attributes->get('_api_operation');
 
         return $this->processor->process($body, $operation, [], $context);
     }
+
+    public static function provide(): Entrypoint
+    {
+        return new Entrypoint(static::$resourceNameCollection);
+    }
 }

src/Symfony/Bundle/Resources/config/api.xml

@@ -96,7 +96,7 @@
         <service id="ApiPlatform\Action\NotFoundAction" alias="api_platform.action.not_found" public="true" />
         <service id="ApiPlatform\Action\NotExposedAction" alias="api_platform.action.not_exposed" public="true" />
 
-        <service id="api_platform.action.entrypoint" class="ApiPlatform\Action\EntrypointAction" public="true">
+        <service id="api_platform.action.entrypoint" class="ApiPlatform\Documentation\Action\EntrypointAction" public="true">
             <argument type="service" id="api_platform.metadata.resource.name_collection_factory" />
             <argument type="service" id="api_platform.state_provider.main" on-invalid="null" />
             <argument type="service" id="api_platform.state_processor.main" on-invalid="null" />

src/Symfony/Bundle/Resources/config/legacy/events.xml

@@ -10,6 +10,7 @@
             <argument>%api_platform.formats%</argument>
             <argument>%api_platform.error_formats%</argument>
             <argument>%api_platform.docs_formats%</argument>
+            <argument>%api_platform.event_listeners_backward_compatibility_layer%</argument>
 
             <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" priority="28" />
         </service>

src/Symfony/EventListener/AddFormatListener.php

@@ -34,7 +34,7 @@ final class AddFormatListener
 {
     use OperationRequestInitiatorTrait;
 
-    public function __construct(private readonly Negotiator $negotiator, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, private readonly array $formats = [], private readonly array $errorFormats = [], private readonly array $docsFormats = [])
+    public function __construct(private readonly Negotiator $negotiator, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, private readonly array $formats = [], private readonly array $errorFormats = [], private readonly array $docsFormats = [], private readonly bool $eventsBackwardCompatibility = true)
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
     }
@@ -50,7 +50,7 @@ public function onKernelRequest(RequestEvent $event): void
         $request = $event->getRequest();
         $operation = $this->initializeOperation($request);
 
-        if ('api_platform.symfony.main_controller' === $operation?->getController()) {
+        if ('api_platform.symfony.main_controller' === $operation?->getController() || ($this->eventsBackwardCompatibility && 'api_platform.action.entrypoint' === $request->attributes->get('_controller')) || $request->attributes->get('_api_platform_disable_listeners')) {
             return;
         }
 

src/Symfony/EventListener/AddHeadersListener.php

@@ -35,7 +35,7 @@ public function __construct(private readonly bool $etag = false, private readonl
     public function onKernelResponse(ResponseEvent $event): void
     {
         $request = $event->getRequest();
-        if (!$request->isMethodCacheable()) {
+        if (!$request->isMethodCacheable() || $request->attributes->get('_api_platform_disable_listeners')) {
             return;
         }
 

src/Symfony/EventListener/AddLinkHeaderListener.php

@@ -49,7 +49,7 @@ public function onKernelResponse(ResponseEvent $event): void
         $operation = $this->initializeOperation($request);
 
         // API Platform 3.2 has a MainController where everything is handled by processors/providers
-        if ('api_platform.symfony.main_controller' === $operation?->getController() || $this->isPreflightRequest($request)) {
+        if ('api_platform.symfony.main_controller' === $operation?->getController() || $this->isPreflightRequest($request) || $request->attributes->get('_api_platform_disable_listeners')) {
             return;
         }
 

src/Symfony/EventListener/AddTagsListener.php

@@ -58,6 +58,7 @@ public function onKernelResponse(ResponseEvent $event): void
             !$request->isMethodCacheable()
             || !$response->isCacheable()
             || (!$attributes = RequestAttributesExtractor::extractAttributes($request))
+            || $request->attributes->get('_api_platform_disable_listeners')
         ) {
             return;
         }

src/Symfony/EventListener/DenyAccessListener.php

@@ -62,7 +62,7 @@ public function onSecurityPostValidation(ViewEvent $event): void
      */
     private function checkSecurity(Request $request, string $attribute, array $extraVariables = []): void
     {
-        if (!$this->resourceAccessChecker || !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
+        if ($request->attributes->get('_api_platform_disable_listeners') || !$this->resourceAccessChecker || !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
             return;
         }