Begin Introduction of new 'sunset' API-Resource annotation in order to support: sunset header

Author: blanky0230

src/Annotation/ApiResource.php

@@ -51,8 +51,9 @@
  *     @Attribute("routePrefix", type="string"),
  *     @Attribute("shortName", type="string"),
  *     @Attribute("subresourceOperations", type="array"),
+ *     @Attribute("sunset", type="string"),
  *     @Attribute("swaggerContext", type="array"),
- *     @Attribute("validationGroups", type="mixed")
+ *     @Attribute("validationGroups", type="mixed"),
  * )
  */
 final class ApiResource
@@ -248,6 +249,11 @@ final class ApiResource
      */
     private $validationGroups;
 
+    /**
+     * @var string
+     */
+    private $sunset;
+
     /**
      * @throws InvalidArgumentException
      */

src/Sunset/EventListener/AddSunsetHeaderListener.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Sunset\EventListener;
+
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Util\RequestAttributesExtractor;
+use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+
+class AddSunsetHeaderListener
+{
+    private $resourceMetadataFactory;
+
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
+    {
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
+    }
+
+    public function onKernelResponse(FilterResponseEvent $event)
+    {
+        $request = $event->getRequest();
+        $attributes = RequestAttributesExtractor::extractAttributes($request);
+
+        if (!$attributes) {
+            return;
+        }
+
+        $response = $event->getResponse();
+        $metadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
+
+        if (null !== $metadata->getAttribute('sunset')) {
+            $response->headers->set('Sunset', $metadata->getAttribute('sunset'));
+        }
+    }
+}

tests/Annotation/ApiResourceTest.php

@@ -54,6 +54,7 @@ public function testConstruct()
             'shortName' => 'shortName',
             'subresourceOperations' => [],
             'validationGroups' => ['foo', 'bar'],
+            'sunset' => 'Thu, 11 Oct 2018 00:00:00 +0200',
         ]);
 
         $this->assertSame('shortName', $resource->shortName);
@@ -84,6 +85,7 @@ public function testConstruct()
             'pagination_partial' => true,
             'route_prefix' => '/foo',
             'validation_groups' => ['baz', 'qux'],
+            'sunset' => 'Thu, 11 Oct 2018 00:00:00 +0200',
         ], $resource->attributes);
     }
 

tests/Sunset/AddSunsetHeaderListenerTest.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Sunset;
+
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
+use ApiPlatform\Core\Sunset\EventListener\AddSunsetHeaderListener;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+
+class AddSunsetHeaderListenerTest extends TestCase
+{
+    public function testSetSunsetHeader()
+    {
+        $request = new Request([], [], ['_api_resource_class' => Dummy::class, '_api_item_operation_name' => 'get']);
+        $request->setMethod('GET');
+        $response = new Response();
+        $date = new \DateTimeImmutable('tomorrow');
+
+        $eventProphecy = $this->prophesize(FilterResponseEvent::class);
+        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
+        $eventProphecy->getResponse()->willReturn($response)->shouldBeCalled();
+        $event = $eventProphecy->reveal();
+
+        $resourceMetadata = new ResourceMetadata(null, null, null, null,
+            null, ['sunset' => $date->format(DATE_RFC1123)]);
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $resourceMetadataFactoryProphecy->create(Dummy::class)->willReturn($resourceMetadata)->shouldBeCalled();
+
+        $listener = new AddSunsetHeaderListener($resourceMetadataFactoryProphecy->reveal());
+        $listener->onKernelResponse($event);
+        $this->assertSame($event->getResponse(), $response);
+        $this->assertEquals($date,
+            \DateTime::createFromFormat(DATE_RFC1123, $event->getResponse()->headers->get('Sunset')));
+    }
+}