JITM Package: Update the WooCommerce logo in JITMs (display after Feb 4). #41322

elliottprogrammer · 2025-01-25T15:42:34Z

In this PR we are updating the WooCommerce logo shown in JITM's.
The new logo should not display before Feb 4, 2025.

Background: Slack conversation: p1737629667392579-slack-C01264051NE

Screenshots:

BEFORE Feb 4th 2025	On or After Feb 4th, 2025

Proposed changes:

If current date is on or after Feb 4, 2025, display the New WooCommerce logo svg in Woo JITM's.

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

Slack conversation: p1737629667392579-slack-C01264051NE

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

No

Testing instructions:

Apply this PR branch to a Jurassic Ninja site via the Jetpack Beta plugin, OR to your local Jetpack dev environment site (using Docker).
If wpcom PR 171101-ghe-Automattic/wpcom is not shipped yet, you will need to apply the wpcom PR branch to your sandbox and then `define( 'JETPACK__SANDBOX_DOMAIN', 'Your sandbox domain' ); to your Jetpack site (in wp-config.php).
Even if the above wpcom PR is already shipped, still it is advised that you point your site to your wpcom sandbox anyway, that way you can add these filters (below) ⤵️ to your 0-sandbox.php file, which makes things easier when trying to test & display specific JITMS.

// Disable JITM cache during development
add_filter( 'jetpack_just_in_time_msg_cache', '__return_false', 1 );
// Disable JITM throttling
add_filter( 'jetpack_jitm_should_return_jitms', '__return_true', 1 );

Make sure your Jetpack site does Not have a paid plan.
Make sure Jetpack is connected (both site & user).
Install and activate the WooCommerce plugin.
Go to the "Products" (WooCommerce-->Products(edit products)) page: (/wp-admin/edit.php?post_type=product).
In the URL add this url query param: &test_jitm=1 and re-load the page.
The Woo Test Jitm should now show at the top of the page.
If the current date is before Feb 4th, the old, classic Woo logo should be showing in the JITM.
To view/test the new Woo logo, Add this filter to your site's wp-config.php file:

add_filter( 'jetpack_jitm_use_new_woo_logo', '__return_true', 1 );

Reload the page and you should now see the new Woo logo svg in the JITM.
Examine the code change and logic. See that the new logo will display when the current date is on or after Feb 4th, 2025.

github-actions · 2025-01-25T15:43:18Z

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/woo-jitm-logo 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 update/woo-jitm-logo

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/woo-jitm-logo

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 · 2025-01-25T15:43:37Z

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:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

jeherve · 2025-01-27T13:58:08Z

projects/packages/jitm/src/class-jitm.php

-			</style><g><defs><polygon id="SVGID_1_" points="83.8 100 0 100 0 0.3 83.8 0.3 167.6 0.3 167.6 100 "/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" overflow="visible"/></clipPath><g class="st0"><g><defs><rect id="SVGID_3_" width="168" height="100"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" overflow="visible"/></clipPath><g class="st1"><defs><path id="SVGID_5_" d="M15.6 0.3H152c8.6 0 15.6 7 15.6 15.6v52c0 8.6-7 15.6-15.6 15.6h-48.9l6.7 16.4L80.2 83.6H15.6C7 83.6 0 76.6 0 67.9v-52C0 7.3 7 0.3 15.6 0.3"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" overflow="visible"/></clipPath><g class="st2"><defs><rect id="SVGID_7_" width="168" height="100"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" overflow="visible"/></clipPath><rect x="-10" y="-9.7" class="st3" width="187.6" height="119.7"/></g></g></g></g></g><g><defs><path id="SVGID_9_" d="M8.4 14.5c1-1.3 2.4-2 4.3-2.1 3.5-0.2 5.5 1.4 6 4.9 2.1 14.3 4.4 26.4 6.9 36.4l15-28.6c1.4-2.6 3.1-3.9 5.2-4.1 3-0.2 4.9 1.7 5.6 5.7 1.7 9.1 3.9 16.9 6.5 23.4 1.8-17.4 4.8-30 9-37.7 1-1.9 2.5-2.9 4.5-3 1.6-0.1 3 0.3 4.3 1.4 1.3 1 2 2.3 2.1 3.9 0.1 1.2-0.1 2.3-0.7 3.3 -2.7 5-4.9 13.2-6.6 24.7 -1.7 11.1-2.3 19.8-1.9 26.1 0.1 1.7-0.1 3.2-0.8 4.5 -0.8 1.5-2 2.4-3.7 2.5 -1.8 0.1-3.6-0.7-5.4-2.5C52.4 66.7 47.4 57 43.7 44.1c-4.4 8.8-7.7 15.3-9.9 19.7 -4 7.7-7.5 11.7-10.3 11.9 -1.9 0.1-3.5-1.4-4.8-4.7 -3.5-9-7.3-26.3-11.3-52C7.1 17.3 7.5 15.8 8.4 14.5"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" overflow="visible"/></clipPath><rect x="-2.7" y="-0.6" class="st4" width="90.6" height="86.4"/></g><g><defs><path id="SVGID_11_" d="M155.6 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.6 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.6-5.9 5.3-12.4 5.3-19.4C159 33.4 157.9 28.9 155.6 25.2zM147 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C147.5 40.9 147.3 42.6 147 44.2z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" overflow="visible"/></clipPath><rect x="109.6" y="6.9" class="st5" width="59.4" height="71.4"/></g><g><defs><path id="SVGID_13_" d="M112.7 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.5 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.5-5.9 5.3-12.4 5.3-19.4C116 33.4 114.9 28.9 112.7 25.2zM104.1 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C104.6 40.9 104.4 42.6 104.1 44.2z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" overflow="visible"/></clipPath><rect x="66.7" y="6.9" class="st6" width="59.4" height="71.4"/></g></svg></div>';
+				// Don't show the new Woo svg logo until after Feb 4th, 2025
+				// After Feb 4th 2025, we can remove this date condition check ( & filter) and the old svg logo.
+				$content_icon = apply_filters( 'woo_jitm_use_new_logo', $date_now >= $feb_4_date )


Could you add a docblock to that filter, so our codex can pick it up?

I would also recommend using a jetpack_jitm prefix, to match the rest of the package:

jetpack/projects/packages/jitm/src/class-post-connection-jitm.php

Line 348 in 58bed95

$envelopes = apply_filters( 'jetpack_jitm_received_envelopes', $envelopes, $message_path );

For the @since value, you can use $$next-version$$ as the value, it will be automatically replaced on release day:

jetpack/projects/packages/README.md

Lines 114 to 123 in d3f5823

### Package Version Annotations

When needing to add a package version number inside a DocBlock, please use `$$next-version$$` as such:

- `@since $$next-version$$`

- `@deprecated $$next-version$$`

- `@deprecated since $$next-version$$`

- `_deprecated_function( __METHOD__, 'package-$$next-version$$' );` (other WordPress deprecation functions also work, but note it must be all on one line).

The `$$next-version$$` specifier will be automatically replaced with the correct package version number the next time a new version of that package is released.

jeherve · 2025-01-27T14:00:20Z

projects/packages/jitm/src/class-jitm.php

+		$date_now   = new \DateTime();
+		$feb_4_date = new \DateTime( '02-04-2025' );


Would it be worth adding wp_timezone() when getting the dates, so as to switch at the right moment regardless of your site settings?

Thanks for the suggestion @jeherve! Yes sure, why not! It wouldn't hurt!
I mean AFAIK I don't think it's completely necessary for the logo to switch for everybody at the exact same time, but then again, sure why not? I think it would be even better that way! 😉

But would you mind checking/reviewing my code changes using wp_timezone()?
I don't think I've ever used wp_timezone() before, so I'm not completely sure I did it correctly..., Does it look OK to you?

AFAIK I don't think it's completely necessary for the logo to switch for everybody at the exact same time

Can confirm. As long as it happens at some point on the 4th :)

would you mind checking/reviewing my code changes using wp_timezone()?

You should be able to pass the timezone directly as you build the date object:

$feb_4_date = new \DateTime( '02-04-2025', wp_timezone() );

elliottprogrammer · 2025-01-28T14:31:06Z

@jeherve, Thanks for the review, much appreciated! 😃

Could you add a docblock to that filter, so our codex can pick it up?

I would also recommend using a jetpack_jitm prefix, to match the rest of the package:

Yes sounds good! Thanks for the feedback!

Added a docblock to the filter
Prefixed the filter name with jetpack_jitm_ to match the rest of the package.
Added the use of wp_timezone() when checking for the Feb 4th date. (Can you take a look?)

For the @since value, you can use $$next-version$$ as the value, it will be automatically replaced on release day:

Oh that's awesome, I didn't know about $$next-version$$! TIL!! 🙌

grzegorz-cp

Looks good. I was able to see the JITM a few times but not constantly, so this might be an issue with my testing.

jeherve · 2025-01-28T15:16:22Z

projects/packages/jitm/src/class-jitm.php

+		$date_now   = new \DateTime();
+		$feb_4_date = new \DateTime( '02-04-2025' );


would you mind checking/reviewing my code changes using wp_timezone()?

You should be able to pass the timezone directly as you build the date object:

$feb_4_date = new \DateTime( '02-04-2025', wp_timezone() );

elliottprogrammer added 2 commits January 25, 2025 10:29

Update the WooCommerce logo in JITMs (display after Feb 4, 2025).

87e36c9

changelog

7b79a4c

elliottprogrammer self-assigned this Jan 25, 2025

github-actions bot added the [Package] Jitm label Jan 25, 2025

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 Jan 25, 2025

Fix DateTime & apply filter hook for showing old/new logo.

988af22

elliottprogrammer requested a review from a team January 26, 2025 12:29

elliottprogrammer added [Status] Needs Team Review 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 Jan 26, 2025

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 Jan 26, 2025

jeherve reviewed Jan 27, 2025

View reviewed changes

elliottprogrammer added 2 commits January 28, 2025 09:06

Use 'jetpack_jitm' prefix and add docblock on use_new_woo_logo filter.

7b78f7b

Utilize wp_timezone when checking the Feb 4th date.

c713acf

elliottprogrammer added 3 commits January 28, 2025 09:45

Merge branch 'trunk' into update/woo-jitm-logo

9cb6a9c

Remove use of 'wp_timezone()'.

4339dc4

re-add 'wp_timezone()' and mock in php unit test.

cd6ac2f

github-actions bot added the [Tests] Includes Tests label Jan 28, 2025

elliottprogrammer requested a review from jeherve January 28, 2025 15:52

elliottprogrammer added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. 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 Jan 28, 2025

github-actions bot added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jan 28, 2025

grzegorz-cp approved these changes Jan 28, 2025

View reviewed changes

jeherve approved these changes Jan 29, 2025

View reviewed changes

jeherve 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! [Status] Needs Team Review labels Jan 29, 2025

jeherve added the [Status] Ready to Merge Go ahead, you can push that green button! label Jan 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JITM Package: Update the WooCommerce logo in JITMs (display after Feb 4). #41322

JITM Package: Update the WooCommerce logo in JITMs (display after Feb 4). #41322

elliottprogrammer commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

jeherve Jan 27, 2025

jeherve Jan 27, 2025

elliottprogrammer Jan 28, 2025

KokkieH Jan 28, 2025

jeherve Jan 28, 2025

elliottprogrammer commented Jan 28, 2025 •

edited

Loading

grzegorz-cp left a comment

jeherve Jan 28, 2025

	### Package Version Annotations

	When needing to add a package version number inside a DocBlock, please use `$$next-version$$` as such:

	- `@since $$next-version$$`
	- `@deprecated $$next-version$$`
	- `@deprecated since $$next-version$$`
	- `_deprecated_function( __METHOD__, 'package-$$next-version$$' );` (other WordPress deprecation functions also work, but note it must be all on one line).

	The `$$next-version$$` specifier will be automatically replaced with the correct package version number the next time a new version of that package is released.

		$date_now = new \DateTime();
		$feb_4_date = new \DateTime( '02-04-2025' );

JITM Package: Update the WooCommerce logo in JITMs (display after Feb 4). #41322

Are you sure you want to change the base?

JITM Package: Update the WooCommerce logo in JITMs (display after Feb 4). #41322

Conversation

elliottprogrammer commented Jan 25, 2025 • edited Loading

Screenshots:

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 Jan 25, 2025 • edited Loading

github-actions bot commented Jan 25, 2025 • edited Loading

jeherve Jan 27, 2025

Choose a reason for hiding this comment

jeherve Jan 27, 2025

Choose a reason for hiding this comment

elliottprogrammer Jan 28, 2025

Choose a reason for hiding this comment

KokkieH Jan 28, 2025

Choose a reason for hiding this comment

jeherve Jan 28, 2025

Choose a reason for hiding this comment

elliottprogrammer commented Jan 28, 2025 • edited Loading

grzegorz-cp left a comment

Choose a reason for hiding this comment

jeherve Jan 28, 2025

Choose a reason for hiding this comment

elliottprogrammer commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

github-actions bot commented Jan 25, 2025 •

edited

Loading

elliottprogrammer commented Jan 28, 2025 •

edited

Loading