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 card: Add the Last scan time (with tooltip) based on plugin state. #38091

Merged
merged 20 commits into from
Jul 12, 2024
Merged

Protect card: Add the Last scan time (with tooltip) based on plugin state. #38091

merged 20 commits into from
Jul 12, 2024

Conversation

elliottprogrammer
Copy link
Contributor

@elliottprogrammer elliottprogrammer commented Jun 27, 2024 •
edited
Loading

This PR is the first PR in a series that will add/show various pieces of information on the Protect product card in My Jetpack. In this PR we will show:

  1. if the Protect plugin is Not active, we will show the number of installed plugins and themes on the site. For Example: "12 Plugins & 3 Themes ⓘ" (with an info-icon popup).
  2. If the Protect plugin is active, we will show the last scan time, For example: "Last scan: 17 hours ago".

See Design P2: p1HpG7-rFA-p2 (Figma link is within the post)

Screenshots:

Protect plugin Not active:

Screen Shot 2024-06-27 at 12 06 26

Screen Shot 2024-06-27 at 12 07 29

Protect plugin Active:

Screen Shot 2024-06-27 at 12 04 49

Note: The "Scan", "Auto-Firewall", and "Logins-Blocked" sections are currently empty and not functional. Those will be added to in upcoming PR's.

Proposed changes:

  • Adds a 'themes' property to the window.myJetpackInitialState object.
  • Adds a protectStatus property to the window.myJetpackInitialState object.
  • Imports/uses the protect-status 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

Project Thread: pbNhbs-aP6-p2

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

No

Testing instructions:

  • Run this PR locally (Docker dev environment) or from a Jurassic Ninja site using the Beta Tester plugin running this Jetpack branch.
  • First make sure the Protect plugin is installed, but Not active.
  • Go to My Jetpack and view the Protect product card.
  • Verify you see the number of installed plugins and themes of the site on the Protect card (upper right corner).
  • Verify you see an info icon (tooltip) and verify the info popup/tooltip works correctly and it matches the Figma design (linked in the Design post: p1HpG7-rFA-p2)
  • Activate the Protect plugin. (Also make sure Jetpack is connected)
  • Go back to My Jetpack and view the Protect card again.
  • Verify you now see the "Last scan time:" with a proper value (in the upper right corner of the card)
    • On a brand new site, you may need to wait a minute for the initial first scan to complete, and then refresh the page to see the "Last scan time:" with a proper value. (although typically the first scan is very quick (just a couple seconds), in my experience).
  • You can verify and compare the design with the Figma design (linked in the Design post: p1HpG7-rFA-p2)
@elliottprogrammer elliottprogrammer self-assigned this Jun 27, 2024
@elliottprogrammer elliottprogrammer mentioned this pull request Jun 27, 2024
Closed
3 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 27, 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 add/mj-protect-card-last-scan-time branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/mj-protect-card-last-scan-time

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] My Jetpack [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. labels Jun 27, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 27, 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.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Backup plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Boost plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Search plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Social plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Starter Plugin plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Protect plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Videopress plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Migration plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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 Jun 27, 2024
@elliottprogrammer elliottprogrammer requested a review from a team June 27, 2024 16:14
CodeyGuyDylan
CodeyGuyDylan requested changes Jun 27, 2024
View reviewed changes
Copy link
Contributor

@CodeyGuyDylan CodeyGuyDylan left a comment

Choose a reason for hiding this comment

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

With the Popover component, it doesn't close when I click outside of it, and it does close when I click inside of it. The useOutsideAlerter hook is good to handle this

popover-issuue.mov

Additionally, the testing instructions say to make sure it works correctly. I am not sure if this encompasses the content of the Popover but the numbers inside are incorrect

image

We might want to hide the "Last scanned" text entirely until we have a scan time to show 🤔

image

I'm seeing a responsiveness issue on medium-sized screen:
image

We might want to increase the minimum width of these cards as we add more information to them. It's a grid so it should scale nicely if we do that
projects/packages/my-jetpack/_inc/components/product-cards-section/protect-card/index.tsx Outdated Show resolved Hide resolved
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx Outdated Show resolved Hide resolved
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx Outdated Show resolved Hide resolved
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx Outdated Show resolved Hide resolved
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx Outdated Show resolved Hide resolved
projects/packages/my-jetpack/_inc/components/product-cards-section/protect-card/style.scss Outdated Show resolved Hide resolved
projects/packages/my-jetpack/_inc/components/product-cards-section/protect-card/style.scss Outdated Show resolved Hide resolved
projects/packages/my-jetpack/_inc/components/product-cards-section/protect-card/style.scss Outdated Show resolved Hide resolved
projects/packages/my-jetpack/_inc/components/product-cards-section/protect-card/style.scss Outdated Show resolved Hide resolved
projects/packages/my-jetpack/src/class-initializer.php Outdated Show resolved Hide resolved
@elliottprogrammer elliottprogrammer removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jul 1, 2024
@elliottprogrammer
Copy link
Contributor Author

Thanks for the excellent review @CodeyGuyDylan, I've addressed all feedback. 🙌
CodeyGuyDylan
CodeyGuyDylan requested changes Jul 1, 2024
View reviewed changes
Copy link
Contributor

@CodeyGuyDylan CodeyGuyDylan left a comment

Choose a reason for hiding this comment

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

Thank you for all of the changes! It works much better for me. I did have some more comments but not nearly as many as last time 🤔 I think this is very close

Also I know we talked in slack but putting here for visibility that I'm not sure we should show the plugins & themes data in the event that the user has Protect active but no scan data is available due to lack of site connection or if the initial scan is still running
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx Show resolved Hide resolved
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx Outdated Show resolved Hide resolved
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx
const hideTooltip = useCallback( () => {
// Don't hide the tooltip here if it's the toolTip button that was clicked (the button
// becoming the document's activeElement). Instead let toggleTooltip() handle the closing.
if ( useTooltipRef.current && ! useTooltipRef.current.contains( document.activeElement ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks pretty similar to the useOutsideAlerter hook that already exists in this project, was there a reason it didn't work for this use-case?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, there is a feature already built into the Popover that detects when the focus is triggered outside of the popover, and when that happens, the onClose function is fired. The onClose is a user defined function via the onClose prop of the Popover.
So in other words, the feature is already built into the Popover, I just had to modify the onClose behavior slightly by telling it to not treat clicking the info-icon button as an outside focus event.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah ok I see, thank you for taking care of that!
projects/packages/my-jetpack/_inc/components/product-cards-section/protect-card/style.scss Outdated Show resolved Hide resolved
...es/my-jetpack/_inc/components/product-cards-section/protect-card/use-protect-tooltip-copy.ts
),
},
scanThreatsTooltip:
hasProtectPaidPlan && numThreats
Copy link
Contributor

Choose a reason for hiding this comment

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

I know this isn't going to be implemented until the next PR, but we'll want a case for a user that does not have the protect paid plan but does have threats. Right now if that were the case, the tooltip would say that all appears well even though they have threats
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes thanks. Yeah, this will implemented in the next PR. 👍
@elliottprogrammer
Copy link
Contributor Author

elliottprogrammer commented Jul 1, 2024 •
edited
Loading

Thank you for all of the changes! It works much better for me. I did have some more comments but not nearly as many as last time 🤔 I think this is very close

Also I know we talked in slack but putting here for visibility that I'm not sure we should show the plugins & themes data in the event that the user has Protect active but no scan data is available due to lack of site connection or if the initial scan is still running

Thanks @CodeyGuyDylan! Yeah, I've addressed your additional feedback items, and I removed the "Plugins & Themes" text when the plugin is active but there is no scan data available (b/c initial scan in progress or site disconnected, etc). 👍
Let me know if you have any additional feedback. 😃
CodeyGuyDylan
CodeyGuyDylan reviewed Jul 2, 2024
View reviewed changes
...ages/my-jetpack/_inc/components/product-cards-section/protect-card/protect-value-section.tsx
const hideTooltip = useCallback( () => {
// Don't hide the tooltip here if it's the toolTip button that was clicked (the button
// becoming the document's activeElement). Instead let toggleTooltip() handle the closing.
if ( useTooltipRef.current && ! useTooltipRef.current.contains( document.activeElement ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah ok I see, thank you for taking care of that!
...es/my-jetpack/_inc/components/product-cards-section/protect-card/use-protect-tooltip-copy.ts
text: sprintf(
/* translators: %1$d is the number of plugins and %2$d is the number of themes installed on the site. */
__(
'Your site has %1$d plugins and %2$d themes lacking security measures. Improve your site’s safety by adding protection at no cost.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like we'll need to implement a _n() here to handle plurals 😄
image
I know you're working on another PR having to do with tooltips so feel free to handle that there instead if you'd like
@CodeyGuyDylan CodeyGuyDylan self-requested a review July 2, 2024 13:37
CodeyGuyDylan
CodeyGuyDylan previously approved these changes Jul 2, 2024
View reviewed changes
@elliottprogrammer elliottprogrammer merged commit f9312c7 into trunk Jul 12, 2024
69 of 70 checks passed
@elliottprogrammer elliottprogrammer deleted the add/mj-protect-card-last-scan-time branch July 12, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] My Jetpack [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site.
2 participants
@elliottprogrammer @CodeyGuyDylan