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

Title Optimization: improve button behavior on error screen #39554

Merged
merged 3 commits into from
Sep 27, 2024

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented Sep 26, 2024

Fixes p8oabR-1Af-p2#comment-8236.

Proposed changes:

  • Properly clean error state when closing the modal or clicking the "Cancel" button; this is necessary so the user can get rid of the error message and start again when closing the modal and opening it again
  • Improve how we handle the "Try again" button:
    • when there are old options to show, simply show them and let the user request a new generation (with keywords or not)
    • when there are no old options (the error happened before the first 3 got generated), then try the generation again (may help solve transient errors)

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?

Testing instructions:

First, let's simulate an error after the first 3 suggestions

  • Go to the block editor and add some content to it
  • On the Jetpack sidebar, look for the "Improve title for SEO" button and click it
  • After the modal shows the suggestions, type some random keywords on the keyword field (example: "pwoieopqweiqopweiq") and request a new generation
  • You should see the "Unclear request" error message:
Screenshot 2024-09-26 at 17 15 26
  • Click the "Try again" button and:
    • confirm you see the old suggestions
    • confirm you are able to type new keywords and request a new generation
  • Type another random keyword and click "Generate again" to get to the error UI once more
  • On the error UI, click "Cancel"
  • This will close the modal and clean up the tool state
  • Go to the sidebar and click "Improve title for SEO" again
  • Confirm a new generation starts and you see 3 new suggestions

Now let's simulate an error before the first generation.

  • Close the modal and set the connection throttling setting of your browser to "Offline"
  • Click the "Improve title for SEO" button on the Jetpack sidebar
  • You will see another error message:
Screenshot 2024-09-26 at 17 55 01
  • Click "Try again"
  • This time, since there is no previous suggestions to show, the tool will try the generation another time
  • Since you are still offline, you will see the error again
  • Change the throttling setting to be back online
  • Click "Try again"
  • Confirm the tool will properly start a new generation and show 3 new suggestion for you
Screenshot 2024-09-26 at 17 55 09

@lhkowalski lhkowalski added [Status] In Progress [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Extension] AI Assistant Plugin labels Sep 26, 2024
@lhkowalski lhkowalski requested a review from a team September 26, 2024 20:41
@lhkowalski lhkowalski self-assigned this Sep 26, 2024
Copy link
Contributor

github-actions bot commented Sep 26, 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/jetpack-ai-reset-error-on-title-optimization branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-reset-error-on-title-optimization
    

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

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.


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 October 1, 2024 (scheduled code freeze on September 30, 2024).

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

Copy link
Contributor

@CGastrell CGastrell left a comment

Choose a reason for hiding this comment

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

Works great! Thanks for addressing these! :shipit:

@lhkowalski lhkowalski merged commit b1f867e into trunk Sep 27, 2024
61 checks passed
@lhkowalski lhkowalski deleted the update/jetpack-ai-reset-error-on-title-optimization branch September 27, 2024 17:54
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants