|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* This file is part of the API Platform project. |
|
5
|
|
|
* |
|
6
|
|
|
* (c) Kévin Dunglas <[email protected]> |
|
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\Core\GraphQl\Subscription; |
|
15
|
|
|
|
|
16
|
|
|
use ApiPlatform\Core\Api\IriConverterInterface; |
|
17
|
|
|
use ApiPlatform\Core\GraphQl\Resolver\Stage\SerializeStageInterface; |
|
18
|
|
|
use ApiPlatform\Core\GraphQl\Resolver\Util\IdentifierTrait; |
|
19
|
|
|
use ApiPlatform\Core\Util\ResourceClassInfoTrait; |
|
20
|
|
|
use ApiPlatform\Core\Util\SortTrait; |
|
21
|
|
|
use GraphQL\Type\Definition\ResolveInfo; |
|
22
|
|
|
use Psr\Cache\CacheItemPoolInterface; |
|
23
|
|
|
|
|
24
|
|
|
/** |
|
25
|
|
|
* Manages all the queried subscriptions by creating their ID |
|
26
|
|
|
* and saving to a cache the information needed to publish updated data. |
|
27
|
|
|
* |
|
28
|
|
|
* @experimental |
|
29
|
|
|
* |
|
30
|
|
|
* @author Alan Poulain <[email protected]> |
|
31
|
|
|
*/ |
|
32
|
|
|
final class SubscriptionManager implements SubscriptionManagerInterface |
|
33
|
|
|
{ |
|
34
|
|
|
use IdentifierTrait; |
|
35
|
|
|
use ResourceClassInfoTrait; |
|
36
|
|
|
use SortTrait; |
|
37
|
|
|
|
|
38
|
|
|
private $subscriptionsCache; |
|
39
|
|
|
private $subscriptionIdentifierGenerator; |
|
40
|
|
|
private $serializeStage; |
|
41
|
|
|
private $iriConverter; |
|
42
|
|
|
|
|
43
|
|
|
public function __construct(CacheItemPoolInterface $subscriptionsCache, SubscriptionIdentifierGeneratorInterface $subscriptionIdentifierGenerator, SerializeStageInterface $serializeStage, IriConverterInterface $iriConverter) |
|
44
|
|
|
{ |
|
45
|
|
|
$this->subscriptionsCache = $subscriptionsCache; |
|
46
|
|
|
$this->subscriptionIdentifierGenerator = $subscriptionIdentifierGenerator; |
|
47
|
|
|
$this->serializeStage = $serializeStage; |
|
48
|
|
|
$this->iriConverter = $iriConverter; |
|
49
|
|
|
} |
|
50
|
|
|
|
|
51
|
|
|
public function retrieveSubscriptionId(array $context, ?array $result): ?string |
|
52
|
|
|
{ |
|
53
|
|
|
/** @var ResolveInfo $info */ |
|
54
|
|
|
$info = $context['info']; |
|
55
|
|
|
$fields = $info->getFieldSelection(PHP_INT_MAX); |
|
56
|
|
|
$this->arrayRecursiveSort($fields, 'ksort'); |
|
57
|
|
|
$iri = $this->getIdentifierFromContext($context); |
|
58
|
|
|
if (null === $iri) { |
|
59
|
|
|
return null; |
|
60
|
|
|
} |
|
61
|
|
|
$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri)); |
|
62
|
|
|
$subscriptions = []; |
|
63
|
|
|
if ($subscriptionsCacheItem->isHit()) { |
|
64
|
|
|
$subscriptions = $subscriptionsCacheItem->get(); |
|
65
|
|
|
foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) { |
|
66
|
|
|
if ($subscriptionFields === $fields) { |
|
67
|
|
|
return $subscriptionId; |
|
68
|
|
|
} |
|
69
|
|
|
} |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
|
|
$subscriptionId = $this->subscriptionIdentifierGenerator->generateSubscriptionIdentifier($fields); |
|
73
|
|
|
unset($result['clientSubscriptionId']); |
|
74
|
|
|
$subscriptions[] = [$subscriptionId, $fields, $result]; |
|
75
|
|
|
$subscriptionsCacheItem->set($subscriptions); |
|
76
|
|
|
$this->subscriptionsCache->save($subscriptionsCacheItem); |
|
77
|
|
|
|
|
78
|
|
|
return $subscriptionId; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* @param object $object |
|
83
|
|
|
*/ |
|
84
|
|
|
public function getPushPayloads($object): array |
|
85
|
|
|
{ |
|
86
|
|
|
$iri = $this->iriConverter->getIriFromItem($object); |
|
87
|
|
|
$subscriptions = $this->getSubscriptionsFromIri($iri); |
|
88
|
|
|
|
|
89
|
|
|
$resourceClass = $this->getObjectClass($object); |
|
90
|
|
|
|
|
91
|
|
|
$payloads = []; |
|
92
|
|
|
foreach ($subscriptions as [$subscriptionId, $subscriptionFields, $subscriptionResult]) { |
|
93
|
|
|
$resolverContext = ['fields' => $subscriptionFields, 'is_collection' => false, 'is_mutation' => false, 'is_subscription' => true]; |
|
94
|
|
|
|
|
95
|
|
|
$data = ($this->serializeStage)($object, $resourceClass, 'update', $resolverContext); |
|
96
|
|
|
unset($data['clientSubscriptionId']); |
|
97
|
|
|
|
|
98
|
|
|
if ($data !== $subscriptionResult) { |
|
99
|
|
|
$payloads[] = [$subscriptionId, $data]; |
|
100
|
|
|
} |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
return $payloads; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* @return array<array> |
|
108
|
|
|
*/ |
|
109
|
|
|
private function getSubscriptionsFromIri(string $iri): array |
|
110
|
|
|
{ |
|
111
|
|
|
$subscriptionsCacheItem = $this->subscriptionsCache->getItem($this->encodeIriToCacheKey($iri)); |
|
112
|
|
|
|
|
113
|
|
|
if ($subscriptionsCacheItem->isHit()) { |
|
114
|
|
|
return $subscriptionsCacheItem->get(); |
|
115
|
|
|
} |
|
116
|
|
|
|
|
117
|
|
|
return []; |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
private function encodeIriToCacheKey(string $iri): string |
|
121
|
|
|
{ |
|
122
|
|
|
return str_replace('/', '_', $iri); |
|
123
|
|
|
} |
|
124
|
|
|
} |
|
125
|
|
|
|
api-platform /
core
