14640911521

Committed 24 Apr 2025 11:52AM UTC coverage: 8.525% (+0.3%) from 8.252%

Build # 14640911521

Build Type

Pull #6904

github

Committed by

web-flow

Commit Message

Merge cc46e696b into a3e5e53ea

Pull Request Pull Request #6904: feat(graphql): added support for graphql subscriptions to work for actions

Run Details

110 of 184 new or added lines in 7 files covered. (59.78%)

2 existing lines in 2 files now uncovered.

13133 of 154056 relevant lines covered (8.52%)

14.01 hits per line

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

56.76

/src/GraphQl/Subscription/SubscriptionManager.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\GraphQl\Subscription;

use ApiPlatform\GraphQl\Resolver\Util\IdentifierTrait;
use ApiPlatform\Metadata\GraphQl\Operation;
use ApiPlatform\Metadata\GraphQl\Subscription;
use ApiPlatform\Metadata\IriConverterInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;
use ApiPlatform\Metadata\Util\SortTrait;
use ApiPlatform\State\ProcessorInterface;
use GraphQL\Type\Definition\ResolveInfo;
use Psr\Cache\CacheItemPoolInterface;

/**
 * Manages all the queried subscriptions by creating their ID
 * and saving to a cache the information needed to publish updated data.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class SubscriptionManager implements OperationAwareSubscriptionManagerInterface
{
    use IdentifierTrait;
    use ResourceClassInfoTrait;
    use SortTrait;

    public function __construct(private readonly CacheItemPoolInterface $subscriptionsCache, private readonly SubscriptionIdentifierGeneratorInterface $subscriptionIdentifierGenerator, private readonly ProcessorInterface $normalizeProcessor, private readonly IriConverterInterface $iriConverter, private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory)
    {
    }

    public function retrieveSubscriptionId(array $context, ?array $result, ?Operation $operation = null): ?string
    {
        /** @var ResolveInfo $info */
        $info = $context['info'];
        $fields = $info->getFieldSelection(\PHP_INT_MAX);
        $this->arrayRecursiveSort($fields, 'ksort');
        $iri = $operation ? $this->getIdentifierFromOperation($operation, $context['args'] ?? []) : $this->getIdentifierFromContext($context);
        if (empty($iri)) {
            return null;
        }

        $options = $operation->getMercure() ?? false;
        $private = $options['private'] ?? false;
        $privateFields = $options['private_fields'] ?? [];
        $previousObject = $context['graphql_context']['previous_object'] ?? null;
        if ($private && $privateFields && $previousObject) {
            foreach ($options['private_fields'] as $privateField) {
                $fields['__private_field_'.$privateField] = $this->getResourceId($privateField, $previousObject);
            }
        }
        if ($operation->isCollection()) {
            $subscriptionId = $this->updateSubscriptionCollectionCacheData(
                $iri,
                $fields,
            );
        } else {
            $subscriptionId = $this->updateSubscriptionItemCacheData(
                $iri,
                $fields,
                $result,
                $private,
                $privateFields,
                $previousObject
            );
        }

        return $subscriptionId;
    }

    public function getPushPayloads(object $object, string $type): array
    {
        if ('delete' === $type) {
            $payloads =  $this->getDeletePushPayloads($object);
        } else {
            $payloads = $this->getCreatedOrUpdatedPayloads($object);
        }

        return $payloads;
    }

    /**
     * @return array<array>
     */
    private function getSubscriptionsFromIri(string $iri): array
    {
        $subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));

        if ($subscriptionsCacheItem->isHit()) {
            return $subscriptionsCacheItem->get();
        }

        return [];
    }

    private function removeItemFromSubscriptionCache(string $iri): void
    {
        $cacheKey = $this->encodeIriToCacheKey($iri);
        if ($this->subscriptionsCache->hasItem($cacheKey)) {
            $this->subscriptionsCache->deleteItem($cacheKey);
        }
    }

    private function encodeIriToCacheKey(string $iri): string
    {
        return str_replace('/', '_', $iri);
    }

    private function getResourceId(mixed $privateField, object $previousObject): string
    {
        $id = $previousObject->{'get' . ucfirst($privateField)}()->getId();
        if ($id instanceof \Stringable) {
            return (string)$id;
        }
        return $id;
    }

    private function getCollectionIri(string $iri): string
    {
        return substr($iri, 0, strrpos($iri, '/'));
    }

    private function getCreatedOrUpdatedPayloads(object $object): array
    {
        $iri = $this->iriConverter->getIriFromResource($object);
        // Add collection subscriptions
        $subscriptions = array_merge(
            $this->getSubscriptionsFromIri($this->getCollectionIri($iri)),
            $this->getSubscriptionsFromIri($iri)
        );

        $resourceClass = $this->getObjectClass($object);
        $resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);
        $shortName = $resourceMetadata->getOperation()->getShortName();

        $mercure = $resourceMetadata->getOperation()->getMercure() ?? false;
        $private = $mercure['private'] ?? false;
        $privateFieldsConfig = $mercure['private_fields'] ?? [];
        $privateFieldData = [];
        if ($private && $privateFieldsConfig) {
            foreach ($privateFieldsConfig as $privateField) {
                $privateFieldData['__private_field_'.$privateField] = $this->getResourceId($privateField, $object);
            }
        }

        $payloads = [];
        foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {
            if ($privateFieldData) {
                $fieldDiff = array_intersect_assoc($subscriptionFields, $privateFieldData);
                if ($fieldDiff !== $privateFieldData) {
                    continue;
                }
            }
            $resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];
            $operation = (new Subscription())->withName('mercure_subscription')->withShortName($shortName);
            $data = $this->normalizeProcessor->process($object, $operation, [], $resolverContext);

            unset($data['clientSubscriptionId']);

            if ($data !== $subscriptionResult) {
                $payloads[] = [$subscriptionId, $data];
            }
        }
        return $payloads;
    }

    private function getDeletePushPayloads(object $object): array
    {
        $iri = $object->id;
        $subscriptions = $this->getSubscriptionsFromIri($iri);
        if ($subscriptions === []) {
            // Get subscriptions from collection Iri
            $subscriptions = $this->getSubscriptionsFromIri($this->getCollectionIri($iri));
        }

        $payloads = [];
        foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {
            $payloads[] = [$subscriptionId, ['type' => 'delete', 'payload' => $object]];
        }
        $this->removeItemFromSubscriptionCache($iri);
        return $payloads;
    }

    private function updateSubscriptionItemCacheData(
        string  $iri,
        array   $fields,
        ?array  $result,
        bool    $private,
        array   $privateFields,
        ?object $previousObject
    ): string
    {
        $subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));
        $subscriptions = [];
        if ($subscriptionsCacheItem->isHit()) {
            /*
             * @var array<array{string, array<string, string|array>, array<string, string|array>}>
             */
            $subscriptions = $subscriptionsCacheItem->get();
            foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {
                if ($subscriptionFields === $fields) {
                    return $subscriptionId;
                }
            }
        }

        $subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields);
        unset($result['clientSubscriptionId']);
        if ($private && $privateFields && $previousObject) {
            foreach ($privateFields as $privateField) {
                unset($result['__private_field_' . $privateField]);
            }
        }
        $subscriptions[] = [$subscriptionId, $fields, $result];
        $subscriptionsCacheItem->set($subscriptions);
        $this->subscriptionsCache->save($subscriptionsCacheItem);
        return $subscriptionId;
    }



    private function updateSubscriptionCollectionCacheData(
        string $iri,
        array  $fields,
    ): string
    {
        $subscriptionCollectionCacheItem = $this->subscriptionsCache->getItem(
            $this->encodeIriToCacheKey($this->getCollectionIri($iri)),
        );
        if ($subscriptionCollectionCacheItem->isHit()) {
            $collectionSubscriptions = $subscriptionCollectionCacheItem->get();
            foreach ($collectionSubscriptions as [$subscriptionId, $subscriptionFields]) {
                if ($subscriptionFields === $fields) {
                    return $subscriptionId;
                }
            }
        }
        $subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields + ['__collection' => true]);
        $subscriptions[] = [$subscriptionId, $fields, []];
        $subscriptionCollectionCacheItem->set($subscriptions);
        $this->subscriptionsCache->save($subscriptionCollectionCacheItem);
        return $subscriptionId;
    }
}

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\GraphQl\Subscription;
15
16	use ApiPlatform\GraphQl\Resolver\Util\IdentifierTrait;
17	use ApiPlatform\Metadata\GraphQl\Operation;
18	use ApiPlatform\Metadata\GraphQl\Subscription;
19	use ApiPlatform\Metadata\IriConverterInterface;
20	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
21	use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;
22	use ApiPlatform\Metadata\Util\SortTrait;
23	use ApiPlatform\State\ProcessorInterface;
24	use GraphQL\Type\Definition\ResolveInfo;
25	use Psr\Cache\CacheItemPoolInterface;
26
27	/**
28	* Manages all the queried subscriptions by creating their ID
29	* and saving to a cache the information needed to publish updated data.
30	*
31	* @author Alan Poulain <contact@alanpoulain.eu>
32	*/
33	final class SubscriptionManager implements OperationAwareSubscriptionManagerInterface
34	{
35	use IdentifierTrait;
36	use ResourceClassInfoTrait;
37	use SortTrait;
38
39	public function __construct(private readonly CacheItemPoolInterface $subscriptionsCache, private readonly SubscriptionIdentifierGeneratorInterface $subscriptionIdentifierGenerator, private readonly ProcessorInterface $normalizeProcessor, private readonly IriConverterInterface $iriConverter, private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory)
40	{
41	}	647✔
42
43	public function retrieveSubscriptionId(array $context, ?array $result, ?Operation $operation = null): ?string
44	{
45	/** @var ResolveInfo $info */
46	$info = $context['info'];	1✔
47	$fields = $info->getFieldSelection(\PHP_INT_MAX);	1✔
48	$this->arrayRecursiveSort($fields, 'ksort');	1✔
49	$iri = $operation ? $this->getIdentifierFromOperation($operation, $context['args'] ?? []) : $this->getIdentifierFromContext($context);	1✔
50	if (empty($iri)) {	1✔
51	return null;	×
52	}
53
54	$options = $operation->getMercure() ?? false;	1✔
55	$private = $options['private'] ?? false;	1✔
56	$privateFields = $options['private_fields'] ?? [];	1✔
57	$previousObject = $context['graphql_context']['previous_object'] ?? null;	1✔
58	if ($private && $privateFields && $previousObject) {	1✔
NEW 59	foreach ($options['private_fields'] as $privateField) {	×
NEW 60	$fields['__private_field_'.$privateField] = $this->getResourceId($privateField, $previousObject);	×
61	}
62	}
63	if ($operation->isCollection()) {	1✔
NEW 64	$subscriptionId = $this->updateSubscriptionCollectionCacheData(	×
NEW 65	$iri,	×
NEW 66	$fields,	×
NEW 67	);	×
68	} else {
69	$subscriptionId = $this->updateSubscriptionItemCacheData(	1✔
70	$iri,	1✔
71	$fields,	1✔
72	$result,	1✔
73	$private,	1✔
74	$privateFields,	1✔
75	$previousObject	1✔
76	);	1✔
77	}
78
79	return $subscriptionId;	1✔
80	}
81
82	public function getPushPayloads(object $object, string $type): array
83	{
84	if ('delete' === $type) {	4✔
NEW 85	$payloads = $this->getDeletePushPayloads($object);	×
86	} else {
87	$payloads = $this->getCreatedOrUpdatedPayloads($object);	4✔
88	}
89
90	return $payloads;	4✔
91	}
92
93	/**
94	* @return array<array>
95	*/
96	private function getSubscriptionsFromIri(string $iri): array
97	{
98	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	4✔
99
100	if ($subscriptionsCacheItem->isHit()) {	4✔
101	return $subscriptionsCacheItem->get();	1✔
102	}
103
104	return [];	4✔
105	}
106
107	private function removeItemFromSubscriptionCache(string $iri): void
108	{
NEW 109	$cacheKey = $this->encodeIriToCacheKey($iri);	×
NEW 110	if ($this->subscriptionsCache->hasItem($cacheKey)) {	×
NEW 111	$this->subscriptionsCache->deleteItem($cacheKey);	×
112	}
113	}
114
115	private function encodeIriToCacheKey(string $iri): string
116	{
117	return str_replace('/', '_', $iri);	4✔
118	}
119
120	private function getResourceId(mixed $privateField, object $previousObject): string
121	{
NEW 122	$id = $previousObject->{'get' . ucfirst($privateField)}()->getId();	×
NEW 123	if ($id instanceof \Stringable) {	×
NEW 124	return (string)$id;	×
125	}
NEW 126	return $id;	×
127	}
128
129	private function getCollectionIri(string $iri): string
130	{
131	return substr($iri, 0, strrpos($iri, '/'));	4✔
132	}
133
134	private function getCreatedOrUpdatedPayloads(object $object): array
135	{
136	$iri = $this->iriConverter->getIriFromResource($object);	4✔
137	// Add collection subscriptions
138	$subscriptions = array_merge(	4✔
139	$this->getSubscriptionsFromIri($this->getCollectionIri($iri)),	4✔
140	$this->getSubscriptionsFromIri($iri)	4✔
141	);	4✔
142
143	$resourceClass = $this->getObjectClass($object);	4✔
144	$resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);	4✔
145	$shortName = $resourceMetadata->getOperation()->getShortName();	4✔
146
147	$mercure = $resourceMetadata->getOperation()->getMercure() ?? false;	4✔
148	$private = $mercure['private'] ?? false;	4✔
149	$privateFieldsConfig = $mercure['private_fields'] ?? [];	4✔
150	$privateFieldData = [];	4✔
151	if ($private && $privateFieldsConfig) {	4✔
NEW 152	foreach ($privateFieldsConfig as $privateField) {	×
NEW 153	$privateFieldData['__private_field_'.$privateField] = $this->getResourceId($privateField, $object);	×
154	}
155	}
156
157	$payloads = [];	4✔
158	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	4✔
159	if ($privateFieldData) {	1✔
NEW 160	$fieldDiff = array_intersect_assoc($subscriptionFields, $privateFieldData);	×
NEW 161	if ($fieldDiff !== $privateFieldData) {	×
NEW 162	continue;	×
163	}
164	}
165	$resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];	1✔
166	$operation = (new Subscription())->withName('mercure_subscription')->withShortName($shortName);	1✔
167	$data = $this->normalizeProcessor->process($object, $operation, [], $resolverContext);	1✔
168
169	unset($data['clientSubscriptionId']);	1✔
170
171	if ($data !== $subscriptionResult) {	1✔
172	$payloads[] = [$subscriptionId, $data];	1✔
173	}
174	}
175	return $payloads;	4✔
176	}
177
178	private function getDeletePushPayloads(object $object): array
179	{
NEW 180	$iri = $object->id;	×
NEW 181	$subscriptions = $this->getSubscriptionsFromIri($iri);	×
NEW 182	if ($subscriptions === []) {	×
183	// Get subscriptions from collection Iri
NEW 184	$subscriptions = $this->getSubscriptionsFromIri($this->getCollectionIri($iri));	×
185	}
186
NEW 187	$payloads = [];	×
NEW 188	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
NEW 189	$payloads[] = [$subscriptionId, ['type' => 'delete', 'payload' => $object]];	×
190	}
NEW 191	$this->removeItemFromSubscriptionCache($iri);	×
UNCOV 192	return $payloads;	×
193	}
194
195	private function updateSubscriptionItemCacheData(
196	string $iri,
197	array $fields,
198	?array $result,
199	bool $private,
200	array $privateFields,
201	?object $previousObject
202	): string
203	{
204	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	1✔
205	$subscriptions = [];	1✔
206	if ($subscriptionsCacheItem->isHit()) {	1✔
207	/*
208	* @var array<array{string, array<string, string\|array>, array<string, string\|array>}>
209	*/
NEW 210	$subscriptions = $subscriptionsCacheItem->get();	×
NEW 211	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
NEW 212	if ($subscriptionFields === $fields) {	×
NEW 213	return $subscriptionId;	×
214	}
215	}
216	}
217
218	$subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields);	1✔
219	unset($result['clientSubscriptionId']);	1✔
220	if ($private && $privateFields && $previousObject) {	1✔
NEW 221	foreach ($privateFields as $privateField) {	×
NEW 222	unset($result['__private_field_' . $privateField]);	×
223	}
224	}
225	$subscriptions[] = [$subscriptionId, $fields, $result];	1✔
226	$subscriptionsCacheItem->set($subscriptions);	1✔
227	$this->subscriptionsCache->save($subscriptionsCacheItem);	1✔
228	return $subscriptionId;	1✔
229	}
230
231
232
233	private function updateSubscriptionCollectionCacheData(
234	string $iri,
235	array $fields,
236	): string
237	{
NEW 238	$subscriptionCollectionCacheItem = $this->subscriptionsCache->getItem(	×
NEW 239	$this->encodeIriToCacheKey($this->getCollectionIri($iri)),	×
NEW 240	);	×
NEW 241	if ($subscriptionCollectionCacheItem->isHit()) {	×
NEW 242	$collectionSubscriptions = $subscriptionCollectionCacheItem->get();	×
NEW 243	foreach ($collectionSubscriptions as [$subscriptionId, $subscriptionFields]) {	×
NEW 244	if ($subscriptionFields === $fields) {	×
NEW 245	return $subscriptionId;	×
246	}
247	}
248	}
NEW 249	$subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields + ['__collection' => true]);	×
NEW 250	$subscriptions[] = [$subscriptionId, $fields, []];	×
NEW 251	$subscriptionCollectionCacheItem->set($subscriptions);	×
NEW 252	$this->subscriptionsCache->save($subscriptionCollectionCacheItem);	×
NEW 253	return $subscriptionId;	×
254	}
255	}

api-platform / core / 14640911521

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