[1.x] Sender.net Integration

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, you should run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
• For the time this application is open, only your commits are allowed.
• 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 and no other user will be able to opt projects into security advisory policy.
• 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.
• 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. master is a wrong name for a branch, which needs to be deleted. Release branch names always end with the literal .x as described in Release branches.

2. Fix phpcs issue.

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml sender_net/

FILE: sender_net/src/SenderNetApi.php                                                                 
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE                                                                                                        
--------------------------------------------------------------------------------
 246 | ERROR | The array declaration extends to column 91 (the limit is 80). The array content should be split up over multiple lines 
--------------------------------------------------------------------------------

3. FILE: src/Plugin/Block/SubscriptionBlock.php

  /**
   * Load services.
   *
   * @param array $configuration
   *   The configuration.
   * @param string $plugin_id
   *   The plugin id.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Form\FormBuilderInterface $formBuilder
   *   The form builder.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, FormBuilderInterface $formBuilder) {

The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

Rest looks fine to me.

Let’s wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.

• 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 doesn't follow the coding standards, contains possible security issue, or does not correctly use the Drupal API; the single points are not ordered, not even by importance

src/Form/SubscriptionForm.php

     $msg = $this->t("Subscriber with email '@email' already exists.", ['@email' => $email]);

      // Subscriber already exists.
      $this->logger->warning($msg);
      $this->messenger()->addError($msg);

The first argument of warning() and similar logger methods is a literal string.

    // Check if subscriber already exists.
    $existingSubscriber = $this->senderApi->getSubscriberByEmail($email);
    if ($existingSubscriber) {
      $msg = $this->t("Subscriber with email '@email' already exists.", ['@email' => $email]);

      // Subscriber already exists.
      $this->logger->warning($msg);
      $this->messenger()->addError($msg);
    }

Validating the entered values is a task for validateForm().

  /**
   * Configuration manager.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

  /**
   * Logger channel factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $logger;

Since the parent class is FormBase, those properties are not necessary. Instead, the class should use the methods to set the logger factory and the config factory, or to retrieve a logger and a configuration object.

src/Form/SettingsForm.php

**
 * Configure sender.net settings.
 */
class SettingsForm extends ConfigFormBase implements ContainerInjectionInterface {

ContainerInjectionInterface is already implemented by ConfigFormBase; there is no need to re-implement it.

    $form['api_access_tokens'] = [
      '#type' => 'textarea',
      '#title' => $this->t('Enter your API access token'),
      '#default_value' => $apiKey,
      '#description' => $this->t('Get API access tokens from sender.net <a href="https://app.sender.net/settings/tokens" target="_blank">account</a>.'),
      '#required' => TRUE,
    ];

    $form['api_base_url'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Base URL'),
      '#default_value' => 'https://api.sender.net/v2/',
      '#description' => $this->t('Get Base URL from sender.net <a href="https://api.sender.net/#introduction" target="_blank">docs</a>.'),
      '#required' => TRUE,
    ];

URLs should be added to translatable strings via placeholders. Translators are not expected to change the used URL when translating strings.

      catch (\Exception $e) {
        $this->messenger->addError($this->t('Unable to load groups. Please check your API access token and try again.'));
        $this->logger->error('Error loading groups: @error', ['@error' => $e->getMessage()]);
      }

To log exceptions, there is watchdog_exception() or the class method described in that documentation page.

I am changing priority as per Issue priorities.

This thread has been idle, in the Needs work state with no activity for several months. Therefore, I am assuming that you are no longer pursuing this application, and I marked it as Closed (won't fix).

If this is incorrect, and you are still pursuing this application, then please feel free to re-open it and set the issue status to Needs work or Needs review, depending on the current status of your code.

1. FILE: templates/block--subscription.html.twig

Twig code needs to be correctly indented. Drupal uses two spaces for indentation, not four spaces or tabs.

2. FILE: sender_net.module

/**
 * @file
 * Sender.net module implementation.
 */

The usual description for a .module file is Hook implementations for the [module name] module. where [module name] is the module name given in the .info.yml file.

Rest looks fine to me.

Let’s wait for other reviewers to take a look.

src/Form/SettingsForm.php

    $form['api_access_tokens'] = [
      '#type' => 'textarea',
      '#title' => $this->t('Enter your API access token'),
      '#default_value' => $apiKey,
      '#description' => $this->t('Get API access tokens from sender.net <a href="@url" target="_blank">account</a>.', ['@url' => 'https://app.sender.net/settings/tokens']),
      '#required' => TRUE,
    ];

The correct placeholder for URL starts with :. It must also be wrapped on double quotation marks, as reported on FormattableMarkup::placeholderFormat().

:variable: Return value is escaped with \Drupal\Component\Utility\Html::escape() and filtered for dangerous protocols using UrlHelper::stripDangerousProtocols(). Use this when using the "href" attribute, ensuring the attribute value is always wrapped in quotes

      catch (\Exception $e) {
        watchdog_exception('sender_net', $e);
        $this->messenger->addError($this->t('Unable to load groups. Please check your API access token and try again.'));
      }

Since the module can be installed on Drupal 11 too, it cannot use watchdog_exception(), which does not exist in Drupal 11. The following code needs to replace the line calling watchdog_exception('sender_net', $e).

\Drupal::logger('sender_net')->log(RfcLogLevel::ERROR, '%type: @message in %function (line %line of %file).', Error::decodeException($e));

Instead of \Drupal::logger(), an injected service should be used.

src/Form/SubscriptionForm.php

Is there any reason to use a separate class for the plugin form?

src/SenderNetApi.php

      watchdog_exception('sender_net', $th);
      $this->logger->error('API request failed: @message', ['@message' => $th->getMessage()]);

Only one of those lines is necessary, since both lines log an error message. See also my previous note on watchdog_exception().

manual review:

1. SettingsForm: Drupal\Component\Utility\Error does not exist, did you mean Drupal\Core\Utility\Error?
2. SenderNetApi: $entity_type_manager is unused, should it be removed?
3. SenderNetApi: $logger class variable docs are wrong, this is not the channel but the logger itself?

But otherwise looks good to me.

Thanks for your contribution, Vinay!

I updated your account so you can opt into security advisory coverage now.

Here are some recommended readings to help with excellent maintainership:

• Dries' post on Responsible maintainers
• Best practices for creating and maintaining projects
• Maintaining a drupal.org project with Git
• Commit messages - providing history and credit
• Release naming conventions.
• Helping maintainers in the issue queues

You can find lots more contributors chatting on Slack or IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thanks to the dedicated reviewer(s) as well.