10010837821

Committed 19 Jul 2024 03:54PM UTC coverage: 64.225% (-0.5%) from 64.689%

Build # 10010837821

Build Type

push

github

Committed by

web-flow

Commit Message

chore: missing deprecations (#6480)

Run Details

50 of 228 new or added lines in 14 files covered. (21.93%)

186 existing lines in 31 files now uncovered.

11549 of 17982 relevant lines covered (64.23%)

68.6 hits per line

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

2.27

/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\Stage\SerializeStage;
use ApiPlatform\GraphQl\Resolver\Stage\SerializeStageInterface;
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 SerializeStageInterface|ProcessorInterface|null $serializeStage = null, private readonly ?IriConverterInterface $iriConverter = null, private readonly ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
    {
        if (!$serializeStage instanceof ProcessorInterface) {
            trigger_deprecation('api-platform/core', '4.0', sprintf('Using an instanceof "%s" is deprecated, use "%s" instead.', SerializeStageInterface::class, ProcessorInterface::class));
        }
    }

    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 (null === $iri) {
            return null;
        }
        $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']);
        $subscriptions[] = [$subscriptionId, $fields, $result];
        $subscriptionsCacheItem->set($subscriptions);
        $this->subscriptionsCache->save($subscriptionsCacheItem);

        return $subscriptionId;
    }

    public function getPushPayloads(object $object): array
    {
        $iri = $this->iriConverter->getIriFromResource($object);
        $subscriptions = $this->getSubscriptionsFromIri($iri);

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

        $payloads = [];
        foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {
            $resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];
            /** @var Operation */
            $operation = (new Subscription())->withName('update_subscription')->withShortName($shortName);
            if ($this->serializeStage instanceof ProcessorInterface) {
                $data = $this->serializeStage->process($object, $operation, [], $resolverContext);
            } elseif ($this->serializeStage instanceof SerializeStage) {
                $data = ($this->serializeStage)($object, $resourceClass, $operation, $resolverContext);
            } else {
                throw new \LogicException();
            }

            unset($data['clientSubscriptionId']);

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

        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 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\Stage\SerializeStage;
17	use ApiPlatform\GraphQl\Resolver\Stage\SerializeStageInterface;
18	use ApiPlatform\GraphQl\Resolver\Util\IdentifierTrait;
19	use ApiPlatform\Metadata\GraphQl\Operation;
20	use ApiPlatform\Metadata\GraphQl\Subscription;
21	use ApiPlatform\Metadata\IriConverterInterface;
22	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
23	use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;
24	use ApiPlatform\Metadata\Util\SortTrait;
25	use ApiPlatform\State\ProcessorInterface;
26	use GraphQL\Type\Definition\ResolveInfo;
27	use Psr\Cache\CacheItemPoolInterface;
28
29	/**
30	* Manages all the queried subscriptions by creating their ID
31	* and saving to a cache the information needed to publish updated data.
32	*
33	* @author Alan Poulain <contact@alanpoulain.eu>
34	*/
35	final class SubscriptionManager implements OperationAwareSubscriptionManagerInterface
36	{
37	use IdentifierTrait;
38	use ResourceClassInfoTrait;
39	use SortTrait;
40
41	public function __construct(private readonly CacheItemPoolInterface $subscriptionsCache, private readonly SubscriptionIdentifierGeneratorInterface $subscriptionIdentifierGenerator, private readonly SerializeStageInterface\|ProcessorInterface\|null $serializeStage = null, private readonly ?IriConverterInterface $iriConverter = null, private readonly ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null)
42	{
43	if (!$serializeStage instanceof ProcessorInterface) {	107✔
NEW 44	trigger_deprecation('api-platform/core', '4.0', sprintf('Using an instanceof "%s" is deprecated, use "%s" instead.', SerializeStageInterface::class, ProcessorInterface::class));	×
45	}
46	}
47
48	public function retrieveSubscriptionId(array $context, ?array $result, ?Operation $operation = null): ?string
49	{
50	/** @var ResolveInfo $info */
51	$info = $context['info'];	×
52	$fields = $info->getFieldSelection(\PHP_INT_MAX);	×
53	$this->arrayRecursiveSort($fields, 'ksort');	×
54	$iri = $operation ? $this->getIdentifierFromOperation($operation, $context['args'] ?? []) : $this->getIdentifierFromContext($context);	×
55	if (null === $iri) {	×
56	return null;	×
57	}
58	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	×
59	$subscriptions = [];	×
60	if ($subscriptionsCacheItem->isHit()) {	×
61	$subscriptions = $subscriptionsCacheItem->get();	×
62	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
63	if ($subscriptionFields === $fields) {	×
64	return $subscriptionId;	×
65	}
66	}
67	}
68
69	$subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields);	×
70	unset($result['clientSubscriptionId']);	×
71	$subscriptions[] = [$subscriptionId, $fields, $result];	×
72	$subscriptionsCacheItem->set($subscriptions);	×
73	$this->subscriptionsCache->save($subscriptionsCacheItem);	×
74
75	return $subscriptionId;	×
76	}
77
78	public function getPushPayloads(object $object): array
79	{
80	$iri = $this->iriConverter->getIriFromResource($object);	×
81	$subscriptions = $this->getSubscriptionsFromIri($iri);	×
82
83	$resourceClass = $this->getObjectClass($object);	×
84	$resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);	×
85	$shortName = $resourceMetadata->getOperation()->getShortName();	×
86
87	$payloads = [];	×
88	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
89	$resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];	×
90	/** @var Operation */
91	$operation = (new Subscription())->withName('update_subscription')->withShortName($shortName);	×
NEW 92	if ($this->serializeStage instanceof ProcessorInterface) {	×
NEW 93	$data = $this->serializeStage->process($object, $operation, [], $resolverContext);	×
NEW 94	} elseif ($this->serializeStage instanceof SerializeStage) {	×
UNCOV 95	$data = ($this->serializeStage)($object, $resourceClass, $operation, $resolverContext);	×
96	} else {
97	throw new \LogicException();	×
98	}
99
100	unset($data['clientSubscriptionId']);	×
101
102	if ($data !== $subscriptionResult) {	×
103	$payloads[] = [$subscriptionId, $data];	×
104	}
105	}
106
107	return $payloads;	×
108	}
109
110	/**
111	* @return array<array>
112	*/
113	private function getSubscriptionsFromIri(string $iri): array
114	{
115	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	×
116
117	if ($subscriptionsCacheItem->isHit()) {	×
118	return $subscriptionsCacheItem->get();	×
119	}
120
121	return [];	×
122	}
123
124	private function encodeIriToCacheKey(string $iri): string
125	{
126	return str_replace('/', '_', $iri);	×
127	}
128	}

api-platform / core / 10010837821

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