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: Show loading indicator as status icon when scan in progress #40624

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

Conversation

nateweller
Copy link
Contributor

Proposed changes:

  • Updates the ScanReport component to accept a scanInProgress: boolean prop, which displays a Spinner instead of a ShieldIcon in the "status" column when a scan is currently in progress.

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

N/A

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

No

Testing instructions:

  • Test the home page in Protect while a scan is running and then complete.
Screenshot 2024-12-15 at 1 33 27 PM

@nateweller nateweller added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Team Review labels Dec 15, 2024
@nateweller nateweller requested a review from a team December 15, 2024 20:37
@nateweller nateweller self-assigned this Dec 15, 2024
@nateweller nateweller changed the base branch from trunk to fix/protect/home-stat-card-gap December 15, 2024 20:37
Copy link
Contributor

github-actions bot commented Dec 15, 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/scan-report-loading-indicators 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/scan-report-loading-indicators
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/protect/scan-report-loading-indicators
    

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 [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. RNA labels Dec 15, 2024
Copy link
Contributor

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.

@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 15, 2024
@nateweller nateweller force-pushed the fix/protect/home-stat-card-gap branch from 7aadefb to cc4dc36 Compare December 16, 2024 02:00
@nateweller nateweller force-pushed the add/protect/scan-report-loading-indicators branch from 4eb7f10 to d17f3f7 Compare December 16, 2024 02:01
@nateweller nateweller force-pushed the fix/protect/home-stat-card-gap branch from cc4dc36 to 6cf16bd Compare December 16, 2024 03:24
@nateweller nateweller force-pushed the add/protect/scan-report-loading-indicators branch from d17f3f7 to 2f7cfc8 Compare December 16, 2024 03:25
@nateweller nateweller force-pushed the fix/protect/home-stat-card-gap branch from 6cf16bd to b13df3f Compare December 16, 2024 04:15
@nateweller nateweller force-pushed the add/protect/scan-report-loading-indicators branch 2 times, most recently from aeb3c42 to dc8c830 Compare December 16, 2024 04:29
@nateweller nateweller force-pushed the fix/protect/home-stat-card-gap branch from b13df3f to 4335e70 Compare December 16, 2024 16:31
@nateweller nateweller force-pushed the add/protect/scan-report-loading-indicators branch from dc8c830 to 7700614 Compare December 16, 2024 16:31
Copy link
Contributor

@dkmyta dkmyta left a comment

Choose a reason for hiding this comment

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

Logic looks sounds, IMHO though having a scanning icon for each row is a little overkill, especially when all a site is approach 20 entries in the table. The icon in the header card let's us know its in progress, maybe thats enough? I suppose this is an effort to make it clear to the user that current data is live? I am not a design expert by any means, so the decision shouldn't be solely up to me but perhaps we should run this by the team for more opinions.

nateweller and others added 9 commits December 17, 2024 16:34
* 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 <[email protected]>

---------

Co-authored-by: Nate Weller <[email protected]>
Protect: add HMR support

Revert "Protect: add HMR support"

This reverts commit 06497a0.
@nateweller nateweller force-pushed the fix/protect/home-stat-card-gap branch from 4335e70 to 9a6e7ee Compare December 17, 2024 23:40
@nateweller nateweller force-pushed the add/protect/scan-report-loading-indicators branch from 7700614 to d860f37 Compare December 17, 2024 23:41
Base automatically changed from fix/protect/home-stat-card-gap to add/protect/core December 18, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Components [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 [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants