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: Add fair usage message on Extension AI Control #39103

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented Aug 27, 2024

Proposed changes:

  • Create a simple FairUsageLimitMessage component on the AI Client package
  • Show the FairUsageLimitMessage on the Extension AI Control component when the site has an unlimited plan but was flagged as requiring upgrade (the rule we created to simplify things, as per pe4Cmx-2FY-p2)

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:

  • Run this branch on your testing site
  • Sandbox the public-api domain and change the 0-sandbox.php file to add the following filters, so we simulate an unlimited plan over the fair usage limit:
add_filter( 'jetpack_ai_tier_licensed_quantity', function() { return 1; } );
add_filter( 'jetpack_ai_current_period_requests_count', function() { return 3001; } );
  • Go to the block editor and add some text to a paragraph
  • Look for the AI extension on the paragraph and click it to open the AI Control component
  • Confirm you see the component with the fair usage message under it, containing a link to the fair usage policy (actually, a Jetpack redirect link still not pointing to a final page) and yellow background:
Screenshot 2024-08-27 at 17 04 44
  • Confirm also that the extension is disabled, so you can't use it
  • Confirm that clicking some of the quick actions on the extension menu will aslo trigger the AI Control component, disabled and with the fair usage message under it
  • Bonus points for inserting a form block and confirming the AI extension there is also triggered disabled and with the yellow fair usage message under it
Screenshot 2024-08-27 at 17 05 13
  • Confirm the UI you see matches the proposed design from p1HpG7-tUE-p2
  • Go back to the 0-sandbox.php file and change the filters to:

add_filter( 'jetpack_ai_tier_licensed_quantity', function() { return 1; } );
add_filter( 'jetpack_ai_current_period_requests_count', function() { return 2900; } );
  • Confirm the fair usage messages are gone on the AI Assistant extension, that it now shows the guidelines message and is enabled for use

@lhkowalski lhkowalski added [Status] In Progress [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [JS Package] AI Client labels Aug 27, 2024
@lhkowalski lhkowalski requested a review from a team August 27, 2024 20:04
@lhkowalski lhkowalski self-assigned this Aug 27, 2024
Copy link
Contributor

github-actions bot commented Aug 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-add-fair-usage-message-on-extension-ai-control branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-add-fair-usage-message-on-extension-ai-control
    

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 daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for September 3, 2024 (scheduled code freeze on September 2, 2024).

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

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

@lhkowalski lhkowalski merged commit f22c8d7 into trunk Aug 27, 2024
61 checks passed
@lhkowalski lhkowalski deleted the update/jetpack-ai-add-fair-usage-message-on-extension-ai-control branch August 27, 2024 21:15
@github-actions github-actions bot added this to the jetpack/13.8 milestone Aug 27, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Add first draft of fair usage message

* Remove ugly period

* Use warning severity for the fair usage limit message

* Show the fair usage message on the extension AI control when an unlimited site is flagged as requireUpgrade

* Update user story about the ai control component

* changelog

* Changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] AI Assistant [JS Package] AI Client [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ RNA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants