drupal 8 – AgileAdam.com

Writing Tests for Drush Commands

/ March 21, 2024

There are plenty of examples of these in the wild, but I figured I’d show a stripped down version of an automated Kernel test that successfully tests a drush command. The trick here is making sure you set up a logger and that you stub a few methods (if you happen to use $this->logger() and dt() in your Drush commands). Also featured in this example is the use of Faker to generate realistic test data.

<?php

declare(strict_types = 1);

namespace Drupal\mymodule\Tests\Kernel {

  use Drupal\KernelTests\KernelTestBase;
  use Drupal\mymodule\Drush\Commands\QueueCommands;
  use Drush\Log\DrushLoggerManager;
  use Faker\Factory;
  use Faker\Generator;
  use Psr\Log\LoggerInterface;

  /**
   * Tests the QueueCommands Drush command file.
   */
  final class QueueTest extends KernelTestBase {

    /**
     * {@inheritdoc}
     */
    protected static $modules = [
      // Enable all the modules that this test relies on.
      'auto_entitylabel',
      'block',
      'datetime',
      'eck',
      'field',
      'file',
      'image',
      'link',
      'mymodule',
      'mysql',
      'options',
      'path',
      'path_alias',
      'system',
      'text',
      'user',
      'views',
      'views_bulk_operations',
    ];

    /**
     * The Faker generator.
     *
     * @var \Faker\Generator
     */
    protected Generator $faker;

    /**
     * The logger.
     *
     * @var \Drush\Log\DrushLoggerManager|\Psr\Log\LoggerInterface
     */
    protected DrushLoggerManager|LoggerInterface $logger;

    /**
     * The Drush queue commands.
     *
     * @var \Drupal\mymodule\Drush\Commands\QueueCommands
     */
    protected QueueCommands $drushQueueCommands;

    /**
     * Set up the test environment.
     */
    protected function setUp(): void {
      parent::setUp();

      // Install required config.
      $this->installConfig(['mymodule']);

      $this->faker = Factory::create();
      $logger_class = class_exists(DrushLoggerManager::class) ? DrushLoggerManager::class : LoggerInterface::class;
      $this->logger = $this->prophesize($logger_class)->reveal();
      $drushQueueCommands = new QueueCommands();
      $drushQueueCommands->setLogger($this->logger);
    }

    /**
     * Tests the mymodule:close-all-registration-entities drush command.
     */
    public function testCloseAllRegistrationEntities() {
      // Create a single registration entity.
      // Just demoing simple Faker usage for blog post.
      $registration = \Drupal::entityTypeManager()
        ->getStorage('registration')
        ->create([
          'type' => 'appt',
          'field_echeckin_link' => $this->faker->url(),
          'field_epic_id' => $this->faker->randomNumber(9),
          'field_first_name' => $this->faker->firstName(),
          'field_has_echeckin_link' => $this->faker->boolean(),
          'field_outcome' => NULL,
          'field_phone_number' => $this->faker->phoneNumber(),
          'field_sequence_is_open' => 1,
        ]);
      $registration->save();

      // This method exists in my module's Drush command file.
      // It sets field_sequence_is_open field to 0 for all open reg entities.
      // drush mymodule:close-all-registration-entities.
      $this->drushQueueCommands->closeAllRegistrationEntities();

      // Assert that the registration entity was updated.
      $this->assertCount(1, \Drupal::entityTypeManager()
        ->getStorage('registration')
        ->loadByProperties(['field_sequence_is_open' => 0]));
    }

  }
}

namespace {
  if (!function_exists('dt')) {

    /**
     * Stub for dt().
     *
     * @param string $message
     *   The text.
     * @param array $replace
     *   The replacement values.
     *
     *   The text.
     */
    function dt($message, array $replace = []): string {
      return strtr($message, $replace);
    }

  }

  if (!function_exists('drush_op')) {

    /**
     * Stub for drush_op.
     *
     * @param callable $callable
     *   The function to call.
     */
    function drush_op(callable $callable) {
      $args = func_get_args();
      array_shift($args);
      return call_user_func_array($callable, $args);
    }

  }

}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

<?php

declare(strict_types = 1);

namespace Drupal\mymodule\Tests\Kernel {

use Drupal\KernelTests\KernelTestBase;

use Drupal\mymodule\Drush\Commands\QueueCommands;

use Drush\Log\DrushLoggerManager;

use Faker\Factory;

use Faker\Generator;

use Psr\Log\LoggerInterface;

/**

* Tests the QueueCommands Drush command file.

final class QueueTest extends KernelTestBase {

/**

* {@inheritdoc}

protected static $modules = [

// Enable all the modules that this test relies on.

'auto_entitylabel',

'block',

'datetime',

'eck',

'field',

'file',

'image',

'link',

'mymodule',

'mysql',

'options',

'path',

'path_alias',

'system',

'text',

'user',

'views',

'views_bulk_operations',

];

/**

* The Faker generator.

* @var \Faker\Generator

protected Generator $faker;

/**

* The logger.

* @var \Drush\Log\DrushLoggerManager|\Psr\Log\LoggerInterface

protected DrushLoggerManager|LoggerInterface $logger;

/**

* The Drush queue commands.

* @var \Drupal\mymodule\Drush\Commands\QueueCommands

protected QueueCommands $drushQueueCommands;

/**

* Set up the test environment.

protected function setUp(): void {

parent::setUp();

// Install required config.

$this->installConfig(['mymodule']);

$this->faker = Factory::create();

$logger_class = class_exists(DrushLoggerManager::class) ? DrushLoggerManager::class : LoggerInterface::class;

$this->logger = $this->prophesize($logger_class)->reveal();

$drushQueueCommands = new QueueCommands();

$drushQueueCommands->setLogger($this->logger);

}

/**

* Tests the mymodule:close-all-registration-entities drush command.

public function testCloseAllRegistrationEntities() {

// Create a single registration entity.

// Just demoing simple Faker usage for blog post.

$registration = \Drupal::entityTypeManager()

->getStorage('registration')

->create([

'type' => 'appt',

'field_echeckin_link' => $this->faker->url(),

'field_epic_id' => $this->faker->randomNumber(9),

'field_first_name' => $this->faker->firstName(),

'field_has_echeckin_link' => $this->faker->boolean(),

'field_outcome' => NULL,

'field_phone_number' => $this->faker->phoneNumber(),

'field_sequence_is_open' => 1,

]);

$registration->save();

// This method exists in my module's Drush command file.

// It sets field_sequence_is_open field to 0 for all open reg entities.

// drush mymodule:close-all-registration-entities.

$this->drushQueueCommands->closeAllRegistrationEntities();

// Assert that the registration entity was updated.

$this->assertCount(1, \Drupal::entityTypeManager()

->getStorage('registration')

->loadByProperties(['field_sequence_is_open' => 0]));

}

namespace {

if (!function_exists('dt')) {

/**

* Stub for dt().

* @param string $message

* The text.

* @param array $replace

* The replacement values.

* The text.

function dt($message, array $replace = []): string {

return strtr($message, $replace);

}

if (!function_exists('drush_op')) {

/**

* Stub for drush_op.

* @param callable $callable

* The function to call.

function drush_op(callable $callable) {

$args = func_get_args();

array_shift($args);

return call_user_func_array($callable, $args);

}

I learned this via the migrate_tools project here.

Development

Skip Empty Values During Concatenation in a Drupal 10 Migration

/ January 3, 2024

UPDATE. You can do the same as below without the need for a custom module function. (source)

  field_address_full:
      - plugin: callback
        callable: array_filter
        source:
          - address_1
          - city
          - state
      - plugin: concat
        delimiter: ', '

field_address_full:

- plugin: callback

callable: array_filter

source:

- address_1

- city

- state

- plugin: concat

delimiter: ', '

This quick example shows one method to ignore empty values in a Drupal 10 migration concatenate process.

Code

Migrate code:

process:
  temp_address_parts:
    -
      plugin: skip_on_empty
      method: process
      source:
        - address_1
        - city
        - state
    -
      plugin: callback
      callable: mymodule_migrate_filter_empty
  field_address_full:
    plugin: concat
    delimiter: ', '
    source: '@temp_address_parts'

process:

temp_address_parts:

plugin: skip_on_empty

method: process

source:

- address_1

- city

- state

plugin: callback

callable: mymodule_migrate_filter_empty

field_address_full:

plugin: concat

delimiter: ', '

source: '@temp_address_parts'

Module code:

/**
 * Filters out empty values from an array.
 */
function mymodule_migrate_filter_empty($values): array {
  return array_filter($values, function ($value) {
    return !empty($value);
  });
}

/**

* Filters out empty values from an array.

function mymodule_migrate_filter_empty($values): array {

return array_filter($values, function ($value) {

return !empty($value);

});

}

Result

Example data:

address_1,city,state
1 Main St.,Portland,ME
2 Main St.,Portland
,Portland,ME

address_1,city,state

1 Main St.,Portland,ME

2 Main St.,Portland

,Portland,ME

Resulting field_address_full plain text value

1 Main St., Portland, ME
1 Main St., Portland
Portland, ME

1 Main St., Portland, ME

1 Main St., Portland

Portland, ME

Development

Drupal Migrate API skip_on_multiple Process Plugin

/ June 7, 2023
Here’s a Migrate API process plugin I wrote in Drupal 9 that skips a property or row when more than one value exists. My use case:
1. My source data has locations; each location has multiple associated organizations
2. My new Drupal site has locations; each location has a parent organization
3. I want to only populate the field_parent_org field (an entity reference) if there is a single organization value in the source data for the location
4. I’m using a custom module called “pdms_migrate”
I’ve stripped out all of the noise from the examples below… hopefully it’s enough to help you understand the example:
read more

Development

Setting a LIMIT on an UPDATE query in Drupal 8 / 9

/ March 24, 2021

Here’s a quick tip regarding Drupal database manipulation. Specifically, I needed a way to flip a boolean value (from 1 to 0) on the first N rows in a database table that matched a specific set of conditions.

The Problem

It seems you cannot enforce a LIMIT on an UPDATE query using a static query in Drupal.

Here’s what I was trying to do:

$db = \Drupal::database();
$query = $db->query('UPDATE {mytable} SET ondemand=:zero WHERE ondemand=:one ORDER BY imported_at ASC LIMIT :limit', [
  ':zero' => 0,
  ':one' => 1,
  ':limit' => $qtyToConvert,
]);
$query->execute();

$db = \Drupal::database();

$query = $db->query('UPDATE {mytable} SET ondemand=:zero WHERE ondemand=:one ORDER BY imported_at ASC LIMIT :limit', [

':zero' => 0,

':one' => 1,

':limit' => $qtyToConvert,

]);

$query->execute();

This throws an error. I believe the issue is caused by the variable substitution wrapping the limit value in quotes. The error message starts with:

SQLSTATE[42000]: Syntax error or access violation: 1064 You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ''10'' at line 1...

1	SQLSTATE[42000]: Syntax error or access violation: 1064 You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ''10'' at line 1...

If you run this query manually in MySQL, it works fine with LIMIT 10 but doesn’t work with LIMIT '10' (it throws the same error shown above).

The Solution

Given dynamic queries are favored over static queries, and that this static query doesn’t work, I ended up getting to the finish line with two dynamic queries.

I have tested the solution on 10,000 records and it took < 6 seconds to process the entire request on my local dev lando site.

“code” is a unique identifier column in the database table.

$db = \Drupal::database();
$query = $db->select('mytable', 'mt')
  ->condition('ondemand', 1)
  ->orderBy('imported_at')
  ->fields('mt', ['code'])
  ->range(0, $qtyToConvert);
$codesToReset = $query->execute()->fetchCol();

$db->update('mytable')
  ->fields(['ondemand' => 0])
  ->condition('code', $codesToReset, 'IN')
  ->execute();
return count($codesToReset);

$db = \Drupal::database();

$query = $db->select('mytable', 'mt')

->condition('ondemand', 1)

->orderBy('imported_at')

->fields('mt', ['code'])

->range(0, $qtyToConvert);

$codesToReset = $query->execute()->fetchCol();

$db->update('mytable')

->fields(['ondemand' => 0])

->condition('code', $codesToReset, 'IN')

->execute();

return count($codesToReset);

Development

Missing Titles on Drupal 8 ECK Content Listings

/ February 5, 2021

UPDATE: I discovered the solution below was only working when the Title base field was enabled for the entity type. If you enable the title field on the entity type it works, but then the title is required to save a new record. I will look for an alternative solution to avoid using the Title field altogether. Also, I’ll look into https://www.drupal.org/project/eck/issues/2785297.

I’ve recently run into an issue with an ECK-created custom entity type. There was no reason for me to use the “Title” field on this particular entity type. Unfortunately, when you don’t have a title field several of the built-in entity listings and displays seem broken. Here’s what the Content List screen looks like, for example:

read more

Development

Adding Custom Fields to the Field Edit Screen in Drupal 8 / 9

/ December 14, 2020

Introduction

I’m building an API with Drupal 8/9. There is additional information I want to track against each field instance in each content type (or custom entity type) in the system. This information includes where the field’s data comes from, who is responsible for maintaining it, etc. This is useful for the site administrator and developers to track where things are coming from. Drupal’s Third Party Settings functionality makes this easy.

Result

This is what you see when you edit the First name field:

When you click Save settings the data is saved to this specific field’s instance configuration (meaning if you reuse this field you can fill the info out differently per instance).

Solution

There are two ways to achieve this. In both cases, we use hook_form_FORM_ID_alter() to introduce the new fields. I am doing this within a custom module called pdms. The code lives in pdms.module.

Method #1:

With this method, the system automatically handles storing the value into the field configuration’s third party settings.

This happens because we use the third_party_settings key.

/**
 * Implements hook_form_FORM_ID_alter().
 */
function pdms_form_field_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $entity = $form_state->getFormObject()->getEntity();

  $form['third_party_settings']['pdms']['canonical_source'] = [
    '#type' => 'textarea',
    '#title' => t('Canonical source'),
    '#description' => t('From where does this data originate?'),
    '#default_value' => $entity->getThirdPartySetting('pdms', 'canonical_source'),
  ];

  ... etc ...
}

/**

* Implements hook_form_FORM_ID_alter().

function pdms_form_field_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {

$entity = $form_state->getFormObject()->getEntity();

$form['third_party_settings']['pdms']['canonical_source'] = [

'#type' => 'textarea',

'#title' => t('Canonical source'),

'#description' => t('From where does this data originate?'),

'#default_value' => $entity->getThirdPartySetting('pdms', 'canonical_source'),

];

... etc ...

}

The issue I had with this approach is that I could not get it to work if I put the fields in a fieldset (as shown in the screenshot).

I think it’d be a matter of getting $entity->getThirdPartySetting() to look into the fieldset somehow. If you know how to do this, please let me know!

Method #2:

This method gives us more control over what happens when the form is submitted.

Because we have more control we’re able to traverse the fieldset easily.

You can see, too, how I unset the third party setting if the value is empty. I am not sure if I’ll keep this in place; we’ll see if it causes any issues when I attempt to build a report showing all of the fields and their info.

/**
 * Implements hook_form_FORM_ID_alter().
 */
function pdms_form_field_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $entity = $form_state->getFormObject()->getEntity();

  $form['#entity_builders'][] = 'pdms_set_third_party_settings_field_info';

  $form['pdms_field_info'] = [
    '#type' => 'fieldset',
    '#title' => 'MySite Field Info',
  ];

  $form['pdms_field_info']['canonical_source'] = [
    '#type' => 'textfield',
    '#title' => t('Canonical source'),
    '#description' => t('From where does this data originate?'),
    '#default_value' => $entity->getThirdPartySetting('pdms', 'canonical_source'),
  ];

  $form['pdms_field_info']['canonical_source_location'] = [
    '#type' => 'textfield',
    '#title' => t('Canonical source location'),
    '#description' => t('Where within the canonical source can we find this data?'),
    '#default_value' => $entity->getThirdPartySetting('pdms', 'canonical_source_location'),
  ];

  $form['pdms_field_info']['author'] = [
    '#type' => 'textfield',
    '#title' => t('Author'),
    '#description' => t('Who maintains this data at the canonical source?'),
    '#default_value' => $entity->getThirdPartySetting('pdms', 'author'),
  ];

  $form['pdms_field_info']['author_contact_info'] = [
    '#type' => 'textfield',
    '#title' => t('Author contact info'),
    '#description' => t('How do we contact the author?'),
    '#default_value' => $entity->getThirdPartySetting('pdms', 'author_contact_info'),
  ];

  $form['pdms_field_info']['known_usages'] = [
    '#type' => 'textarea',
    '#title' => t('Known usages'),
    '#description' => t('Who/what is using this data and how are they using it?<br/>Separate each item with a blank line.<br/><strong>Format:</strong> source: description</strong>'),
    '#default_value' => $entity->getThirdPartySetting('pdms', 'known_usages'),
  ];
}

/**
 * Entity builder for PDMS field info third party settings.
 */
function pdms_set_third_party_settings_field_info($entity_type, $entity, &$form, \Drupal\Core\Form\FormStateInterface $form_state) {
  $fields = [
    'canonical_source',
    'canonical_source_location',
    'author',
    'author_contact_info',
    'known_usages',
  ];

  foreach ($fields as $field_name) {
    if ($form_state->getValue($field_name)) {
      $entity->setThirdPartySetting('pdms', $field_name, $form_state->getValue($field_name));
    }
    else {
      $entity->unsetThirdPartySetting('pdms', $field_name);
    }
  }

/**

* Implements hook_form_FORM_ID_alter().

function pdms_form_field_config_edit_form_alter(&$form, FormStateInterface $form_state, $form_id) {

$entity = $form_state->getFormObject()->getEntity();

$form['#entity_builders'][] = 'pdms_set_third_party_settings_field_info';

$form['pdms_field_info'] = [

'#type' => 'fieldset',

'#title' => 'MySite Field Info',

];

$form['pdms_field_info']['canonical_source'] = [

'#type' => 'textfield',

'#title' => t('Canonical source'),

'#description' => t('From where does this data originate?'),

'#default_value' => $entity->getThirdPartySetting('pdms', 'canonical_source'),

];

$form['pdms_field_info']['canonical_source_location'] = [

'#type' => 'textfield',

'#title' => t('Canonical source location'),

'#description' => t('Where within the canonical source can we find this data?'),

'#default_value' => $entity->getThirdPartySetting('pdms', 'canonical_source_location'),

];

$form['pdms_field_info']['author'] = [

'#type' => 'textfield',

'#title' => t('Author'),

'#description' => t('Who maintains this data at the canonical source?'),

'#default_value' => $entity->getThirdPartySetting('pdms', 'author'),

];

$form['pdms_field_info']['author_contact_info'] = [

'#type' => 'textfield',

'#title' => t('Author contact info'),

'#description' => t('How do we contact the author?'),

'#default_value' => $entity->getThirdPartySetting('pdms', 'author_contact_info'),

];

$form['pdms_field_info']['known_usages'] = [

'#type' => 'textarea',

'#title' => t('Known usages'),

'#description' => t('Who/what is using this data and how are they using it? Separate each item with a blank line. Format: source: description'),

'#default_value' => $entity->getThirdPartySetting('pdms', 'known_usages'),

];

}

/**

* Entity builder for PDMS field info third party settings.

function pdms_set_third_party_settings_field_info($entity_type, $entity, &$form, \Drupal\Core\Form\FormStateInterface $form_state) {

$fields = [

'canonical_source',

'canonical_source_location',

'author',

'author_contact_info',

'known_usages',

];

foreach ($fields as $field_name) {

if ($form_state->getValue($field_name)) {

$entity->setThirdPartySetting('pdms', $field_name, $form_state->getValue($field_name));

}

else {

$entity->unsetThirdPartySetting('pdms', $field_name);

}

Development

Increasing Memory for Specific Paths in Drupal 8

/ July 18, 2020

Most of the examples I see for Drupal 8 are for single-path memory limit increases.

The examples for Drupal 7 often follow the pattern below.

Here’s a D8 version that supports multiple paths.

Place this in your settings.php (or site/environment-specific settings.php), then update the paths accordingly.

read more
Development

Conditionally Triggering Salesforce Push Operations in Drupal 8

/ June 29, 2020

The user interface for the Salesforce Suite in Drupal 8 is fantastic. The suite itself is incredibly powerful. Among the many options, for each mapping you create you can specify what operations should trigger a synchronization. Here’s an example:

We recently faced an issue with the “Drupal entity update” trigger being called too often. The salesforce_push module implements hook_entity_update() , which gets called a lot. After looking at how the functions are called in salesforce_push.module I realized there were two choices:

read more

Development

Patch for Drupal 8.7.14 SA-CORE-2020-004, SA-CORE-2020-005, and SA-CORE-2020-006

/ June 25, 2020

I have a site that’s temporarily stuck on 8.7.14; it’s not worth the risk to update to 8.8.8 right now.

I was able to diff 8.8.7 and 8.8.8 to figure out what changes were made for these security announcements:

I could then compare the changes with 8.7.14 to create the patch below, which applies against 8.7.14 without any issues.

DISCLAIMER: The formal recommendation is to update to 8.8.8 if at all possible. Use the patch below at your own risk.

diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc
index 348724d6..e9b7cbc1 100644
--- a/core/includes/bootstrap.inc
+++ b/core/includes/bootstrap.inc
@@ -673,11 +673,17 @@ function drupal_valid_test_ua($new_prefix = NULL) {
     // Ensure that no information leaks on production sites.
     $test_db = new TestDatabase($prefix);
     $key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';
-    if (!is_readable($key_file)) {
+    if (!is_readable($key_file) || is_dir($key_file)) {
       header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
       exit;
     }
     $private_key = file_get_contents($key_file);
+    // The string from drupal_generate_test_ua() is 74 bytes long. If we don't
+    // have it, tests cannot be allowed.
+    if (empty($private_key) || strlen($private_key) < 74) {
+      header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
+      exit;
+    }
     // The file properties add more entropy not easily accessible to others.
     $key = $private_key . filectime(__FILE__) . fileinode(__FILE__);
     $time_diff = REQUEST_TIME - $time;
diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php
index 4bf64196..7bacc473 100644
--- a/core/lib/Drupal/Core/Form/FormBuilder.php
+++ b/core/lib/Drupal/Core/Form/FormBuilder.php
@@ -18,6 +18,7 @@
 use Drupal\Core\Theme\ThemeManagerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\FileBag;
+use Symfony\Component\HttpFoundation\ParameterBag;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -955,8 +956,16 @@ public function doBuildForm($form_id, &$element, FormStateInterface &$form_state
             // This value is checked in self::handleInputElement().
             $form_state->setInvalidToken(TRUE);
 
+            // Ignore all submitted values.
+            $form_state->setUserInput([]);
+
+            $request = $this->requestStack->getCurrentRequest();
+            // Do not trust any POST data.
+            $request->request = new ParameterBag();
             // Make sure file uploads do not get processed.
-            $this->requestStack->getCurrentRequest()->files = new FileBag();
+            $request->files = new FileBag();
+            // Ensure PHP globals reflect these changes.
+            $request->overrideGlobals();
           }
         }
       }
diff --git a/core/lib/Drupal/Core/Form/FormValidator.php b/core/lib/Drupal/Core/Form/FormValidator.php
index 57d24cc2..2afcb52b 100644
--- a/core/lib/Drupal/Core/Form/FormValidator.php
+++ b/core/lib/Drupal/Core/Form/FormValidator.php
@@ -124,10 +124,8 @@ public function validateForm($form_id, &$form, FormStateInterface &$form_state)
    * {@inheritdoc}
    */
   public function setInvalidTokenError(FormStateInterface $form_state) {
-    $url = $this->requestStack->getCurrentRequest()->getRequestUri();
-
     // Setting this error will cause the form to fail validation.
-    $form_state->setErrorByName('form_token', $this->t('The form has become outdated. Copy any unsaved work in the form below and then <a href=":link">reload this page</a>.', [':link' => $url]));
+    $form_state->setErrorByName('form_token', $this->t('The form has become outdated. Press the back button, copy any unsaved work in the form, and then reload the page.'));
   }
 
   /**
diff --git a/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php b/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php
index 0b6254d8..db8e7fbe 100644
--- a/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php
+++ b/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php
@@ -45,7 +45,7 @@ public function testManagedFile() {
             $file_field_name => \Drupal::service('file_system')->realpath($test_file->getFileUri()),
           ];
           $this->drupalPostForm(NULL, $edit, t('Save'));
-          $this->assertText('The form has become outdated. Copy any unsaved work in the form below');
+          $this->assertText('The form has become outdated.');
           $last_fid = $this->getLastFileId();
           $this->assertEqual($last_fid_prior, $last_fid, 'File was not saved when uploaded with an invalid form token.');
 
diff --git a/core/modules/jsonapi/src/Controller/EntityResource.php b/core/modules/jsonapi/src/Controller/EntityResource.php
index 5c43d3ee..e21903c2 100644
--- a/core/modules/jsonapi/src/Controller/EntityResource.php
+++ b/core/modules/jsonapi/src/Controller/EntityResource.php
@@ -315,7 +315,7 @@ public function patchIndividual(ResourceType $resource_type, EntityInterface $en
       ));
     }
     $data += ['attributes' => [], 'relationships' => []];
-    $field_names = array_merge(array_keys($data['attributes']), array_keys($data['relationships']));
+    $field_names = array_map([$resource_type, 'getInternalName'], array_merge(array_keys($data['attributes']), array_keys($data['relationships'])));
 
     array_reduce($field_names, function (EntityInterface $destination, $field_name) use ($resource_type, $parsed_entity) {
       $this->updateEntityField($resource_type, $parsed_entity, $destination, $field_name);
diff --git a/core/modules/jsonapi/src/Controller/FileUpload.php b/core/modules/jsonapi/src/Controller/FileUpload.php
index b07dd51d..f8517fd7 100644
--- a/core/modules/jsonapi/src/Controller/FileUpload.php
+++ b/core/modules/jsonapi/src/Controller/FileUpload.php
@@ -112,6 +112,7 @@ public function __construct(AccountInterface $current_user, EntityFieldManagerIn
    *   created file entity.
    */
   public function handleFileUploadForExistingResource(Request $request, ResourceType $resource_type, $file_field_name, FieldableEntityInterface $entity) {
+    $file_field_name = $resource_type->getInternalName($file_field_name);
     $field_definition = $this->validateAndLoadFieldDefinition($resource_type->getEntityTypeId(), $resource_type->getBundle(), $file_field_name);
 
     static::ensureFileUploadAccess($this->currentUser, $field_definition, $entity);
@@ -138,7 +139,7 @@ public function handleFileUploadForExistingResource(Request $request, ResourceTy
     $entity->save();
 
     $route_parameters = ['entity' => $entity->uuid()];
-    $route_name = sprintf('jsonapi.%s.%s.related', $resource_type->getTypeName(), $file_field_name);
+    $route_name = sprintf('jsonapi.%s.%s.related', $resource_type->getTypeName(), $resource_type->getPublicName($file_field_name));
     $related_url = Url::fromRoute($route_name, $route_parameters)->toString(TRUE);
     $request = Request::create($related_url->getGeneratedUrl(), 'GET', [], $request->cookies->all(), [], $request->server->all());
     return $this->httpKernel->handle($request, HttpKernelInterface::SUB_REQUEST);
@@ -161,6 +162,7 @@ public function handleFileUploadForExistingResource(Request $request, ResourceTy
    *   Thrown when there are validation errors.
    */
   public function handleFileUploadForNewResource(Request $request, ResourceType $resource_type, $file_field_name) {
+    $file_field_name = $resource_type->getInternalName($file_field_name);
     $field_definition = $this->validateAndLoadFieldDefinition($resource_type->getEntityTypeId(), $resource_type->getBundle(), $file_field_name);
 
     static::ensureFileUploadAccess($this->currentUser, $field_definition);
@@ -182,7 +184,7 @@ public function handleFileUploadForNewResource(Request $request, ResourceType $r
     /* $self_link = new Link(new CacheableMetadata(), $this->entity->toUrl('jsonapi'), ['self']); */
     $links = new LinkCollection(['self' => $self_link]);
 
-    $relatable_resource_types = $resource_type->getRelatableResourceTypesByField($file_field_name);
+    $relatable_resource_types = $resource_type->getRelatableResourceTypesByField($resource_type->getPublicName($file_field_name));
     $file_resource_type = reset($relatable_resource_types);
     $resource_object = ResourceObject::createFromEntity($file_resource_type, $file);
     return new ResourceResponse(new JsonApiDocumentTopLevel(new ResourceObjectData([$resource_object], 1), new NullIncludedData(), $links), 201, []);
diff --git a/core/modules/system/tests/src/Functional/Form/FormTest.php b/core/modules/system/tests/src/Functional/Form/FormTest.php
index 849944b0..62ae3c54 100644
--- a/core/modules/system/tests/src/Functional/Form/FormTest.php
+++ b/core/modules/system/tests/src/Functional/Form/FormTest.php
@@ -244,21 +244,27 @@ public function testInputWithInvalidToken() {
     $this->assertSession()
       ->elementExists('css', 'input[name="form_token"]')
       ->setValue('invalid token');
+    $random_string = $this->randomString();
     $edit = [
-      'textfield' => $this->randomString(),
+      'textfield' => $random_string,
       'checkboxes[bar]' => TRUE,
       'select' => 'bar',
       'radios' => 'foo',
     ];
     $this->drupalPostForm(NULL, $edit, 'Submit');
     $this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');
-    $this->assertText('The form has become outdated. Copy any unsaved work in the form below');
-    // Verify that input elements retained the posted values.
-    $this->assertFieldByName('textfield', $edit['textfield']);
+
+    $assert = $this->assertSession();
+    $element = $assert->fieldExists('textfield');
+    $this->assertEmpty($element->getValue());
+    $assert->responseNotContains($random_string);
+    $this->assertText('The form has become outdated.');
+    // Ensure that we don't use the posted values.
+    $this->assertFieldByName('textfield', '');
     $this->assertNoFieldChecked('edit-checkboxes-foo');
-    $this->assertFieldChecked('edit-checkboxes-bar');
-    $this->assertOptionSelected('edit-select', 'bar');
-    $this->assertFieldChecked('edit-radios-foo');
+    $this->assertNoFieldChecked('edit-checkboxes-bar');
+    $this->assertOptionSelected('edit-select', '');
+    $this->assertNoFieldChecked('edit-radios-foo');
 
     // Check another form that has a textarea input.
     $this->drupalGet(Url::fromRoute('form_test.required'));
@@ -271,9 +277,9 @@ public function testInputWithInvalidToken() {
     ];
     $this->drupalPostForm(NULL, $edit, 'Submit');
     $this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');
-    $this->assertText('The form has become outdated. Copy any unsaved work in the form below');
-    $this->assertFieldByName('textfield', $edit['textfield']);
-    $this->assertFieldByName('textarea', $edit['textarea']);
+    $this->assertText('The form has become outdated.');
+    $this->assertFieldByName('textfield', '');
+    $this->assertFieldByName('textarea', '');
 
     // Check another form that has a number input.
     $this->drupalGet(Url::fromRoute('form_test.number'));
@@ -281,12 +287,14 @@ public function testInputWithInvalidToken() {
       ->elementExists('css', 'input[name="form_token"]')
       ->setValue('invalid token');
     $edit = [
-      'integer_step' => mt_rand(1, 100),
+      // We choose a random value which is higher than the default value,
+      // so we don't accidentally generate the default value.
+      'integer_step' => mt_rand(6, 100),
     ];
     $this->drupalPostForm(NULL, $edit, 'Submit');
     $this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');
-    $this->assertText('The form has become outdated. Copy any unsaved work in the form below');
-    $this->assertFieldByName('integer_step', $edit['integer_step']);
+    $this->assertText('The form has become outdated.');
+    $this->assertFieldByName('integer_step', 5);
 
     // Check a form with a Url field
     $this->drupalGet(Url::fromRoute('form_test.url'));
@@ -298,8 +306,9 @@ public function testInputWithInvalidToken() {
     ];
     $this->drupalPostForm(NULL, $edit, 'Submit');
     $this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');
-    $this->assertText('The form has become outdated. Copy any unsaved work in the form below');
-    $this->assertFieldByName('url', $edit['url']);
+    $this->assertText('The form has become outdated.');
+    $this->assertFieldByName('url', '');
+
   }
 
   /**
diff --git a/core/modules/system/tests/src/Functional/Form/ValidationTest.php b/core/modules/system/tests/src/Functional/Form/ValidationTest.php
index 094a0af7..50451a98 100644
--- a/core/modules/system/tests/src/Functional/Form/ValidationTest.php
+++ b/core/modules/system/tests/src/Functional/Form/ValidationTest.php
@@ -68,7 +68,7 @@ public function testValidate() {
     $this->drupalPostForm(NULL, ['name' => 'validate'], 'Save');
     $this->assertNoFieldByName('name', '#value changed by #validate', 'Form element #value was not altered.');
     $this->assertNoText('Name value: value changed by setValueForElement() in #validate', 'Form element value in $form_state was not altered.');
-    $this->assertText('The form has become outdated. Copy any unsaved work in the form below');
+    $this->assertText('The form has become outdated.');
   }
 
   /**
diff --git a/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php b/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php
index 8d20db5c..d2dec0c6 100644
--- a/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php
+++ b/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php
@@ -799,12 +799,30 @@ public function testInvalidToken($expected, $valid_token, $user_is_authenticated
     $expected_form = $form_id();
     $form_arg = $this->getMockForm($form_id, $expected_form);
 
+    // Set up some request data so we can be sure it is removed when a token is
+    // invalid.
+    $this->request->request->set('foo', 'bar');
+    $_POST['foo'] = 'bar';
+
     $form_state = new FormState();
     $input['form_id'] = $form_id;
     $input['form_token'] = $form_token;
+    $input['test'] = 'example-value';
     $form_state->setUserInput($input);
-    $this->simulateFormSubmission($form_id, $form_arg, $form_state, FALSE);
+    $form = $this->simulateFormSubmission($form_id, $form_arg, $form_state, FALSE);
     $this->assertSame($expected, $form_state->hasInvalidToken());
+    if ($expected) {
+      $this->assertEmpty($form['test']['#value']);
+      $this->assertEmpty($form_state->getValue('test'));
+      $this->assertEmpty($_POST);
+      $this->assertEmpty(iterator_to_array($this->request->request->getIterator()));
+    }
+    else {
+      $this->assertEquals('example-value', $form['test']['#value']);
+      $this->assertEquals('example-value', $form_state->getValue('test'));
+      $this->assertEquals('bar', $_POST['foo']);
+      $this->assertEquals('bar', $this->request->request->get('foo'));
+    }
   }
 
   public function providerTestInvalidToken() {
diff --git a/core/tests/Drupal/Tests/Core/Form/FormTestBase.php b/core/tests/Drupal/Tests/Core/Form/FormTestBase.php
index ef08ab77..36605065 100644
--- a/core/tests/Drupal/Tests/Core/Form/FormTestBase.php
+++ b/core/tests/Drupal/Tests/Core/Form/FormTestBase.php
@@ -173,7 +173,7 @@ protected function setUp() {
       ->getMock();
     $this->account = $this->getMock('Drupal\Core\Session\AccountInterface');
     $this->themeManager = $this->getMock('Drupal\Core\Theme\ThemeManagerInterface');
-    $this->request = new Request();
+    $this->request = Request::createFromGlobals();
     $this->eventDispatcher = $this->getMock('Symfony\Component\EventDispatcher\EventDispatcherInterface');
     $this->requestStack = new RequestStack();
     $this->requestStack->push($this->request);
diff --git a/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php b/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php
index 18f0be28..10f54905 100644
--- a/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php
+++ b/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php
@@ -131,7 +131,7 @@ public function testValidateInvalidFormToken() {
       ->getMock();
     $form_state->expects($this->once())
       ->method('setErrorByName')
-      ->with('form_token', 'The form has become outdated. Copy any unsaved work in the form below and then <a href="/test/example?foo=bar">reload this page</a>.');
+      ->with('form_token', 'The form has become outdated. Press the back button, copy any unsaved work in the form, and then reload the page.');
     $form_state->setValue('form_token', 'some_random_token');
     $form_validator->validateForm('test_form_id', $form, $form_state);
     $this->assertTrue($form_state->isValidationComplete());

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc

index 348724d6..e9b7cbc1 100644

--- a/core/includes/bootstrap.inc

+++ b/core/includes/bootstrap.inc

@@ -673,11 +673,17 @@ function drupal_valid_test_ua($new_prefix = NULL) {

// Ensure that no information leaks on production sites.

$test_db = new TestDatabase($prefix);

$key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';

- if (!is_readable($key_file)) {

+ if (!is_readable($key_file) || is_dir($key_file)) {

header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');

exit;

}

$private_key = file_get_contents($key_file);

+ // The string from drupal_generate_test_ua() is 74 bytes long. If we don't

+ // have it, tests cannot be allowed.

+ if (empty($private_key) || strlen($private_key) < 74) {

+ header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');

+ exit;

+ }

// The file properties add more entropy not easily accessible to others.

$key = $private_key . filectime(__FILE__) . fileinode(__FILE__);

$time_diff = REQUEST_TIME - $time;

diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php

index 4bf64196..7bacc473 100644

--- a/core/lib/Drupal/Core/Form/FormBuilder.php

+++ b/core/lib/Drupal/Core/Form/FormBuilder.php

@@ -18,6 +18,7 @@

use Drupal\Core\Theme\ThemeManagerInterface;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;

use Symfony\Component\HttpFoundation\FileBag;

+use Symfony\Component\HttpFoundation\ParameterBag;

use Symfony\Component\HttpFoundation\RequestStack;

use Symfony\Component\HttpFoundation\Response;

@@ -955,8 +956,16 @@ public function doBuildForm($form_id, &$element, FormStateInterface &$form_state

// This value is checked in self::handleInputElement().

$form_state->setInvalidToken(TRUE);

+ // Ignore all submitted values.

+ $form_state->setUserInput([]);

+ $request = $this->requestStack->getCurrentRequest();

+ // Do not trust any POST data.

+ $request->request = new ParameterBag();

// Make sure file uploads do not get processed.

- $this->requestStack->getCurrentRequest()->files = new FileBag();

+ $request->files = new FileBag();

+ // Ensure PHP globals reflect these changes.

+ $request->overrideGlobals();

}

diff --git a/core/lib/Drupal/Core/Form/FormValidator.php b/core/lib/Drupal/Core/Form/FormValidator.php

index 57d24cc2..2afcb52b 100644

--- a/core/lib/Drupal/Core/Form/FormValidator.php

+++ b/core/lib/Drupal/Core/Form/FormValidator.php

@@ -124,10 +124,8 @@ public function validateForm($form_id, &$form, FormStateInterface &$form_state)

* {@inheritdoc}

public function setInvalidTokenError(FormStateInterface $form_state) {

- $url = $this->requestStack->getCurrentRequest()->getRequestUri();

// Setting this error will cause the form to fail validation.

- $form_state->setErrorByName('form_token', $this->t('The form has become outdated. Copy any unsaved work in the form below and then <a href=":link">reload this page</a>.', [':link' => $url]));

+ $form_state->setErrorByName('form_token', $this->t('The form has become outdated. Press the back button, copy any unsaved work in the form, and then reload the page.'));

}

/**

diff --git a/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php b/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php

index 0b6254d8..db8e7fbe 100644

--- a/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php

+++ b/core/modules/file/tests/src/Functional/FileManagedFileElementTest.php

@@ -45,7 +45,7 @@ public function testManagedFile() {

$file_field_name => \Drupal::service('file_system')->realpath($test_file->getFileUri()),

];

$this->drupalPostForm(NULL, $edit, t('Save'));

- $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

+ $this->assertText('The form has become outdated.');

$last_fid = $this->getLastFileId();

$this->assertEqual($last_fid_prior, $last_fid, 'File was not saved when uploaded with an invalid form token.');

diff --git a/core/modules/jsonapi/src/Controller/EntityResource.php b/core/modules/jsonapi/src/Controller/EntityResource.php

index 5c43d3ee..e21903c2 100644

--- a/core/modules/jsonapi/src/Controller/EntityResource.php

+++ b/core/modules/jsonapi/src/Controller/EntityResource.php

@@ -315,7 +315,7 @@ public function patchIndividual(ResourceType $resource_type, EntityInterface $en

));

}

$data += ['attributes' => [], 'relationships' => []];

- $field_names = array_merge(array_keys($data['attributes']), array_keys($data['relationships']));

+ $field_names = array_map([$resource_type, 'getInternalName'], array_merge(array_keys($data['attributes']), array_keys($data['relationships'])));

array_reduce($field_names, function (EntityInterface $destination, $field_name) use ($resource_type, $parsed_entity) {

$this->updateEntityField($resource_type, $parsed_entity, $destination, $field_name);

diff --git a/core/modules/jsonapi/src/Controller/FileUpload.php b/core/modules/jsonapi/src/Controller/FileUpload.php

index b07dd51d..f8517fd7 100644

--- a/core/modules/jsonapi/src/Controller/FileUpload.php

+++ b/core/modules/jsonapi/src/Controller/FileUpload.php

@@ -112,6 +112,7 @@ public function __construct(AccountInterface $current_user, EntityFieldManagerIn

* created file entity.

public function handleFileUploadForExistingResource(Request $request, ResourceType $resource_type, $file_field_name, FieldableEntityInterface $entity) {

+ $file_field_name = $resource_type->getInternalName($file_field_name);

$field_definition = $this->validateAndLoadFieldDefinition($resource_type->getEntityTypeId(), $resource_type->getBundle(), $file_field_name);

static::ensureFileUploadAccess($this->currentUser, $field_definition, $entity);

@@ -138,7 +139,7 @@ public function handleFileUploadForExistingResource(Request $request, ResourceTy

$entity->save();

$route_parameters = ['entity' => $entity->uuid()];

- $route_name = sprintf('jsonapi.%s.%s.related', $resource_type->getTypeName(), $file_field_name);

+ $route_name = sprintf('jsonapi.%s.%s.related', $resource_type->getTypeName(), $resource_type->getPublicName($file_field_name));

$related_url = Url::fromRoute($route_name, $route_parameters)->toString(TRUE);

$request = Request::create($related_url->getGeneratedUrl(), 'GET', [], $request->cookies->all(), [], $request->server->all());

return $this->httpKernel->handle($request, HttpKernelInterface::SUB_REQUEST);

@@ -161,6 +162,7 @@ public function handleFileUploadForExistingResource(Request $request, ResourceTy

* Thrown when there are validation errors.

public function handleFileUploadForNewResource(Request $request, ResourceType $resource_type, $file_field_name) {

+ $file_field_name = $resource_type->getInternalName($file_field_name);

$field_definition = $this->validateAndLoadFieldDefinition($resource_type->getEntityTypeId(), $resource_type->getBundle(), $file_field_name);

static::ensureFileUploadAccess($this->currentUser, $field_definition);

@@ -182,7 +184,7 @@ public function handleFileUploadForNewResource(Request $request, ResourceType $r

/* $self_link = new Link(new CacheableMetadata(), $this->entity->toUrl('jsonapi'), ['self']); */

$links = new LinkCollection(['self' => $self_link]);

- $relatable_resource_types = $resource_type->getRelatableResourceTypesByField($file_field_name);

+ $relatable_resource_types = $resource_type->getRelatableResourceTypesByField($resource_type->getPublicName($file_field_name));

$file_resource_type = reset($relatable_resource_types);

$resource_object = ResourceObject::createFromEntity($file_resource_type, $file);

return new ResourceResponse(new JsonApiDocumentTopLevel(new ResourceObjectData([$resource_object], 1), new NullIncludedData(), $links), 201, []);

diff --git a/core/modules/system/tests/src/Functional/Form/FormTest.php b/core/modules/system/tests/src/Functional/Form/FormTest.php

index 849944b0..62ae3c54 100644

--- a/core/modules/system/tests/src/Functional/Form/FormTest.php

+++ b/core/modules/system/tests/src/Functional/Form/FormTest.php

@@ -244,21 +244,27 @@ public function testInputWithInvalidToken() {

$this->assertSession()

->elementExists('css', 'input[name="form_token"]')

->setValue('invalid token');

+ $random_string = $this->randomString();

$edit = [

- 'textfield' => $this->randomString(),

+ 'textfield' => $random_string,

'checkboxes[bar]' => TRUE,

'select' => 'bar',

'radios' => 'foo',

];

$this->drupalPostForm(NULL, $edit, 'Submit');

$this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');

- $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

- // Verify that input elements retained the posted values.

- $this->assertFieldByName('textfield', $edit['textfield']);

+ $assert = $this->assertSession();

+ $element = $assert->fieldExists('textfield');

+ $this->assertEmpty($element->getValue());

+ $assert->responseNotContains($random_string);

+ $this->assertText('The form has become outdated.');

+ // Ensure that we don't use the posted values.

+ $this->assertFieldByName('textfield', '');

$this->assertNoFieldChecked('edit-checkboxes-foo');

- $this->assertFieldChecked('edit-checkboxes-bar');

- $this->assertOptionSelected('edit-select', 'bar');

- $this->assertFieldChecked('edit-radios-foo');

+ $this->assertNoFieldChecked('edit-checkboxes-bar');

+ $this->assertOptionSelected('edit-select', '');

+ $this->assertNoFieldChecked('edit-radios-foo');

// Check another form that has a textarea input.

$this->drupalGet(Url::fromRoute('form_test.required'));

@@ -271,9 +277,9 @@ public function testInputWithInvalidToken() {

];

$this->drupalPostForm(NULL, $edit, 'Submit');

$this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');

- $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

- $this->assertFieldByName('textfield', $edit['textfield']);

- $this->assertFieldByName('textarea', $edit['textarea']);

+ $this->assertText('The form has become outdated.');

+ $this->assertFieldByName('textfield', '');

+ $this->assertFieldByName('textarea', '');

// Check another form that has a number input.

$this->drupalGet(Url::fromRoute('form_test.number'));

@@ -281,12 +287,14 @@ public function testInputWithInvalidToken() {

->elementExists('css', 'input[name="form_token"]')

->setValue('invalid token');

$edit = [

- 'integer_step' => mt_rand(1, 100),

+ // We choose a random value which is higher than the default value,

+ // so we don't accidentally generate the default value.

+ 'integer_step' => mt_rand(6, 100),

];

$this->drupalPostForm(NULL, $edit, 'Submit');

$this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');

- $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

- $this->assertFieldByName('integer_step', $edit['integer_step']);

+ $this->assertText('The form has become outdated.');

+ $this->assertFieldByName('integer_step', 5);

// Check a form with a Url field

$this->drupalGet(Url::fromRoute('form_test.url'));

@@ -298,8 +306,9 @@ public function testInputWithInvalidToken() {

];

$this->drupalPostForm(NULL, $edit, 'Submit');

$this->assertFieldByXpath('//div[contains(@class, "error")]', NULL, 'Error message is displayed with invalid token even when required fields are filled.');

- $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

- $this->assertFieldByName('url', $edit['url']);

+ $this->assertText('The form has become outdated.');

+ $this->assertFieldByName('url', '');

}

/**

diff --git a/core/modules/system/tests/src/Functional/Form/ValidationTest.php b/core/modules/system/tests/src/Functional/Form/ValidationTest.php

index 094a0af7..50451a98 100644

--- a/core/modules/system/tests/src/Functional/Form/ValidationTest.php

+++ b/core/modules/system/tests/src/Functional/Form/ValidationTest.php

@@ -68,7 +68,7 @@ public function testValidate() {

$this->drupalPostForm(NULL, ['name' => 'validate'], 'Save');

$this->assertNoFieldByName('name', '#value changed by #validate', 'Form element #value was not altered.');

$this->assertNoText('Name value: value changed by setValueForElement() in #validate', 'Form element value in $form_state was not altered.');

- $this->assertText('The form has become outdated. Copy any unsaved work in the form below');

+ $this->assertText('The form has become outdated.');

}

/**

diff --git a/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php b/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php

index 8d20db5c..d2dec0c6 100644

--- a/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php

+++ b/core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php

@@ -799,12 +799,30 @@ public function testInvalidToken($expected, $valid_token, $user_is_authenticated

$expected_form = $form_id();

$form_arg = $this->getMockForm($form_id, $expected_form);

+ // Set up some request data so we can be sure it is removed when a token is

+ // invalid.

+ $this->request->request->set('foo', 'bar');

+ $_POST['foo'] = 'bar';

$form_state = new FormState();

$input['form_id'] = $form_id;

$input['form_token'] = $form_token;

+ $input['test'] = 'example-value';

$form_state->setUserInput($input);

- $this->simulateFormSubmission($form_id, $form_arg, $form_state, FALSE);

+ $form = $this->simulateFormSubmission($form_id, $form_arg, $form_state, FALSE);

$this->assertSame($expected, $form_state->hasInvalidToken());

+ if ($expected) {

+ $this->assertEmpty($form['test']['#value']);

+ $this->assertEmpty($form_state->getValue('test'));

+ $this->assertEmpty($_POST);

+ $this->assertEmpty(iterator_to_array($this->request->request->getIterator()));

+ }

+ else {

+ $this->assertEquals('example-value', $form['test']['#value']);

+ $this->assertEquals('example-value', $form_state->getValue('test'));

+ $this->assertEquals('bar', $_POST['foo']);

+ $this->assertEquals('bar', $this->request->request->get('foo'));

+ }

}

public function providerTestInvalidToken() {

diff --git a/core/tests/Drupal/Tests/Core/Form/FormTestBase.php b/core/tests/Drupal/Tests/Core/Form/FormTestBase.php

index ef08ab77..36605065 100644

--- a/core/tests/Drupal/Tests/Core/Form/FormTestBase.php

+++ b/core/tests/Drupal/Tests/Core/Form/FormTestBase.php

@@ -173,7 +173,7 @@ protected function setUp() {

->getMock();

$this->account = $this->getMock('Drupal\Core\Session\AccountInterface');

$this->themeManager = $this->getMock('Drupal\Core\Theme\ThemeManagerInterface');

- $this->request = new Request();

+ $this->request = Request::createFromGlobals();

$this->eventDispatcher = $this->getMock('Symfony\Component\EventDispatcher\EventDispatcherInterface');

$this->requestStack = new RequestStack();

$this->requestStack->push($this->request);

diff --git a/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php b/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php

index 18f0be28..10f54905 100644

--- a/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php

+++ b/core/tests/Drupal/Tests/Core/Form/FormValidatorTest.php

@@ -131,7 +131,7 @@ public function testValidateInvalidFormToken() {

->getMock();

$form_state->expects($this->once())

->method('setErrorByName')

- ->with('form_token', 'The form has become outdated. Copy any unsaved work in the form below and then <a href="/test/example?foo=bar">reload this page</a>.');

+ ->with('form_token', 'The form has become outdated. Press the back button, copy any unsaved work in the form, and then reload the page.');

$form_state->setValue('form_token', 'some_random_token');

$form_validator->validateForm('test_form_id', $form, $form_state);

$this->assertTrue($form_state->isValidationComplete());

Development

Storing First and Last Name with Social API for Drupal 8

/ June 22, 2020

I recently worked on a project that relied on Social API for Google, Facebook, and Yahoo authentication. Out of the box everything worked great. Our site stores the user’s first name and last name in two fields on the user entity: field_first_name and field_last_name. There are a few ways to tap into the Social API authentication process (which comes from the Social Auth component).

Originally we leveraged the SocialAuthEvents::USER_CREATED event in an event subscriber. We set the first name and last name, then re-saved the user. This, however, executes after the user is created. The issue we had was that we also have Salesforce integration and both name fields are required in Salesforce. When the user is first saved it was pushing to Salesforce without the name fields, which triggered an error.

The solution was to implement a different event handler: SocialAuthEvents::USER_FIELDS

This lets you manipulate the user fields before the user is saved. I poked through the Social Auth code and figured out how to get the first and last name values. Here’s the working solution:

web/modules/custom/mymodule/mymodule.services.yml

services:
  mymodule.social_auth_subscriber:
    class: Drupal\mymodule\EventSubscriber\MymoduleSocialAuthSubscriber
    tags:
      - { name: 'event_subscriber' }

services:

mymodule.social_auth_subscriber:

class: Drupal\mymodule\EventSubscriber\MymoduleSocialAuthSubscriber

tags:

- { name: 'event_subscriber' }

web/modules/custom/mymodule/src/EventSubscriber/MymoduleSocialAuthSubscriber.php

<?php

namespace Drupal\mymodule\EventSubscriber;

use Drupal\social_auth\Event\SocialAuthEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Drupal\social_auth\Event\UserFieldsEvent;

/**
 * Subscribe to Social API events.
 *
 * @package Drupal\social_auth_subscriber\EventSubscriber
 */
class MymoduleSocialAuthSubscriber implements EventSubscriberInterface {

  /**
   * {@inheritdoc}
   *
   * Returns an array of event names this subscriber wants to listen to.
   */
  public static function getSubscribedEvents() {
    $events[SocialAuthEvents::USER_FIELDS] = ['onUserFields'];
    return $events;
  }

  /**
   * Populates name fields before user creation.
   *
   * @param \Drupal\social_auth\Event\UserFieldsEvent $event
   *   The Social Auth user event object.
   */
  public function onUserFields(UserFieldsEvent $event) {
    $fields = $event->getUserFields();

    $user = $event->getSocialAuthUser();
    $first_name = $user->getFirstName();
    $last_name = $user->getLastName();
    $fullname = $user->getName();
    list($first_name_fallback, $last_name_fallback) = explode(' ', $fullname);

    if (!empty($first_name)) {
      $fields['field_first_name'] = ucfirst($first_name);
    }
    elseif (!empty($first_name_fallback)) {
      $fields['field_first_name'] = ucfirst($first_name_fallback);
    }

    if (!empty($last_name)) {
      $fields['field_last_name'] = ucfirst($last_name);
    }
    elseif (!empty($last_name_fallback)) {
      $fields['field_last_name'] = ucfirst($last_name_fallback);
    }

    $event->setUserFields($fields);
  }

}

<?php

namespace Drupal\mymodule\EventSubscriber;

use Drupal\social_auth\Event\SocialAuthEvents;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;

use Drupal\social_auth\Event\UserFieldsEvent;

/**

* Subscribe to Social API events.

* @package Drupal\social_auth_subscriber\EventSubscriber

class MymoduleSocialAuthSubscriber implements EventSubscriberInterface {

/**

* {@inheritdoc}

* Returns an array of event names this subscriber wants to listen to.

public static function getSubscribedEvents() {

$events[SocialAuthEvents::USER_FIELDS] = ['onUserFields'];

return $events;

}

/**

* Populates name fields before user creation.

* @param \Drupal\social_auth\Event\UserFieldsEvent $event

* The Social Auth user event object.

public function onUserFields(UserFieldsEvent $event) {

$fields = $event->getUserFields();

$user = $event->getSocialAuthUser();

$first_name = $user->getFirstName();

$last_name = $user->getLastName();

$fullname = $user->getName();

list($first_name_fallback, $last_name_fallback) = explode(' ', $fullname);

if (!empty($first_name)) {

$fields['field_first_name'] = ucfirst($first_name);

}

elseif (!empty($first_name_fallback)) {

$fields['field_first_name'] = ucfirst($first_name_fallback);

}

if (!empty($last_name)) {

$fields['field_last_name'] = ucfirst($last_name);

}

elseif (!empty($last_name_fallback)) {

$fields['field_last_name'] = ucfirst($last_name_fallback);

}

$event->setUserFields($fields);

}

After creating/updating the files above, just clear the caches and test.