add flag metadata + few fixes + headers/status

Author: soyuka

composer.json

@@ -110,7 +110,6 @@
         "symfony/deprecation-contracts": "^3.1",
         "symfony/http-foundation": "^6.4 || ^7.0",
         "symfony/http-kernel": "^6.4 || ^7.0",
-        "symfony/json-streamer": "^7.3",
         "symfony/property-access": "^6.4 || ^7.0",
         "symfony/property-info": "^6.4 || ^7.1",
         "symfony/serializer": "^6.4 || ^7.0",
@@ -173,9 +172,10 @@
         "symfony/expression-language": "^6.4 || ^7.0",
         "symfony/finder": "^6.4 || ^7.0",
         "symfony/form": "^6.4 || ^7.0",
-        "symfony/framework-bundle": "^6.4 || ^7.0",
+        "symfony/framework-bundle": "7.4.x-dev",
         "symfony/http-client": "^6.4 || ^7.0",
         "symfony/intl": "^6.4 || ^7.0",
+        "symfony/json-streamer": "7.4.x-dev",
         "symfony/maker-bundle": "^1.24",
         "symfony/mercure-bundle": "*",
         "symfony/messenger": "^6.4 || ^7.0",

src/Hydra/State/JsonStreamerProcessor.php

@@ -26,19 +26,31 @@
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use ApiPlatform\State\Pagination\PartialPaginatorInterface;
 use ApiPlatform\State\ProcessorInterface;
+use ApiPlatform\State\Util\HttpResponseHeadersTrait;
+use ApiPlatform\State\Util\HttpResponseStatusTrait;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\JsonStreamer\StreamWriterInterface;
 use Symfony\Component\TypeInfo\Type;
 
+/**
+ * @implements ProcessorInterface<mixed,mixed>
+ */
 final class JsonStreamerProcessor implements ProcessorInterface
 {
+    use HttpResponseHeadersTrait;
+    use HttpResponseStatusTrait;
+
+    /**
+     * @param ProcessorInterface<mixed,mixed> $processor
+     * @param StreamWriterInterface<array<string,mixed>> $jsonStreamer
+     */
     public function __construct(
         private readonly ProcessorInterface $processor,
         private readonly StreamWriterInterface $jsonStreamer,
         private readonly string $pageParameterName = 'page',
         private readonly string $enabledParameterName = 'pagination',
-        private readonly int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH
+        private readonly int $urlGenerationStrategy = UrlGeneratorInterface::ABS_PATH,
     ) {
     }
 
@@ -67,6 +79,7 @@ private function getSearch(Operation $operation, string $requestUri): IriTemplat
         }
 
         $parts = parse_url($requestUri);
+
         return new IriTemplate(
             variableRepresentation: 'BasicRepresentation',
             mapping: $mapping,
@@ -120,7 +133,12 @@ private function getView(mixed $object, string $requestUri, Operation $operation
 
     public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
     {
-        if ($context['request']->query->has('skip_json_stream')) {
+        if (!$operation->getJsonStream() || !($request = $context['request'] ?? null)) {
+            return $this->processor->process($data, $operation, $uriVariables, $context);
+        }
+
+        // TODO: remove this before merging
+        if ($request->query->has('skip_json_stream')) {
             return $this->processor->process($data, $operation, $uriVariables, $context);
         }
 
@@ -129,7 +147,7 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
         }
 
         if ($operation instanceof CollectionOperationInterface) {
-            $requestUri = $context['request']->getRequestUri() ?? '';
+            $requestUri = $request->getRequestUri() ?? '';
             $collection = new Collection();
             $collection->member = $data;
             $collection->view = $this->getView($data, $requestUri, $operation);
@@ -146,17 +164,25 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
                 $collection->totalItems = \count($data);
             }
 
-            $response = new StreamedResponse($this->jsonStreamer->write($collection, Type::generic(Type::object($collection::class), Type::object($operation->getClass())), [
-                'data' => $data,
-                'operation' => $operation,
-            ]));
+            $data = $this->jsonStreamer->write(
+                $collection,
+                Type::generic(Type::object($collection::class), Type::object($operation->getClass())),
+                ['data' => $data, 'operation' => $operation],
+            );
         } else {
-            $response = new StreamedResponse($this->jsonStreamer->write($data, Type::object($operation->getClass()), [
+            $data = $this->jsonStreamer->write($data, Type::object($operation->getClass()), [
                 'data' => $data,
                 'operation' => $operation,
-            ]));
+            ]);
         }
 
+        /** @var Iterable<string> $data */
+        $response = new StreamedResponse(
+            $data,
+            $this->getStatus($request, $operation, $context),
+            $this->getHeaders($request, $operation, $context)
+        );
+
         return $this->processor->process($response, $operation, $uriVariables, $context);
     }
 }

src/JsonLd/JsonStreamer/ValueTransformer/ContextValueTransformer.php

@@ -0,0 +1,36 @@
+<?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\JsonLd\JsonStreamer\ValueTransformer;
+
+use ApiPlatform\Metadata\UrlGeneratorInterface;
+use Symfony\Component\JsonStreamer\ValueTransformer\ValueTransformerInterface;
+use Symfony\Component\TypeInfo\Type;
+
+final class ContextValueTransformer implements ValueTransformerInterface
+{
+    public function __construct(
+        private readonly UrlGeneratorInterface $urlGenerator,
+    ) {
+    }
+
+    public function transform(mixed $value, array $options = []): mixed
+    {
+        return $this->urlGenerator->generate('api_jsonld_context', ['shortName' => $options['operation']->getShortName()], $options['operation']->getUrlGenerationStrategy());
+    }
+
+    public static function getStreamValueType(): Type
+    {
+        return Type::string();
+    }
+}

src/JsonLd/JsonStreamer/IriValueTransformer.php renamed to src/JsonLd/JsonStreamer/ValueTransformer/IriValueTransformer.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\JsonLd\JsonStreamer;
+namespace ApiPlatform\JsonLd\JsonStreamer\ValueTransformer;
 
 use ApiPlatform\Hydra\Collection;
 use ApiPlatform\Metadata\CollectionOperationInterface;

src/JsonLd/JsonStreamer/WritePropertyMetadataLoader.php

@@ -16,7 +16,6 @@
 use ApiPlatform\Hydra\IriTemplate;
 use ApiPlatform\Hydra\Collection;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
-use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Metadata\Util\TypeHelper;
 use Symfony\Component\JsonStreamer\Mapping\PropertyMetadata;
 use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoaderInterface;
@@ -27,7 +26,6 @@ final class WritePropertyMetadataLoader implements PropertyMetadataLoaderInterfa
     public function __construct(
         private readonly PropertyMetadataLoaderInterface $loader,
         private readonly ResourceClassResolverInterface $resourceClassResolver,
-        private readonly UrlGeneratorInterface $urlGenerator,
     ) {
     }
 
@@ -63,7 +61,7 @@ public function load(string $className, array $options = [], array $context = []
             $properties['@context'] = new PropertyMetadata(
                 'id', // virual property
                 Type::string(), // virtual property
-                staticValue: $this->urlGenerator->generate('api_jsonld_context', ['shortName' => $options['operation']->getShortName()], $options['operation']->getUrlGenerationStrategy()),
+                ['api_platform.jsonld.json_streamer.write.value_transformer.context'],
             );
         }
 

src/Metadata/ApiResource.php

@@ -965,6 +965,7 @@ public function __construct(
         array|Parameters|null $parameters = null,
         protected ?bool $strictQueryParameterValidation = null,
         protected ?bool $hideHydraOperation = null,
+        ?bool $jsonStream = null,
         protected array $extraProperties = [],
     ) {
         parent::__construct(
@@ -1011,6 +1012,7 @@ class: $class,
             middleware: $middleware,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
+            jsonStream: $jsonStream,
             extraProperties: $extraProperties
         );
 

src/Metadata/Delete.php

@@ -100,6 +100,7 @@ public function __construct(
         array|string|null $middleware = null,
         ?bool $strictQueryParameterValidation = null,
         protected ?bool $hideHydraOperation = null,
+        ?bool $jsonStream = null,
         array $extraProperties = [],
     ) {
         parent::__construct(
@@ -177,6 +178,7 @@ class: $class,
             rules: $rules,
             policy: $policy,
             middleware: $middleware,
+            jsonStream: $jsonStream,
             extraProperties: $extraProperties,
             collectDenormalizationErrors: $collectDenormalizationErrors,
             parameters: $parameters,

src/Metadata/Error.php

@@ -95,6 +95,7 @@ public function __construct(
         $processor = null,
         ?OptionsInterface $stateOptions = null,
         ?bool $hideHydraOperation = null,
+        ?bool $jsonStream = null,
         array $extraProperties = [],
     ) {
         parent::__construct(
@@ -171,6 +172,7 @@ class: $class,
             processor: $processor,
             stateOptions: $stateOptions,
             hideHydraOperation: $hideHydraOperation,
+            jsonStream: $jsonStream,
             extraProperties: $extraProperties,
         );
     }

src/Metadata/ErrorResource.php

@@ -84,6 +84,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
+        ?bool $jsonStream = null,
         array $extraProperties = [],
     ) {
         parent::__construct(
@@ -151,6 +152,7 @@ class: $class,
             provider: $provider,
             processor: $processor,
             stateOptions: $stateOptions,
+            jsonStream: $jsonStream,
             extraProperties: $extraProperties
         );
     }

src/Metadata/Get.php

@@ -100,6 +100,7 @@ public function __construct(
         array|string|null $middleware = null,
         ?bool $strictQueryParameterValidation = null,
         protected ?bool $hideHydraOperation = null,
+        ?bool $jsonStream = null,
         array $extraProperties = [],
     ) {
         parent::__construct(
@@ -181,6 +182,7 @@ class: $class,
             middleware: $middleware,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
+            jsonStream: $jsonStream,
             extraProperties: $extraProperties,
         );
     }