Pass the path array to CacheKeyAndTags::key() (#2176)

Author: mostafa-rz

CHANGELOG.md

@@ -9,6 +9,8 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+- Change `CacheKeyAndTags` interface signature class https://github.com/nuwave/lighthouse/pull/2176
+
 ### Changed
 
 - Pass resolver arguments to `FieldBuilderDirective::handleFieldBuilder()` https://github.com/nuwave/lighthouse/pull/2234

src/Cache/CacheDirective.php

@@ -71,6 +71,7 @@ function ($root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo)
                     ? data_get($root, $rootCacheKey)
                     : null;
                 $fieldName = $resolveInfo->fieldName;
+                $path = $resolveInfo->path;
 
                 $cache = $shouldUseTags
                     ? $this->cacheRepository->tags([
@@ -85,7 +86,8 @@ function ($root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo)
                     $parentName,
                     $rootID,
                     $fieldName,
-                    $args
+                    $args,
+                    $path
                 );
 
                 // We found a matching value in the cache, so we can just return early without actually running the query.

src/Cache/CacheKeyAndTags.php

@@ -11,8 +11,9 @@ interface CacheKeyAndTags
      *
      * @param  int|string|null $id
      * @param  array<string, mixed> $args
+     * @param  array<int, string|int> $path
      */
-    public function key(?Authenticatable $user, bool $isPrivate, string $parentName, $id, string $fieldName, array $args): string;
+    public function key(?Authenticatable $user, bool $isPrivate, string $parentName, $id, string $fieldName, array $args, array $path): string;
 
     /**
      * Generate a tag for the parent.

src/Cache/CacheKeyAndTagsGenerator.php

@@ -12,14 +12,16 @@ class CacheKeyAndTagsGenerator implements CacheKeyAndTags
     /**
      * @param  int|string|null  $id
      * @param  array<string, mixed>  $args
+     * @param  array<int, string|int> $path
      */
     public function key(
         ?Authenticatable $user,
         bool $isPrivate,
         string $parentName,
         $id,
         string $fieldName,
-        array $args
+        array $args,
+        array $path
     ): string {
         $parts = [self::PREFIX];
 

tests/Integration/Execution/DataLoader/RelationBatchLoaderTest.php

@@ -637,7 +637,7 @@ public function testBatchLoaderWithExpiredCacheEntry(): void
         ');
 
         Cache::forget(
-            (new CacheKeyAndTagsGenerator())->key(null, false, 'Post', $post2->id, 'comments', [])
+            (new CacheKeyAndTagsGenerator())->key(null, false, 'Post', $post2->id, 'comments', [], ['posts', $post2->id, 'comments'])
         );
 
         $secondRequest = $this->graphQL(/** @lang GraphQL */ '

tests/Integration/Schema/Directives/LimitDirectiveTest.php

@@ -171,7 +171,7 @@ public function testLimitsWithCache(): void
         assert($cache instanceof CacheRepository);
 
         $data = $cache->get(
-            (new CacheKeyAndTagsGenerator())->key(null, false, 'User', $user2->id, 'tasks', ['limit' => 1])
+            (new CacheKeyAndTagsGenerator())->key(null, false, 'User', $user2->id, 'tasks', ['limit' => 1], ['user', $user2->id, 'tasks'])
         );
         $this->assertIsArray($data);