14635100171

Committed 24 Apr 2025 06:39AM UTC coverage: 8.271% (+0.02%) from 8.252%

Build # 14635100171

Build Type

Pull #6904

github

Committed by

web-flow

Commit Message

Merge c9cefd82e into a3e5e53ea

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

Run Details

0 of 73 new or added lines in 3 files covered. (0.0%)

1999 existing lines in 144 files now uncovered.

13129 of 158728 relevant lines covered (8.27%)

13.6 hits per line

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

67.35

/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);
            }
        }
        $subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));
        $subscriptions = [];
        if ($subscriptionsCacheItem->isHit()) {
            $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 ($options['private_fields'] as $privateField) {
                unset($result['__private_field_'.$privateField]);
            }
        }
        $subscriptions[] = [$subscriptionId, $fields, $result];
        $subscriptionsCacheItem->set($subscriptions);
        $this->subscriptionsCache->save($subscriptionsCacheItem);

        $this->updateSubscriptionCollectionCacheData(
            $iri,
            $fields,
            $subscriptions,
        );

        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 updateSubscriptionCollectionCacheData(
        ?string                       $iri,
        array                         $fields,
        array                         $subscriptions,
    ): void
    {
        $subscriptionCollectionCacheItem = $this->subscriptionsCache->getItem(
            $this->encodeIriToCacheKey($this->getCollectionIri($iri)),
        );
        if ($subscriptionCollectionCacheItem->isHit()) {
            $collectionSubscriptions = $subscriptionCollectionCacheItem->get();
            foreach ($collectionSubscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {
                if ($subscriptionFields === $fields) {
                    return;
                }
            }
        }
        $subscriptionCollectionCacheItem->set($subscriptions);
        $this->subscriptionsCache->save($subscriptionCollectionCacheItem);
    }

    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);
        $subscriptions = $this->getSubscriptionsFromIri($iri);
        if ($subscriptions === []) {
            // Get subscriptions from collection Iri
            $subscriptions = $this->getSubscriptionsFromIri($this->getCollectionIri($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('update_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 encodeIriToCacheKey(string $iri): string
    {
        return str_replace('/', '_', $iri);
    }
}

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 */
UNCOV 46	$info = $context['info'];	1✔
UNCOV 47	$fields = $info->getFieldSelection(\PHP_INT_MAX);	1✔
UNCOV 48	$this->arrayRecursiveSort($fields, 'ksort');	1✔
UNCOV 49	$iri = $operation ? $this->getIdentifierFromOperation($operation, $context['args'] ?? []) : $this->getIdentifierFromContext($context);	1✔
NEW 50	if (empty($iri)) {	1✔
51	return null;	×
52	}
NEW 53	$options = $operation->getMercure() ?? false;	1✔
NEW 54	$private = $options['private'] ?? false;	1✔
NEW 55	$privateFields = $options['private_fields'] ?? [];	1✔
NEW 56	$previousObject = $context['graphql_context']['previous_object'] ?? null;	1✔
NEW 57	if ($private && $privateFields && $previousObject) {	1✔
NEW 58	foreach ($options['private_fields'] as $privateField) {	×
NEW 59	$fields['__private_field_'.$privateField] = $this->getResourceId($privateField, $previousObject);	×
60	}
61	}
UNCOV 62	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	1✔
UNCOV 63	$subscriptions = [];	1✔
UNCOV 64	if ($subscriptionsCacheItem->isHit()) {	1✔
65	$subscriptions = $subscriptionsCacheItem->get();	×
66	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
67	if ($subscriptionFields === $fields) {	×
68	return $subscriptionId;	×
69	}
70	}
71	}
72
UNCOV 73	$subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields);	1✔
UNCOV 74	unset($result['clientSubscriptionId']);	1✔
NEW 75	if ($private && $privateFields && $previousObject) {	1✔
NEW 76	foreach ($options['private_fields'] as $privateField) {	×
NEW 77	unset($result['__private_field_'.$privateField]);	×
78	}
79	}
UNCOV 80	$subscriptions[] = [$subscriptionId, $fields, $result];	1✔
UNCOV 81	$subscriptionsCacheItem->set($subscriptions);	1✔
UNCOV 82	$this->subscriptionsCache->save($subscriptionsCacheItem);	1✔
83
NEW 84	$this->updateSubscriptionCollectionCacheData(	1✔
NEW 85	$iri,	1✔
NEW 86	$fields,	1✔
NEW 87	$subscriptions,	1✔
NEW 88	);	1✔
89
UNCOV 90	return $subscriptionId;	1✔
91	}
92
93	public function getPushPayloads(object $object, string $type): array
94	{
NEW 95	if ('delete' === $type) {	4✔
NEW 96	$payloads = $this->getDeletePushPayloads($object);	×
97	} else {
NEW 98	$payloads = $this->getCreatedOrUpdatedPayloads($object);	4✔
99	}
100
NEW 101	return $payloads;	4✔
102	}
103
104	/**
105	* @return array<array>
106	*/
107	private function getSubscriptionsFromIri(string $iri): array
108	{
NEW 109	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	4✔
110
NEW 111	if ($subscriptionsCacheItem->isHit()) {	4✔
NEW 112	return $subscriptionsCacheItem->get();	1✔
113	}
114
NEW 115	return [];	3✔
116	}
117
118	private function removeItemFromSubscriptionCache(string $iri): void
119	{
NEW 120	$cacheKey = $this->encodeIriToCacheKey($iri);	×
NEW 121	if ($this->subscriptionsCache->hasItem($cacheKey)) {	×
NEW 122	$this->subscriptionsCache->deleteItem($cacheKey);	×
123	}
124	}
125
126	private function updateSubscriptionCollectionCacheData(
127	?string $iri,
128	array $fields,
129	array $subscriptions,
130	): void
131	{
NEW 132	$subscriptionCollectionCacheItem = $this->subscriptionsCache->getItem(	1✔
NEW 133	$this->encodeIriToCacheKey($this->getCollectionIri($iri)),	1✔
NEW 134	);	1✔
NEW 135	if ($subscriptionCollectionCacheItem->isHit()) {	1✔
NEW 136	$collectionSubscriptions = $subscriptionCollectionCacheItem->get();	1✔
NEW 137	foreach ($collectionSubscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	1✔
NEW 138	if ($subscriptionFields === $fields) {	1✔
NEW 139	return;	×
140	}
141	}
142	}
NEW 143	$subscriptionCollectionCacheItem->set($subscriptions);	1✔
NEW 144	$this->subscriptionsCache->save($subscriptionCollectionCacheItem);	1✔
145	}
146
147	private function getResourceId(mixed $privateField, object $previousObject): string
148	{
NEW 149	$id = $previousObject->{'get' . ucfirst($privateField)}()->getId();	×
NEW 150	if ($id instanceof \Stringable) {	×
NEW 151	return (string)$id;	×
152	}
NEW 153	return $id;	×
154	}
155
156	private function getCollectionIri(string $iri): string
157	{
NEW 158	return substr($iri, 0, strrpos($iri, '/'));	3✔
159	}
160
161	private function getCreatedOrUpdatedPayloads(object $object): array
162	{
UNCOV 163	$iri = $this->iriConverter->getIriFromResource($object);	4✔
UNCOV 164	$subscriptions = $this->getSubscriptionsFromIri($iri);	4✔
NEW 165	if ($subscriptions === []) {	4✔
166	// Get subscriptions from collection Iri
NEW 167	$subscriptions = $this->getSubscriptionsFromIri($this->getCollectionIri($iri));	3✔
168	}
169
UNCOV 170	$resourceClass = $this->getObjectClass($object);	4✔
UNCOV 171	$resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);	4✔
UNCOV 172	$shortName = $resourceMetadata->getOperation()->getShortName();	4✔
173
NEW 174	$mercure = $resourceMetadata->getOperation()->getMercure() ?? false;	4✔
NEW 175	$private = $mercure['private'] ?? false;	4✔
NEW 176	$privateFieldsConfig = $mercure['private_fields'] ?? [];	4✔
NEW 177	$privateFieldData = [];	4✔
NEW 178	if ($private && $privateFieldsConfig) {	4✔
NEW 179	foreach ($privateFieldsConfig as $privateField) {	×
NEW 180	$privateFieldData['__private_field_'.$privateField] = $this->getResourceId($privateField, $object);	×
181	}
182	}
183
UNCOV 184	$payloads = [];	4✔
UNCOV 185	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	4✔
NEW 186	if ($privateFieldData) {	1✔
NEW 187	$fieldDiff = array_intersect_assoc($subscriptionFields, $privateFieldData);	×
NEW 188	if ($fieldDiff !== $privateFieldData) {	×
NEW 189	continue;	×
190	}
191	}
UNCOV 192	$resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];	1✔
UNCOV 193	$operation = (new Subscription())->withName('update_subscription')->withShortName($shortName);	1✔
UNCOV 194	$data = $this->normalizeProcessor->process($object, $operation, [], $resolverContext);	1✔
195
UNCOV 196	unset($data['clientSubscriptionId']);	1✔
197
UNCOV 198	if ($data !== $subscriptionResult) {	1✔
UNCOV 199	$payloads[] = [$subscriptionId, $data];	1✔
200	}
201	}
UNCOV 202	return $payloads;	4✔
203	}
204
205	private function getDeletePushPayloads(object $object): array
206	{
NEW 207	$iri = $object->id;	×
NEW 208	$subscriptions = $this->getSubscriptionsFromIri($iri);	×
NEW 209	if ($subscriptions === []) {	×
210	// Get subscriptions from collection Iri
NEW 211	$subscriptions = $this->getSubscriptionsFromIri($this->getCollectionIri($iri));	×
212	}
213
NEW 214	$payloads = [];	×
NEW 215	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
NEW 216	$payloads[] = [$subscriptionId, ['type' => 'delete', 'payload' => $object]];	×
217	}
NEW 218	$this->removeItemFromSubscriptionCache($iri);	×
NEW 219	return $payloads;	×
220	}
221
222	private function encodeIriToCacheKey(string $iri): string
223	{
UNCOV 224	return str_replace('/', '_', $iri);	4✔
225	}
226	}

api-platform / core / 14635100171

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