Add context option

phpstan-baseline.neon

@@ -21,7 +21,7 @@ parameters:
 			path: src/Attribute/RouteParamValue/PropertyValues.php
 
 		-
-			message: "#^Method Sofascore\\\\PurgatoryBundle\\\\Cache\\\\Configuration\\\\Subscriptions\\:\\:getIterator\\(\\) should return Traversable\\<int, array\\{routeName\\: string, routeParams\\?\\: array\\<string, array\\{type\\: string, values\\: array\\<int, mixed\\>, optional\\?\\: true\\}\\>, if\\?\\: string, actions\\?\\: non\\-empty\\-array\\<int, Sofascore\\\\PurgatoryBundle\\\\Listener\\\\Enum\\\\Action\\>\\}\\> but returns ArrayIterator\\<int, array\\{routeName\\: string, routeParams\\?\\: array\\<string, array\\{type\\: string, values\\: array\\<int, mixed\\>, optional\\?\\: bool\\}\\>, if\\?\\: string, actions\\?\\: non\\-empty\\-array\\<int, Sofascore\\\\PurgatoryBundle\\\\Listener\\\\Enum\\\\Action\\>\\}\\>\\.$#"
+			message: "#^Method Sofascore\\\\PurgatoryBundle\\\\Cache\\\\Configuration\\\\Subscriptions\\:\\:getIterator\\(\\) should return Traversable\\<int, array\\{routeName\\: string, routeParams\\?\\: array\\<string, array\\{type\\: string, values\\: array\\<int, mixed\\>, optional\\?\\: true\\}\\>, if\\?\\: string, actions\\?\\: non\\-empty\\-array\\<int, Sofascore\\\\PurgatoryBundle\\\\Listener\\\\Enum\\\\Action\\>, context\\?\\: array\\<string, bool\\|float\\|int\\|string\\|null\\>\\}\\> but returns ArrayIterator\\<int, array\\{routeName\\: string, routeParams\\?\\: array\\<string, array\\{type\\: string, values\\: array\\<int, mixed\\>, optional\\?\\: bool\\}\\>, if\\?\\: string, actions\\?\\: non\\-empty\\-array\\<int, Sofascore\\\\PurgatoryBundle\\\\Listener\\\\Enum\\\\Action\\>, context\\?\\: array\\<string, bool\\|float\\|int\\|string\\|null\\>\\}\\>\\.$#"
 			count: 1
 			path: src/Cache/Configuration/Subscriptions.php
 

src/Attribute/PurgeOn.php

@@ -30,6 +30,7 @@ final class PurgeOn
      * @param ?non-empty-array<string, string|non-empty-list<string>|ValuesInterface> $routeParams
      * @param string|non-empty-list<string>|null                                      $route
      * @param value-of<Action>|non-empty-list<value-of<Action>|Action>|Action|null    $actions
+     * @param array<string, ?scalar>                                                  $context
      */
     public function __construct(
         public readonly string $class,
@@ -38,6 +39,7 @@ public function __construct(
         string|Expression|null $if = null,
         string|array|null $route = null,
         string|array|Action|null $actions = null,
+        public readonly array $context = [],
     ) {
         $this->target = \is_array($target) || \is_string($target) ? new ForProperties($target) : $target;
         $this->routeParams = null !== $routeParams ? self::normalizeRouteParams($routeParams) : null;

src/Cache/Configuration/Configuration.php

@@ -14,6 +14,7 @@ final class Configuration implements \Countable
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }>> $configuration
      */
     public function __construct(
@@ -58,6 +59,7 @@ public function count(): int
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }>>
      */
     public function toArray(): array

src/Cache/Configuration/ConfigurationLoader.php

@@ -45,6 +45,10 @@ public function load(): Configuration
                 $config['actions'] = $subscription->actions;
             }
 
+            if ($subscription->context) {
+                $config['context'] = $subscription->context;
+            }
+
             $configuration[$key][] = $config;
         }
 

src/Cache/Configuration/Subscriptions.php

@@ -12,6 +12,7 @@
  *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
  *     if?: string,
  *     actions?: non-empty-list<Action>,
+ *     context?: array<string, ?scalar>,
  * }>
  */
 final class Subscriptions implements \IteratorAggregate, \Countable
@@ -23,6 +24,7 @@ final class Subscriptions implements \IteratorAggregate, \Countable
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }> $subscriptions
      */
     public function __construct(
@@ -55,6 +57,7 @@ public function key(): string
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }>
      */
     public function toArray(): array

src/Cache/PropertyResolver/AssociationResolver.php

@@ -85,6 +85,7 @@ class: $associationClass,
             route: $routeMetadata->route,
             actions: $routeMetadata->purgeOn->actions,
             if: $if,
+            context: $routeMetadata->purgeOn->context,
         );
 
         return true;

src/Cache/PropertyResolver/EmbeddableResolver.php

@@ -55,6 +55,7 @@ class: $routeMetadata->purgeOn->class,
                 route: $routeMetadata->route,
                 actions: $routeMetadata->purgeOn->actions,
                 if: $routeMetadata->purgeOn->if,
+                context: $routeMetadata->purgeOn->context,
             );
         }
 

src/Cache/PropertyResolver/PropertyResolver.php

@@ -47,6 +47,7 @@ class: $routeMetadata->purgeOn->class,
             route: $routeMetadata->route,
             actions: $routeMetadata->purgeOn->actions,
             if: $routeMetadata->purgeOn->if,
+            context: $routeMetadata->purgeOn->context,
         );
 
         return true;

src/Cache/RouteMetadata/YamlMetadataProvider.php

@@ -31,7 +31,7 @@
  */
 final class YamlMetadataProvider implements RouteMetadataProviderInterface
 {
-    private const ALLOWED_KEYS = ['class', 'target', 'route_params', 'if', 'actions'];
+    private const ALLOWED_KEYS = ['class', 'target', 'route_params', 'if', 'actions', 'context'];
     private ?YamlParser $yamlParser = null;
 
     /**
@@ -87,6 +87,7 @@ private function provideFromFile(array $configuration, RouteCollection $routeCol
              *     route_params?: ?non-empty-array<string, string|non-empty-list<string>|TaggedValue>,
              *     if?: ?string,
              *     actions?: value-of<Action>|non-empty-list<value-of<Action>|Action>|Action|null,
+             *     context?: array<string, ?scalar>,
              * } $purgeOn
              */
             foreach ($purgeOns as $purgeOn) {
@@ -109,6 +110,7 @@ private function provideFromFile(array $configuration, RouteCollection $routeCol
      *     route_params?: ?non-empty-array<string, string|non-empty-list<string>|TaggedValue>,
      *     if?: ?string,
      *     actions?: value-of<Action>|non-empty-list<value-of<Action>|Action>|Action|null,
+     *     context?: array<string, ?scalar>,
      * } $purgeOn
      */
     private function validate(array $purgeOn, string $routeName): void
@@ -130,6 +132,7 @@ private function validate(array $purgeOn, string $routeName): void
      *     route_params?: ?non-empty-array<string, string|non-empty-list<string>|TaggedValue>,
      *     if?: ?string,
      *     actions?: value-of<Action>|non-empty-list<value-of<Action>|Action>|Action|null,
+     *     context?: array<string, ?scalar>,
      * } $purgeOn
      */
     private function buildPurgeOn(array $purgeOn): PurgeOn
@@ -140,6 +143,7 @@ class: $purgeOn['class'],
             routeParams: isset($purgeOn['route_params']) ? array_map($this->buildRouteParam(...), $purgeOn['route_params']) : null,
             if: $purgeOn['if'] ?? null,
             actions: $purgeOn['actions'] ?? null,
+            context: $purgeOn['context'] ?? [],
         );
     }
 

src/Cache/Subscription/PurgeSubscription.php

@@ -15,6 +15,7 @@ final class PurgeSubscription
      * @param class-string                   $class
      * @param array<string, ValuesInterface> $routeParams
      * @param ?non-empty-list<Action>        $actions
+     * @param array<string, ?scalar>         $context
      */
     public function __construct(
         public readonly string $class,
@@ -23,7 +24,8 @@ public function __construct(
         public readonly string $routeName,
         public readonly Route $route,
         public readonly ?array $actions,
-        public readonly ?Expression $if = null,
+        public readonly ?Expression $if,
+        public readonly array $context,
     ) {
     }
 }

src/Cache/Subscription/PurgeSubscriptionProvider.php

@@ -74,6 +74,7 @@ class: $purgeOn->class,
                     route: $routeMetadata->route,
                     actions: $purgeOn->actions,
                     if: $purgeOn->if,
+                    context: $routeMetadata->purgeOn->context,
                 );
 
                 continue;

src/Command/DebugCommand.php

@@ -223,6 +223,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }>>
      */
     private function findSubscriptions(string $subscription, bool $withProperties): array
@@ -246,6 +247,7 @@ private function findSubscriptions(string $subscription, bool $withProperties):
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }>>
      */
     private function findSubscriptionsForRoute(string $routeName): array
@@ -267,6 +269,7 @@ private function findSubscriptionsForRoute(string $routeName): array
      *     routeParams?: array<string, array{type: string, values: list<mixed>, optional?: true}>,
      *     if?: string,
      *     actions?: non-empty-list<Action>,
+     *     context?: array<string, ?scalar>,
      * }>> $configuration
      */
     private function display(SymfonyStyle $io, array $configuration): void
@@ -286,6 +289,7 @@ private function display(SymfonyStyle $io, array $configuration): void
                         ['Route Params', isset($subscription['routeParams']) ? $this->formatRouteParams($subscription['routeParams']) : 'NONE'],
                         ['Condition', $subscription['if'] ?? 'NONE'],
                         ['Actions', isset($subscription['actions']) ? $this->formatActions($subscription['actions']) : 'ANY'],
+                        ['Context', isset($subscription['context']) ? $this->formatContext($subscription['context']) : 'NONE'],
                     ],
                 );
             }
@@ -335,6 +339,19 @@ private function formatActions(array $actions): string
         );
     }
 
+    /**
+     * @param array<string, ?scalar> $context
+     */
+    private function formatContext(array $context): string
+    {
+        $values = [];
+        foreach ($context as $key => $value) {
+            $values[] = \sprintf('%s: %s', $key, var_export($value, true));
+        }
+
+        return implode(\PHP_EOL, $values);
+    }
+
     private function configuration(): Configuration
     {
         return $this->configuration ??= $this->configurationLoader->load();

src/Listener/EntityChangeListener.php

@@ -13,7 +13,9 @@
 use Sofascore\PurgatoryBundle\Listener\Enum\Action;
 use Sofascore\PurgatoryBundle\Purger\PurgeRequest;
 use Sofascore\PurgatoryBundle\Purger\PurgerInterface;
+use Sofascore\PurgatoryBundle\RouteProvider\PurgeRoute;
 use Sofascore\PurgatoryBundle\RouteProvider\RouteProviderInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 final class EntityChangeListener
@@ -91,11 +93,22 @@ private function handleChanges(LifecycleEventArgs $eventArgs, Action $action): v
                     referenceType: UrlGeneratorInterface::ABSOLUTE_URL,
                 );
 
-                $this->queuedPurgeRequests[$url] ??= new PurgeRequest(
+                $this->queuedPurgeRequests[$this->generateHash(
+                    url: $url,
+                    route: $route,
+                )] ??= new PurgeRequest(
                     url: $url,
                     route: $route,
                 );
             }
         }
     }
+
+    private function generateHash(string $url, PurgeRoute $route): string
+    {
+        $context = $route->context;
+        ksort($context);
+
+        return ContainerBuilder::hash([$url, $context]);
+    }
 }

src/RouteProvider/AbstractEntityRouteProvider.php

@@ -99,6 +99,7 @@ private function processValidSubscriptions(Subscriptions $subscriptions, array $
                 yield new PurgeRoute(
                     name: $subscription['routeName'],
                     params: $routeParams,
+                    context: $subscription['context'] ?? [],
                 );
             }
         }

src/RouteProvider/PurgeRoute.php

@@ -8,10 +8,12 @@ final class PurgeRoute
 {
     /**
      * @param array<string, ?scalar> $params
+     * @param array<string, ?scalar> $context
      */
     public function __construct(
         public readonly string $name,
         public readonly array $params,
+        public readonly array $context = [],
     ) {
     }
 }

templates/profiler.html.twig

@@ -61,6 +61,7 @@
                     <th scope="col" class="key">#</th>
                     <th scope="col">URLs</th>
                     <th scope="col">Routes</th>
+                    <th scope="col">Context</th>
                     <th scope="col">Time</th>
                 </tr>
                 </thead>
@@ -70,6 +71,7 @@
                         <th scope="row">{{ key + 1 }}</th>
                         <td>{{ purge.requests|map(request => request.url)|join('\n')|nl2br }}</td>
                         <td>{{ purge.requests|map(request => request.route.name)|join('\n')|nl2br }}</td>
+                        <td>{{ purge.requests|map(request => request.route.context|json_encode(constant('JSON_FORCE_OBJECT')))|join('\n')|nl2br }}</td>
                         <td>{{ '%.2f'|format(purge.time * 1000) }} <span class="unit">ms</span></td>
                     </tr>
                 {% endfor %}

tests/Application/ApplicationTest.php

@@ -19,6 +19,7 @@
 use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Measurements;
 use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Person;
 use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Plane;
+use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Plant;
 use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Ship;
 use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Enum\Country;
 use Symfony\Component\PropertyAccess\PropertyPath;
@@ -842,4 +843,23 @@ public function testOldValuesWithMissingRouteParamsAreNotPurged(): void
             static fn (string $url): bool => str_starts_with($url, '/for-owner-and-veterinarian'),
         ));
     }
+
+    /**
+     * @see PlantController::detailsAction
+     */
+    public function testPurgeOnWithContext(): void
+    {
+        $plant = new Plant();
+        $plant->name = 'Plant Ash';
+
+        $this->entityManager->persist($plant);
+        $this->entityManager->flush();
+
+        self::assertUrlIsPurged('/plant/'.$plant->id);
+
+        $purgeRequests = self::getPurger()->getPurgedRequests();
+
+        self::assertCount(1, $purgeRequests);
+        self::assertSame(['qux' => true, 'corge' => 2], $purgeRequests[0]->route->context);
+    }
 }

tests/Cache/Configuration/CachedConfigurationLoaderTest.php

@@ -49,6 +49,7 @@ class: 'Foo',
                     route: new Route('/foo'),
                     actions: [Action::Update],
                     if: null,
+                    context: [],
                 ),
                 new PurgeSubscription(
                     class: 'Foo',
@@ -58,6 +59,7 @@ class: 'Foo',
                     route: new Route('/foo'),
                     actions: [Action::Create],
                     if: null,
+                    context: ['qux' => true, 'corge' => 2],
                 ),
             ]);
 
@@ -92,6 +94,7 @@ class: 'Foo',
                         ],
                     ],
                     'actions' => [Action::Create],
+                    'context' => ['qux' => true, 'corge' => 2],
                 ],
             ],
         ], $configuration->toArray());