[1.1.x] API Orchestrator

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.

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.

A specific point may just be an example and may apply in other places.

1. FILE: api_orchestrator.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.

2. FILE: composer.json

There is no need to add the required Drupal version, since that is already added by the Drupal.org Composer façade.

3. FILE: src/Controller/DashboardController.php

  /**
   * The Api Orchestrator service.
   */
  protected ApiOrchestratorService $apiGatewayService;

  /**
   * Constructs a DashboardController object.
   */
  public function __construct(ApiOrchestratorService $apiGatewayService) {
    $this->apiGatewayService = $apiGatewayService;
  }

FILE: src/Controller/PublicApiController.php

  /**
   * Database connection.
   */
  protected Connection $database;

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

  /**
   * Flood service for rate limiting.
   */
  protected FloodInterface $flood;

  /**
   * Constructor.
   */
  public function __construct(
    Connection $database,
    ConfigFactoryInterface $config_factory,
    FloodInterface $flood,
  ) {
    $this->database = $database;
    $this->configFactory = $config_factory;
    $this->flood = $flood;
  }

FILE: src/Controller/RequestController.php

  /**
   * The Api Orchestrator service.
   */
  protected ApiOrchestratorService $apiGatewayService;

  /**
   * Constructs a RequestController object.
   */
  public function __construct(ApiOrchestratorService $apiGatewayService) {
    $this->apiGatewayService = $apiGatewayService;
  }

FILE: src/Controller/RequestViewController.php

  /**
   * The Api Orchestrator service.
   */
  protected ApiOrchestratorService $apiGatewayService;

  /**
   * Constructs a RequestViewController object.
   */
  public function __construct(ApiOrchestratorService $apiGatewayService) {
    $this->apiGatewayService = $apiGatewayService;
  }

FILE: src/Controller/ResponseDownloadController.php

  /**
   * The file system service.
   */
  protected FileSystemInterface $fileSystem;

  /**
   * Constructs a ResponseDownloadController object.
   */
  public function __construct(FileSystemInterface $fileSystem) {
    $this->fileSystem = $fileSystem;
  }

FILE: src/Form/ApiEndpointForm.php

  /**
   * The Api Orchestrator service.
   */
  protected ApiOrchestratorServiceInterface $apiOrchestratorService;

  /**
   * Constructs a new ApiEndpointForm.
   *
   * @param \Drupal\api_orchestrator\Service\ApiOrchestratorServiceInterface $api_orchestrator_service
   *   The Api Orchestrator service.
   */
  public function __construct(
    ApiOrchestratorServiceInterface $api_orchestrator_service,
  ) {
    $this->apiOrchestratorService = $api_orchestrator_service;
  }

New modules, which are compatible with Drupal 10 and higher versions are expected to include type declarations in property definitions, and use constructor property promotion.

4. FILE: src/Entity/ApiEndpoint.php, src/Entity/ApiRequest.php, src/Entity/ApiService.php, src/Plugin/QueueWorker/ApiRequestQueueWorker.php

Projects that are compatible with Drupal 10 or higher versions should use attributes instead of annotations.

5. FILE: src/Form/ApiOrchestratorSettingsForm.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.

Releases should not be created after each review done here.

It is better not to create new releases during these applications, since a review could ask for a change that is not backward compatible with the existing releases. Just using a development version avoids those BC issues.

I updated the wrong branch name in the title in Comment #4. Fixing it now.

FILE: api_orchestrator.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).

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.

I am changing priority as per Issue priorities.

Just to make clear the point about not duplicating the Drupal core requirements in the composer.json file: Applicants should know that the Drupal.org Composer façade adds the Drupal core requirements for the project when the composer.json file does not contain them. Not repeating them avoids any issue caused by the composer.json file having different Drupal core requirements than the ones contained in the .info.yml file.

I cannot think of any workflow where Composer is not used, given that Composer is required by Drupal core to gather the dependencies it needs. Therefore, I cannot think of any case where the Drupal.org Composer façade is not involved when site builders are requiring the modules necessary for their sites.

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:

• Dries' post on Responsible maintainers
• Maintainership
• Git version control system
• Issue procedures and etiquette
• Maintaining and responding to issues for a project
• Release naming conventions.

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.