Migrate Drupal's BlockPluginId plugin is hard to read and awkward to use. It depends on being placed in a specific spot in a process pipeline, after a specific plugin (static_map). This is all unnecessary -- it can be easily refactored into a much sleeker and better-integrated plugin by extending StaticMap and taking advantage of the inherited functionality.

This patch turns BlockPluginId into a subclass of StaticMap. BlockPluginId's specialized processing happens first, and if no plugin ID can be derived from that logic, it falls back to static mapping.

If the static mapping is bypassed on failure, the plugin will create a new plugin ID from the input values, in the form $module:$delta, which will be saved with the migrated block. Chances are, a plugin with this composite ID will not actually exist, so when the block is displayed in the migrated site, the block system will use the fallback (broken) plugin. This means more blocks can be migrated into their correct theme and region, giving the site owner a chance to set the correct plugin ID later.

As of #5, this patch does not break BC.

CommentFileSizeAuthor
#23 2796165-23.patch7.35 KBquietone
#23 diff-18-23.txt6.2 KBquietone
#18 2796165-18.drupal.Refactor-BlockPluginId-to-improve-data-integrity-flexibility-and-maintainability.patch11 KBmikelutz
#10 interdiff-2796165-5-10.txt4.1 KBphenaproxima
#10 2796165-10.patch11.07 KBphenaproxima
#5 interdiff-2796165-2-5.txt1.43 KBphenaproxima
#5 2796165-5.patch9.51 KBphenaproxima
#2 2796165-2.patch9.36 KBphenaproxima
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

phenaproxima created an issue. See original summary.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Active » Needs review
FileSize
2796165-2.patch9.36 KB

First attempt. Chances are, this will break the plugin's unit some test. (BlockPluginId has no unit test.)

Status: Needs review » Needs work

The last submitted patch, 2: 2796165-2.patch, failed testing.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Issue tags: +Needs tests
phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Needs work » Needs review
Issue tags: -Migrate BC break
FileSize
2796165-5.patch9.51 KB
interdiff-2796165-2-5.txt1.43 KB

Added an is_scalar() check to BlockPluginId for backwards compatibility, and removed the bypass flag from the d6_block and d7_block migrations so that, out of the box, they'll behave the way they did before the refactoring.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Issue summary: View changes
phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Issue summary: View changes
phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Issue tags: +DX (Developer Experience)
mikeryan’s picture

mikeryan
he/him
Primary language English
Location Murphysboro, IL, USA
CreditAttribution: mikeryan as a volunteer and at Virtuoso Performance commented
Status: Needs review » Needs work 
  1. +++ b/core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
@@ -46,20 +46,26 @@ public function __construct(array $configuration, $plugin_id, array $plugin_defi
+    if ($container->get('module_handler')->moduleExists('block_content')) {
...
+    $reflector = new \ReflectionClass($plugin_definition['class']);
+    return $reflector->newInstanceArgs($arguments);

    create() definitely needs some comments to explain why we're resorting to moduleExists() and reflection here. 

  2. +++ b/core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
@@ -46,20 +46,26 @@ public function __construct(array $configuration, $plugin_id, array $plugin_defi
+          'd6_custom_block',
+          'd7_custom_block',

    Hardcoded migration IDs make this plugin unusable for custom migration scenarios, let's make these configurable (a la #2640842: Make related file migration ID configurable in d6_cck_file).

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Needs work » Needs review
FileSize
2796165-10.patch11.07 KB
interdiff-2796165-5-10.txt4.1 KB

Both addressed. Still needs tests, though...

heddn’s picture

heddn
Primary language English
Location Nicaragua
CreditAttribution: heddn at MTech, LLC commented

I've used the patch in #10 on a live site and it seems to function fine. However, I didn't use any of the advanced features or capabilities of the patch so leaving at needs review.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Needs review » Needs work

NW for tests.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

mikelutz’s picture

mikelutz
He/Him
Primary language English
Location Michigan, USA
CreditAttribution: mikelutz as a volunteer commented
mikelutz’s picture

mikelutz
He/Him
Primary language English
Location Michigan, USA
CreditAttribution: mikelutz as a volunteer commented
FileSize
2796165-18.drupal.Refactor-BlockPluginId-to-improve-data-integrity-flexibility-and-maintainability.patch11 KB

Starting with a re-roll for 8.7.x

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

quietone’s picture

quietone CreditAttribution: quietone as a volunteer commented
Status: Needs work » Needs review
FileSize
diff-18-23.txt6.2 KB
2796165-23.patch7.35 KB

Always wondered about this one so I rerolled it.

Status: Needs review » Needs work

The last submitted patch, 23: 2796165-23.patch, failed testing. View results

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.