Project description

Paragraphs Usage Manager provides administration interfaces to manage where paragraph types are allowed across paragraph reference fields.

The module adds a global permissions-like matrix where rows represent compatible parent entity fields and columns represent paragraph types. It also provides a per-paragraph-type usage page to manage where a specific paragraph type can be used.

The goal is to make paragraph type availability easier to manage on projects with many entity types, bundles, and paragraph reference fields, without having to edit each field configuration manually.

Why this project is useful

On larger Drupal projects using Paragraphs, enabling a new paragraph type across many content types, custom entity bundles, and paragraph reference fields can require many repetitive field configuration changes.

This module centralizes that workflow and provides a safer, more readable administration UI for site builders and maintainers.

Security advisory coverage request

I am requesting permission to opt my projects into Drupal security advisory coverage.

The project is a full Drupal.org module project. It contains PHP services, forms, routing, permissions, configuration schema, update hooks, JavaScript/CSS assets, and automated kernel test coverage.

The project is compatible with supported Drupal versions and is licensed as GPL-2.0-or-later.

Additional notes

I understand that this application is for granting my Drupal.org account the permission to opt projects into security advisory coverage, and that once approved I will be able to opt this and future projects into coverage.

The project has stable releases available and the code used for this application has been committed to the main project repository, not only to an issue fork.

Project link

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

Branch used for review: 1.1.x / main

Comments

nono95230 created an issue. See original summary.

vishal.kadam’s picture

Issue summary: View changes
avpaderno’s picture

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

Status: Needs review » Needs work

1. main is acceptable as a branch name, but it is not yet fully supported on drupal.org.

With contributed projects, it is still not possible to create an issue for the main branch. For projects used in these applications, for which it is still suggested to work with release-specific branches, it should be better to avoid using a branch with that name.

2. FILE: paragraphs_usage_manager.libraries.yml

version: VERSION

VERSION is only used by Drupal core modules. Contributed modules should use a literal string that does not change with the Drupal core version a site is using.

3. FILE: paragraphs_usage_manager.module

A new module that aims to be compatible with latest Drupal releases is expected to implement hooks as class methods as described in Support for object oriented hook implementations using autowired services.

4. FILE: src/Form/ParagraphSingleTypeUsageSettingsForm.php, src/Form/ParagraphUsageManagerSettingsForm.php, src/Form/ParagraphUsageOverviewSettingsForm.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.