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.

Sign up for GitHub

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

Jump to bottom

AI Assistant: Add events to inline extensions #37297

Merged
merged 6 commits into from May 9, 2024
Merged

AI Assistant: Add events to inline extensions #37297

merged 6 commits into from May 9, 2024

Conversation

dhasilva
Copy link
Contributor

@dhasilva dhasilva commented May 8, 2024 •
edited

Fixes #37294
Fixes #37296

Proposed changes:

  • Adds events to toolbar and input actions
  • Extracts code from the extension to the input component for localized computation
  • Checks for block extension availability only once
  • Memoize values and functions for performance enhancement

The events are:

On toolbar:

  • jetpack_ai_assistant_extension_toolbar_menu_show when the AI menu is opened.
  • jetpack_editor_ai_assistant_extension_toolbar_prompt_show when "Ask AI Assistant" is clicked. [NEW]
  • jetpack_editor_ai_assistant_extension_toolbar_button_click when a toolbar suggestion is clicked (like change tone).

On input:

  • jetpack_ai_upgrade_button on upgrade.
  • jetpack_ai_assistant_try_again when the "Try again" button is clicked. [NEW]
  • jetpack_ai_assistant_undo when the undo icon is clicked [NEW]
  • jetpack_ai_assistant_extension_stop when the "Stop" button is clicked on an inline extension [NEW]
  • jetpack_ai_assistant_extension_generate when the "Generate" button is clicked on an inline extension [NEW]

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 inline extensions (instructions)
  • Enable the debug messages with localStorage.setItem( 'debug', '*' ); and reload the editor page
  • Add a Heading with some content
  • Use the extension with manual and suggested actions
  • Check the debug messages in the console. The events must match the list above.
  • Create an AI Assistant block
  • Send a request on the block
  • Check that the requests count is updated correctly

@dhasilva dhasilva requested a review from a team May 8, 2024 23:42
@dhasilva dhasilva self-assigned this May 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 8, 2024 •
edited

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-inline-extensions-events branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-inline-extensions-events

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 github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label May 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 8, 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 June 4, 2024 (scheduled code freeze on June 3, 2024).

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

vianasw
vianasw approved these changes May 9, 2024
View reviewed changes
Copy link
Contributor

@vianasw vianasw left a comment •
edited

Choose a reason for hiding this comment

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

The code seems fine. I tested it following the instructions, and everything checked out. There was only one weird behavior where the upgrade message under the input disappeared and appeared again. It happened when I had an assistant block also opened and the heading assistant extension. I was able to reproduce it, but I think it's something we can address in another PR.

...ack/extensions/blocks/ai-assistant/inline-extensions/components/ai-assistant-input/index.tsx
currentTier,
} = useAiFeature();

const disabled = useMemo(
Copy link
Contributor

Choose a reason for hiding this comment

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

The calculation you're memorizing isn't particularly costly, right? I'm not sure if it's a premature optimization but I guess you're being extra cautious just in case.

@dhasilva dhasilva merged commit e4b1a32 into trunk May 9, 2024
56 checks passed
@dhasilva dhasilva deleted the update/jetpack-ai-inline-extensions-events branch May 9, 2024 14:14
@github-actions github-actions bot added this to the jetpack/13.5 milestone May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vianasw vianasw vianasw approved these changes

Assignees

@dhasilva dhasilva

Labels
[Block] AI Assistant [Extension] AI Assistant [JS Package] AI Client [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ RNA
Projects
None yet
Milestone
jetpack/13.5
Development

Successfully merging this pull request may close these issues.

AI Assistant: Implement Heading inline extension AI Assistant: Add events to inline extensions
2 participants
@dhasilva @vianasw