[1.0.x] Open AI Metadata

Thank you for applying! Reviewers will review the project files, describing what needs to be changed.

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.

To reviewers: Please read How to review security advisory coverage applications, What to cover in an application review, and Drupal.org security advisory coverage application workflow.

While this application is open, only the user who opened the application can make commits to the project used for the application.

Reviewers only describe what needs to be changed; they don't provide patches to fix what reported in a review.

Fix PHPCS Issue.

vendor/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,php  web/modules/open_ai_metadata/

FILE: /web/modules/open_ai_metadata/src/Form/MetadataConfigForm.php
--------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 5 WARNINGS AFFECTING 6 LINES
--------------------------------------------------------------------------------------------------
   1 | ERROR   | [x] End of line character is invalid; expected "\n" but found "\r\n"
  33 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
  88 | WARNING | [ ] Unused variable $api_model.
 111 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
 112 | WARNING | [ ] Unused variable $values.
 120 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
--------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------


FILE: /web/modules/open_ai_metadata/src/Form/MetadataSettingsForm.php
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 6 WARNINGS AFFECTING 7 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
  1 | ERROR   | [x] End of line character is invalid; expected "\n" but found "\r\n"
 34 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
 43 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 46 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
 55 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 74 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
 77 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
---------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------------


FILE: /web/modules/open_ai_metadata/open_ai_metadata.module
-----------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------
 1 | ERROR | [x] End of line character is invalid; expected "\n" but found "\r\n"
-----------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY

• 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 doesn't correctly use the Drupal API; the single points aren't ordered, not even by importance

src/Form/MetadataConfigForm.php

/**
 * Function to create the Metadata Config Form.
 */
class MetadataConfigForm extends ConfigFormBase {

That is the documentation comment for a class, not a function. There is no need to start the comment with Function to nor Class to.

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

The state service is used to store temporary information that is not human-edited, as Information types says. Human-edited information is stored in a configuration object; that is why the ConfigFormBase class has the config() method.

$this->messenger()->addMessage('Configurations saved successfully');

The first argument passed to MessengerInterface::addError(), MessengerInterface::addMessage(), MessengerInterface::addStatus(), and MessengerInterface::addWarning() must be a translatable string.
That message is not necessary, though, since the parent method already shows a message; it just needs to be called.

open_ai_metadata.module

$node = \Drupal::routeMatch()->getParameter('node');

The node object is already available in $variables['node'].

/**
 * Function to generate metadata from Open AI.
 */
function open_ai_metadata_generate_metadata(array &$form, FormStateInterface $form_state) {

The short description for an AJAX callback is similar to the one used for _update_ckeditor5_html_filter(). (The longer description is optional, as for hooks.)

/**
 * AJAX callback handler for filter_format_form().
 *
 * Used instead of editor_form_filter_admin_form_ajax from the editor module.
 */

Thank you for your contribution! I am going to update your account.

These 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 more contributors chatting on the Slack #contribute channel. So, come hang out and stay involved.
Thank you, 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.

I thank all the reviewers.