function JsonApiRegressionTest::testLeakCacheMetadataInOmitted

Ensure EntityAccessDeniedHttpException cacheability is taken into account.

File

core/modules/jsonapi/tests/src/Functional/JsonApiRegressionTest.php, line 1169

Class

JsonApiRegressionTest

JSON:API regression tests.

Namespace

Code

public function testLeakCacheMetadataInOmitted() {
    $term = Term::create([
        'name' => 'Llama term',
        'vid' => 'tags',
    ]);
    $term->setUnpublished();
    $term->save();
    $node = Node::create([
        'type' => 'article',
        'title' => 'Llama node',
        'field_tags' => [
            'target_id' => $term->id(),
        ],
    ]);
    $node->save();
    $user = $this->drupalCreateUser([
        'access content',
    ]);
    $request_options = [
        RequestOptions::AUTH => [
            $user->getAccountName(),
            $user->pass_raw,
        ],
    ];
    // Request with unpublished term. At this point it would include the term
    // into "omitted" part of the response. The point here is that we
    // purposefully warm up the cache where it is excluded from response and
    // on the next run we will assure merely publishing term is enough to make
    // it visible, i.e. that the 1st response was invalidated in Drupal cache.
    $url = Url::fromUri('internal:/jsonapi/' . $node->getEntityTypeId() . '/' . $node->bundle(), [
        'query' => [
            'include' => 'field_tags',
        ],
    ]);
    $response = $this->request('GET', $url, $request_options);
    $this->assertSame(200, $response->getStatusCode());
    $response = Json::decode((string) $response->getBody());
    $this->assertArrayNotHasKey('included', $response, 'JSON API response does not contain "included" taxonomy term as the latter is not published, i.e not accessible.');
    $omitted = $response['meta']['omitted']['links'];
    unset($omitted['help']);
    $omitted = reset($omitted);
    $expected_url = Url::fromUri('internal:/jsonapi/' . $term->getEntityTypeId() . '/' . $term->bundle() . '/' . $term->uuid());
    $expected_url->setAbsolute();
    $this->assertSame($expected_url->toString(), $omitted['href'], 'Entity that is excluded due to access constraints is correctly reported in the "Omitted" section of the JSON API response.');
    $term->setPublished();
    $term->save();
    $response = $this->request('GET', $url, $request_options);
    $this->assertSame(200, $response->getStatusCode());
    $this->assertEquals($term->uuid(), Json::decode((string) $response->getBody())['included'][0]['id'], 'JSON API response contains "included" taxonomy term as it became published, i.e accessible.');
}