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

Protect: Add WAF StatCards #35739

Draft
wants to merge 57 commits into
base: trunk
Choose a base branch
from
Draft

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Feb 16, 2024

Description

Proposed changes:

  • Makes the StatCard js-packages component easily accessible
  • Adds Waf_Blocklog_Manager class and migrates related methods over
  • Adds a new set of methods for tracking daily and monthly blocked requests stats via a new jetpack_waf_blocklog_daily_summary option
  • Adds the StatCard components to the FirewallHeader and hooks up the new stats

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

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

  • No

Testing instructions:

  • Check out this branch and start up your Jurassic Tube with Protect installed and active with a scan-level plan
  • Enable the WAF, ensure share data is toggled, configure your settings as desired
  • Register several blocked requests and verify that the stats in the UI are updated accordingly on refresh
  • Modify the $date value in the update_daily_summary() method of the Waf_Blocklog_Manager class to simulate requests from a different day within the same month and from outside of the current month
  • Verify that the jetpack_waf_blocklog_daily_summary option data and stats in the UI reflect the entries and that any data logged outside of the current month is pruned
  • Verify that stats are 0 and disabled when a scan upgrade is removed (paid feature flag is set) and/or share data is disabled
  • Ensure no jetpack-waf/waf-blocklog entries or jetpack_waf_blocklog_daily_summary option updates are made when share data is disabled (note that wp_jetpack_waf_blocklog table entries will continue)
  • Modify the option data to verify display when values are significant
  • Switch between desktop and mobile view to ensure the display is responsive
  • Ensure no regressions are introduced relating to WAF and blocklog operations
  • Run cd projects/js-packages/storybook && npm run storybook:dev and verify that all Protect FirewallHeader stories render
  • Run jetpack test packages/waf php to ensure that all integration tests pass

Screenshots:

Desktop:
Screen Shot 2024-02-22 at 15 07 29

Mobile:
Screen Shot 2024-02-22 at 15 08 15

Copy link
Contributor

github-actions bot commented Feb 16, 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 add/protect-firewall-stat-cards branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/protect-firewall-stat-cards
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/protect-firewall-stat-cards
    

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 [JS Package] Components [Package] WAF [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Status] In Progress [Tests] Includes Tests RNA labels Feb 16, 2024
Copy link
Contributor

github-actions bot commented Feb 16, 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.


Once your PR is ready for review, check one last time that all required checks 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 reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

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

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

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


Protect plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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


Wpcomsh plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Feb 19, 2024
@github-actions github-actions bot added the Docs label Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs E2E Tests [JS Package] Components [Package] Identity Crisis [Package] WAF [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Wpcomsh RNA [Status] In Progress [Tests] Includes Tests
1 participant