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: History fields preset #40580

Open
wants to merge 34 commits into
base: add/protect/core
Choose a base branch
from

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Dec 11, 2024

Description

Adds custom fields when viewing Active threats and History (only in table view).

Proposed changes

  • Display relevant fields dependant on dataFields and statusFilters
    • When current filter is included in statusFilters show auto-fix
    • When fixed, ignored, or historic (fixed and ignored) show first-detected, fixed-on, and hide auto-fix
    • Always show Status so you can distinguish between active/historic threats when viewing all only for the paid view
      • This could be further conditional to be hidden when only viewing current threats?
      • We may also want to include this field in list view for better clarity
  • Show a more descriptive Auto-fix item in actions drop down only in list view, removing it from table view in favour of the Auto-fix field

Potential issues:

  • If a user has no active threats and views all (either by removing all or adding all status filters), the auto-fix column will display even though they are technically viewing only historical threats.
  • If a user is in a filter state where fields are not included (eg. no filters applied), they cannot apply such fields (eg. first-detected) manually from the settings.

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:

  • Review ThreatsDataViews storybooks
  • Checkout this Protect branch on Jurassic Tube/Ninja
  • Ensure that the toggle between Active threats and History applies the correct fields preset
  • Ensure modifying filters also applies the correct field presets

Screenshots

Active threats:
Screen Shot 2024-12-17 at 12 52 37

History:
Screen Shot on 2024-12-17 at 12-53-04

Action drop-down auto-fix in list view (now removed in table view):
Screen Shot on 2024-12-17 at 12-54-01

nateweller and others added 14 commits December 11, 2024 11:17
#40057)

Co-authored-by: Nate Weller <hello@nateweller.com>
* Update Scan and History section header structure/content

* changelog

* Update projects/plugins/protect/src/js/routes/scan/scan-admin-section-hero.tsx

Co-authored-by: Nate Weller <nate.weller@automattic.com>

---------

Co-authored-by: Nate Weller <nate.weller@automattic.com>
Protect: add HMR support

Revert "Protect: add HMR support"

This reverts commit 06497a0.
* Init project branch

* Protect: Add Go to Cloud and Scan now button to Protect primary header (#40057)

Co-authored-by: Nate Weller <hello@nateweller.com>

* Protect: Update Scan and History headers (#40058)

* Update Scan and History section header structure/content

* changelog

* Update projects/plugins/protect/src/js/routes/scan/scan-admin-section-hero.tsx

Co-authored-by: Nate Weller <nate.weller@automattic.com>

---------

Co-authored-by: Nate Weller <nate.weller@automattic.com>

* Protect: de-emphasize cloud link by using link variant (#40211)

* Protect: add ShieldIcon component

* Protect: Add ShieldIcon Component (#40402)

* Protect: Integrate ThreatsDataViews Component (#40076)

* Components: Add ScanReport (#40419)

* Fix type errors

* Protect: add home page

---------

Co-authored-by: Nate Weller <hello@nateweller.com>
Co-authored-by: Nate Weller <nate.weller@automattic.com>
Co-authored-by: Dean Kmyta <dkmyta@automattic.com>
@github-actions github-actions bot added [JS Package] Components [JS Package] Scan [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Status] In Progress RNA labels Dec 11, 2024
Copy link
Contributor

github-actions bot commented Dec 11, 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/components/threats-data-views-history-fields-preset 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/components/threats-data-views-history-fields-preset
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/components/threats-data-views-history-fields-preset
    

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 Dec 11, 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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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: Please add missing changelog entries for the following projects: projects/js-packages/components, projects/plugins/protect

Use the Jetpack CLI tool to generate changelog entries by running the following command: jetpack changelog add.
Guidelines: /docs/writing-a-good-changelog-entry.md


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.

@dkmyta dkmyta changed the base branch from trunk to add/protect/core December 11, 2024 23:33
nateweller and others added 8 commits December 14, 2024 20:28
#40057)

Co-authored-by: Nate Weller <hello@nateweller.com>
* Update Scan and History section header structure/content

* changelog

* Update projects/plugins/protect/src/js/routes/scan/scan-admin-section-hero.tsx

Co-authored-by: Nate Weller <nate.weller@automattic.com>

---------

Co-authored-by: Nate Weller <nate.weller@automattic.com>
nateweller and others added 5 commits December 14, 2024 20:28
Protect: add HMR support

Revert "Protect: add HMR support"

This reverts commit 06497a0.
* Init project branch

* Protect: Add Go to Cloud and Scan now button to Protect primary header (#40057)

Co-authored-by: Nate Weller <hello@nateweller.com>

* Protect: Update Scan and History headers (#40058)

* Update Scan and History section header structure/content

* changelog

* Update projects/plugins/protect/src/js/routes/scan/scan-admin-section-hero.tsx

Co-authored-by: Nate Weller <nate.weller@automattic.com>

---------

Co-authored-by: Nate Weller <nate.weller@automattic.com>

* Protect: de-emphasize cloud link by using link variant (#40211)

* Protect: add ShieldIcon component

* Protect: Add ShieldIcon Component (#40402)

* Protect: Integrate ThreatsDataViews Component (#40076)

* Components: Add ScanReport (#40419)

* Fix type errors

* Protect: add home page

---------

Co-authored-by: Nate Weller <hello@nateweller.com>
Co-authored-by: Nate Weller <nate.weller@automattic.com>
Co-authored-by: Dean Kmyta <dkmyta@automattic.com>
@dkmyta dkmyta marked this pull request as ready for review December 17, 2024 21:04
@nateweller nateweller force-pushed the add/protect/core branch 2 times, most recently from 2a3f2fe to aac1879 Compare December 18, 2024 20:21
@nateweller nateweller requested a review from a team December 18, 2024 23:06
@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 Dec 18, 2024
Comment on lines +357 to +358
...( dataFields.includes( 'firstDetected' ) &&
( statusFilters.includes( 'fixed' ) || statusFilters.includes( 'ignored' ) )
Copy link
Contributor

Choose a reason for hiding this comment

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

I am curious if there's a possible alternative configuration that would allow us to still include the "first detected" field regardless of the current filters, but hide/show the particular field in the table view based on the current filters, instead of omitting the definition of the fields entirely. I'll follow up on this!

Copy link
Contributor Author

@dkmyta dkmyta Dec 18, 2024

Choose a reason for hiding this comment

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

I had a similar hope, and did come across isVisible which I thought might be an option but seemed to not function as I expected it to.

Copy link
Contributor

@nateweller nateweller Dec 18, 2024

Choose a reason for hiding this comment

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

Could we use isVisible? Edit: ah, that might be a per-item method.

Copy link
Contributor

Choose a reason for hiding this comment

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

I am working on a potential approach using the onChangeView callback, will share shortly!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a heads up that I did start with the onChangeView approach and it seemed to have its own limitations - IIRC there were challenges related to not being able to check the current view state against the changed view state because it was always outdated. Regardless, interested to see what you think might work reintroducing that take.

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 [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants