14306224552

Committed 07 Apr 2025 09:55AM UTC coverage: 8.425% (+1.2%) from 7.202%

Build # 14306224552

Build Type

push

github

Committed by

web-flow

Commit Message

fix(metadata): yaml link security (#7066)

Run Details

1 of 3 new or added lines in 2 files covered. (33.33%)

2165 existing lines in 153 files now uncovered.

13288 of 157729 relevant lines covered (8.42%)

22.89 hits per line

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

84.62

/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 (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);
            $data = $this->normalizeProcessor->process($object, $operation, [], $resolverContext);

            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\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	}	1,142✔
42
43	public function retrieveSubscriptionId(array $context, ?array $result, ?Operation $operation = null): ?string
44	{
45	/** @var ResolveInfo $info */
UNCOV 46	$info = $context['info'];	2✔
UNCOV 47	$fields = $info->getFieldSelection(\PHP_INT_MAX);	2✔
UNCOV 48	$this->arrayRecursiveSort($fields, 'ksort');	2✔
UNCOV 49	$iri = $operation ? $this->getIdentifierFromOperation($operation, $context['args'] ?? []) : $this->getIdentifierFromContext($context);	2✔
UNCOV 50	if (null === $iri) {	2✔
51	return null;	×
52	}
UNCOV 53	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	2✔
UNCOV 54	$subscriptions = [];	2✔
UNCOV 55	if ($subscriptionsCacheItem->isHit()) {	2✔
56	$subscriptions = $subscriptionsCacheItem->get();	×
57	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	×
58	if ($subscriptionFields === $fields) {	×
59	return $subscriptionId;	×
60	}
61	}
62	}
63
UNCOV 64	$subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields);	2✔
UNCOV 65	unset($result['clientSubscriptionId']);	2✔
UNCOV 66	$subscriptions[] = [$subscriptionId, $fields, $result];	2✔
UNCOV 67	$subscriptionsCacheItem->set($subscriptions);	2✔
UNCOV 68	$this->subscriptionsCache->save($subscriptionsCacheItem);	2✔
69
UNCOV 70	return $subscriptionId;	2✔
71	}
72
73	public function getPushPayloads(object $object): array
74	{
UNCOV 75	$iri = $this->iriConverter->getIriFromResource($object);	2✔
UNCOV 76	$subscriptions = $this->getSubscriptionsFromIri($iri);	2✔
77
UNCOV 78	$resourceClass = $this->getObjectClass($object);	2✔
UNCOV 79	$resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);	2✔
UNCOV 80	$shortName = $resourceMetadata->getOperation()->getShortName();	2✔
81
UNCOV 82	$payloads = [];	2✔
UNCOV 83	foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) {	2✔
UNCOV 84	$resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true];	2✔
85	/** @var Operation */
UNCOV 86	$operation = (new Subscription())->withName('update_subscription')->withShortName($shortName);	2✔
UNCOV 87	$data = $this->normalizeProcessor->process($object, $operation, [], $resolverContext);	2✔
88
UNCOV 89	unset($data['clientSubscriptionId']);	2✔
90
UNCOV 91	if ($data !== $subscriptionResult) {	2✔
UNCOV 92	$payloads[] = [$subscriptionId, $data];	2✔
93	}
94	}
95
UNCOV 96	return $payloads;	2✔
97	}
98
99	/**
100	* @return array<array>
101	*/
102	private function getSubscriptionsFromIri(string $iri): array
103	{
UNCOV 104	$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri));	2✔
105
UNCOV 106	if ($subscriptionsCacheItem->isHit()) {	2✔
UNCOV 107	return $subscriptionsCacheItem->get();	2✔
108	}
109
110	return [];	×
111	}
112
113	private function encodeIriToCacheKey(string $iri): string
114	{
UNCOV 115	return str_replace('/', '_', $iri);	4✔
116	}
117	}

api-platform / core / 14306224552

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