[1.2.x] Node Swapper

Thank you for applying!

Please read Review process for security advisory coverage: What to expect for more details and Security advisory coverage application checklist to understand what reviewers look for. Tips for ensuring a smooth review gives some hints for a smoother review.

The important notes are the following.

• If you have not done it yet, enable GitLab CI for the project, and fix what reported from the phpcs job. This help to fix most of what reviewers would report.
• For the time this application is open, only your commits are allowed. No other people, including other maintainers/co-maintainers can make commits.
• The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application.
• Nobody else will get the permission to opt projects into security advisory policy. If there are other maintainers/co-maintainers who will to get that permission, they need to apply with a different module.
• We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

To the reviewers

Please read How to review security advisory coverage applications, Application workflow, What to cover in an application review, and Tools to use for reviews.

The important notes are the following.

• It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
• Reviewers should show the output of a CLI tool only once per application. The configuration used for these tools needs to be the same configuration used by GitLab CI, stored in the GitLab Templates repository.
• It may be best to have the applicant fix things before further review.

For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues.

1. FILE: README.md

The README file is missing the required sections - Installation and Configuration.

2. FILE: node_swapper.info.yml

version: '8.x-1.2.0'
project: 'node_swapper'

Remove "project" and "version" from the info file, it will be added by drupal.org packaging automatically.

The module is missing the composer.json file.

Use dependency injection for loading Path Aliases and Nodes

FILE: /var/www/html/web/modules/custom/node_swapper/src/Service/NodeSwapperService.php
------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
------------------------------------------------------------------------------------------------------
  90 | WARNING | PathAlias::load calls should be avoided in classes, use dependency injection instead
  97 | WARNING | PathAlias::load calls should be avoided in classes, use dependency injection instead
 124 | WARNING | Node::load calls should be avoided in classes, use dependency injection instead
 125 | WARNING | Node::load calls should be avoided in classes, use dependency injection instead
------------------------------------------------------------------------------------------------------

And actually, you should use ParamConverter in routing file to get node objects directly instead of loading them in the buildForm method. You can get inspired from other node route definitions.

In src/Form/NodeSwapperConfirmForm.php line 88, the param type for $entity_type_manager should be \Drupal\Core\Entity\EntityTypeManagerInterface, though the __construct() method does not require any function description anymore, so unless you want to keep it, the whole description block can be removed.

$src_node->title->value should be $src_node->label(), same for destination node.

And just noticed that your default branch is main. That should not be the case, it should probably be 1.2.x for your latest tag release.
See https://www.drupal.org/docs/develop/git/git-for-drupal-project-maintaine...

Thanks! 👍 Changes look good to me, except for the inheritdoc comment on NodeSwapperConfirmForm constructor. It should be completely removed or defined, not inherited (this is super minor).

And I also noticed that the config schema defines the old_node_unpublish as boolean, but the default value from the config install folder is set to integer. It should match the defined type.

Changing the status because of the schema issue.

Question: now that the main branch is 1.2.x, should I update this issue's description to include that information?

You didn't have the main branch mentioned in the description, so that's up to you. What's important is that the default gitlab branch is set to 1.2.x as expected.

Looks good to me!
Let's wait for others / Project Moderator to take a look.

• The following points are just a start and don't necessarily encompass all of the changes that may be necessary
• A specific point may just be an example and may apply in other places
• A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
• The single review points are not ordered, not even by importance

src/Form/NodeSwapperConfirmForm.php

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

A parent class already defines that property, which does not need to be re-declared.

  public function __construct(
    ConfigFactoryInterface $config_factory,
    RequestStack $request_stack,
    Connection $connection,
    AliasManagerInterface $alias_manager,
    TimeInterface $time,
    EntityTypeManagerInterface $entity_type_manager,
    NodeSwapperService $node_swapper_service,
    NodeInterface $src,
    NodeInterface $dest,
  ) {
    $this->configFactory = $config_factory;
    $this->requestStack = $request_stack;
    $this->database = $connection;
    $this->aliasManager = $alias_manager;
    $this->time = $time;
    $this->entityTypeManager = $entity_type_manager;
    $this->nodeSwapperService = $node_swapper_service;
    $this->src = $src;
    $this->dest = $dest;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('config.factory'),
      $container->get('request_stack'),
      $container->get('database'),
      $container->get('path_alias.manager'),
      $container->get('datetime.time'),
      $container->get('entity_type.manager'),
      $container->get('node_swapper.service'),
      $container->get('current_route_match')->getParameter('src'),s
      $container->get('current_route_match')->getParameter('dest'),
    );
  }

create() should also call $this->setMessenger() with the messenger service retrieved from the container.

    $message = '';
    $message .= "<p>This will point all alises and redirects of \"{$src_node->label()}\" to \"{$dest_node->label()}\".</p>";
    $message .= "<p>In addition, <b>ALL</b> aliases of \"New Node\" will be deleted. Redirects will not be deleted.</p>";

$message needs to be a translatable string.

Let's see if other reviewers report other changes.

src/Form/NodeSwapperConfirmForm.php

  public function __construct(
    ConfigFactoryInterface $config_factory,
    RequestStack $request_stack,
    Connection $connection,
    AliasManagerInterface $alias_manager,
    TimeInterface $time,
    EntityTypeManagerInterface $entity_type_manager,
    NodeSwapperService $node_swapper_service,
    NodeInterface $src,
    NodeInterface $dest,
    MessengerInterface $messenger,
  ) {
    $this->configFactory = $config_factory;
    $this->requestStack = $request_stack;
    $this->database = $connection;
    $this->aliasManager = $alias_manager;
    $this->time = $time;
    $this->entityTypeManager = $entity_type_manager;
    $this->nodeSwapperService = $node_swapper_service;
    $this->src = $src;
    $this->dest = $dest;
    $this->setMessenger($messenger);
  }

Starting with Drupal 10.2, the parent class requires also the $typedConfigManager parameter, which also means the project cannot be compatible with all the Drupal 10 releases and Drupal 11. It needs to at least require Drupal 10.2, and pass the required parameter to the parent class's constructor.

src/Form/NodeSwapperForm.php

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

The parent class already defines that property. It also define a method to set it.

src/Form/NodeSwapperSettingsForm.php

    $form['old_node_suffix'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Old Node Suffix'),
      '#description' => $this->t('The default alphanumeric ending to append on old URLs. Ex: /my-url-[SUFFIX]. Users can override this setting on a case-by-case basis.'),
      '#required' => TRUE,
      '#default_value' => $this->config('node_swapper.settings')->get('old_node_suffix'),
      '#pattern' => '[a-z0-9-_]+',
    ];

With Drupal 10 and Drupal 11, there is no longer need to use #default_value for each form element, when the parent class is ConfigFormBase: It is sufficient to use #config_target, as in the following code.

    $form['image_toolkit'] = [
      '#type' => 'radios',
      '#title' => $this->t('Select an image processing toolkit'),
      '#config_target' => 'system.image:toolkit',
      '#options' => [],
    ];

Using that code, it is no longer needed to save the configuration values in the form submission handler: The parent class will take care of that.

I apologize: When I added two sentences, I added them in the wrong place and accidently removed the existing sentences. The correct comment was supposed to be the following one.

src/Form/NodeSwapperConfirmForm.php

  public function __construct(
    ConfigFactoryInterface $config_factory,
    RequestStack $request_stack,
    Connection $connection,
    AliasManagerInterface $alias_manager,
    TimeInterface $time,
    EntityTypeManagerInterface $entity_type_manager,
    NodeSwapperService $node_swapper_service,
    NodeInterface $src,
    NodeInterface $dest,
    MessengerInterface $messenger,
  ) {
    $this->configFactory = $config_factory;
    $this->requestStack = $request_stack;
    $this->database = $connection;
    $this->aliasManager = $alias_manager;
    $this->time = $time;
    $this->entityTypeManager = $entity_type_manager;
    $this->nodeSwapperService = $node_swapper_service;
    $this->src = $src;
    $this->dest = $dest;
    $this->setMessenger($messenger);
  }

Some of those properties are already defined from a parent class; they do not need to be defined again. The parent class also defines methods to set those properties; those methods should be used in the constructor.

• $configFactory: setConfigFactory()
• $requestStack: setRequestStack()

The documentation for ConfirmFormBase also lists the methods to get the value of those properties.

src/Form/NodeSwapperForm.php

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

The parent class already defines that property. It also define a method to set it.

src/Form/NodeSwapperSettingsForm.php

Starting with Drupal 10.2, the parent class requires also the $typedConfigManager parameter, which also means the project cannot be compatible with all the Drupal 10 releases and Drupal 11. It needs to at least require Drupal 10.2, and pass the required parameter to the parent class's constructor.

With Drupal 10 and Drupal 11, there is no longer need to use #default_value for each form element, when the parent class is ConfigFormBase: It is sufficient to use #config_target, as in the following code.

    $form['image_toolkit'] = [
      '#type' => 'radios',
      '#title' => $this->t('Select an image processing toolkit'),
      '#config_target' => 'system.image:toolkit',
      '#options' => [],
    ];

Using that code, it is no longer needed to save the configuration values in the form submission handler: The parent class will take care of that.

Yes, the form submission handler is no longer necessary, since the parent class implements it and saves the configuration values basing on the values used for #config_target.

Furthermore, in addition to what reported for the src/Form/NodeSwapperForm.php file, the following code needs to use configFactory().

    $config = $this->configFactory->get('node_swapper.settings');

    $form['unpublish'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Unpublish Old Node'),
      '#description' => $this->t('If checked, the old node will be unpublished'),
      '#default_value' => $config->get('old_node_unpublish'),
    ];

I am changing priority as per Issue priorities.

This thread has been idle, in the needs work state with no activity for some months.

May you confirm you are still pursuing this application? If this is the case, and you made commits basing on what previously reported, or you can answer the questions previously asked, please change the status to Needs review.

I am changing priority as per Issue priorities.

src/Form/NodeSwapperConfirmForm.php

Code compatible with latest Drupal releases should use property promotion.

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('database'),
      $container->get('path_alias.manager'),
      $container->get('datetime.time'),
      $container->get('entity_type.manager'),
      $container->get('node_swapper.service'),
      $container->get('current_route_match')->getParameter('src'),
      $container->get('current_route_match')->getParameter('dest'),
      $container->get('messenger'),
    );
  }

  /**
   * ID of the item to swap from.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $src;

  /**
   * ID of the item to swap to.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $dest;

Properties are expected to be defined before any method.

src/Form/NodeSwapperConfirmForm.php

  public function __construct(
    Connection $connection,
    AliasManagerInterface $alias_manager,
    TimeInterface $time,
    EntityTypeManagerInterface $entity_type_manager,
    NodeSwapperService $node_swapper_service,
    NodeInterface $src,
    NodeInterface $dest,
    MessengerInterface $messenger,
  ) {
    $this->database = $connection;
    $this->aliasManager = $alias_manager;
    $this->time = $time;
    $this->entityTypeManager = $entity_type_manager;
    $this->nodeSwapperService = $node_swapper_service;
    $this->src = $src;
    $this->dest = $dest;
    $this->setMessenger($messenger);
  }

Code compatible with latest Drupal releases should use property promotion.

The constructor should call ::setConfigFactory(), in the same way it calls ::setMessenger(). It should also initialize ::$requestStack for which, unfortunately, the base class does not provide a method.

node_swapper.services.yml

Services can be autowired starting with Drupal 9.3.x. This means that it is no longer necessary to give a list of service arguments in the .services.yml file; they will be retrieved from the constructor definition.

I am changing priority as per Issue priorities.