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

Deprecate geo location module #41193

Merged
merged 5 commits into from
Jan 21, 2025
Merged

Conversation

monsieur-z
Copy link
Contributor

@monsieur-z monsieur-z commented Jan 20, 2025

Fixes https://github.com/Automattic/vulcan/issues/604

Proposed changes:

This PR removes the geolocation module from the Jetpack plugin and adds a deprecation warning for the Jetpack_Geo_Location class.

The feature enables users to tag posts with geolocation data (in Calypso) and include the information in RSS feeds, meta tags, and Geo microformat following post content.

Initially tackled in this PR: #40895. This PR keeps the includes to prevent potential fatals, as hinted here: #40895 (comment)

Given the scope of the feature, no deprecation warning is issued.

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

n/a

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

No.

Testing instructions:

Note: I haven't been able to tag posts with geolocation data in Calypso. Let's at least verify the PR doesn't break posts and that deprecation warnings are issued.

  • Spin up a Jetpack test site with this branch
  • Install and activate a theme that supports geo-location, such as Twenty Seventeen
  • Make sure you can see your server logs
  • Open your browser console
  • Create a new post, publish it, and visit the frontend
  • Check there's no errors in the console or the logs
  • Check that you can see the deprecate warning in the server logs
  • Install the Twenty Four theme
  • Notice you don't see the warnings

@monsieur-z monsieur-z self-assigned this Jan 20, 2025
Copy link
Contributor

github-actions bot commented Jan 20, 2025

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 remove/remove/jetpack-geo-location-2 branch.

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

    bin/jetpack-downloader test jetpack remove/remove/jetpack-geo-location-2
    

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] Geo Location [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Tests] Includes Tests labels Jan 20, 2025
Copy link
Contributor

github-actions bot commented Jan 20, 2025

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:

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

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


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on February 4, 2025).

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 Jan 20, 2025
public function sanitize_coordinate( $coordinate ) {
if ( ! $coordinate ) {
return null;
_deprecated_class( 'Jetpack_Geo_Location', '$$next-version', '' );
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Only show the deprecation warning if the theme supports the feature.

@monsieur-z monsieur-z requested a review from a team January 20, 2025 21:23
@monsieur-z monsieur-z marked this pull request as ready for review January 20, 2025 21:23
@monsieur-z monsieur-z added [Status] Needs Team Review and removed [Status] In Progress [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 20, 2025
@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 Jan 20, 2025
@monsieur-z monsieur-z added [Type] Task 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 20, 2025
Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

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

This tests well for me, just left a typo fix suggestion 👍

…o-location.php

Co-authored-by: Karen Attfield <karenlattfield@gmail.com>
@monsieur-z monsieur-z merged commit 47714da into trunk Jan 21, 2025
61 checks passed
@monsieur-z monsieur-z deleted the remove/remove/jetpack-geo-location-2 branch January 21, 2025 15:16
@github-actions github-actions bot added this to the jetpack/14.3 milestone Jan 21, 2025
coder-karen added a commit that referenced this pull request Jan 24, 2025
* Deprecate Jetpack geo location module

* changelog

* Prevent linting error

* Fix linting error

* Update projects/plugins/jetpack/modules/geo-location/class.jetpack-geo-location.php

Co-authored-by: Karen Attfield <karenlattfield@gmail.com>

---------

Co-authored-by: Karen Attfield <karenlattfield@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Geo Location [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests [Type] Task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants