AgileAdam.com

Uncategorized

Actionable Task Naming – Reduce Confusion, Increase Speed

/ August 24, 2020

I’ve worked on many teams across many task management systems. One practice that has consistently brought clarity to our projects is actionable task naming. That is, naming tasks in a way that makes them assignable and actionable. This will reduce the number of false assumptions made, and the amount of time it takes people to interpret a task, every time they encounter the task!

Doing this is easy, too.

Instructions:

When you’re writing a task, say these words first (in your head): “I need you to…” or “I need them to…” or “John needs to” — you get the gist. It’s that simple (most of the time).

Example 1:

Instead of Hero image on the homepage is too large you could say Make homepage hero image smaller or Homepage: make hero image smaller or similar.

Note that I often remove the word “the” (Make the homepage hero image smaller).

Example 2:

This time I’ll illustrate why this practice is useful:
Address field is optional — does that mean it is currently optional but needs to be required? Or does it mean that it’s presently required but needs to be optional? I don’t want to have to ask myself that question each time I pass by this task. It’d be much easier to understand the intent/issue if it was written Make address field optional or Make address field required or similar.

On a Related Note (for Developers)

You can use a similar practice when writing version control commit messages.

Instead of I need you to... we use the prefix This will....

The result is consistent messages that say what will happen with a commit is applied/reverted.

Example:
Update jQuery UI version to 3.5.1

read more
Development

Remotely Resetting a Pantheon WordPress User’s Password via Terminus and WP-CLI

/ August 21, 2020

PHP

terminus wp SITEHERE.ENVHERE -- user update UIDHERE --user_pass=PASSHERE

1

terminus wp SITEHERE.ENVHERE -- user update UIDHERE --user_pass=PASSHERE

read more
Photography

Walter’s First Birthday

/ August 20, 2020

read more
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

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.

Development

Overriding “Required Message” on Composite Fields in Webform (Drupal 8)

/ June 18, 2020

The more commonly used fields in Webform (text, radios, etc.) offer the ability to set a custom Required message string. This is the text that shows in the error message when a required field is not filled.

Here’s what that screen looks like when you’re configuring a field on the Build screen:

There are several element types that do not provide a UI field to set this Required message value. The composite Name and Advanced Address field are two examples I encountered. For these fields you have to dig a little deeper, but it’s easy once you get the hang of it. Visit the Advanced tab for the field, then scroll to the bottom where you’ll see a Custom Settings fieldset.

read more

Development

Snippet: MySQL table sizes ordered by largest to smallest (in MB and Row Count)

/ May 20, 2020

Show All Tables By Size in MB

SELECT table_name AS "Tables", ROUND(((data_length + index_length) / 1024 / 1024), 2) "Size in MB" FROM information_schema.TABLES WHERE table_schema = DATABASE() ORDER BY (data_length + index_length) DESC;

1	SELECT table_name AS "Tables", ROUND(((data_length + index_length) / 1024 / 1024), 2) "Size in MB" FROM information_schema.TABLES WHERE table_schema = DATABASE() ORDER BY (data_length + index_length) DESC;

Show All Tables By Size in MB (if > 1 MB)

SELECT table_name AS "Tables", ROUND(((data_length + index_length) / 1024 / 1024), 2) "Size in MB" FROM information_schema.TABLES WHERE table_schema = DATABASE() AND (data_length + index_length) > 1048576 ORDER BY (data_length + index_length) DESC;

1	SELECT table_name AS "Tables", ROUND(((data_length + index_length) / 1024 / 1024), 2) "Size in MB" FROM information_schema.TABLES WHERE table_schema = DATABASE() AND (data_length + index_length) > 1048576 ORDER BY (data_length + index_length) DESC;

Show All Tables By Number of Rows

SELECT table_name, table_rows FROM INFORMATION_SCHEMA.TABLES WHERE table_schema = DATABASE() ORDER BY table_rows DESC;

1	SELECT table_name, table_rows FROM INFORMATION_SCHEMA.TABLES WHERE table_schema = DATABASE() ORDER BY table_rows DESC;

Development

Using Drupal 8 Persistent Login Module on Platform.sh

/ May 15, 2020

The Persistent Login module relies an extra cookie to maintain a Drupal user’s session. The configuration screen for this module lets you specify a prefix for the cookie. The default is “PL”. If you are using the site on HTTPS, the module prepends an “S” to the cookie it creates. Here’s an example cookie name: SPLfa0650d6d985433d455a3b15cc70fd9b .

Platform.sh lets you configure cookie cache settings via routes.yaml .

If you’re using Persistent Login you must tell the system not to ignore this cookie.

Here’s a standard (and simple) routes.yaml file on a Drupal 8 site:

"https://{all}/":
  type: upstream
  upstream: "app:http"
  cache:
    enabled: true
    # Base the cache on the session cookie.
    # Ignore all other cookies.
    cookies: ['/^SS?ESS/', '/^Drupal.visitor/']

"https://{all}/":

type: upstream

upstream: "app:http"

cache:

enabled: true

# Base the cache on the session cookie.

# Ignore all other cookies.

cookies: ['/^SS?ESS/', '/^Drupal.visitor/']

Here’s a modified version which allows Persistent Login to work correctly:

"https://{all}/":
  type: upstream
  upstream: "app:http"
  cache:
    enabled: true
    # Base the cache on the session cookie and persistent login cookie.
    # Ignore all other cookies.
    cookies: ['/^SS?ESS/', '/^S?PL/', '/^Drupal.visitor/']

"https://{all}/":

type: upstream

upstream: "app:http"

cache:

enabled: true

# Base the cache on the session cookie and persistent login cookie.

# Ignore all other cookies.

cookies: ['/^SS?ESS/', '/^S?PL/', '/^Drupal.visitor/']

There is a bit more discussion around how these cookies are handled here: https://www.drupal.org/node/2898065/discuss

Instructions:

Example 1:

Example 2:

On a Related Note (for Developers)

Example: