Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Infinite scroll added checks to validate input #39618

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

darssen
Copy link
Contributor

@darssen darssen commented Oct 2, 2024

Fixes Warnings in Infinite scroll Module like:
Undefined array key "query_before"
Undefined array key "query_args"
Undefined array key "last_post_date"
118d8bdb2d4600db50a5c7b306828911-logstash

Proposed changes:

  • Added isset check to validate inputs. Removed phpcs ignores, accordingly.
  • Deprecate the infinite_scroll_posts_where hook

Testing instructions:

Code Review

Edited: For the changes when deprecating the infinite_scroll_posts_where.

  • Please make sure to test Infinite Scroll with a non-block theme and activate Infinite Scroll module.
  • Make sure you have enough posts on the test site. Go to the frontend and scroll to the bottom of the posts so that the code in this PR gets triggered.
  • Ensure we don't get any errors
  • Test with this onebin 35e05-pb/ to check that the filter still works and you should see a Depecrated hook like the following
PHP Deprecated:  Hook infinite_scroll_posts_where is <strong>deprecated</strong> since version $$next-version$$ with no alternative available. in /var/www/html/wp-includes/functions.php on line 6085

@darssen darssen requested a review from a team October 2, 2024 08:10
@darssen darssen self-assigned this Oct 2, 2024
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/infinite-scroll-added-checks-to-validate-input branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/infinite-scroll-added-checks-to-validate-input
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Oct 2, 2024
Copy link
Contributor

github-actions bot commented Oct 2, 2024

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.
  • 🔴 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.


🔴 Action required: We would recommend that you add a section to the PR description to specify whether this PR includes any changes to data or privacy, like so:

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

My PR adds *x* and *y*.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for November 5, 2024 (scheduled code freeze on November 4, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 2, 2024
@@ -779,7 +780,7 @@ public function query_time_filter( $where, $query ) {
* @param string $last_post_date @deprecated Last Post Date timestamp.
*/
$operator = 'ASC' === $_REQUEST['query_args']['order'] ? '>' : '<'; // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- no changes to the site.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this assign makes sense anymore since in line 756 we return early if 'DESC' !== $_REQUEST['query_args']['order']
@jeherve I see you have been working with Infinite Scroll in the past. Is line 756 a bug or should we directly do $operator = '<' ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the $operator and $last_post_date were supposed to be deprecated.

* @param string $operator @deprecated Query operator.
* @param string $last_post_date @deprecated Last Post Date timestamp.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I don't know that this parameter is needed at all anymore. It seems like it would be safe to remove, maybe using apply_filters_deprecated()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I don't know that this parameter is needed at all anymore. It seems like it would be safe to remove, maybe using apply_filters_deprecated()

TBH I don't even like the filter since it is supposed to be something similar to posts_where but it works differently since it adds to the $where and doesn't replace it the way posts_where does.

By checking the official documentation, it looks like we would need to replace it with a new filter ($replacement), but the $args are the same ones for both new and replacement filters which defeats the purpose of removing $operator.

Would something like the below diff work? I have not added a replacement purposefully since the idea is to remove the filter and the fields entirely in a future release.

diff --git a/projects/plugins/jetpack/modules/infinite-scroll/infinity.php b/projects/plugins/jetpack/modules/infinite-scroll/infinity.php
index 52929d303b..f6a2c3f5b0 100644
--- a/projects/plugins/jetpack/modules/infinite-scroll/infinity.php
+++ b/projects/plugins/jetpack/modules/infinite-scroll/infinity.php
@@ -778,9 +778,9 @@ class The_Neverending_Home_Page {
                         * @param string $operator @deprecated Query operator.
                         * @param string $last_post_date @deprecated Last Post Date timestamp.
                         */
-                       $operator       = 'ASC' === $_REQUEST['query_args']['order'] ? '>' : '<'; // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- no changes to the site.
-                       $last_post_date = sanitize_text_field( wp_unslash( $_REQUEST['last_post_date'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- no changes to the site.
-                       $where         .= apply_filters( 'infinite_scroll_posts_where', $clause, $query, $operator, $last_post_date );
+                       $operator       = '<';
+                       $last_post_date = isset( $_REQUEST['last_post_date'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['last_post_date'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no changes to the site
+                       $where         .= apply_filters_deprecated( 'infinite_scroll_posts_where', array( $clause, $query, $operator, $last_post_date ), '$$next-version$$', '' );
                }

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think that would be okay. 🚢

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implemented in 3b49148

Updated the test instructions too

@darssen darssen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Oct 2, 2024
@github-actions github-actions bot added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Infinite Scroll [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants