17582447659

Committed 09 Sep 2025 12:23PM UTC coverage: 22.592% (-0.01%) from 22.604%

Build # 17582447659

Build Type

push

github

Committed by

web-flow

Commit Message

fix(jsonld): various json streamer fixes (#7374)

Run Details

33 of 35 new or added lines in 2 files covered. (94.29%)

27 existing lines in 9 files now uncovered.

12071 of 53430 relevant lines covered (22.59%)

13.33 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.3

/src/Serializer/State/JsonStreamerProcessor.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * 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\Serializer\State;

use ApiPlatform\Metadata\CollectionOperationInterface;
use ApiPlatform\Metadata\Error;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\IriConverterInterface;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
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>|null       $processor
     * @param StreamWriterInterface<array<string,mixed>> $jsonStreamer
     */
    public function __construct(
        private readonly ?ProcessorInterface $processor,
        private readonly StreamWriterInterface $jsonStreamer,
        ?IriConverterInterface $iriConverter = null,
        ?ResourceClassResolverInterface $resourceClassResolver = null,
        ?OperationMetadataFactoryInterface $operationMetadataFactory = null,
    ) {
        $this->resourceClassResolver = $resourceClassResolver;
        $this->iriConverter = $iriConverter;
        $this->operationMetadataFactory = $operationMetadataFactory;
    }

    public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
    {
        if (
            $operation instanceof Error
            || $data instanceof Response
            || !$operation instanceof HttpOperation
            || !($request = $context['request'] ?? null)
            || !$operation->getJsonStream()
            || 'json' !== $request->getRequestFormat()
        ) {
            return $this->processor?->process($data, $operation, $uriVariables, $context);
        }

        if ($operation instanceof CollectionOperationInterface) {
            $data = $this->jsonStreamer->write(
                $data,
                Type::list(Type::object($operation->getClass())),
                ['data' => $data, 'operation' => $operation],
            );
        } else {
            $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 ? $this->processor->process($response, $operation, $uriVariables, $context) : $response;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Serializer\State;
15
16	use ApiPlatform\Metadata\CollectionOperationInterface;
17	use ApiPlatform\Metadata\Error;
18	use ApiPlatform\Metadata\HttpOperation;
19	use ApiPlatform\Metadata\IriConverterInterface;
20	use ApiPlatform\Metadata\Operation;
21	use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface;
22	use ApiPlatform\Metadata\ResourceClassResolverInterface;
23	use ApiPlatform\State\ProcessorInterface;
24	use ApiPlatform\State\Util\HttpResponseHeadersTrait;
25	use ApiPlatform\State\Util\HttpResponseStatusTrait;
26	use Symfony\Component\HttpFoundation\Response;
27	use Symfony\Component\HttpFoundation\StreamedResponse;
28	use Symfony\Component\JsonStreamer\StreamWriterInterface;
29	use Symfony\Component\TypeInfo\Type;
30
31	/**
32	* @implements ProcessorInterface<mixed,mixed>
33	*/
34	final class JsonStreamerProcessor implements ProcessorInterface
35	{
36	use HttpResponseHeadersTrait;
37	use HttpResponseStatusTrait;
38
39	/**
40	* @param ProcessorInterface<mixed,mixed>\|null $processor
41	* @param StreamWriterInterface<array<string,mixed>> $jsonStreamer
42	*/
43	public function __construct(
44	private readonly ?ProcessorInterface $processor,
45	private readonly StreamWriterInterface $jsonStreamer,
46	?IriConverterInterface $iriConverter = null,
47	?ResourceClassResolverInterface $resourceClassResolver = null,
48	?OperationMetadataFactoryInterface $operationMetadataFactory = null,
49	) {
50	$this->resourceClassResolver = $resourceClassResolver;	269✔
51	$this->iriConverter = $iriConverter;	269✔
52	$this->operationMetadataFactory = $operationMetadataFactory;	269✔
53	}
54
55	public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
56	{
57	if (
58	$operation instanceof Error	3✔
59	\|\| $data instanceof Response	3✔
60	\|\| !$operation instanceof HttpOperation	3✔
61	\|\| !($request = $context['request'] ?? null)	3✔
62	\|\| !$operation->getJsonStream()	3✔
63	\|\| 'json' !== $request->getRequestFormat()	3✔
64	) {
UNCOV 65	return $this->processor?->process($data, $operation, $uriVariables, $context);	×
66	}
67
68	if ($operation instanceof CollectionOperationInterface) {	3✔
69	$data = $this->jsonStreamer->write(	1✔
70	$data,	1✔
71	Type::list(Type::object($operation->getClass())),	1✔
72	['data' => $data, 'operation' => $operation],	1✔
73	);	1✔
74	} else {
75	$data = $this->jsonStreamer->write(	2✔
76	$data,	2✔
77	Type::object($operation->getClass()),	2✔
78	['data' => $data, 'operation' => $operation],	2✔
79	);	2✔
80	}
81
82	/** @var iterable<string> $data */
83	$response = new StreamedResponse(	3✔
84	$data,	3✔
85	$this->getStatus($request, $operation, $context),	3✔
86	$this->getHeaders($request, $operation, $context)	3✔
87	);	3✔
88
89	return $this->processor ? $this->processor->process($response, $operation, $uriVariables, $context) : $response;	3✔
90	}
91	}

api-platform / core / 17582447659

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous