class JsonApiRegressionTest

class JsonApiRegressionTest extends JsonApiFunctionalTestBase {
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'basic_auth',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Ensure deep nested include works on multi target entity type field.
     *
     * @see https://www.drupal.org/project/drupal/issues/2973681
     */
    public function testDeepNestedIncludeMultiTargetEntityTypeFieldFromIssue2973681() : void {
        // Set up data model.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'comment',
        ], TRUE), 'Installed modules.');
        $this->addDefaultCommentField('node', 'article');
        $this->addDefaultCommentField('taxonomy_term', 'tags', 'comment', CommentItemInterface::OPEN, 'tcomment');
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->createEntityReferenceField('node', 'page', 'field_comment', NULL, 'comment', 'default', [
            'target_bundles' => [
                'comment' => 'comment',
                'tcomment' => 'tcomment',
            ],
        ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        $this->rebuildAll();
        // Create data.
        $node = Node::create([
            'title' => 'test article',
            'type' => 'article',
        ]);
        $node->save();
        $comment = Comment::create([
            'subject' => 'Llama',
            'entity_id' => 1,
            'entity_type' => 'node',
            'field_name' => 'comment',
        ]);
        $comment->save();
        $page = Node::create([
            'title' => 'test node',
            'type' => 'page',
            'field_comment' => [
                'entity' => $comment,
            ],
        ]);
        $page->save();
        // Test.
        $user = $this->drupalCreateUser([
            'access content',
            'access comments',
        ]);
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/page?include=field_comment,field_comment.entity_id,field_comment.entity_id.uid'), [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ]);
        $this->assertSame(200, $response->getStatusCode());
    }
    
    /**
     * Ensures GETting terms works when multiple vocabularies exist.
     *
     * @see https://www.drupal.org/project/drupal/issues/2977879
     */
    public function testGetTermWhenMultipleVocabulariesExistFromIssue2977879() : void {
        // Set up data model.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'taxonomy',
        ], TRUE), 'Installed modules.');
        Vocabulary::create([
            'name' => 'one',
            'vid' => 'one',
        ])->save();
        Vocabulary::create([
            'name' => 'two',
            'vid' => 'two',
        ])->save();
        $this->rebuildAll();
        // Create data.
        Term::create([
            'vid' => 'one',
        ])->setName('Test')
            ->save();
        // Test.
        $user = $this->drupalCreateUser([
            'access content',
        ]);
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/taxonomy_term/one'), [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ]);
        $this->assertSame(200, $response->getStatusCode());
    }
    
    /**
     * Ensures GETting node collection + hook_node_grants() implementations works.
     *
     * @see https://www.drupal.org/project/drupal/issues/2984964
     */
    public function testGetNodeCollectionWithHookNodeGrantsImplementationsFromIssue2984964() : void {
        // Set up data model.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'node_access_test',
        ], TRUE), 'Installed modules.');
        node_access_rebuild();
        $this->rebuildAll();
        // Create data.
        Node::create([
            'title' => 'test article',
            'type' => 'article',
        ])->save();
        // Test.
        $user = $this->drupalCreateUser([
            'access content',
        ]);
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/article'), [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ]);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertContains('user.node_grants:view', explode(' ', $response->getHeader('X-Drupal-Cache-Contexts')[0]));
    }
    
    /**
     * Cannot GET an entity with dangling references in an ER field.
     *
     * @see https://www.drupal.org/project/drupal/issues/2984647
     */
    public function testDanglingReferencesInAnEntityReferenceFieldFromIssue2984647() : void {
        // Set up data model.
        $this->drupalCreateContentType([
            'type' => 'journal_issue',
        ]);
        $this->drupalCreateContentType([
            'type' => 'journal_conference',
        ]);
        $this->drupalCreateContentType([
            'type' => 'journal_article',
        ]);
        $this->createEntityReferenceField('node', 'journal_article', 'field_issue', NULL, 'node', 'default', [
            'target_bundles' => [
                'journal_issue' => 'journal_issue',
            ],
        ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        $this->createEntityReferenceField('node', 'journal_article', 'field_mentioned_in', NULL, 'node', 'default', [
            'target_bundles' => [
                'journal_issue' => 'journal_issue',
                'journal_conference' => 'journal_conference',
            ],
        ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        $this->rebuildAll();
        // Create data.
        $issue_node = Node::create([
            'title' => 'Test Journal Issue',
            'type' => 'journal_issue',
        ]);
        $issue_node->save();
        $conference_node = Node::create([
            'title' => 'First Journal Conference!',
            'type' => 'journal_conference',
        ]);
        $conference_node->save();
        $user = $this->drupalCreateUser([
            'access content',
            'edit own journal_article content',
        ]);
        $article_node = Node::create([
            'title' => 'Test Journal Article',
            'type' => 'journal_article',
            'field_issue' => [
                [
                    'target_id' => $issue_node->id(),
                ],
            ],
            'field_mentioned_in' => [
                [
                    'target_id' => $issue_node->id(),
                ],
                [
                    'target_id' => $conference_node->id(),
                ],
            ],
        ]);
        $article_node->setOwner($user);
        $article_node->save();
        // Test.
        $url = Url::fromUri(sprintf('internal:/jsonapi/node/journal_article/%s', $article_node->uuid()));
        $request_options = [
            RequestOptions::HEADERS => [
                'Content-Type' => 'application/vnd.api+json',
                'Accept' => 'application/vnd.api+json',
            ],
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        $issue_node->delete();
        $response = $this->request('GET', $url, $request_options);
        $document = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        // Entity reference field allowing a single bundle: dangling reference's
        // resource type is deduced.
        $this->assertSame([
            [
                'type' => 'node--journal_issue',
                'id' => 'missing',
                'meta' => [
                    'links' => [
                        'help' => [
                            'href' => 'https://www.drupal.org/docs/8/modules/json-api/core-concepts#missing',
                            'meta' => [
                                'about' => "Usage and meaning of the 'missing' resource identifier.",
                            ],
                        ],
                    ],
                ],
            ],
        ], $document['data']['relationships']['field_issue']['data']);
        // Entity reference field allowing multiple bundles: dangling reference's
        // resource type is NOT deduced.
        $this->assertSame([
            [
                'type' => 'unknown',
                'id' => 'missing',
                'meta' => [
                    'links' => [
                        'help' => [
                            'href' => 'https://www.drupal.org/docs/8/modules/json-api/core-concepts#missing',
                            'meta' => [
                                'about' => "Usage and meaning of the 'missing' resource identifier.",
                            ],
                        ],
                    ],
                ],
            ],
            [
                'type' => 'node--journal_conference',
                'id' => $conference_node->uuid(),
                'meta' => [
                    'drupal_internal__target_id' => (int) $conference_node->id(),
                ],
            ],
        ], $document['data']['relationships']['field_mentioned_in']['data']);
    }
    
    /**
     * Ensures that JSON:API routes are caches are dynamically rebuilt.
     *
     * Adding a new relationship field should cause new routes to be immediately
     * regenerated. The site builder should not need to manually rebuild caches.
     *
     * @see https://www.drupal.org/project/drupal/issues/2984886
     */
    public function testThatRoutesAreRebuiltAfterDataModelChangesFromIssue2984886() : void {
        $user = $this->drupalCreateUser([
            'access content',
        ]);
        $request_options = [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/dog'), $request_options);
        $this->assertSame(404, $response->getStatusCode());
        $node_type_dog = NodeType::create([
            'type' => 'dog',
            'name' => 'Dog',
        ]);
        $node_type_dog->save();
        NodeType::create([
            'type' => 'cat',
            'name' => 'Cat',
        ])->save();
        \Drupal::service('router.builder')->rebuildIfNeeded();
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/dog'), $request_options);
        $this->assertSame(200, $response->getStatusCode());
        $this->createEntityReferenceField('node', 'dog', 'field_test', NULL, 'node');
        \Drupal::service('router.builder')->rebuildIfNeeded();
        $dog = Node::create([
            'type' => 'dog',
            'title' => 'retriever',
        ]);
        $dog->save();
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/dog/' . $dog->uuid() . '/field_test'), $request_options);
        $this->assertSame(200, $response->getStatusCode());
        $this->createEntityReferenceField('node', 'cat', 'field_test', NULL, 'node');
        \Drupal::service('router.builder')->rebuildIfNeeded();
        $cat = Node::create([
            'type' => 'cat',
            'title' => 'E. Napoleon',
        ]);
        $cat->save();
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/cat/' . $cat->uuid() . '/field_test'), $request_options);
        $this->assertSame(200, $response->getStatusCode());
        FieldConfig::loadByName('node', 'cat', 'field_test')->delete();
        \Drupal::service('router.builder')->rebuildIfNeeded();
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/cat/' . $cat->uuid() . '/field_test'), $request_options);
        $this->assertSame(404, $response->getStatusCode());
        $node_type_dog->delete();
        \Drupal::service('router.builder')->rebuildIfNeeded();
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/dog'), $request_options);
        $this->assertSame(404, $response->getStatusCode());
    }
    
    /**
     * Ensures denormalizing relationships with aliased field names works.
     *
     * @see https://www.drupal.org/project/drupal/issues/3007113
     * @see https://www.drupal.org/project/jsonapi_extras/issues/3004582#comment-12817261
     */
    public function testDenormalizeAliasedRelationshipFromIssue2953207() : void {
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        // Since the JSON:API module does not have an explicit mechanism to set up
        // field aliases, create a strange data model so that automatic aliasing
        // allows us to test aliased relationships.
        // @see \Drupal\jsonapi\ResourceType\ResourceTypeRepository::getFieldMapping()
        $internal_relationship_field_name = 'type';
        $public_relationship_field_name = 'taxonomy_term_' . $internal_relationship_field_name;
        // Set up data model.
        $this->createEntityReferenceField('taxonomy_term', 'tags', $internal_relationship_field_name, NULL, 'user');
        $this->rebuildAll();
        // Create data.
        Term::create([
            'name' => 'foobar',
            'vid' => 'tags',
            'type' => [
                'target_id' => 1,
            ],
        ])->save();
        // Test.
        $user = $this->drupalCreateUser([
            'edit terms in tags',
        ]);
        $body = [
            'data' => [
                'type' => 'user--user',
                'id' => User::load(0)->uuid(),
            ],
        ];
        // Test.
        $response = $this->request('PATCH', Url::fromUri(sprintf('internal:/jsonapi/taxonomy_term/tags/%s/relationships/%s', Term::load(1)->uuid(), $public_relationship_field_name)), [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
            RequestOptions::HEADERS => [
                'Content-Type' => 'application/vnd.api+json',
            ],
            RequestOptions::BODY => Json::encode($body),
        ]);
        $this->assertSame(204, $response->getStatusCode());
    }
    
    /**
     * Ensures that Drupal's page cache is effective.
     *
     * @see https://www.drupal.org/project/drupal/issues/3009596
     */
    public function testPageCacheFromIssue3009596() : void {
        $anonymous_role = Role::load(RoleInterface::ANONYMOUS_ID);
        $anonymous_role->grantPermission('access content');
        $anonymous_role->trustData()
            ->save();
        NodeType::create([
            'type' => 'emu_fact',
            'name' => 'Emu Fact',
        ])->save();
        \Drupal::service('router.builder')->rebuildIfNeeded();
        $node = Node::create([
            'type' => 'emu_fact',
            'title' => "Emus don't say moo!",
        ]);
        $node->save();
        $request_options = [
            RequestOptions::HEADERS => [
                'Accept' => 'application/vnd.api+json',
            ],
        ];
        $node_url = Url::fromUri('internal:/jsonapi/node/emu_fact/' . $node->uuid());
        // The first request should be a cache MISS.
        $response = $this->request('GET', $node_url, $request_options);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertSame('MISS', $response->getHeader('X-Drupal-Cache')[0]);
        // The second request should be a cache HIT.
        $response = $this->request('GET', $node_url, $request_options);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertSame('HIT', $response->getHeader('X-Drupal-Cache')[0]);
    }
    
    /**
     * Ensures datetime fields are normalized using the correct timezone.
     *
     * @see https://www.drupal.org/project/drupal/issues/2999438
     */
    public function testPatchingDateTimeNormalizedWrongTimeZoneIssue3021194() : void {
        // Set up data model.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'datetime',
        ], TRUE), 'Installed modules.');
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->rebuildAll();
        FieldStorageConfig::create([
            'field_name' => 'when',
            'type' => 'datetime',
            'entity_type' => 'node',
            'settings' => [
                'datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME,
            ],
        ])->save();
        FieldConfig::create([
            'field_name' => 'when',
            'entity_type' => 'node',
            'bundle' => 'page',
        ])->save();
        // Create data.
        $page = Node::create([
            'title' => 'Stegosaurus',
            'type' => 'page',
            'when' => [
                'value' => '2018-09-16T12:00:00',
            ],
        ]);
        $page->save();
        // Test.
        $user = $this->drupalCreateUser([
            'access content',
        ]);
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/page/' . $page->uuid()), [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ]);
        $doc = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertSame('2018-09-16T22:00:00+10:00', $doc['data']['attributes']['when']);
    }
    
    /**
     * Ensure includes are respected even when POSTing.
     *
     * @see https://www.drupal.org/project/drupal/issues/3026030
     */
    public function testPostToIncludeUrlDoesNotReturnIncludeFromIssue3026030() : void {
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        // Set up data model.
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->rebuildAll();
        // Test.
        $user = $this->drupalCreateUser([
            'bypass node access',
        ]);
        $url = Url::fromUri('internal:/jsonapi/node/page?include=uid');
        $request_options = [
            RequestOptions::HEADERS => [
                'Content-Type' => 'application/vnd.api+json',
                'Accept' => 'application/vnd.api+json',
            ],
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
            RequestOptions::JSON => [
                'data' => [
                    'type' => 'node--page',
                    'attributes' => [
                        'title' => 'test',
                    ],
                ],
            ],
        ];
        $response = $this->request('POST', $url, $request_options);
        $doc = $this->getDocumentFromResponse($response);
        $this->assertSame(201, $response->getStatusCode());
        $this->assertArrayHasKey('included', $doc);
        $this->assertSame($user->label(), $doc['included'][0]['attributes']['name']);
    }
    
    /**
     * Ensure `@FieldType=map` fields are normalized correctly.
     *
     * @see https://www.drupal.org/project/drupal/issues/3040590
     */
    public function testMapFieldTypeNormalizationFromIssue3040590() : void {
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'entity_test',
        ], TRUE), 'Installed modules.');
        // Create data.
        $entity_a = EntityTestMapField::create([
            'name' => 'A',
            'data' => [
                'foo' => 'bar',
                'baz' => 'qux',
            ],
        ]);
        $entity_a->save();
        $entity_b = EntityTestMapField::create([
            'name' => 'B',
        ]);
        $entity_b->save();
        $user = $this->drupalCreateUser([
            'administer entity_test content',
        ]);
        // Test.
        $url = Url::fromUri('internal:/jsonapi/entity_test_map_field/entity_test_map_field?sort=drupal_internal__id');
        $request_options = [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        $response = $this->request('GET', $url, $request_options);
        $data = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertSame([
            'foo' => 'bar',
            'baz' => 'qux',
        ], $data['data'][0]['attributes']['data']);
        $this->assertNull($data['data'][1]['attributes']['data']);
        $entity_a->set('data', [
            'foo' => 'bar',
        ])
            ->save();
        $response = $this->request('GET', $url, $request_options);
        $data = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertSame([
            'foo' => 'bar',
        ], $data['data'][0]['attributes']['data']);
    }
    
    /**
     * Tests that the response still has meaningful error messages.
     */
    public function testRecursionDetectedWhenResponseContainsViolationsFrom3042124() : void {
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        // Set up default request.
        $url = Url::fromUri('internal:/jsonapi/node/article');
        $request_options = [
            RequestOptions::HEADERS => [
                'Content-Type' => 'application/vnd.api+json',
                'Accept' => 'application/vnd.api+json',
            ],
            RequestOptions::JSON => [
                'data' => [
                    'type' => 'node--article',
                    'attributes' => [],
                ],
            ],
        ];
        // Set up test users.
        $user = $this->drupalCreateUser([
            'bypass node access',
        ], 'Sam');
        $admin = $this->drupalCreateUser([], 'Gandalf', TRUE);
        // Make request as regular user.
        $request_options[RequestOptions::AUTH] = [
            $user->getAccountName(),
            $user->pass_raw,
        ];
        $this->request('POST', $url, $request_options);
        $response = $this->request('POST', $url, $request_options);
        // Assert that the response has a body.
        $data = $this->getDocumentFromResponse($response, FALSE);
        $this->assertSame(422, $response->getStatusCode());
        $this->assertNotNull($data);
        $this->assertSame(sprintf('title: This value should not be null.'), $data['errors'][0]['detail']);
        // Make request as regular user.
        $request_options[RequestOptions::AUTH] = [
            $admin->getAccountName(),
            $admin->pass_raw,
        ];
        $this->request('POST', $url, $request_options);
        $response = $this->request('POST', $url, $request_options);
        // Assert that the response has a body.
        $data = $this->getDocumentFromResponse($response, FALSE);
        $this->assertSame(422, $response->getStatusCode());
        $this->assertNotNull($data);
        $this->assertSame(sprintf('title: This value should not be null.'), $data['errors'][0]['detail']);
    }
    
    /**
     * Ensure POSTing invalid data results in a 422 response, not a PHP error.
     *
     * @see https://www.drupal.org/project/drupal/issues/3052954
     */
    public function testInvalidDataTriggersUnprocessableEntityErrorFromIssue3052954() : void {
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        // Set up data model.
        $user = $this->drupalCreateUser([
            'bypass node access',
        ]);
        // Test.
        $request_options = [
            RequestOptions::HEADERS => [
                'Content-Type' => 'application/vnd.api+json',
                'Accept' => 'application/vnd.api+json',
            ],
            RequestOptions::JSON => [
                'data' => [
                    'type' => 'article',
                    'attributes' => [
                        'title' => 'foobar',
                        'created' => 'not_a_date',
                    ],
                ],
            ],
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        $response = $this->request('POST', Url::fromUri('internal:/jsonapi/node/article'), $request_options);
        $this->assertSame(422, $response->getStatusCode());
    }
    
    /**
     * Ensure optional `@FieldType=map` fields are denormalized correctly.
     */
    public function testEmptyMapFieldTypeDenormalization() : void {
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        // Set up data model.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'entity_test',
        ], TRUE), 'Installed modules.');
        // Create data.
        $entity = EntityTestMapField::create([
            'name' => 'foo',
        ]);
        $entity->save();
        $user = $this->drupalCreateUser([
            'administer entity_test content',
        ]);
        // Test.
        $url = Url::fromUri(sprintf('internal:/jsonapi/entity_test_map_field/entity_test_map_field/%s', $entity->uuid()));
        $request_options = [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        // Retrieve the current representation of the entity.
        $response = $this->request('GET', $url, $request_options);
        $doc = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        // Modify the title. The @FieldType=map normalization is not changed. (The
        // name of this field is confusingly also 'data'.)
        $doc['data']['attributes']['name'] = 'bar';
        $request_options[RequestOptions::HEADERS] = [
            'Content-Type' => 'application/vnd.api+json',
            'Accept' => 'application/vnd.api+json',
        ];
        $request_options[RequestOptions::BODY] = Json::encode($doc);
        $response = $this->request('PATCH', $url, $request_options);
        $patched_document = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertSame($doc['data']['attributes']['data'], $patched_document['data']['attributes']['data']);
    }
    
    /**
     * Ensure EntityAccessDeniedHttpException cacheability is taken into account.
     */
    public function testLeakCacheMetadataInOmitted() : void {
        $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);
        $document = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertArrayNotHasKey('included', $document, 'JSON API response does not contain "included" taxonomy term as the latter is not published, i.e not accessible.');
        $omitted = $document['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);
        $document = $this->getDocumentFromResponse($response);
        $this->assertSame(200, $response->getStatusCode());
        $this->assertEquals($term->uuid(), $document['included'][0]['id'], 'JSON API response contains "included" taxonomy term as it became published, i.e accessible.');
    }
    
    /**
     * Tests that "virtual/missing" resources can exist for renamed fields.
     *
     * @see https://www.drupal.org/project/drupal/issues/3034786
     * @see https://www.drupal.org/project/drupal/issues/3035544
     */
    public function testAliasedFieldsWithVirtualRelationships() : void {
        // Set up the data model.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'taxonomy',
            'jsonapi_test_resource_type_building',
        ], TRUE), 'Installed modules.');
        \Drupal::state()->set('jsonapi_test_resource_type_builder.resource_type_field_aliases', [
            'node--article' => [
                'field_tags' => 'field_aliased',
            ],
        ]);
        $this->rebuildAll();
        $tag_term = Term::create([
            'vid' => 'tags',
            'name' => 'test_tag',
        ]);
        $tag_term->save();
        $article_node = Node::create([
            'type' => 'article',
            'title' => 'test_article',
            'field_tags' => [
                'target_id' => $tag_term->id(),
            ],
        ]);
        $article_node->save();
        // Make a broken reference.
        $tag_term->delete();
        // Make sure that accessing a node that references a deleted term does not
        // cause an error.
        $user = $this->drupalCreateUser([
            'bypass node access',
        ]);
        $request_options = [
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        $response = $this->request('GET', Url::fromUri('internal:/jsonapi/node/article/' . $article_node->uuid()), $request_options);
        $this->assertSame(200, $response->getStatusCode());
    }
    
    /**
     * Tests that caching isn't happening for non-cacheable methods.
     *
     * @see https://www.drupal.org/project/drupal/issues/3072076
     */
    public function testNonCacheableMethods() : void {
        $this->container
            ->get('module_installer')
            ->install([
            'jsonapi_test_non_cacheable_methods',
        ], TRUE);
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        $node = Node::create([
            'type' => 'article',
            'title' => 'Llama non-cacheable',
        ]);
        $node->save();
        $user = $this->drupalCreateUser([
            'access content',
            'create article content',
            'edit any article content',
            'delete any article content',
        ]);
        $base_request_options = [
            RequestOptions::HEADERS => [
                'Content-Type' => 'application/vnd.api+json',
                'Accept' => 'application/vnd.api+json',
            ],
            RequestOptions::AUTH => [
                $user->getAccountName(),
                $user->pass_raw,
            ],
        ];
        $methods = [
            'HEAD',
            'GET',
        ];
        foreach ($methods as $method) {
            $response = $this->request($method, Url::fromUri('internal:/jsonapi/node/article/' . $node->uuid()), $base_request_options);
            $this->assertSame(200, $response->getStatusCode());
        }
        $patch_request_options = $base_request_options + [
            RequestOptions::JSON => [
                'data' => [
                    'type' => 'node--article',
                    'id' => $node->uuid(),
                ],
            ],
        ];
        $response = $this->request('PATCH', Url::fromUri('internal:/jsonapi/node/article/' . $node->uuid()), $patch_request_options);
        $this->assertSame(200, $response->getStatusCode());
        $response = $this->request('DELETE', Url::fromUri('internal:/jsonapi/node/article/' . $node->uuid()), $base_request_options);
        $this->assertSame(204, $response->getStatusCode());
        $post_request_options = $base_request_options + [
            RequestOptions::JSON => [
                'data' => [
                    'type' => 'node--article',
                    'attributes' => [
                        'title' => 'Llama non-cacheable',
                    ],
                ],
            ],
        ];
        $response = $this->request('POST', Url::fromUri('internal:/jsonapi/node/article'), $post_request_options);
        $this->assertSame(201, $response->getStatusCode());
    }

}