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

Jetpack AI Image: handle enter shortcut on user custom prompt field #38103

Merged
merged 10 commits into from
Jun 28, 2024

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented Jun 27, 2024

Closes #38102.

Proposed changes:

  • Add a <KeyboardShortcuts /> wrapper on the user custom prompt field to deal with enter hits
  • When the focus is inside the custom prompt field and the user hits enter, we trigger the image generation, unless there is no prompt typed on it (or no content on the post as well, when it's a featured image generation)
  • Rename some vars on the AiImageModal component so they read less like a function and more like the flags they re

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:

  • Enable the beta extensions, go to the block editor and add an image block
  • Click "Select Image" and then "Generate with AI" to open the image generation tool
  • Confirm the UI is showing as expected, with no buggy textareas or misalignements
  • Type something on the custom prompt field (example: "a giant cup of coffee") and then hit "enter"
  • Confirm the generation will start
  • Do the same check for the featured image generator
    • In this case, the "enter" shortcut will work when:
      • the post has content but the custom prompt is empty
      • the post is empty but the user typed a custom prompt
      • both the post and the custom prompt have content
    • It will not work when both the post and the custom prompt are empty (as expected)

@lhkowalski lhkowalski added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jun 27, 2024
@lhkowalski lhkowalski requested a review from a team June 27, 2024 21:28
@lhkowalski lhkowalski self-assigned this Jun 27, 2024
Copy link
Contributor

github-actions bot commented Jun 27, 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-image-handle-enter-shortcut branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-image-handle-enter-shortcut
    

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 Jun 27, 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.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for July 2, 2024 (scheduled code freeze on July 1, 2024).

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

@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 Jun 27, 2024
@lhkowalski lhkowalski added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jun 27, 2024
bindGlobal
shortcuts={ {
enter: () => {
if ( ! disableGenerateButton ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Unrelated to this PR:
disableGenerateButton reads like a function. I would suggest changing it to generateButtonDisabled. Same for the other variables.

Copy link
Contributor

@dhasilva dhasilva Jun 27, 2024

Choose a reason for hiding this comment

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

Pressing Enter once on a page with no content and no instructions do not trigger a generation, but it adds a newline, and then subsequent enters do trigger the generation.

My suggestion here is to consider the button disabled not only if there is no content, but also if there is only whitespace, as sending an empty request causes a 400 error.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed both your feedbacks, renaming some vars and also trimming the content of the user prompt so remove extra spaces on it, so a field with only new lines can't be submitted.

@lhkowalski lhkowalski requested a review from dhasilva June 28, 2024 14:36
Copy link
Contributor

@dhasilva dhasilva left a comment

Choose a reason for hiding this comment

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

LGTM. Nice!

@lhkowalski lhkowalski merged commit 6752a34 into trunk Jun 28, 2024
57 checks passed
@lhkowalski lhkowalski deleted the update/jetpack-ai-image-handle-enter-shortcut branch June 28, 2024 14:44
@github-actions github-actions bot added this to the jetpack/13.6 milestone Jun 28, 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
2 participants