Replace single Node with two new nodes

[mglaman]

We have a deprecated method that is actually replaced with two different method calls. I'm not sure how to return as returning an array from MethodCall_ node throws an error in the traverse:

Rule: https://github.com/palantirnet/drupal-rector/blob/101d36381b953a44eb2c34c6f1f9e6d1530d3209/src/Rector/Deprecation/UiHelperTraitDrupalPostFormRector.php

Code sample example:

            new CodeSample(
                <<<'CODE_BEFORE'
$edit = [];
$edit['action'] = 'action_goto_action';
$this->drupalPostForm('admin/config/system/actions', $edit, 'Create');
CODE_BEFORE
                ,
                <<<'CODE_AFTER'
$edit = [];
$edit['action'] = 'action_goto_action';
$this->drupalGet('admin/config/system/actions');
$this->submitForm($edit, 'Create');
CODE_AFTER
            )
        ]);

With this:

    public function getNodeTypes(): array
    {
        return [
            Node\Expr\MethodCall::class,
        ];
    }

It errors if I return an array and not a single node. Maybe there is a node class I am missing?

[TomasVotruba]

Hi, could you provide full rule?

[mglaman]

Yes, sorry!

https://github.com/palantirnet/drupal-rector/blob/101d36381b953a44eb2c34c6f1f9e6d1530d3209/src/Rector/Deprecation/UiHelperTraitDrupalPostFormRector.php

[TomasVotruba]

I see, thanks!

[mglaman]

I just found https://github.com/rectorphp/rector-laravel/blob/main/src/Rector/MethodCall/ChangeQueryWhereDateValueWithCarbonRector.php!

I need to call addNodeBeforeNode to add a node before the replaced node. Although, it is deprecated, and $nodesToAddCollector is private.

This solved my problem:

            if ($options === null) {
                $this->addNodeBeforeNode(
                    $this->nodeFactory->createLocalMethodCall('drupalGet', [$path]),
                    $node
                );
            } else {
                $this->addNodeBeforeNode(
                    $this->nodeFactory->createLocalMethodCall('drupalGet', [$path, $options]),
                    $node
                );
            }

[TomasVotruba]

That's a different case then. Could you share the rule in a PR I can check out?

[mglaman]

@TomasVotruba the PR is here: palantirnet/drupal-rector#162. There are a lot of changes. Hopefully this links you right to the file: https://github.com/palantirnet/drupal-rector/pull/162/files#diff-9b4f9d938e5e7eefe227001a5d75bd25d2147a2cb4584d0c401ce82b0d988c05

It's replacing this deprecated method: https://git.drupalcode.org/project/drupal/-/blob/9.3.x/core/tests/Drupal/Tests/UiHelperTrait.php#L198

We need to replace calls to drupalPostForm to a drupalGet and submitForm – the helper method which invoked these two commands methods was deprecated for a more explicit execution. That's why I need to insert a node before the main call.

[mglaman]

@TomasVotruba just came back on this a year later to try and fix usages of deprecated addNodeBeforeNode and hitting the same problem for the same rule. It looks like rector-laravel is still using it as well: https://github.com/rectorphp/rector-laravel/search?q=addNodeBeforeNode. Will this be safe to use for a while, or will the laravel package have a good example for the fix?

[TomasVotruba]

In case both nodes are stmts, they should be returned instead. If one of them is expr, there is no other way at the moment than addNodeBeforeNode().

[mglaman]

Thank you!