Contrib.social

Add backward compatibility to Rector rules

Open on Drupal.org →
Created on 28 March 2023, about 2 years ago
Updated 2 December 2023, over 1 year ago

Problem / Motivation

Rector is a brute force tool that assumes code is always running the latest version without backward compatibility considerations. See my blog post here https://mglaman.dev/blog/adding-backward-compatibility-rector-rules

I want to make it possible for Rules added to have backward compatibility fixes available. This will streamline Rector fixes for contributed modules.

PR on GitHub #222

Proposed solution

Adds AbstractDrupalCoreRector base class to enable backward compatibility. It also skips Rector rules if the current Drupal version is less than the introduced change.

Based on the work by @mglaman on #222 and refactored since we now have DeprecationHelper in core.

This change introduced a number of new things:

Configuration interface for BC enabled rules

DrupalRector\Contract\VersionedConfigurationInterface: If an configuration implements this interface the developer can supply a version for the configured rule. With this drupal-rector can identify the following things:

  1. What version does this rule apply to
  2. What version needs a BC fix
  3. What version just needs the normal fix.

Concrete configuration for rules with no own configuration

DrupalRector\Rector\ValueObject\DrupalIntroducedVersionConfiguration: A configuration valueobject that only contains a version. If a rector does not need any configuration itself, the developer can use this valueobject to supply version information about the rector.

Base class for BC rule rectors

AbstractDrupalCoreRector: This class can be used as a base for BC fixes. It will check the Drupal version, the configuration object for applicable version and either skip the rule, run in in BC mode, or just run it normally.

Supported node types

Currently the only type of node it applies to is CallLike. When new rules arrise that might need to apply to other type of nodes. But lets add those as they come up.

// Create a backwards compatible call if the node is a call-like expression.
if ($node instanceof Node\Expr\CallLike && $result instanceof Node\Expr\CallLike) {
return $this->createBcCallOnCallLike($node, $result, $configuration->getIntroducedVersion());
}
CallLike is a one of the following type of calls:

PhpParser\Node\Expr\FuncCall::class
PhpParser\Node\Expr\MethodCall::class
PhpParser\Node\Expr\New_::class
PhpParser\Node\Expr\NullsafeMethodCall::class
PhpParser\Node\Expr\StaticCall::class

Future optimization with SkipVoters

In the future we might want to add a SkipVoterInterface so we can determine that a rule does not apply earlier in the process. BUT this means if old cold is introduced into a project at a later time, that will not be removed. So not sure we even want that.

Rector to remove BC code paths

DrupalRector\Rector\Deprecation\RemoveDeprecationHelperRector: This rector will remove all BC calls using DeprecationHelper from the code if the Drupal version used is higher than the version check in the code. For now it is only ran in a UnitTest, but as we get closed to Drupal 11, we might want to enable this.

✨ Feature request
Status

Fixed

Component

Code

Created by

🇺🇸United States mglaman WI, USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024