Moving jetpack_is_mobile into a package #16129

dero · 2020-06-11T07:12:25Z

Needs tests.

Changes proposed in this Pull Request:

Moves jetpack_is_mobile into a separate package.

Is this a new feature or does it add/remove features to an existing part of Jetpack?

This is decoupling a feature from Jetpack.

Testing instructions:

Make sure jetpack_is_mobile is still usable and returns the same values as before.
Make sure Automattic\Jetpack\Mobile::is_mobile works.

Proposed changelog entry for your changes:

Move jetpack_is_mobile method into a separate package.

jetpackbot · 2020-06-11T07:14:45Z

	Warnings
⚠️	`pre-commit` hook was skipped for one or more commits
⚠️	The Privacy section is missing for this PR. Please specify whether this PR includes any changes to data or privacy.

This is an automated check which relies on PULL_REQUEST_TEMPLATE. We encourage you to follow that template as it helps Jetpack maintainers do their job. If you think 'Testing instructions' or 'Proposed changelog entry' are not needed for your PR - please explain why you think so. Thanks for cooperation 🤖

E2E results is available here (for debugging purposes): https://jetpack-e2e-dashboard.herokuapp.com/pr-16129

Generated by 🚫 dangerJS against b1f20eb

fgiannar

I was wondering if you could maybe explain the reasoning behind the decision to move jetpack_is_mobile into a package.
Is there maybe a discussion or a P2 about it so we can better understand it?
What mostly troubles me here is that jetpack_is_mobile is also widely used in WP.com so porting this change there could be an issue.
Furthermore, if we were to create a package, maybe it would make sense to have something more generic than Mobile, like User_Agent for example, since the functionality ported there is not necessarily mobile-specific.

dero · 2020-06-17T12:47:33Z

Is there maybe a discussion or a P2 about it so we can better understand it?

@fgiannar That's certainly a relevant concern, thank you for asking. @gravityrail should be able to provide more context. It's needed for an (yet) undisclosed A8C project.

gravityrail · 2020-06-17T13:54:13Z

We want to reuse this function in a separate project. If there's a better form for extracting it, let me know.

Master thread is pbIAo1-g-p2

gravityrail

Left a few comments, mostly around naming.

class.jetpack.php

composer.json

packages/mobile/README.md

gravityrail · 2020-06-17T14:55:06Z

Is there maybe a discussion or a P2 about it so we can better understand it?

There is not a public discussion, this is for a prototype. Beyond the p2 link above, we do have a ticket and project. Basically, the project wants to estimate the viewport size from the user agent. Jetpack's user agent detection is much richer and more reliable than core's so we wanted to have this as a shared package that we can reuse in our own plugin.

What mostly troubles me here is that jetpack_is_mobile is also widely used in WP.com so porting this change there could be an issue.

I share that concern. Let's leave a compatibility function in-place with the same name, that calls through to the package. That is an approach that we have used before.

…not verified]

dero · 2020-06-19T16:10:58Z

@gravityrail Could you please have another look?

jeherve

Some quick notes after a first review for me:

It seems you committed a package-lock.json in here. We don't need it so you can remove it I think 👍

Do you think you could look at the linting errors this brings up? We try to keep the /packages directory free of any errors. I realize a lot of those carry over from the old files, but I think it'd be nice to fix them instead of having to bypass the pre-commit hook every time we have to make changes to those files in the future.

packages/device-detection/src/class-device-detection.php

class.jetpack-user-agent.php

dero · 2020-06-22T18:20:22Z

Maybe we should keep the Jetpack_User_Agent_Info class around for a few more releases, with the methods that are still in use elsewhere, and in those add a deprecation message recommending the switch to the package, and then calling the matching method in the package.

Absolutely, thank you for checking, @jeherve – I will try to push the needed changes tomorrow.

…tpack into add/jetpack-mobile-package

dero · 2020-06-23T07:59:44Z

@jeherve Added Jetpack_User_Agent_Info back with deprecation notices in f74e9c9.

jeherve

Thanks a lot. I only have one comment left.

class.jetpack-user-agent.php

jeherve

This looks good to me. Merging this now.

Changes addressed

jeherve · 2020-06-25T12:31:01Z

automattic/jetpack-device-detection v1.0.0 is now available and can be used in other projects:
https://packagist.org/packages/automattic/jetpack-device-detection

jeherve · 2020-06-25T15:33:26Z

D45479-code: the package is now available on WordPress.com.
D45478-code: working on bringing the rest of the changes over.

dereksmart · 2020-07-07T19:46:41Z

class.jetpack-user-agent.php

+	 *
+	 * @return bool
+	 */
+	public function is_tablet() {


This change from static is throwing fatals for sites running the p2-breathe theme. https://wordpress.com/theme/p2-breathe

Follow-up: #16430

Moving jetpack_is_mobile into a package [not verified]

d1f5cd3

matticbot added the Touches WP.com Files label Jun 11, 2020

github-actions bot added the [Status] Needs Package Release This PR made changes to a package. Let's update that package now. label Jun 11, 2020

dero added 3 commits June 16, 2020 16:41

Add is_mobile tests [not verified]

797dbc1

Add tests for UA returned value [not verified]

99878a0

Update the class comment and is_mobile method comments. [not verified]

96545e4

dero self-assigned this Jun 16, 2020

dero marked this pull request as ready for review June 16, 2020 15:15

dero changed the title ~~[WIP] Moving jetpack_is_mobile into a package~~ Moving jetpack_is_mobile into a package Jun 16, 2020

dero added the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Jun 16, 2020

fgiannar reviewed Jun 17, 2020

View reviewed changes

fgiannar 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 Crew. Label will be renamed soon. labels Jun 17, 2020

gravityrail previously requested changes Jun 17, 2020

View reviewed changes

class.jetpack.php Outdated Show resolved Hide resolved

composer.json Outdated Show resolved Hide resolved

packages/mobile/README.md Outdated Show resolved Hide resolved

packages/mobile/README.md Outdated Show resolved Hide resolved

jeherve added the [Focus] Jetpack DNA label Jun 17, 2020

dero added 5 commits June 18, 2020 23:19

Rename Mobile package to Device Detection.

5ea57ae

Rename Mobile to Device_Detection, implement get_info, update tests […

4a9724d

…not verified]

Add shorthand methods, update tests. [not verified]

5b8bc41

Update Device_Detection package README.

2965e8d

Make User_Agent_Info park of Device_Detection package. [not verified]

6108e07

dero requested a review from georgestephanis as a code owner June 19, 2020 16:07

dero requested a review from gravityrail June 19, 2020 16:09

jeherve added this to the 8.7 milestone Jun 19, 2020

jeherve requested changes Jun 19, 2020

View reviewed changes

packages/device-detection/src/class-device-detection.php Show resolved Hide resolved

class.jetpack-user-agent.php Outdated Show resolved Hide resolved

class.jetpack-user-agent.php Outdated Show resolved Hide resolved

class.jetpack-user-agent.php Show resolved Hide resolved

Address CR feedback.

45a2fdd

dero added 2 commits June 23, 2020 09:50

Add the Jetpack_User_Agent_Info class back. Add deprecation notices.

f74e9c9

Merge branch 'add/jetpack-mobile-package' of github.com:Automattic/je…

86bc887

…tpack into add/jetpack-mobile-package

dero added [Status] Needs Review To request a review from Crew. 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 Jun 23, 2020

jeherve requested changes Jun 24, 2020

View reviewed changes

class.jetpack-user-agent.php Outdated Show resolved Hide resolved

jeherve 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 Crew. Label will be renamed soon. labels Jun 24, 2020

Use __METHOD__ instead of __FUNCTION__.

b1f20eb

dero added [Status] Needs Review To request a review from Crew. 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 Jun 25, 2020

jeherve approved these changes Jun 25, 2020

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Jun 25, 2020

jeherve merged commit a8aec09 into master Jun 25, 2020

jeherve deleted the add/jetpack-mobile-package branch June 25, 2020 12:27

matticbot added [Status] Needs Changelog and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Jun 25, 2020

jeherve added [Status] Needs Testing We need to add this change to the testing call for this month's release and removed [Status] Needs Package Release This PR made changes to a package. Let's update that package now. labels Jun 25, 2020

jeherve removed the [Status] Needs Changelog label Jun 29, 2020

dereksmart reviewed Jul 7, 2020

View reviewed changes

jeherve removed the [Status] Needs Testing We need to add this change to the testing call for this month's release label Apr 27, 2021

This was referenced Oct 18, 2022

De-Fusion: Custom CSS #25182

Closed

De-Fusion: Infinite Scroll #25195

Closed

jeherve mentioned this pull request Apr 29, 2024

Dara: move away from deprecated class Automattic/themes#7783

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moving jetpack_is_mobile into a package #16129

Moving jetpack_is_mobile into a package #16129

dero commented Jun 11, 2020 •

edited

Loading

jetpackbot commented Jun 11, 2020 •

edited

Loading

fgiannar left a comment

dero commented Jun 17, 2020

gravityrail commented Jun 17, 2020 •

edited

Loading

gravityrail left a comment

gravityrail commented Jun 17, 2020

dero commented Jun 19, 2020

jeherve left a comment

dero commented Jun 22, 2020

dero commented Jun 23, 2020

jeherve left a comment

jeherve left a comment

jeherve commented Jun 25, 2020

jeherve commented Jun 25, 2020

dereksmart Jul 7, 2020 •

edited

Loading

jeherve Jul 8, 2020

Moving jetpack_is_mobile into a package #16129

Moving jetpack_is_mobile into a package #16129

Conversation

dero commented Jun 11, 2020 • edited Loading

Changes proposed in this Pull Request:

Is this a new feature or does it add/remove features to an existing part of Jetpack?

Testing instructions:

Proposed changelog entry for your changes:

jetpackbot commented Jun 11, 2020 • edited Loading

fgiannar left a comment

Choose a reason for hiding this comment

dero commented Jun 17, 2020

gravityrail commented Jun 17, 2020 • edited Loading

gravityrail left a comment

Choose a reason for hiding this comment

gravityrail commented Jun 17, 2020

dero commented Jun 19, 2020

jeherve left a comment

Choose a reason for hiding this comment

dero commented Jun 22, 2020

dero commented Jun 23, 2020

jeherve left a comment

Choose a reason for hiding this comment

jeherve left a comment

Choose a reason for hiding this comment

jeherve commented Jun 25, 2020

jeherve commented Jun 25, 2020

dereksmart Jul 7, 2020 • edited Loading

Choose a reason for hiding this comment

jeherve Jul 8, 2020

Choose a reason for hiding this comment

dero commented Jun 11, 2020 •

edited

Loading

jetpackbot commented Jun 11, 2020 •

edited

Loading

gravityrail commented Jun 17, 2020 •

edited

Loading

dereksmart Jul 7, 2020 •

edited

Loading