The module suppresses Drupal status, warning, and error messages that match configured patterns, filtering them just before the status messages template renders.

Project link

https://www.drupal.org/project/error_squelch

Comments

dinis created an issue. See original summary.

avpaderno’s picture

Assigned: dinis » Unassigned
Issue summary: View changes

Thank you for applying!

Before giving links helpful to understand how the review process works, what to expect from a review, and what to do to avoid a review takes more time than needed, I would like to thank all the reviewers for the work they do.
These applications are volunters-driven, which also means it is not possible to predict when an application will be marked fixed and the applicant will get the permission to opt projects into security advisory policy. While we aim to make an application as quick as possible, it is also important for us that more people review the project used for an application. In this way, we make sure applications do not miss some important points that should be instead reported.
Applications are not meant to be complete debugging sessions that eliminate every existing bug, though. I apologize if sometimes applications seem to go into too-detailed reviews.

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 enable GitLab CI for the project and fix the PHP_CodeSniffer errors/warnings it reports.
  • 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 will not be changed by this application; once this application is closed, you will be able to change the project status from Not covered to Opt into security advisory coverage. This is possible only 14 days after the project is created.

    Keep in mind that once the project is opted into security advisory coverage, only Security Team members may change coverage.
  • Only the person who created the application will get the permission to opt projects into security advisory coverage. No other person will get the same permission from the same application; that applies also to co-maintainers/maintainers of the project used for the application.
  • 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 project moderator before posting the first comment on newly created applications. Project moderators 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.

vishal.kadam’s picture

Title: 1.0 Error Squelch » [1.0.x] Error Squelch
vishal.kadam’s picture

Status: Needs review » Needs work

1. FILE: error_squelch.info.yml

A new project should not declare itself compatible with a Drupal release that is no longer supported. No site should be using Drupal 8 nor Drupal 9, and people should not be encouraged to use those Drupal releases.

2. FILE: error_squelch.module

For a new module that aims to be compatible with Drupal 10 and Drupal 11, I would rather implement hooks as class methods as described in Support for object oriented hook implementations using autowired services.
It would require increasing the minimum Drupal 10 version supported, but Drupal 10.1 is no longer supported.

3. FILE: src/Form/ErrorSquelchSettingsForm.php

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.
For this change, it is necessary to require at least Drupal 10.3, but that is not an issue, since Drupal 10.2.x is no longer supported.

dinis’s picture

Hey @vishal.kadam,

Thanks for the thorough review. Good catch on all three! I've just pushed commit c012ea3 to 1.0.x, addressing everything:

**1. core_version_requirement**
Raised to ^10.3 || ^11 in both error_squelch.info.yml and composer.json. You're right that pinning to 10.3+ lets us use the modern patterns below without compatibility shims.

**2. Object-oriented hook implementation**
Moved hook_preprocess_status_messages() out of error_squelch.module and into src/Hook/ErrorSquelchHooks.php using the #[Hook('preprocess_status_messages')] attribute. The class is registered as a service in error_squelch.services.yml using its FQCN as the service ID, with MessageSquelcher, ConfigFactory, and AccountProxy injected via the constructor. The .module file is now just a @file docblock.

**3. #config_target in the settings form**
Rewrote ErrorSquelchSettingsForm::buildForm() to use #config_target for all four fields. The three booleans use the simple 'error_squelch.settings:key' string form; squelch_patterns uses a ConfigTarget object with fromConfig/toConfig closures to handle the array to newline-delimited string conversion. submitForm() was removed entirely since the parent now handles everything.

Also ran phpcs with Drupal and DrupalPractice standards. Zero errors, zero warnings. GitLab CI is running now.

Thanks again for taking the time to review, I'm a bit rusty with community submissions :)

Cheers,
Danielle

vishal.kadam’s picture

FILE: error_squelch.module

Since the module is declared compatible with Drupal 10.3, removing the function implementing the hook is not possible. The function still needs to be defined, but it calls the method defined by the service class, as described in Support for object oriented hook implementations using autowired services (Backwards-compatible Hook implementation for Drupal versions from 10.1 to 11.0).

vishal.kadam’s picture

Remember to change status, when the project is ready to be reviewed. In this queue, projects are only reviewed when the status is Needs review.

dinis’s picture

Status: Needs work » Needs review

Hi @vishal.kadam,

Thanks for catching that, good eyes :)

While I was in there, I also did a broader polish pass (commit 83943c1):

- README.md still said "Drupal 9, 10, or 11" from earlier drafts; now
correctly says "Drupal 10.3 or later, or Drupal 11" to match info.yml
- Added configure: error_squelch.settings so the Configure link appears
on /admin/modules
- Added _admin_route: TRUE to the settings route
- Migrated Drush commands from src/Commands/ to src/Drush/Commands/ and
dropped drush.services.yml in favour of attribute-based autodiscovery
with a create() method

phpcs clean, Drush commands tested locally, CI running. Flipping status
to Needs review.

Cheers,
Danielle

vishal.kadam’s picture

Rest seems fine to me.

Please wait for other reviewers and Project Moderator to take a look and if everything goes fine, you will get the role.

avpaderno’s picture

Status: Needs review » Reviewed & tested by the community

Thank you for your contribution and for your patience with the review process!

I am going to update your account so you can opt into security advisory coverage any project you create, including the projects you already created.

These are some recommended readings to help you with maintainership:

You can find more contributors chatting on Slack or IRC in #drupal-contribute. So, come hang out and stay involved!
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.

I thank also all the reviewers for helping with these applications.

avpaderno’s picture

Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.