Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\Tests\jsonapi\Functional;
Chris@18: 
Chris@18: use Drupal\Component\Serialization\Json;
Chris@18: use Drupal\Component\Utility\NestedArray;
Chris@18: use Drupal\Core\Cache\Cache;
Chris@18: use Drupal\Core\Url;
Chris@18: use Drupal\field\Entity\FieldConfig;
Chris@18: use Drupal\field\Entity\FieldStorageConfig;
Chris@18: use Drupal\node\Entity\Node;
Chris@18: use Drupal\user\Entity\User;
Chris@18: use GuzzleHttp\RequestOptions;
Chris@18: 
Chris@18: /**
Chris@18:  * JSON:API integration test for the "User" content entity type.
Chris@18:  *
Chris@18:  * @group jsonapi
Chris@18:  */
Chris@18: class UserTest extends ResourceTestBase {
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public static $modules = ['user'];
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $entityTypeId = 'user';
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $resourceTypeName = 'user--user';
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $patchProtectedFieldNames = [
Chris@18:     'changed' => NULL,
Chris@18:   ];
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $anonymousUsersCanViewLabels = TRUE;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    *
Chris@18:    * @var \Drupal\taxonomy\TermInterface
Chris@18:    */
Chris@18:   protected $entity;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $labelFieldName = 'name';
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $firstCreatedEntityId = 4;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected static $secondCreatedEntityId = 5;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function setUpAuthorization($method) {
Chris@18:     // @todo Remove this in
Chris@18:     $this->grantPermissionsToTestedRole(['access content']);
Chris@18: 
Chris@18:     switch ($method) {
Chris@18:       case 'GET':
Chris@18:         $this->grantPermissionsToTestedRole(['access user profiles']);
Chris@18:         break;
Chris@18: 
Chris@18:       case 'POST':
Chris@18:       case 'PATCH':
Chris@18:       case 'DELETE':
Chris@18:         $this->grantPermissionsToTestedRole(['administer users']);
Chris@18:         break;
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function createEntity() {
Chris@18:     // Create a "Llama" user.
Chris@18:     $user = User::create(['created' => 123456789]);
Chris@18:     $user->setUsername('Llama')
Chris@18:       ->setChangedTime(123456789)
Chris@18:       ->activate()
Chris@18:       ->save();
Chris@18: 
Chris@18:     return $user;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function createAnotherEntity($key) {
Chris@18:     /** @var \Drupal\user\UserInterface $user */
Chris@18:     $user = $this->getEntityDuplicate($this->entity, $key);
Chris@18:     $user->setUsername($user->label() . '_' . $key);
Chris@18:     $user->setEmail("$key@example.com");
Chris@18:     $user->save();
Chris@18:     return $user;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getExpectedDocument() {
Chris@18:     $self_url = Url::fromUri('base:/jsonapi/user/user/' . $this->entity->uuid())->setAbsolute()->toString(TRUE)->getGeneratedUrl();
Chris@18:     return [
Chris@18:       'jsonapi' => [
Chris@18:         'meta' => [
Chris@18:           'links' => [
Chris@18:             'self' => ['href' => 'http://jsonapi.org/format/1.0/'],
Chris@18:           ],
Chris@18:         ],
Chris@18:         'version' => '1.0',
Chris@18:       ],
Chris@18:       'links' => [
Chris@18:         'self' => ['href' => $self_url],
Chris@18:       ],
Chris@18:       'data' => [
Chris@18:         'id' => $this->entity->uuid(),
Chris@18:         'type' => 'user--user',
Chris@18:         'links' => [
Chris@18:           'self' => ['href' => $self_url],
Chris@18:         ],
Chris@18:         'attributes' => [
Chris@18:           'created' => '1973-11-29T21:33:09+00:00',
Chris@18:           'changed' => (new \DateTime())->setTimestamp($this->entity->getChangedTime())->setTimezone(new \DateTimeZone('UTC'))->format(\DateTime::RFC3339),
Chris@18:           'default_langcode' => TRUE,
Chris@18:           'langcode' => 'en',
Chris@18:           'name' => 'Llama',
Chris@18:           'drupal_internal__uid' => 3,
Chris@18:         ],
Chris@18:       ],
Chris@18:     ];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getExpectedCacheContexts(array $sparse_fieldset = NULL) {
Chris@18:     $cache_contexts = parent::getExpectedCacheContexts($sparse_fieldset);
Chris@18:     if ($sparse_fieldset === NULL || in_array('mail', $sparse_fieldset)) {
Chris@18:       $cache_contexts = Cache::mergeContexts($cache_contexts, ['user']);
Chris@18:     }
Chris@18:     return $cache_contexts;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getPostDocument() {
Chris@18:     return [
Chris@18:       'data' => [
Chris@18:         'type' => 'user--user',
Chris@18:         'attributes' => [
Chris@18:           'name' => 'Dramallama',
Chris@18:         ],
Chris@18:       ],
Chris@18:     ];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getExpectedUnauthorizedAccessMessage($method) {
Chris@18:     switch ($method) {
Chris@18:       case 'GET':
Chris@18:         return "The 'access user profiles' permission is required and the user must be active.";
Chris@18: 
Chris@18:       case 'PATCH':
Chris@18:         return "Users can only update their own account, unless they have the 'administer users' permission.";
Chris@18: 
Chris@18:       case 'DELETE':
Chris@18:         return "The 'cancel account' permission is required.";
Chris@18: 
Chris@18:       default:
Chris@18:         return parent::getExpectedUnauthorizedAccessMessage($method);
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests PATCHing security-sensitive base fields of the logged in account.
Chris@18:    */
Chris@18:   public function testPatchDxForSecuritySensitiveBaseFields() {
Chris@18:     // @todo Remove line below in favor of commented line in https://www.drupal.org/project/jsonapi/issues/2878463.
Chris@18:     $url = Url::fromRoute(sprintf('jsonapi.user--user.individual'), ['entity' => $this->account->uuid()]);
Chris@18:     /* $url = $this->account->toUrl('jsonapi'); */
Chris@18: 
Chris@18:     $original_normalization = $this->normalize($this->account, $url);
Chris@18:     // @todo Remove the array_diff_key() call in https://www.drupal.org/node/2821077.
Chris@18:     $original_normalization['data']['attributes'] = array_diff_key(
Chris@18:       $original_normalization['data']['attributes'],
Chris@18:       ['created' => TRUE, 'changed' => TRUE, 'name' => TRUE]
Chris@18:     );
Chris@18: 
Chris@18:     // Since this test must be performed by the user that is being modified,
Chris@18:     // we must use $this->account, not $this->entity.
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18: 
Chris@18:     // Test case 1: changing email.
Chris@18:     $normalization = $original_normalization;
Chris@18:     $normalization['data']['attributes']['mail'] = 'new-email@example.com';
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // DX: 405 when read-only mode is enabled.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceErrorResponse(405, sprintf("JSON:API is configured to accept only read operations. Site administrators can configure this at %s.", Url::fromUri('base:/admin/config/services/jsonapi')->setAbsolute()->toString(TRUE)->getGeneratedUrl()), $url, $response);
Chris@18:     $this->assertSame(['GET'], $response->getHeader('Allow'));
Chris@18: 
Chris@18:     $this->config('jsonapi.settings')->set('read_only', FALSE)->save(TRUE);
Chris@18: 
Chris@18:     // DX: 422 when changing email without providing the password.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceErrorResponse(422, 'mail: Your current password is missing or incorrect; it\'s required to change the Email.', NULL, $response, '/data/attributes/mail');
Chris@18: 
Chris@18:     $normalization['data']['attributes']['pass']['existing'] = 'wrong';
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // DX: 422 when changing email while providing a wrong password.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceErrorResponse(422, 'mail: Your current password is missing or incorrect; it\'s required to change the Email.', NULL, $response, '/data/attributes/mail');
Chris@18: 
Chris@18:     $normalization['data']['attributes']['pass']['existing'] = $this->account->passRaw;
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // 200 for well-formed request.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceResponse(200, FALSE, $response);
Chris@18: 
Chris@18:     // Test case 2: changing password.
Chris@18:     $normalization = $original_normalization;
Chris@18:     $normalization['data']['attributes']['mail'] = 'new-email@example.com';
Chris@18:     $new_password = $this->randomString();
Chris@18:     $normalization['data']['attributes']['pass']['value'] = $new_password;
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // DX: 422 when changing password without providing the current password.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceErrorResponse(422, 'pass: Your current password is missing or incorrect; it\'s required to change the Password.', NULL, $response, '/data/attributes/pass');
Chris@18: 
Chris@18:     $normalization['data']['attributes']['pass']['existing'] = $this->account->passRaw;
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // 200 for well-formed request.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceResponse(200, FALSE, $response);
Chris@18: 
Chris@18:     // Verify that we can log in with the new password.
Chris@18:     $this->assertRpcLogin($this->account->getAccountName(), $new_password);
Chris@18: 
Chris@18:     // Update password in $this->account, prepare for future requests.
Chris@18:     $this->account->passRaw = $new_password;
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18: 
Chris@18:     // Test case 3: changing name.
Chris@18:     $normalization = $original_normalization;
Chris@18:     $normalization['data']['attributes']['mail'] = 'new-email@example.com';
Chris@18:     $normalization['data']['attributes']['pass']['existing'] = $new_password;
Chris@18:     $normalization['data']['attributes']['name'] = 'Cooler Llama';
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // DX: 403 when modifying username without required permission.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceErrorResponse(403, 'The current user is not allowed to PATCH the selected field (name).', $url, $response, '/data/attributes/name');
Chris@18: 
Chris@18:     $this->grantPermissionsToTestedRole(['change own username']);
Chris@18: 
Chris@18:     // 200 for well-formed request.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceResponse(200, FALSE, $response);
Chris@18: 
Chris@18:     // Verify that we can log in with the new username.
Chris@18:     $this->assertRpcLogin('Cooler Llama', $new_password);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Verifies that logging in with the given username and password works.
Chris@18:    *
Chris@18:    * @param string $username
Chris@18:    *   The username to log in with.
Chris@18:    * @param string $password
Chris@18:    *   The password to log in with.
Chris@18:    */
Chris@18:   protected function assertRpcLogin($username, $password) {
Chris@18:     $request_body = [
Chris@18:       'name' => $username,
Chris@18:       'pass' => $password,
Chris@18:     ];
Chris@18:     $request_options = [
Chris@18:       RequestOptions::HEADERS => [],
Chris@18:       RequestOptions::BODY => Json::encode($request_body),
Chris@18:     ];
Chris@18:     $response = $this->request('POST', Url::fromRoute('user.login.http')->setRouteParameter('_format', 'json'), $request_options);
Chris@18:     $this->assertSame(200, $response->getStatusCode());
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests PATCHing security-sensitive base fields to change other users.
Chris@18:    */
Chris@18:   public function testPatchSecurityOtherUser() {
Chris@18:     // @todo Remove line below in favor of commented line in https://www.drupal.org/project/jsonapi/issues/2878463.
Chris@18:     $url = Url::fromRoute(sprintf('jsonapi.user--user.individual'), ['entity' => $this->account->uuid()]);
Chris@18:     /* $url = $this->account->toUrl('jsonapi'); */
Chris@18: 
Chris@18:     $original_normalization = $this->normalize($this->account, $url);
Chris@18: 
Chris@18:     // Since this test must be performed by the user that is being modified,
Chris@18:     // we must use $this->account, not $this->entity.
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18: 
Chris@18:     $normalization = $original_normalization;
Chris@18:     $normalization['data']['attributes']['mail'] = 'new-email@example.com';
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($normalization);
Chris@18: 
Chris@18:     // DX: 405 when read-only mode is enabled.
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     $this->assertResourceErrorResponse(405, sprintf("JSON:API is configured to accept only read operations. Site administrators can configure this at %s.", Url::fromUri('base:/admin/config/services/jsonapi')->setAbsolute()->toString(TRUE)->getGeneratedUrl()), $url, $response);
Chris@18:     $this->assertSame(['GET'], $response->getHeader('Allow'));
Chris@18: 
Chris@18:     $this->config('jsonapi.settings')->set('read_only', FALSE)->save(TRUE);
Chris@18: 
Chris@18:     // Try changing user 1's email.
Chris@18:     $user1 = $original_normalization;
Chris@18:     $user1['data']['attributes']['mail'] = 'another_email_address@example.com';
Chris@18:     $user1['data']['attributes']['uid'] = 1;
Chris@18:     $user1['data']['attributes']['name'] = 'another_user_name';
Chris@18:     $user1['data']['attributes']['pass']['existing'] = $this->account->passRaw;
Chris@18:     $request_options[RequestOptions::BODY] = Json::encode($user1);
Chris@18:     $response = $this->request('PATCH', $url, $request_options);
Chris@18:     // Ensure the email address has not changed.
Chris@18:     $this->assertEquals('admin@example.com', $this->entityStorage->loadUnchanged(1)->getEmail());
Chris@18:     $this->assertResourceErrorResponse(403, 'The current user is not allowed to PATCH the selected field (uid). The entity ID cannot be changed.', $url, $response, '/data/attributes/uid');
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests GETting privacy-sensitive base fields.
Chris@18:    */
Chris@18:   public function testGetMailFieldOnlyVisibleToOwner() {
Chris@18:     // Create user B, with the same roles (and hence permissions) as user A.
Chris@18:     $user_a = $this->account;
Chris@18:     $pass = user_password();
Chris@18:     $user_b = User::create([
Chris@18:       'name' => 'sibling-of-' . $user_a->getAccountName(),
Chris@18:       'mail' => 'sibling-of-' . $user_a->getAccountName() . '@example.com',
Chris@18:       'pass' => $pass,
Chris@18:       'status' => 1,
Chris@18:       'roles' => $user_a->getRoles(),
Chris@18:     ]);
Chris@18:     $user_b->save();
Chris@18:     $user_b->passRaw = $pass;
Chris@18: 
Chris@18:     // Grant permission to role that both users use.
Chris@18:     $this->grantPermissionsToTestedRole(['access user profiles']);
Chris@18: 
Chris@18:     $collection_url = Url::fromRoute('jsonapi.user--user.collection', [], ['query' => ['sort' => 'drupal_internal__uid']]);
Chris@18:     // @todo Remove line below in favor of commented line in https://www.drupal.org/project/jsonapi/issues/2878463.
Chris@18:     $user_a_url = Url::fromRoute(sprintf('jsonapi.user--user.individual'), ['entity' => $user_a->uuid()]);
Chris@18:     /* $user_a_url = $user_a->toUrl('jsonapi'); */
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18: 
Chris@18:     // Viewing user A as user A: "mail" field is accessible.
Chris@18:     $response = $this->request('GET', $user_a_url, $request_options);
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertArrayHasKey('mail', $doc['data']['attributes']);
Chris@18:     // Also when looking at the collection.
Chris@18:     $response = $this->request('GET', $collection_url, $request_options);
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertSame($user_a->uuid(), $doc['data']['2']['id']);
Chris@18:     $this->assertArrayHasKey('mail', $doc['data'][2]['attributes'], "Own user--user resource's 'mail' field is visible.");
Chris@18:     $this->assertSame($user_b->uuid(), $doc['data'][count($doc['data']) - 1]['id']);
Chris@18:     $this->assertArrayNotHasKey('mail', $doc['data'][count($doc['data']) - 1]['attributes']);
Chris@18: 
Chris@18:     // Now request the same URLs, but as user B (same roles/permissions).
Chris@18:     $this->account = $user_b;
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18:     // Viewing user A as user B: "mail" field should be inaccessible.
Chris@18:     $response = $this->request('GET', $user_a_url, $request_options);
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertArrayNotHasKey('mail', $doc['data']['attributes']);
Chris@18:     // Also when looking at the collection.
Chris@18:     $response = $this->request('GET', $collection_url, $request_options);
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertSame($user_a->uuid(), $doc['data']['2']['id']);
Chris@18:     $this->assertArrayNotHasKey('mail', $doc['data'][2]['attributes']);
Chris@18:     $this->assertSame($user_b->uuid(), $doc['data'][count($doc['data']) - 1]['id']);
Chris@18:     $this->assertArrayHasKey('mail', $doc['data'][count($doc['data']) - 1]['attributes']);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Test good error DX when trying to filter users by role.
Chris@18:    */
Chris@18:   public function testQueryInvolvingRoles() {
Chris@18:     $this->setUpAuthorization('GET');
Chris@18: 
Chris@18:     $collection_url = Url::fromRoute('jsonapi.user--user.collection', [], ['query' => ['filter[roles.id][value]' => 'e9b1de3f-9517-4c27-bef0-0301229de792']]);
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18: 
Chris@18:     // The 'administer users' permission is required to filter by role entities.
Chris@18:     $this->grantPermissionsToTestedRole(['administer users']);
Chris@18: 
Chris@18:     $response = $this->request('GET', $collection_url, $request_options);
Chris@18:     $expected_cache_contexts = ['url.path', 'url.query_args:filter', 'url.site'];
Chris@18:     $this->assertResourceErrorResponse(400, "Filtering on config entities is not supported by Drupal's entity API. You tried to filter on a Role config entity.", $collection_url, $response, FALSE, ['4xx-response', 'http_response'], $expected_cache_contexts, FALSE, 'MISS');
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests that the collection contains the anonymous user.
Chris@18:    */
Chris@18:   public function testCollectionContainsAnonymousUser() {
Chris@18:     $url = Url::fromRoute('jsonapi.user--user.collection', [], ['query' => ['sort' => 'drupal_internal__uid']]);
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18: 
Chris@18:     $response = $this->request('GET', $url, $request_options);
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18: 
Chris@18:     $this->assertCount(4, $doc['data']);
Chris@18:     $this->assertSame(User::load(0)->uuid(), $doc['data'][0]['id']);
Chris@18:     $this->assertSame('Anonymous', $doc['data'][0]['attributes']['name']);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function testCollectionFilterAccess() {
Chris@18:     // Set up data model.
Chris@18:     $this->assertTrue($this->container->get('module_installer')->install(['node'], TRUE), 'Installed modules.');
Chris@18:     FieldStorageConfig::create([
Chris@18:       'entity_type' => static::$entityTypeId,
Chris@18:       'field_name' => 'field_favorite_animal',
Chris@18:       'type' => 'string',
Chris@18:     ])
Chris@18:       ->setCardinality(1)
Chris@18:       ->save();
Chris@18:     FieldConfig::create([
Chris@18:       'entity_type' => static::$entityTypeId,
Chris@18:       'field_name' => 'field_favorite_animal',
Chris@18:       'bundle' => 'user',
Chris@18:     ])
Chris@18:       ->setLabel('Test field')
Chris@18:       ->setTranslatable(FALSE)
Chris@18:       ->save();
Chris@18:     $this->drupalCreateContentType(['type' => 'x']);
Chris@18:     $this->rebuildAll();
Chris@18:     $this->grantPermissionsToTestedRole(['access content']);
Chris@18: 
Chris@18:     // Create data.
Chris@18:     $user_a = User::create([])->setUsername('A')->activate();
Chris@18:     $user_a->save();
Chris@18:     $user_b = User::create([])->setUsername('B')->set('field_favorite_animal', 'stegosaurus')->block();
Chris@18:     $user_b->save();
Chris@18:     $node_a = Node::create(['type' => 'x'])->setTitle('Owned by A')->setOwner($user_a);
Chris@18:     $node_a->save();
Chris@18:     $node_b = Node::create(['type' => 'x'])->setTitle('Owned by B')->setOwner($user_b);
Chris@18:     $node_b->save();
Chris@18:     $node_anon_1 = Node::create(['type' => 'x'])->setTitle('Owned by anon #1')->setOwnerId(0);
Chris@18:     $node_anon_1->save();
Chris@18:     $node_anon_2 = Node::create(['type' => 'x'])->setTitle('Owned by anon #2')->setOwnerId(0);
Chris@18:     $node_anon_2->save();
Chris@18:     $node_auth_1 = Node::create(['type' => 'x'])->setTitle('Owned by auth #1')->setOwner($this->account);
Chris@18:     $node_auth_1->save();
Chris@18: 
Chris@18:     $favorite_animal_test_url = Url::fromRoute('jsonapi.user--user.collection')->setOption('query', ['filter[field_favorite_animal]' => 'stegosaurus']);
Chris@18: 
Chris@18:     // Test.
Chris@18:     $collection_url = Url::fromRoute('jsonapi.node--x.collection');
Chris@18:     $request_options = [];
Chris@18:     $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
Chris@18:     $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
Chris@18:     // ?filter[uid.id]=OWN_UUID requires no permissions: 1 result.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.id]' => $this->account->uuid()]), $request_options);
Chris@18:     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(1, $doc['data']);
Chris@18:     $this->assertSame($node_auth_1->uuid(), $doc['data'][0]['id']);
Chris@18:     // ?filter[uid.id]=ANONYMOUS_UUID: 0 results.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.id]' => User::load(0)->uuid()]), $request_options);
Chris@18:     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(0, $doc['data']);
Chris@18:     // ?filter[uid.name]=A: 0 results.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.name]' => 'A']), $request_options);
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(0, $doc['data']);
Chris@18:     // /jsonapi/user/user?filter[field_favorite_animal]: 0 results.
Chris@18:     $response = $this->request('GET', $favorite_animal_test_url, $request_options);
Chris@18:     $this->assertSame(200, $response->getStatusCode());
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(0, $doc['data']);
Chris@18:     // Grant "view" permission.
Chris@18:     $this->grantPermissionsToTestedRole(['access user profiles']);
Chris@18:     // ?filter[uid.id]=ANONYMOUS_UUID: 0 results.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.id]' => User::load(0)->uuid()]), $request_options);
Chris@18:     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(0, $doc['data']);
Chris@18:     // ?filter[uid.name]=A: 1 result since user A is active.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.name]' => 'A']), $request_options);
Chris@18:     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(1, $doc['data']);
Chris@18:     $this->assertSame($node_a->uuid(), $doc['data'][0]['id']);
Chris@18:     // ?filter[uid.name]=B: 0 results since user B is blocked.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.name]' => 'B']), $request_options);
Chris@18:     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(0, $doc['data']);
Chris@18:     // /jsonapi/user/user?filter[field_favorite_animal]: 0 results.
Chris@18:     $response = $this->request('GET', $favorite_animal_test_url, $request_options);
Chris@18:     $this->assertSame(200, $response->getStatusCode());
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(0, $doc['data']);
Chris@18:     // Grant "admin" permission.
Chris@18:     $this->grantPermissionsToTestedRole(['administer users']);
Chris@18:     // ?filter[uid.name]=B: 1 result.
Chris@18:     $response = $this->request('GET', $collection_url->setOption('query', ['filter[uid.name]' => 'B']), $request_options);
Chris@18:     $this->assertSession()->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(1, $doc['data']);
Chris@18:     $this->assertSame($node_b->uuid(), $doc['data'][0]['id']);
Chris@18:     // /jsonapi/user/user?filter[field_favorite_animal]: 1 result.
Chris@18:     $response = $this->request('GET', $favorite_animal_test_url, $request_options);
Chris@18:     $this->assertSame(200, $response->getStatusCode());
Chris@18:     $doc = Json::decode((string) $response->getBody());
Chris@18:     $this->assertCount(1, $doc['data']);
Chris@18:     $this->assertSame($user_b->uuid(), $doc['data'][0]['id']);
Chris@18:   }
Chris@18: 
Chris@18: }