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

My Jetpack: add connection errors to Global Notice #36840

Merged
merged 9 commits into from
Apr 30, 2024
Merged

My Jetpack: add connection errors to Global Notice #36840

merged 9 commits into from
Apr 30, 2024

Conversation

IanRamosC
Copy link
Contributor

@IanRamosC IanRamosC commented Apr 11, 2024 •
edited
Loading

See linked issue

Proposed changes:

  • This PR removes the usage of <ConnectionError> (from @automattic/jetpack-connection) from My Jetpack. It adds a new hook to use-notification-watcher that consumes the data from the jetpack-connection library and displays it as a Global Notice.
image

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

pbNhbs-ag3-p2

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

Yes, it adds a new event to the "Reconnect Jetpack" button.

Testing instructions:

  • Spin up a JN site with Jetpack Beta pointing to this branch and with Jetpack Debug Tools
  • Visit My Jetpack, connect your account and dismiss the welcome banner
  • Confirm that you don't see any notice on My Jetpack
  • Now, go to Jetpack Debug, enable "Broken token Utilities" and save
  • After refreshing the page, go to "Broken Token" under "Jetpack Debug" and click on "Set invalid blog token" and "Set invalid user tokens"
  • Go back to My Jetpack and confirm that you see an error like the one in the screenshot above. Try reconnecting Jetpack and confirm the behavior makes sense

@IanRamosC IanRamosC self-assigned this Apr 11, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 11, 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/connection-errors-notice branch.

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

    bin/jetpack-downloader test jetpack add/connection-errors-notice

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
Copy link
Contributor

github-actions bot commented Apr 11, 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 May 7, 2024 (scheduled code freeze on May 6, 2024).

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

Backup plugin:

  • Next scheduled release: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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: May 7, 2024.
  • Scheduled code freeze: April 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 [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 Apr 11, 2024
@IanRamosC IanRamosC force-pushed the add/connection-errors-notice branch from 55d87af to 05ba853 Compare April 11, 2024 18:12
@IanRamosC IanRamosC marked this pull request as ready for review April 11, 2024 19:33
@IanRamosC IanRamosC force-pushed the add/connection-errors-notice branch from 28f93b7 to 7a98606 Compare April 22, 2024 14:22
@IanRamosC IanRamosC requested a review from a team April 22, 2024 15:30
CodeyGuyDylan
CodeyGuyDylan requested changes Apr 26, 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.

Not entirely sure changes are needed, but we have the bad installation message, welcome banner, and connection issues all showing a red bubble notification when the notices are visible. Should we have a red bubble notification here too?

projects/packages/my-jetpack/_inc/context/notices/noticeContext.tsx
@@ -1,4 +1,4 @@
import { createContext, useState } from 'react';
import { createContext, useCallback, useState } from 'react';
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice improvements here, thank you!

...cts/packages/my-jetpack/_inc/hooks/use-notification-watcher/use-connection-errors-notice.tsx

const onCtaClick = () => {
restoreConnection();
recordEvent( 'jetpack_my_jetpack_connection_error_notice_reconnect_cta_click' );
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also have a tracks event for this notice being visible? That way we could track percentage clicked 🤔

@IanRamosC IanRamosC force-pushed the add/connection-errors-notice branch from 7a98606 to c073ca4 Compare April 26, 2024 20:10
CodeyGuyDylan
CodeyGuyDylan previously approved these changes Apr 29, 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.

Everything tests as expected, thank you for adding those tracks events for the viewing of the notices!

I had a conversation with @jboland88 (since you were out) about the integration of the red bubbles. The summary of that conversation is that we should create a follow-up task to integrate these connection errors with the red bubble notification since all the others are, but this is good to ship since there is already an existing notice associated with these errors that also does not show a red bubble notification. So looking at the code, this all looks good to me and is definitely an improvement over what came before 😄

@IanRamosC IanRamosC force-pushed the add/connection-errors-notice branch from c073ca4 to 4e01108 Compare April 30, 2024 16:04
@IanRamosC IanRamosC enabled auto-merge (squash) April 30, 2024 16:15
@IanRamosC IanRamosC merged commit f5996c8 into trunk Apr 30, 2024
68 of 70 checks passed
@IanRamosC IanRamosC deleted the add/connection-errors-notice branch April 30, 2024 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CodeyGuyDylan CodeyGuyDylan CodeyGuyDylan approved these changes

Assignees

@IanRamosC IanRamosC

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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@IanRamosC @CodeyGuyDylan