test(caching): Add test case for operation name in cache prefix (#1375)

Author: klausi

tests/src/Kernel/Framework/PersistedQueriesTest.php

@@ -66,7 +66,7 @@ public function testPersistedQueries(array $instanceIds, string $queryId, array
     }
     $this->server->save();
 
-    $result = $this->query($queryId, NULL, [], NULL, TRUE);
+    $result = $this->query($queryId, NULL, [], [], TRUE);
 
     $this->assertSame(200, $result->getStatusCode());
     $this->assertSame($expected, json_decode($result->getContent(), TRUE));

tests/src/Kernel/Framework/ResultCacheTest.php

@@ -11,6 +11,7 @@
 use Drupal\Tests\graphql\Kernel\GraphQLTestBase;
 use GraphQL\Deferred;
 use Prophecy\Argument;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Test query result caching.
@@ -385,4 +386,34 @@ function ($a, $b, $c, $d, FieldContext $field) use ($renderer) {
     $this->assertEquals(200, $result->getStatusCode());
   }
 
+  /**
+   * Ensure that a different operation name does not get a cached result.
+   */
+  public function testOperationNameCaching(): void {
+    $dummy = $this->getMockBuilder(Server::class)
+      ->disableOriginalConstructor()
+      ->onlyMethods(['id'])
+      ->getMock();
+
+    // The dataproducer should be called twice because 2 differently named
+    // queries are not cached.
+    $dummy->expects($this->exactly(2))
+      ->method('id')
+      ->willReturn('test');
+
+    // Use the same resolver for both fields.
+    foreach (['root', 'leakA'] as $field_name) {
+      $this->mockResolver('Query', $field_name,
+        function () use ($dummy) {
+          return $dummy->id();
+        }
+      );
+    }
+
+    // First call is uncached.
+    $this->query('query one { root } query two { leakA }', NULL, [], [], FALSE, Request::METHOD_GET, 'one');
+    // Second call is uncached.
+    $this->query('query one { root } query two { leakA }', NULL, [], [], FALSE, Request::METHOD_GET, 'two');
+  }
+
 }

tests/src/Kernel/Framework/ResultTest.php

@@ -58,7 +58,7 @@ public function testQuery(): void {
    * @coversClass \Drupal\graphql\Cache\RequestPolicy\DenyPost
    */
   public function testPostQuery(): void {
-    $result = $this->query('query { root }', NULL, [], NULL, FALSE, Request::METHOD_POST);
+    $result = $this->query('query { root }', NULL, [], [], FALSE, Request::METHOD_POST);
     $this->assertSame(200, $result->getStatusCode());
     $this->assertSame([
       'data' => [

tests/src/Traits/HttpRequestTrait.php

@@ -27,22 +27,28 @@ trait HttpRequestTrait {
    *   The server instance.
    * @param array $variables
    *   Query variables.
-   * @param array|null $extensions
+   * @param array $extensions
    *   The query extensions.
    * @param bool $persisted
    *   Flag if the query is actually the identifier of a persisted query.
    * @param string $method
    *   Method, GET or POST.
+   * @param string $operationName
+   *   Optional operation name if $query contains multiple operations.
    *
    * @return \Symfony\Component\HttpFoundation\Response
    *   The http response object.
    */
-  protected function query($query, $server = NULL, array $variables = [], array $extensions = NULL, $persisted = FALSE, string $method = Request::METHOD_GET) {
+  protected function query(
+    string $query,
+    ?Server $server = NULL,
+    array $variables = [],
+    array $extensions = [],
+    bool $persisted = FALSE,
+    string $method = Request::METHOD_GET,
+    string $operationName = ''
+  ) {
     $server = $server ?: $this->server;
-    if (!($server instanceof Server)) {
-      throw new \LogicException('Invalid server.');
-    }
-
     $endpoint = $this->server->get('endpoint');
     $extensions = !empty($extensions) ? ['extensions' => $extensions] : [];
     // If the persisted flag is true, then instead of sending the full query to
@@ -52,6 +58,9 @@ protected function query($query, $server = NULL, array $variables = [], array $e
       $query_key => $query,
       'variables' => $variables,
     ] + $extensions;
+    if ($operationName) {
+      $data['operationName'] = $operationName;
+    }
     if ($method === Request::METHOD_GET) {
       $request = Request::create($endpoint, $method, $data);
     }