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

Fix/newsletter popup tabs #38266

Merged
merged 11 commits into from
Jul 11, 2024
Merged

Fix/newsletter popup tabs #38266

merged 11 commits into from
Jul 11, 2024

Conversation

enejb
Copy link
Member

@enejb enejb commented Jul 9, 2024

Fixes #

Proposed changes:

  • This PR has a few different changes.
  • We now use localstorage to presist the state. This also helps with the scroll tabs modal removal.
  • We don't add events directly but use addEventListeners this make sure that we allow other plugins to add their own even listeners (even if they are doing it wrong)
  • We remove events that we shouldn't need. So that they are not running any more once the modal is opened and closed.

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

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

Testing instructions:

Add the following code to ease of testing.

// just for testing.
add_filter( 'jetpack_subscribe_modal_interval', '__return_zero' );

add_filter(
	'jetpack_subscribe_modal_load_time',
	function ( $item ) {
		return 4000;
	}
);

// The model should show up after 4seconds of inactivity on the page instead of 60.
We also skip show the modal every time. ( since the interval is set to zero)

To test.

  1. the modal still shows up after scrolling.
  2. After 4 seconds have passed.
  3. Open the modal in two or more tabs.
    Do not dismiss the modal.
    Note that after dismissing a modal in one tab that it is gone in other modals.
  4. Focus an input or link.
    Notice that the modal doesn't show up.
  5. after the focus shifts to the window again the modal shows up again.
Copy link
Contributor

github-actions bot commented Jul 9, 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 fix/newsletter-popup-tabs branch.

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

    bin/jetpack-downloader test jetpack fix/newsletter-popup-tabs
    

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 [Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jul 9, 2024
Copy link
Contributor

github-actions bot commented Jul 9, 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 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.

@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 Jul 9, 2024
@lezama
Copy link
Contributor

lezama commented Jul 10, 2024

this is great! let me take over and rebase once we merge #38079

@enejb enejb force-pushed the fix/newsletter-popup-tabs branch from e2f0170 to 8a02ab7 Compare July 11, 2024 03:39
@lezama
Copy link
Contributor

lezama commented Jul 11, 2024

pushed a small refactor, let's 🚢 !

@enejb enejb merged commit dc358ae into trunk Jul 11, 2024
56 checks passed
@enejb enejb deleted the fix/newsletter-popup-tabs branch July 11, 2024 19:33
@github-actions github-actions bot 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 11, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
2 participants