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

Merged
merged 90 commits into from
Sep 23, 2024
Merged

Protect: Add WAF StatCards #35739

merged 90 commits into from
Sep 23, 2024

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 new jetpack_waf_blocklog_daily_summary, and jetpack_waf_all_time_stats options
  • 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, and jetpack_waf_all_time_stats 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 jetpack-waf/waf-blocklog entries or jetpack_waf_blocklog_daily_summary, and jetpack_waf_all_time_stats option updates are made when share data is disabled (note that wp_jetpack_waf_blocklog table entries will continue as well)
  • 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.


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 October 1, 2024 (scheduled code freeze on September 30, 2024).

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


Protect plugin:

  • Next scheduled release: none scheduled.

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
@dkmyta dkmyta removed [Package] Identity Crisis This package no longer exists in the monorepo. It was merged into [Package] Connection. [Plugin] Wpcomsh labels Aug 27, 2024
@dkmyta dkmyta marked this pull request as ready for review September 10, 2024 20:48
@nateweller nateweller force-pushed the add/protect-firewall-stat-cards branch 2 times, most recently from fb52e10 to 4235055 Compare September 19, 2024 18:56
@nateweller nateweller force-pushed the add/protect-firewall-stat-cards branch from 4235055 to c27aeac Compare September 19, 2024 19:10
@nateweller nateweller force-pushed the add/protect-firewall-stat-cards branch from 1e6e62e to f573cdd Compare September 19, 2024 19:54
nateweller
nateweller previously approved these changes Sep 19, 2024
Copy link
Contributor

@nateweller nateweller left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@dkmyta dkmyta merged commit 9bc7ce4 into trunk Sep 23, 2024
73 checks passed
@dkmyta dkmyta deleted the add/protect-firewall-stat-cards branch September 23, 2024 20:25
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Add waf stats class blocked requests stats actions, and apply stat card components to firewall header

* Adjust approach for storing and retrieving stats

* changelog

* Fix phpcs enables

* Remove FirewallHeader stories edits

* Use options over an additional table

* Reorg and fix spacing

* Fix dynamic/static calls

* Make update_daily_summary public for tests

* use deprecated setMethods over onlyMethods to bypass PHP 7.0 project test failures

* Fix up project versions

* Disable summary updates if share data is disabled, and add conditions to stat card display

* Remove TODOs

* Improve changelog entries

* Restructuring, improvements, storybook fixes

* Make use of static methods consistent

* Add standalone mode handling for update_daily_summary

* Fix tests

* Add integration tests

* Revert unit test removal

* Fix naming

* Fix project versions

* Fix versions

* Remove IDC package

* Remove duplicate changelog entries

* Revert vscode settings.json changes

* changelog

* Undo wpcomsh plugin updates

* Revert prior changes to wpcomsh

* Fix versions

* Optimize FirewallStatCards

* Fix share data option check

* Fix styling

* Fix translation strings

* Ensure no duplicated code and extra debug data is logged appropriately

* Fix tests

* Fix phan errors

* Use supported phpunit method

* Use supported phpunit method

* Final test fixes

* Remove unused code, add plan check for new stats

* Fix method naming

* Add method for retrieving all time stats

* Make direct db connection persistent, add/fix tests

* Close db connection if initialized

* Add standalone mode direct db handling

* Fix project versions

* Ignore phpcs rules, data needs to be current

* Remove error_log

* Address phan errors

* Use standard approach

* Add update flag to initialization method so we aren't duplicating the action

* Fix initialization method calls

* Manually update phan baselines

* Revert versions updates

* Remove duplicate changelog entries

* Remove FirewallHeader stories from broken dir

* Update stories

* Updates to Blocklog Manager class

* Fix prop name

* Minor enhancements and compatibility improvements

* Statcard adjustments

* Revert phan baselines changes

* Reapply phan baseline changes

* Apply naming consistency, update FirewallSubheading to use IconTooltip

* Fixes

---------

Co-authored-by: Nate Weller <[email protected]>
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] 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. RNA [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants