Proposed changes:

increase the ai-assistant-feature response cache TTL
add a 10 second cache for error responses
increase JP Client's request timeout to 30 seconds

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

37936

TBD

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

No

Testing instructions:

Test using a local env and a sandboxed API. Apply the change to your sandbox:

bin/jetpack-downloader test jetpack change/jetpack-ai-feature-request-caching

Checkout this branch and build/watch on your local env.

Figure out the Jetpack working directory on your sandbox (sun/moon on wp-content/mu-plugins) and edit _inc/lib/class-jetpack-ai-helper.php.

Add a log on line 396 (right before the payload return): l( 'non-cached response' )

$upgrade_type = wpcom_is_vip( $blog_id ) ? 'vip' : 'default';
// HERE!
return array(

Add a log on line 422: l( 'cached response' )

if ( $cache ) {
  // HERE!
  return $cache;
}

Keep an eye on the logs on your sandbox: tail -f /tmp/php-errors.

Open your site and go to the editor, use the Network tab on devtools to see the request to ai-assistant-feature, but you should see already the log on your sandbox. Reload the editor page within a minute to get the "cached response" log. You should be able to repeat this after a minute has passed.

Force an error response by adding a false condition around line 446:

if ( 200 === $response_code ) { // turn this into if ( false && 200 === $response_code ) {

Reload the editor and check the request to verify you got a 200 error response, it should carry a ts property with a timestamp.

Here's the tricky part, as we only cache errors for 10 seconds. You either refresh very quickly or multiply the cache TTL for errors on line 464:

// add some multiplier to the last argument, say, * 3?
set_transient( $transient_name, $error, self::$ai_assistant_feature_error_cache_timeout );

If you're getting a cached error, the timestamp property will be the same and the sandbox should log "cached response". If cache TTL has passed, you'll get a new response.

github-actions[bot] commented 1 week ago

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 change/jetpack-ai-feature-request-caching branch.

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

bin/jetpack-downloader test jetpack change/jetpack-ai-feature-request-caching

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[bot] commented 1 week ago

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

:white_check_mark: Include a description of your PR changes.
:white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
:white_check_mark: Add testing instructions.
:white_check_mark: Specify whether this PR includes any changes to data or privacy.
:white_check_mark: 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 :robot:

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!

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 none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Automattic / jetpack