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 Proofread: Change Breve request endpoint #38149

Merged
merged 4 commits into from
Jul 2, 2024
Merged

AI Proofread: Change Breve request endpoint #38149

merged 4 commits into from
Jul 2, 2024

Conversation

dhasilva
Copy link
Contributor

@dhasilva dhasilva commented Jul 2, 2024

Fixes #38043

Proposed changes:

  • Removes the API key input
  • Uses Jetpack AI's useAiSuggestions hook instead
  • Fixes an issue where the grading score would say "Infinity" when there is no text other than whitespace

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 Breve
  • Open the Jetpack sidebar (post sidebar has a known bug)
  • Check that there is no input for the OpenAI key anymore
  • Check that "fix with AI" is always on if requireUpgrade is false
  • Check that clicking on "Fix with AI" sends a request through the Jetpack AI hook (you can see the stream in the console with debug on)
  • Check that the text is fixed as expected

Note: Requests are still not deducted on the frontend, but should change the backend value

@dhasilva dhasilva requested a review from a team July 2, 2024 00:29
@dhasilva dhasilva self-assigned this Jul 2, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 2, 2024 •
edited
Loading

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-breve-endpoint branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-breve-endpoint

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 [Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jul 2, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 2, 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 August 6, 2024 (scheduled code freeze on July 29, 2024).

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

CGastrell
CGastrell previously approved these changes Jul 2, 2024
View reviewed changes
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.

LGTM! The change looks fine and works as described.

Annoying bug though: if JP sidebar is open (hence, Breve's highlighter is on) you can't use an AI assistant block (you can, but you can't type more than 1 char). Same is true when the post settings sidebar is viewable, effectively enabling Breve's highlighter. In both cases, disabling the highlighter's toggle fixes the issue

renatoagds
renatoagds previously approved these changes Jul 2, 2024
View reviewed changes
Copy link
Contributor

@renatoagds renatoagds left a comment

Choose a reason for hiding this comment

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

LGTM

@renatoagds renatoagds dismissed stale reviews from CGastrell and themself via b08fcba July 2, 2024 16:58
@renatoagds renatoagds force-pushed the update/jetpack-ai-breve-endpoint branch from b08fcba to ae620f3 Compare July 2, 2024 16:59
@renatoagds renatoagds merged commit 22c6a44 into trunk Jul 2, 2024
110 checks passed
@renatoagds renatoagds deleted the update/jetpack-ai-breve-endpoint branch July 2, 2024 17:13
@github-actions github-actions bot added this to the jetpack/13.5.1 milestone Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@renatoagds renatoagds renatoagds approved these changes

@CGastrell CGastrell CGastrell left review comments

Assignees

@dhasilva dhasilva

Labels
[Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Milestone
jetpack/13.5.1
Development

Successfully merging this pull request may close these issues.

AI Assistant: Change Breve to work with Jetpack AI endpoint
3 participants
@dhasilva @CGastrell @renatoagds