Newsletters: Enhance Subscription Modal Display Logic #38079

lezama · 2024-06-27T00:57:58Z

Fixes p1719421326241939/1719262060.786719-slack-C02NQ4HMJKV

Proposed changes:

This PR introduces improvements to the logic controlling the display of the subscription modal.

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:

Go to '..'

github-actions · 2024-06-27T00:58:51Z

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 update/subscribe-modal-behaviour branch.

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

bin/jetpack-downloader test jetpack update/subscribe-modal-behaviour

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 · 2024-06-27T00:59:01Z

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.

simison · 2024-07-01T17:19:45Z

Intersection observer API is now has good enough support, we should use that instead; it's more performant and simpler.

I'm thinking if just relying on full page height works well in all cases, because sometimes sites have a lot of footer content too. 🤔

Some ideas:

Use main or article HTML tag and observe scroll position only within that element, if they exist.
Use entry-content class, which is pretty ubiquitous across themes
Use some of the new classes coming from block templates

simison · 2024-07-05T16:07:40Z

@lezama when Cris is back next week, can you work with her to find good trigger point for these modals?

lezama · 2024-07-10T01:12:27Z

Intersection observer API is now has good enough support, we should use that instead; it's more performant and simpler.

I tried using the Intersection Observer API without success. Although it’s great for detecting when two elements intersect, it doesn’t seem straightforward for our use case. Since a post occupies the entire viewport, it always intersects at the same proportion.

lezama · 2024-07-10T02:07:25Z

I’ve just pushed a simplification. I believe it’s ready for testing.

cc @enejb

lezama · 2024-07-10T11:19:06Z

Use entry-content class, which is pretty ubiquitous across themes

it now uses .entry-content or fallbacks to document

enejb

Still need to test this but I think we should rename the filter since the numbers might not make sense for users that area currently using them.

enejb · 2024-07-10T04:32:32Z

projects/plugins/jetpack/modules/subscriptions/subscribe-modal/subscribe-modal.js

-	};
+	function onScroll() {
+		if ( ! hasLoaded ) {
+			requestAnimationFrame( () => {


❤️ good call on the requestAnimationFrame

enejb · 2024-07-10T17:47:09Z

...ects/plugins/jetpack/modules/subscriptions/subscribe-modal/class-jetpack-subscribe-modal.php

@@ -64,17 +64,35 @@ public function enqueue_assets() {
 			wp_enqueue_script( 'subscribe-modal-js', plugins_url( 'subscribe-modal.js', __FILE__ ), array( 'wp-dom-ready' ), JETPACK__VERSION, true );

 			/**
-			 * Filter how many milliseconds a user must scroll for until the Subscribe Modal appears.
+			 * Filter how many milliseconds until the Subscribe Modal appears.
 			 *
 			 * @module subscriptions
 			 *
 			 * @since 13.4
 			 *
 			 * @param int 300 Time in milliseconds for the Subscribe Modal to appear upon scrolling.


We should update this default comment since it changed.

Should we introduce a slightly different filter name since this one might be in use already.
cc: @Aurorum for awareness and feedback, since you introduced the original filter. :)

No strong views from me! It was added to allow users to customise the default value for the load time; if the default value still changes, I don’t think that’s a big deal.

We should update this default comment since it changed.

done!

enejb · 2024-07-10T17:50:31Z

projects/plugins/jetpack/modules/subscriptions/subscribe-modal/subscribe-modal.js

@@ -57,6 +75,7 @@ domReady( function () {
 		hasLoaded = true;
 		setModalDismissedCookie();
 		window.addEventListener( 'keydown', closeModalOnEscapeKeydown );
+		window.removeEventListener( 'scroll', onScroll );


Good call on removing this event listener.

enejb · 2024-07-10T19:14:04Z

I tested the change on mobile and desktop and it works really nice!

enejb

Looks good!

lezama marked this pull request as ready for review June 27, 2024 00:58

lezama added the [Status] In Progress label Jun 27, 2024

lezama requested a review from a team June 27, 2024 00:58

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 Jun 27, 2024

simison requested a review from crisbusquets July 5, 2024 16:06

lezama added 2 commits July 9, 2024 16:55

add Scroll Threshold

84a9a67

changelog

119e2bb

lezama force-pushed the update/subscribe-modal-behaviour branch from 132c762 to 119e2bb Compare July 9, 2024 19:56

lezama added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Jul 9, 2024

Simplify logic

c9c497d

lezama mentioned this pull request Jul 10, 2024

Fix/newsletter popup tabs #38266

Merged

3 tasks

enejb reviewed Jul 10, 2024

View reviewed changes

update filter docs

36b0344

enejb approved these changes Jul 10, 2024

View reviewed changes

lezama merged commit 6aeaff7 into trunk Jul 10, 2024
56 checks passed

lezama deleted the update/subscribe-modal-behaviour branch July 10, 2024 20:11

github-actions bot added this to the jetpack/13.7 milestone Jul 10, 2024

github-actions bot removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Jul 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Newsletters: Enhance Subscription Modal Display Logic #38079

Newsletters: Enhance Subscription Modal Display Logic #38079

lezama commented Jun 27, 2024

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

simison commented Jul 1, 2024 •

edited

Loading

simison commented Jul 5, 2024

lezama commented Jul 10, 2024

lezama commented Jul 10, 2024

lezama commented Jul 10, 2024

enejb left a comment

enejb Jul 10, 2024

enejb Jul 10, 2024

enejb Jul 10, 2024

Aurorum Jul 10, 2024

lezama Jul 10, 2024

enejb Jul 10, 2024

enejb commented Jul 10, 2024

enejb left a comment

Newsletters: Enhance Subscription Modal Display Logic #38079

Newsletters: Enhance Subscription Modal Display Logic #38079

Conversation

lezama commented Jun 27, 2024

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Jun 27, 2024 • edited Loading

github-actions bot commented Jun 27, 2024 • edited Loading

simison commented Jul 1, 2024 • edited Loading

simison commented Jul 5, 2024

lezama commented Jul 10, 2024

lezama commented Jul 10, 2024

lezama commented Jul 10, 2024

enejb left a comment

Choose a reason for hiding this comment

enejb Jul 10, 2024

Choose a reason for hiding this comment

enejb Jul 10, 2024

Choose a reason for hiding this comment

enejb Jul 10, 2024

Choose a reason for hiding this comment

Aurorum Jul 10, 2024

Choose a reason for hiding this comment

lezama Jul 10, 2024

Choose a reason for hiding this comment

enejb Jul 10, 2024

Choose a reason for hiding this comment

enejb commented Jul 10, 2024

enejb left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024 •

edited

Loading

simison commented Jul 1, 2024 •

edited

Loading