jetpack icon indicating copy to clipboard operation
jetpack copied to clipboard

AI Client: make fetch error retry optional

Open CGastrell opened this issue 1 year ago • 2 comments

Related to #39846

Proposed changes:

This PR will turn onReload prop to optional as we cancel the handler from Jetpack AI.

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

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

No

Testing instructions:

Sandbox the public API, but don't connect to the sandbox so the fetch for AI feature fails. Insert a logo generator on the editor and use the AI toolbar button to open the generator modal.

See the error notice modal doesn't offer a "Try again" button and the instructions state to reload the page as opposed to use the "Try again" button.

Then connect to sandbox to get actual responses from the endpoint. No need to reload, you can call wp.data.dispatch('jetpack-ai/logo-generator').fetchAiAssistantFeature() and the component should update (maybe close and re-open modal between fetch calls).

Try different plans/cases and open and close the modal to confirm it's consistent. You can use this snippet p1729593811040589-slack-C02TQF5VAJD and call

CGastrell avatar Oct 21 '24 13:10 CGastrell

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-fetch-error-retry-optional branch.

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

    bin/jetpack-downloader test jetpack change/jetpack-ai-fetch-error-retry-optional
    

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] avatar Oct 21 '24 13:10 github-actions[bot]

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:

  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 November 5, 2024 (scheduled code freeze on November 4, 2024).

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

github-actions[bot] avatar Oct 21 '24 13:10 github-actions[bot]