New "_api_persist" request attribute to skip the WriteListener

src/EventListener/WriteListener.php

@@ -37,7 +37,7 @@ public function __construct(DataPersisterInterface $dataPersister)
     public function onKernelView(GetResponseForControllerResultEvent $event)
     {
         $request = $event->getRequest();
-        if ($request->isMethodSafe(false) || !$request->attributes->has('_api_resource_class')) {
+        if ($request->isMethodSafe(false) || !$request->attributes->has('_api_resource_class') || !$request->attributes->getBoolean('_api_persist', true)) {
             return;
         }
 

src/Util/AttributesExtractor.php

@@ -58,11 +58,10 @@ public static function extractAttributes(array $attributes): array
             return [];
         }
 
-        if (null === $apiRequest = $attributes['_api_receive'] ?? null) {
-            $result['receive'] = true;
-        } else {
-            $result['receive'] = (bool) $apiRequest;
-        }
+        $result += [
+            'receive' => (bool) ($attributes['_api_receive'] ?? true),
+            'persist' => (bool) ($attributes['_api_persist'] ?? true),
+        ];
 
         return $result;
     }

tests/Bridge/Symfony/Bundle/DataCollector/RequestDataCollectorTest.php

@@ -107,7 +107,7 @@ public function testWithResource()
             $this->response
         );
 
-        $this->assertSame(['resource_class' => DummyEntity::class,  'item_operation_name' => 'get', 'receive' => true], $dataCollector->getRequestAttributes());
+        $this->assertSame(['resource_class' => DummyEntity::class,  'item_operation_name' => 'get', 'receive' => true, 'persist' => true], $dataCollector->getRequestAttributes());
         $this->assertSame(['foo', 'bar'], $dataCollector->getAcceptableContentTypes());
         $this->assertSame(DummyEntity::class, $dataCollector->getResourceClass());
         $this->assertSame(['foo' => null, 'a_filter' => \stdClass::class], $dataCollector->getFilters());

tests/EventListener/AddFormatListenerTest.php

@@ -224,7 +224,7 @@ public function testResourceClassSupportedRequestFormat()
         $event = $eventProphecy->reveal();
 
         $formatsProviderProphecy = $this->prophesize(FormatsProviderInterface::class);
-        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get', 'receive' => true])->willReturn(['csv' => ['text/csv']])->shouldBeCalled();
+        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get', 'receive' => true, 'persist' => true])->willReturn(['csv' => ['text/csv']])->shouldBeCalled();
 
         $listener = new AddFormatListener(new Negotiator(), $formatsProviderProphecy->reveal());
         $listener->onKernelRequest($event);

tests/EventListener/DeserializeListenerTest.php

@@ -172,7 +172,7 @@ public function testDeserializeResourceClassSupportedFormat(string $method, bool
         $serializerContextBuilderProphecy->createFromRequest(Argument::type(Request::class), false, Argument::type('array'))->willReturn([])->shouldBeCalled();
 
         $formatsProviderProphecy = $this->prophesize(FormatsProviderInterface::class);
-        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true])->willReturn(self::FORMATS)->shouldBeCalled();
+        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true, 'persist' => true])->willReturn(self::FORMATS)->shouldBeCalled();
 
         $listener = new DeserializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal(), $formatsProviderProphecy->reveal());
 

tests/EventListener/WriteListenerTest.php

@@ -170,6 +170,31 @@ public function testOnKernelViewWithSafeMethod()
         (new WriteListener($dataPersisterProphecy->reveal()))->onKernelView($event);
     }
 
+    public function testOnKernelViewWithPersistFlagOff()
+    {
+        $dummy = new Dummy();
+        $dummy->setName('Dummyrino');
+
+        $dataPersisterProphecy = $this->prophesize(DataPersisterInterface::class);
+        $dataPersisterProphecy->supports($dummy)->shouldNotBeCalled();
+        $dataPersisterProphecy->persist($dummy)->shouldNotBeCalled();
+        $dataPersisterProphecy->remove($dummy)->shouldNotBeCalled();
+
+        $request = new Request();
+        $request->setMethod('HEAD');
+        $request->attributes->set('_api_resource_class', Dummy::class);
+        $request->attributes->set('_api_persist', false);
+
+        $event = new GetResponseForControllerResultEvent(
+            $this->prophesize(HttpKernelInterface::class)->reveal(),
+            $request,
+            HttpKernelInterface::MASTER_REQUEST,
+            $dummy
+        );
+
+        (new WriteListener($dataPersisterProphecy->reveal()))->onKernelView($event);
+    }
+
     public function testOnKernelViewWithNoResourceClass()
     {
         $dummy = new Dummy();

tests/Serializer/SerializerFilterContextBuilderTest.php

@@ -154,6 +154,7 @@ public function testCreateFromRequestWithoutAttributes()
             'resource_class' => DummyGroup::class,
             'collection_operation_name' => 'get',
             'receive' => true,
+            'persist' => true,
         ];
 
         $resourceMetadata = new ResourceMetadata(

tests/Util/RequestAttributesExtractorTest.php

@@ -27,7 +27,7 @@ public function testExtractCollectionAttributes()
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'post']);
 
         $this->assertEquals(
-            ['resource_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true],
+            ['resource_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true, 'persist' => true],
             RequestAttributesExtractor::extractAttributes($request)
         );
     }
@@ -37,7 +37,7 @@ public function testExtractItemAttributes()
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get']);
 
         $this->assertEquals(
-            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true],
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true, 'persist' => true],
             RequestAttributesExtractor::extractAttributes($request)
         );
     }
@@ -47,21 +47,45 @@ public function testExtractReceive()
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get', '_api_receive' => '0']);
 
         $this->assertEquals(
-            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => false],
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => false, 'persist' => true],
             RequestAttributesExtractor::extractAttributes($request)
         );
 
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get', '_api_receive' => '1']);
 
         $this->assertEquals(
-            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true],
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true, 'persist' => true],
             RequestAttributesExtractor::extractAttributes($request)
         );
 
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get']);
 
         $this->assertEquals(
-            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true],
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true, 'persist' => true],
+            RequestAttributesExtractor::extractAttributes($request)
+        );
+    }
+
+    public function testExtractPersist()
+    {
+        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get', '_api_persist' => '0']);
+
+        $this->assertEquals(
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true, 'persist' => false],
+            RequestAttributesExtractor::extractAttributes($request)
+        );
+
+        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get', '_api_persist' => '1']);
+
+        $this->assertEquals(
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true, 'persist' => true],
+            RequestAttributesExtractor::extractAttributes($request)
+        );
+
+        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get']);
+
+        $this->assertEquals(
+            ['resource_class' => 'Foo', 'item_operation_name' => 'get', 'receive' => true, 'persist' => true],
             RequestAttributesExtractor::extractAttributes($request)
         );
     }