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

ThreatsDataViews: Add ToggleGroupControl #39901

Merged

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Oct 24, 2024

Description

Adds a toggle control the ThreatsDataViews component header to allow for preset filters (easily toggling between active and historic threats).

Proposed changes:

  • Applies a custom ToggleGroupControl component to the header of the ThreatsDataViews

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:

  • Checkout this branch
  • Load storybook with cd projects/js-packages/storybook && npm run storybook:dev
  • View the Threats Data View component
  • Ensure the ToggleGroupControl header content is positioned and styled according to designs in both Table and List views and that the filter are appropriately applied and unapplied when expected.
  • Review the code and ensure the implementation is correct

Screenshots

Screen Shot on 2024-11-04 at 13-51-59

Copy link
Contributor

github-actions bot commented Oct 24, 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/component/threats-data-view-toggle-group-control-alt 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/component/threats-data-view-toggle-group-control-alt
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/component/threats-data-view-toggle-group-control-alt
    

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

Copy link
Contributor

github-actions bot commented Oct 24, 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!


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.

@nateweller nateweller force-pushed the add/components/threats-data-view branch 14 times, most recently from a2f44c1 to cec6f1e Compare October 25, 2024 04:12
@github-actions github-actions bot added [JS Package] Scan [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Tests] Includes Tests labels Oct 25, 2024
@dkmyta dkmyta marked this pull request as ready for review October 25, 2024 19:18
@nateweller nateweller force-pushed the add/components/threats-data-view branch 4 times, most recently from 388600f to 25fb234 Compare October 26, 2024 00:05
@nateweller nateweller self-requested a review November 8, 2024 17:36
Copy link
Contributor

@nateweller nateweller Nov 8, 2024

Choose a reason for hiding this comment

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

Idea - could we extract the <ThreatsStatusToggleGroupControl> component into a separate file?

It could be passed data: Threats[] and view: View properties, and compute/memoize its own values for counts/selected/etc.

It could also accept the existing onChangeView: ( newView: View ) => void callback, and call it with the full updated view objects on click.

The objective being to keep this main index file clean and straightforward, and isolate this custom functionality in its own file. Using the data/view/onChangeView properties directly essentially make it like a mini plugin/extension for the DataViews.

Copy link
Contributor

Choose a reason for hiding this comment

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

Second idea - since these are experimental components, what do you think about wrapping this component with a try/catch or React Error Boundary?

This will not help in the case of import errors, but if any breaking changes are missed, it will prevent the component from crashing the entire scan screen.

Copy link
Contributor

@nateweller nateweller Nov 8, 2024

Choose a reason for hiding this comment

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

Minor - we could update the filters property passed to these story components to use the operator: 'is any' and value: [ 'current' ] approach, to ensure the filter is shown to be active on page load.

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.

Works well! Left comments on organizational approach but otherwise looks pretty much good to go 👍 👍

Comment on lines +530 to +536
header={
<ThreatsStatusToggleGroupControl
data={ data }
view={ view }
onChangeView={ onChangeView }
/>
}
Copy link
Contributor

Choose a reason for hiding this comment

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

clean! 👍

@nateweller
Copy link
Contributor

Nice updates!

  • Left a comment to clean up extra changes left over in the index file.
  • Left a suggestion re: computing the selected value.

nateweller
nateweller previously approved these changes Nov 8, 2024
@dkmyta dkmyta merged commit e9b0e4f into trunk Nov 8, 2024
74 checks passed
@dkmyta dkmyta deleted the add/component/threats-data-view-toggle-group-control-alt branch November 8, 2024 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Components [JS Package] Scan [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