Add possibility to show comment status in views and to filter on comment status

Not sure if this should be considered for core, but patch applies cleanly to 9.1.x.

Well #2 breaks the current behavior of the comment field. Instead of the list of comments one only gets the comment status in views.

Can't we just add a field formatter as an alternative to CommentDefaultFormatter to show the comment status?

Sorry I just uploaded an incorrect patch.

Tagging for testing.

I reviewed the code and it looks very clean :)

Thank you @harlor, On reviewing the code found the below issue.

diff --git a/modules/comment/src/Plugin/Field/FieldFormatter/CommentStatusFormatter.php b/modules/comment/src/Plugin/Field/FieldFormatter/CommentStatusFormatter.php
...
+++ b/modules/comment/src/Plugin/Field/FieldFormatter/CommentStatusFormatter.php

Patch being applied at incorrect location.
Should be a/core/modules/comment/src/....

Updated the patch to apply at correct path location.

Manually tested the patch, works as expected.

Thanks @joshua1234511 for updating the patch. If someone uploads a patch, then they aren't supposed to RTBC the patch so I'm moving back to needs review so we can get other eyes. I might be able to review today.

To review the code more carefully, I wanted to see how status is handle in views for other things and here's some things I found:

1. core/modules/file/src/Plugin/views/filter/Status.php: class Status extends InOperator
   

     public function getValueOptions() {
       if (!isset($this->valueOptions)) {
         $this->valueOptions = [
           0 => $this->t('Temporary'),
           FileInterface::STATUS_PERMANENT => $this->t('Permanent'),
         ];
       }
       return $this->valueOptions;
     }
   

2. core/modules/media/src/Plugin/views/filter/Status.php: class Status extends FilterPluginBase
3. core/modules/node/src/NodeViewsData.php: class NodeViewsData extends EntityViewsData
   

   public function getViewsData() {
   ...
       $data['node_field_data']['status']['filter']['label'] = $this->t('Published status');
       $data['node_field_data']['status']['filter']['type'] = 'yes-no';
       // Use status = 1 instead of status <> 0 in WHERE statement.
       $data['node_field_data']['status']['filter']['use_equal'] = TRUE;
   ...
   

4. core/modules/node/src/Plugin/views/filter/Status.php: class Status extends FilterPluginBase
5. core/modules/user/src/UserViewsData.php: class UserViewsData extends EntityViewsData
   

   public function getViewsData() {
   ...
       $data['users_field_data']['status']['filter']['label'] = $this->t('Active');
       $data['users_field_data']['status']['filter']['type'] = 'yes-no';
   ...
   

In the comment module currently, there are these filters: NodeComment, StatisticsLastUpdated, and UserUid where NodeComment is currently dealing with status:

/**
 * Filter based on comment node status.
 * 
 * @ingroup views_filter_handlers
 * 
 * @ViewsFilter("node_comment")
 */
class NodeComment extends InOperator {
  
  public function getValueOptions() {
    $this->valueOptions = [
      CommentItemInterface::HIDDEN => $this->t('Hidden'),
      CommentItemInterface::CLOSED => $this->t('Closed'), 
      CommentItemInterface::OPEN => $this->t('Open'),
    ];
    return $this->valueOptions;
  }   
    
}

The patch adds a FieldFormatter (CommentStatusFormatter). I don't see a similar pattern for the File, Media, or Node entities, so I'm not clear this approach would be accepted into core.

@joshua1234511 Would you please update the issue summary with steps to test this?

I updated the issue summary with testing instructions.

@mpolishchuck thinking of the use case, the patch provided adds a new field formatter, that only displays the status and not all details. As far as views are concerned a status field can be easily added to views and the filters can be obtained. the default views show only enabled comments and un approved comments are shown in another tab view.
as the status will be available only for admin, don't see its use for regular users.
and comments are already filters in
.../admin/content/comment
.../admin/content/comment/approval

Thanks for the clarification @joshua1234511. Since the title and issue summary mentions views, I assumed that the patch would be updating the views filter or field.

Tagging for updating the issue summary to clarify what this new feature really should be.

Moved the testing steps higher up on issue summary so they are easier to find.

I have applied Patch #14, it was successfully applied and working fine.

Successfully applied the patch #14.

Testing Steps followed:
1. Applied the patch
2. Cleared cache
3. Go to /admin/structure/types/manage/article/display
4. Ensure the Comment field options -> Select "comment status" -> Save
5. Now, create content of type Article (for checking the comment status) by visiting /node/add/article
6. Fill up mandatory fields -> Save
7. Observe the error message
8. Go to the Recent log messages and check the error

Expected Result:
Selecting and saving the settings should show the comment status for each comment

Actual Result:
Comment status is available in the manage field
But, to check the comment status on comments when trying to create a node, it's giving the 500 error message as shown in the attached video and in the screenshots

Hence, moving to needs work.

+1 RTBC for #14 on Drupal 9.5.x. Previously reported errors appear to be related to using the new Olivero theme. Not this patch.

Was tagged in issue summary in #20 which still needs to happen.

I submitted a MR that restores the Views integration from patch #2 on top of current main, and keeps the formatter from patch #14.

The MR now includes an update path. Saved views with a numeric filter on a comment status column are converted to the node_comment filter. Views config saved later with an old numeric filter, such as an imported pre-update export or module-provided config, is converted on save and triggers a deprecation.

Range operators ("<", "<=", ">", ">=", "between", "not between") are converted to an "in" list, because the node_comment filter ignores numeric operators and returns every row.

Generated with the help of an LLM.

Updated summary per #20

The Needs Review Queue Bot tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

cspell was failing on French words in the tests. The cspell tests are passing now. Ready for review.

Kicking back purely because the summary appears to be copy/paste from AI, please see https://www.drupal.org/docs/develop/issues/issue-procedures-and-etiquett... summaries need to be own words.

@Smustgrave Thank you for reviewing the issue. I did condense the verbose output from the AI in my summary re-write. I have further edited the summary. Please let me know if I need to may any other changes.

Thanks!