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

Help Center: extend post fetch endpoint #38445

Merged
merged 2 commits into from
Jul 30, 2024

Conversation

arcangelini
Copy link
Contributor

@arcangelini arcangelini commented Jul 21, 2024

Proposed changes:

Adds the post_url arg to help-center/fetch-post endpoint.

This is part of a larger task to allow support guide links in Help Center open within Help Center.
PR for the main package ⇢ Automattic/wp-calypso#92745
PR for the main endpoint ⇢ D155970-code

Other information:

  • 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)?

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

Nope

Testing instructions:

This does not add any feature to test so really we are only testing to make sure the endpoint works and that Help Center does not break.

  1. Open the dev console in your browser.
  2. Open the Help Center and open a support guide.
  3. Search for a guide and open that as well.
  4. Go to the Network tab in your dev console and view the request for /fetch-post
  5. Copy this request as a fetch
  6. Paste this in the console and replace post_id and blog_id with post_url and the url of an article.
  7. All requests should return 200 with the correct article.
fetch("https://busineselini.wpcomstaging.com/wp-json/help-center/fetch-post?post_id=158974&blog_id=9619154&_locale=user", {
"headers": ...
  });
fetch("https://busineselini.wpcomstaging.com/wp-json/help-center/fetch-post?post_url=https://en.support.wordpress.com/getting-started-with-wordpress-com/&_locale=user", {
  "headers": ...
  });

@arcangelini arcangelini self-assigned this Jul 21, 2024
Copy link
Contributor

github-actions bot commented Jul 21, 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 update/help-center-post-enpoint 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-mu-wpcom-plugin update/help-center-post-enpoint
    

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

Copy link
Contributor

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

@arcangelini arcangelini marked this pull request as ready for review July 30, 2024 09:11
@arcangelini arcangelini added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jul 30, 2024
@arcangelini
Copy link
Contributor Author

I tested this in Simple and Atomic environments and everything seems to be A-OK.

Copy link
Contributor

@escapemanuele escapemanuele left a comment

Choose a reason for hiding this comment

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

This reflects the changes made to the endpoint 👍

Copy link
Contributor

@agrullon95 agrullon95 left a comment

Choose a reason for hiding this comment

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

Tested on atomic site and was able to retrieve the article related info via post_url + blog_id and post_url.

@arcangelini arcangelini merged commit d94211b into trunk Jul 30, 2024
58 of 59 checks passed
@arcangelini arcangelini deleted the update/help-center-post-enpoint branch July 30, 2024 10:01
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants