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: Persist the Help Center open state and clean up Odie endpoints #41126

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from

Conversation

alshakero
Copy link
Member

@alshakero alshakero commented Jan 16, 2025

Fixes Automattic/wp-calypso#97919
Requires but can be merged before: Automattic/wp-calypso#98484

Proposed changes:

  • Adds a proxy endpoint to update user preferences with the Help Center open state.
  • Remove unused Odie's last ID preference.

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?

No.

Testing instructions:

  1. Sync to your Atomic dev site (jetpack rsync mu-wpcom-plugin wpcom-atomic:htdocs/wp-content/plugins/jetpack-mu-wpcom-plugin-dev).
  2. Test PR: Help Center: Persist the Help Center open state wp-calypso#98484

Copy link
Contributor

github-actions bot commented Jan 16, 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!

@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 16, 2025
Copy link
Contributor

github-actions bot commented Jan 16, 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 fix/help-center-open-state 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 fix/help-center-open-state
    

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

@alshakero alshakero marked this pull request as ready for review January 16, 2025 16:03
Comment on lines -188 to -256
/**
* Get chat_id and last_chat_id from user preferences.
*/
public function get_last_chat_id() {
// Forward the request body to the support chat endpoint.
$body = Client::wpcom_json_api_request_as_user(
'/me/preferences',
'2',
array( 'method' => 'GET' )
);

if ( is_wp_error( $body ) ) {
return $body;
}

$response = json_decode( wp_remote_retrieve_body( $body ) );

$projected_response = array(
'odie_chat_id' => $response->odie_chat_id,
'odie_last_chat_id' => $response->odie_last_chat_id ?? null,
);

return rest_ensure_response( $projected_response );
}

/**
* Set chat_id or last_chat_id from user preferences.
*
* @param \WP_REST_Request $request The request sent to the API.
*/
public function set_last_chat_id( \WP_REST_Request $request ) {
$chat_id = $request['odie_chat_id'];
$last_chat_id = $request['odie_last_chat_id'];

$data = array(
'calypso_preferences' => array(),
);

if ( $request->has_param( 'odie_chat_id' ) ) {
$data['calypso_preferences']['odie_chat_id'] = $chat_id;
}

if ( $request->has_param( 'odie_last_chat_id' ) ) {
$data['calypso_preferences']['odie_last_chat_id'] = $last_chat_id;
}

$body = Client::wpcom_json_api_request_as_user(
'/me/preferences',
'2',
array( 'method' => 'POST' ),
$data
);

if ( is_wp_error( $body ) ) {
return $body;
}

$response = json_decode( wp_remote_retrieve_body( $body ) );

$projected_response = array(
'calypso_preferences' => array(
'odie_chat_id' => $response->calypso_preferences->odie_chat_id,
'odie_last_chat_id' => $response->calypso_preferences->odie_last_chat_id,
),
);

return rest_ensure_response( $projected_response );
}

Copy link
Member Author

Choose a reason for hiding this comment

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

These aren't used anymore.

Comment on lines +52 to +71
public function get_state() {
// Forward the request body to the support chat endpoint.
$body = Client::wpcom_json_api_request_as_user(
'/me/preferences',
'2',
array( 'method' => 'GET' )
);

if ( is_wp_error( $body ) ) {
return $body;
}

$response = json_decode( wp_remote_retrieve_body( $body ) );

$projected_response = array(
'help_center_open' => (bool) $response->help_center_open,
);

return rest_ensure_response( $projected_response );
}
Copy link
Member Author

Choose a reason for hiding this comment

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

@sandymcfadden Hi! This is how you proxy a WPCOM endpoint and make it accessible to Atomic sites. Atomic sites can access this via

/wp-json/help-center/open-state

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[mu wpcom Feature] Help Center [Package] Jetpack mu wpcom WordPress.com Features [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!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help Center: Navigating wp-admin to Calypso closes the Help Center
1 participant