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 ShieldIcon Component #40402

Merged
merged 4 commits into from
Dec 5, 2024

Conversation

nateweller
Copy link
Contributor

@nateweller nateweller commented Nov 30, 2024

Proposed changes:

  • Adds a ShieldIcon component for use in the Jetpack protect plugin. Replaces the existing AlertIcon component.
  • This new icon supports a variant property (i.e. default, success, warning, or error) that controls the color and icon. However, the fill and icon properties can be set directly as well to override or opt-out of the variant.
  • Additionally, an outline prop is available to switch between the fill/border shield styles.

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:

  • In Jetpack Protect, review the page header on the Scanner tab.
  • Review the ShieldIcon storybook.

Screenshots

Protect:

Screenshot 2024-12-04 at 1 55 53 PM Screenshot 2024-12-04 at 1 53 44 PM

Storybook:

Screenshot 2024-12-04 at 1 44 26 PM

@nateweller nateweller requested a review from a team November 30, 2024 04:08
@nateweller nateweller self-assigned this Nov 30, 2024
@github-actions github-actions bot added the [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. label Nov 30, 2024
Copy link
Contributor

github-actions bot commented Nov 30, 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.


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 refactor/protect/alert-icon branch from c0fbff8 to c8406d5 Compare December 2, 2024 17:31
@nateweller nateweller marked this pull request as ready for review December 3, 2024 03:41
@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 3, 2024
@nateweller nateweller force-pushed the refactor/protect/alert-icon branch 2 times, most recently from 47daee8 to 0af972e Compare December 3, 2024 05:41
@nateweller nateweller added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Dec 3, 2024
@nateweller nateweller force-pushed the refactor/protect/alert-icon branch from c9e6762 to 62c5e58 Compare December 3, 2024 23:17
Copy link
Contributor

github-actions bot commented Dec 3, 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 refactor/protect/alert-icon 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 refactor/protect/alert-icon
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin refactor/protect/alert-icon
    

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

@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.

Really great idea! This will be fantastic to use in the ScanReport and Home page StatCards.

Nit - it's only a very subtle difference, but think it's possible that we can update the internal icon paths to match the designs?

Error:
Screen Shot on 2024-12-03 at 18-52-33
vs.
Screen Shot on 2024-12-03 at 18-54-59

Success:
Screen Shot on 2024-12-03 at 18-53-16
vs.
Screen Shot on 2024-12-03 at 18-54-26

We should now use this new component in Protect to replace the ProtectCheck and its uses and the error icon in the ErrorAdminSectionHero.

@nateweller nateweller force-pushed the refactor/protect/alert-icon branch 3 times, most recently from a2db115 to c871fb1 Compare December 4, 2024 20:57
@nateweller
Copy link
Contributor Author

Good points @dkmyta, and thanks for the review! 👍

I've updated the new ShieldIcon component this PR introduces to use the paths from the check and warning icons from @wordpress/icons.

@dkmyta dkmyta mentioned this pull request Dec 4, 2024
3 tasks
@nateweller nateweller merged commit 7bf227b into add/protect/core Dec 5, 2024
71 checks passed
@nateweller nateweller deleted the refactor/protect/alert-icon branch December 5, 2024 03:26
nateweller added a commit that referenced this pull request Dec 5, 2024
nateweller added a commit that referenced this pull request Dec 5, 2024
nateweller added a commit that referenced this pull request Dec 5, 2024
@nateweller nateweller mentioned this pull request Dec 5, 2024
3 tasks
nateweller added a commit that referenced this pull request Dec 6, 2024
nateweller added a commit that referenced this pull request Dec 8, 2024
nateweller added a commit that referenced this pull request Dec 9, 2024
nateweller added a commit that referenced this pull request Dec 9, 2024
nateweller added a commit that referenced this pull request Dec 10, 2024
nateweller added a commit that referenced this pull request Dec 10, 2024
nateweller added a commit that referenced this pull request Dec 10, 2024
Protect: Add ShieldIcon Component (#40402)

Components: Add ScanReport (#40419)
nateweller pushed a commit that referenced this pull request Dec 10, 2024
Rebase on admin hero section refactor

Revert accidental type changes

Remove testing code

Init project branch

Protect: Add ShieldIcon Component (#40402)

Refactor AdminSectionHero component
nateweller pushed a commit that referenced this pull request Dec 10, 2024
Rebase on admin hero section refactor

Revert accidental type changes

Remove testing code

Init project branch

Protect: Add ShieldIcon Component (#40402)

Refactor AdminSectionHero component
nateweller pushed a commit that referenced this pull request Dec 10, 2024
Rebase on admin hero section refactor

Revert accidental type changes

Remove testing code

Init project branch

Protect: Add ShieldIcon Component (#40402)

Refactor AdminSectionHero component
nateweller added a commit that referenced this pull request Dec 10, 2024
nateweller added a commit that referenced this pull request Dec 10, 2024
Protect: Add ShieldIcon Component (#40402)

Components: Add ScanReport (#40419)
nateweller pushed a commit that referenced this pull request Dec 10, 2024
Rebase on admin hero section refactor

Revert accidental type changes

Remove testing code

Init project branch

Protect: Add ShieldIcon Component (#40402)

Refactor AdminSectionHero component
dkmyta added a commit that referenced this pull request Dec 10, 2024
* 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>
nateweller added a commit that referenced this pull request Dec 11, 2024
nateweller added a commit that referenced this pull request Dec 11, 2024
* 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>
nateweller added a commit that referenced this pull request Dec 15, 2024
nateweller added a commit that referenced this pull request Dec 15, 2024
* 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>
nateweller added a commit that referenced this pull request Dec 17, 2024
nateweller added a commit that referenced this pull request Dec 17, 2024
* 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>
nateweller added a commit that referenced this pull request Dec 18, 2024
nateweller added a commit that referenced this pull request Dec 18, 2024
* 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>
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 [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