EntityReferenceAutocompleteWidget should define its size setting as an integer

Nice catch! Let's write some tests.

The test looks good. I think we need to update the existing formatters settings as well so we need an upgrade path and upgrade path tests.

The upgrade function looks great to me, just one comment so far:

+++ b/core/modules/system/system.install
@@ -2042,3 +2042,27 @@ function system_update_8403() {
+function system_update_8404() {

Field types, widgets and formatters are still in the "field" realm of the Entity Field API, and we usually put field-related updates in field.install.

So this should be moved there as field_update_8401() ;)

+++ b/core/modules/system/system.install
@@ -2042,3 +2042,27 @@ function system_update_8403() {
+function system_update_8404() {

We are not changing the config schema structure we are just updating existing value so we should use post-update function for this.

+++ b/core/modules/system/system.install
@@ -2042,3 +2042,27 @@ function system_update_8403() {
+  foreach ($config_factory->listAll('core.entity_form_display') as $name) {

Now that schema is correct just load the form display entity using entity api and save it in post-update hook.

Thanks, @phenaproxima this was quick. :D

1. +++ b/core/modules/field/field.post_update.php
   @@ -82,3 +82,24 @@ function field_post_update_remove_handler_submit_setting() {
   +        $component['size'] = (int) $component['size'];
   

   If the schema type is correct then why do we need typecasting here?

2. +++ b/core/tests/Drupal/FunctionalJavascriptTests/EntityReference/EntityReferenceAutocompleteWidgetTest.php
   @@ -49,14 +49,22 @@ public function testEntityReferenceAutocompleteWidget() {
   +      ->defaultSettings();
   +    $this->assertInternalType('integer', $settings['size']);
   

   We are only checking the default settings. What about the settings? Is this correct for save settings?

As confirmed by @phenaproxima in IRC that the issue is only with default size value, not with the saved size value. This means we don't need an upgrade path we only need a test to verify that saved size value is an integer

No longer applies on 8.8.x

Re-roll to 8.8.x

Removed the upgrade path, update test, and update fixture as per #17

Would be great to get this in as it's blocking #2863188: Hardcoded result size limit in the entity reference autocomplete widget.

+++ b/core/tests/Drupal/FunctionalJavascriptTests/EntityReference/EntityReferenceAutocompleteWidgetTest.php
@@ -61,6 +61,14 @@ public function testEntityReferenceAutocompleteWidget() {
+    $plugin_collections = $display_repository->getPluginCollections();
+    $settings = $plugin_collections['widgets']
+      ->get('entity_reference_autocomplete')
+      ->defaultSettings();

This should be:

$settings = $display_repository->getFormDisplay('node', 'page')
->getComponent($field_name)['settings'];

As confirmed by @phenaproxima in IRC that the issue is only with default size value, not with the saved size value. This means we don't need an upgrade path we only need a test to verify that saved size value is an integer

Then it would be better to check the type before and after saving the form display.

Actually I think that it is enough to only load EntityReferenceAutocompleteWidget and all of its subclasses and simply call their defaultSettings() method and asserts, that the size is an integer - of course only if 'size' is present in the returned settings.

Even better - let's do this for all widgets and formatters and check their default values against the specified type in their schema. Having such a general test will show if we have more similar inconsistencies and also will prevent us from introducing new inconsistencies with new code.

Went for #26 over #27 as that sounds out of scope of this issue and a good candidate for a follow up.

That is fair. I think that it looks good now. Thank you.

Committed 49fae2a and pushed to 8.8.x. Thanks!

Needs re-roll for 8.7.x

Re-rolled for 8.7.x

Thanks!

Committed/pushed the 8.7.x backport, thanks!

I'm still getting this error when running "composer upgrade" because composer tries to just install the patch.

Issue #2885441: EntityReferenceAutocompleteWidget should define its size setting as an integer)
   Could not apply patch! Skipping. The error was: Cannot apply patch https://www.drupal.org/files/issues/2885441-2.patch


  [Exception]
  Cannot apply patch Issue #2885441: EntityReferenceAutocompleteWidget should
   define its size setting as an integer (https://www.drupal.org/files/issues
  /2885441-2.patch)!

@bogdog400, you no longer need to apply the patch it has been committed. Remove it from your composer.json file.