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.

Sign up for GitHub

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

Jump to bottom

Protect: Update Threats Data Format and Integrate ThreatsDataViews #39767

Closed
wants to merge 2 commits into from
Closed

Protect: Update Threats Data Format and Integrate ThreatsDataViews #39767

wants to merge 2 commits into from

Conversation

nateweller
Copy link
Contributor

@nateweller nateweller commented Oct 14, 2024 •
edited
Loading

Proposed changes:

  • Updates the protect-models and protect-status packages to use a Threats[] as the default format when providing or working with vulnerabilities and scan results data.
    • This threats-oriented approach matches the current output from the Scan API, and is ideal for integration with DataViews. Overall, this change reduces the amount of data normalization required while maintaining a consistent and predictable format for our scan results data.
    • When initially introduced, the Scan API data was normalized into the pre-existing "Protect Report" format. This change reverses the direction of normalization, meaning that we now normalize the Protect Report results instead.
  • Updates My Jetpack for compatibility with changes in the above protect packages.
  • Updates the Protect plugin to use the new ThreatsDataViews component and data format.
    • Removes the useProtectData() hook in favor of working directly with query hooks.
    • Removes the threat accordions and related components.
    • Combines the active and historic threat routes, while still supporting the /scan/history and /scan/history/:status paths by auto-applying the relevant filter on page load.
  • Adds supporting types and utility functions to the scan JS package.

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

peb6dq-2Ze-p2

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

No

Testing instructions:

Jetpack Protect

  • Test the scan section from top to bottom:
    • Initial install
    • Start for free
    • View free results
    • Upgrade to a paid plan
    • View paid scan results
    • Test threat filters and actions

My Jetpack

  • Go to /wp-admin/admin.php?page=my-jetpack
  • With the Protect plugin inactive, verify the Protect product card shows the counts of installed themes and plugins.
  • With the Protect plugin active, verify the Protect product card shows the last scan timestamp.
Screenshot 2024-10-29 at 1 06 09 PM Screenshot 2024-10-29 at 1 06 53 PM

@nateweller nateweller self-assigned this Oct 14, 2024
@nateweller nateweller requested a review from a team October 14, 2024 19:42
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 14, 2024 •
edited
Loading

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/protect/threats-data 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 update/protect/threats-data

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/protect/threats-data

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 [Package] Protect Models [Package] Protect Status [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Tests] Includes Tests labels Oct 14, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 14, 2024 •
edited
Loading

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 update/protect/threats-data branch from 5095780 to bd4a75b Compare October 14, 2024 20:57
@nateweller nateweller force-pushed the add/components/threats-data-view branch from 8c94083 to 3adfb3c Compare October 16, 2024 19:47
@nateweller nateweller force-pushed the update/protect/threats-data branch 2 times, most recently from 1fe6562 to 3c56160 Compare October 16, 2024 21:07
@nateweller nateweller force-pushed the update/protect/threats-data branch from 3c56160 to 0fa3ff0 Compare October 16, 2024 21:42
@nateweller nateweller force-pushed the add/components/threats-data-view branch 6 times, most recently from be54d44 to 32b6d61 Compare October 21, 2024 20:06
@nateweller nateweller force-pushed the update/protect/threats-data branch 3 times, most recently from 2af226a to 0a242eb Compare October 21, 2024 22:26
@nateweller nateweller force-pushed the update/protect/threats-data branch 3 times, most recently from f234dd1 to 54a675a Compare October 22, 2024 19:18
@nateweller nateweller force-pushed the update/protect/threats-data branch 3 times, most recently from 226ece4 to 071606f Compare October 29, 2024 17:59
@nateweller nateweller changed the title Protect: Update Threats Data Format Protect: Update Threats Data Format and Integrate ThreatsDataViews Oct 29, 2024
@nateweller nateweller force-pushed the add/components/threats-data-view branch 2 times, most recently from 0a1b0bd to 58f6f3e Compare October 29, 2024 20:24
@nateweller nateweller force-pushed the update/protect/threats-data branch 10 times, most recently from d06cee5 to a49ddf7 Compare October 29, 2024 22:57
@nateweller nateweller force-pushed the add/components/threats-data-view branch from 58f6f3e to dd1f233 Compare November 5, 2024 18:46
@nateweller nateweller mentioned this pull request Nov 5, 2024
Merged
3 tasks
@nateweller nateweller force-pushed the add/components/threats-data-view branch 2 times, most recently from 25254f3 to 79804d5 Compare November 5, 2024 21:58
Base automatically changed from add/components/threats-data-view to trunk November 6, 2024 16:33
@nateweller nateweller force-pushed the update/protect/threats-data branch from a49ddf7 to 0730c34 Compare November 6, 2024 16:38
@nateweller nateweller force-pushed the update/protect/threats-data branch 2 times, most recently from 9704735 to b69d9d6 Compare November 6, 2024 17:21
@nateweller nateweller force-pushed the update/protect/threats-data branch from b69d9d6 to f452d36 Compare November 6, 2024 17:22
@nateweller
Copy link
Contributor Author

Closing in favor of #40097 and #40076

@nateweller nateweller closed this Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@nateweller nateweller

Labels
[JS Package] Components [JS Package] Scan [Package] My Jetpack [Package] Protect Models [Package] Protect Status [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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nateweller @dkmyta