WPcom: adjust filter for comment counts used in Calypso

[villanovachile]

Currently certain comment types, comment, pingback, and trackback are whitelisted for being displayed in the comments list. Comment counts, on the other hand are calculated by excluding the comment types order_note, webhook_delivery, review, action_log.

This is done using the jetpack_api_exclude_comment_types_count filter, and does not take into account other comment types that may be used by third-party plugins. As a result, there can be a discrepancy between the comments listed, and the comment count that are displayed.

After discussing this further with @samiff we decided that it may be best to deprecate jetpack_api_exclude_comment_types_count, and instead introduce jetpack_api_include_comment_types_count, which will bring parity to the comment types displayed, and the comment types counted, defaulting to including comment, pingback, and trackback comment types.

Fixes #63872

Changes proposed in this Pull Request:

• deprecate jetpack_api_exclude_comment_types_count and introduce jetpack_api_include_comment_types_count
• The database is now queried for comment_types WHERE comment_type IN matching those specified in the array

Does this pull request change what data or activity we track or use?

No

Testing instructions:

• Create several comments on a post/page
• Go to the wp_comments table, and edit the comment_type to something other than comment, pingback, trackback
• Go to https://wordpress.com/comments/{domain}
• The comment counts should match the number of comments actually listed

[matticbot]

Caution: This PR has changes that must be merged to WordPress.com
Hello villanovachile! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer and confirm D81537-code works as expected before merging this PR. Once this PR is merged, please commit the changes to WP.com. Thank you!
This revision will be updated with each commit to this PR

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ⚠️ All commits were linted before commit.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

---

Jetpack plugin:

• Next scheduled release: July 5, 2022.
• Scheduled code freeze: June 28, 2022.

[samiff]

Looking good, just have a couple thoughts. On the wpcom side, there may need some tests that need to be updated as well, but we can look at that when the time comes.

[villanovachile]

Thanks, Sami! I've gone ahead and committed the suggestions.

[samiff]

Looking good, just a few tiny suggestions 👍

[samiff]

I'm a bit confused on the failing TC tests for the wpcom diff. We are touching the /sites/%s/comment-counts endpoint but I'm seeing failures for the /comments endpoint in a couple TC tests 🤔 I'll have another look at this Monday.

[jeherve]

Suggested change

	$exclude = apply_filters_deprecated( 'jetpack_api_exclude_comment_types_count', array( 'order_note', 'webhook_delivery', 'review', 'action_log' ), 'jetpack-11.0', 'jetpack_api_include_comment_types_count' ); // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	$exclude = apply_filters_deprecated( 'jetpack_api_exclude_comment_types_count', array( 'order_note', 'webhook_delivery', 'review', 'action_log' ), 'jetpack-$$next-version$$', 'jetpack_api_include_comment_types_count' ); // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable

[samiff]

@anomiex Should the replace-next-version-tag script be catching this already, or would it need to be adjusted?

[plugins/jetpack 4:17.704] === Updating $$next-version$$ ===
[plugins/jetpack 4:17.704] 
[plugins/jetpack 4:19.232] Processing projects/plugins/jetpack/class.json-api.php
[plugins/jetpack 4:19.243] ::error file=projects/plugins/jetpack/class.json-api.php,line=1032::Unexpected `$$next-version$$` token.

[jeherve]

Oh, I expected the script to catch this indeed, my bad.
52f4c59

[anomiex]

It probably should, but currently doesn't. It only handles _deprecated_function, _deprecated_constructor, _deprecated_file, _deprecated_argument, and _deprecated_hook.

Handling apply_filters_deprecated may not be entirely straightforward, since it seems likely enough that phpcs might wind up wrapping that onto multiple lines. Maybe it's time to just replace $$next-version$$ everywhere and hope that never manages to collide with anything unexpected.

[jeherve]

This works well for me now, I think it should be good to go. 🚢

Changes have been addressed

[github-actions]

Great news! One last step: head over to your WordPress.com diff, D81537-code, and deploy it.
Once you've done so, come back to this PR and add a comment with your changeset ID.

Thank you!

[samiff]

r246959-wpcom