Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(APQ): Simplify dynamic page cache test code #1394

Merged
merged 4 commits into from
Apr 8, 2024
Merged

test(APQ): Simplify dynamic page cache test code #1394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb832b4
test(APQ): Simplify dynamic page cache test code
klausi Apr 6, 2024
d3417bb
fixed test case result
klausi Apr 8, 2024
b6576a3
remove debug code
klausi Apr 8, 2024
9d5eaf6
phpcs
klausi Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 14 additions & 23 deletions tests/src/Kernel/Framework/AutomaticPersistedQueriesDynamicPageCacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use Symfony\Component\HttpFoundation\Request;

/**
* Tests the automatic persisted query plugin.
* Tests the APQ plugin in combination with dynamic page cache.
*
* @group graphql
*/
Expand Down Expand Up @@ -83,7 +83,6 @@ public function testPageCacheWithDifferentVariables(): void {
$this->server->removeAllPersistedQueryInstances();
$this->server->addPersistedQueryInstance($this->pluginApq);
$this->server->save();
$endpoint = $this->server->get('endpoint');

NodeType::create([
'type' => 'test',
Expand All @@ -108,44 +107,36 @@ public function testPageCacheWithDifferentVariables(): void {
$idQuery = 'query($id: String!) { node(id: $id) { id } }';

// Post query to endpoint to register the query hashes.
$parameters['extensions']['persistedQuery']['sha256Hash'] = hash('sha256', $titleQuery);
$parameters['variables'] = '{"id": "2"}';
$content = json_encode(['query' => $titleQuery] + $parameters);
$request = Request::create($endpoint, 'POST', [], [], [], ['CONTENT_TYPE' => 'application/json'], $content);
$result = $this->container->get('http_kernel')->handle($request);
$extensions['persistedQuery']['sha256Hash'] = hash('sha256', $titleQuery);
$variables = ['id' => '2'];
$result = $this->query($titleQuery, $this->server, $variables, $extensions, FALSE, Request::METHOD_POST);
$this->assertSame(200, $result->getStatusCode());
$this->assertSame(['data' => ['node' => ['title' => 'Node 2']]], json_decode($result->getContent(), TRUE));

$parameters['extensions']['persistedQuery']['sha256Hash'] = hash('sha256', $idQuery);
$parameters['variables'] = '{"id": "2"}';
$content = json_encode(['query' => $idQuery] + $parameters);
$request = Request::create($endpoint, 'POST', [], [], [], ['CONTENT_TYPE' => 'application/json'], $content);
$result = $this->container->get('http_kernel')->handle($request);
$extensions['persistedQuery']['sha256Hash'] = hash('sha256', $idQuery);
$variables = ['id' => '2'];
$result = $this->query($idQuery, $this->server, $variables, $extensions, FALSE, Request::METHOD_POST);
$this->assertSame(200, $result->getStatusCode());
$this->assertSame(['data' => ['node' => ['id' => 2]]], json_decode($result->getContent(), TRUE));

// Execute apq call.
$parameters['variables'] = '{"id": "1"}';
$request = Request::create($endpoint, 'GET', $parameters);
$result = $this->container->get('http_kernel')->handle($request);
$variables = ['id' => '1'];
$result = $this->query(NULL, $this->server, $variables, $extensions);
$this->assertSame(200, $result->getStatusCode());
$this->assertSame(['data' => ['node' => ['id' => 1]]], json_decode($result->getContent(), TRUE));

// Execute apq call with different variables.
$parameters['variables'] = '{"id": "2"}';
$request = Request::create($endpoint, 'GET', $parameters);
$result = $this->container->get('http_kernel')->handle($request);
$variables = ['id' => '2'];
$result = $this->query(NULL, $this->server, $variables, $extensions);
$this->assertSame(200, $result->getStatusCode());
$this->assertSame(['data' => ['node' => ['id' => 2]]], json_decode($result->getContent(), TRUE));

// Execute apq call with same parameters, but different query.
$parameters['extensions']['persistedQuery']['sha256Hash'] = hash('sha256', $titleQuery);
$parameters['variables'] = '{"id": "2"}';
$request = Request::create($endpoint, 'GET', $parameters);
$result = $this->container->get('http_kernel')->handle($request);
$extensions['persistedQuery']['sha256Hash'] = hash('sha256', $titleQuery);
$variables = ['id' => '2'];
$result = $this->query(NULL, $this->server, $variables, $extensions);
$this->assertSame(200, $result->getStatusCode());
$this->assertSame(['data' => ['node' => ['title' => 'Node 2']]], json_decode($result->getContent(), TRUE));

}

}
4 changes: 2 additions & 2 deletions tests/src/Kernel/Framework/AutomaticPersistedQueriesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public function testAutomaticPersistedQueries(): void {
$extensions = ['persistedQuery' => ['sha256Hash' => 'some random hash']];

// Check we get PersistedQueryNotFound.
$result = $this->query('', $this->server, [], $extensions);
$result = $this->query(NULL, $this->server, [], $extensions);

$this->assertSame(200, $result->getStatusCode());
$this->assertSame([
Expand Down Expand Up @@ -97,7 +97,7 @@ public function testAutomaticPersistedQueries(): void {
$this->assertSame(['data' => ['field_one' => 'this is the field one']], json_decode($result->getContent(), TRUE));

// Execute first GET request again.
$result = $this->query($query, $this->server, [], $extensions);
$result = $this->query(NULL, $this->server, [], $extensions);
$this->assertSame(200, $result->getStatusCode());
$this->assertSame(['data' => ['field_one' => 'this is the field one']], json_decode($result->getContent(), TRUE));
}
Expand Down
16 changes: 9 additions & 7 deletions tests/src/Traits/HttpRequestTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ trait HttpRequestTrait {
/**
* Issue a simple query over http.
*
* @param string $query
* The query string.
* @param string|null $query
* The query string. Can be omitted when testing auto persisted queries.
* @param \Drupal\graphql\Entity\Server|null $server
* The server instance.
* @param array $variables
Expand All @@ -40,7 +40,7 @@ trait HttpRequestTrait {
* The http response object.
*/
protected function query(
string $query,
?string $query,
?Server $server = NULL,
array $variables = [],
array $extensions = [],
Expand All @@ -51,13 +51,15 @@ protected function query(
$server = $server ?: $this->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
// the server we only send the query id.
$query_key = $persisted ? 'queryId' : 'query';
$data = [
$query_key => $query,
'variables' => $variables,
] + $extensions;
if (!empty($query)) {
// If the persisted flag is true, then instead of sending the full query
// to the server we only send the query id.
$query_key = $persisted ? 'queryId' : 'query';
$data[$query_key] = $query;
}
if ($operationName) {
$data['operationName'] = $operationName;
}
Expand Down