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: Update sidebar fair usage messaging #39122

Merged

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented Aug 28, 2024

Proposed changes:

  • Move the AI Assistant sidebar fair usage message up, at the top of the sidebar
  • Add fair usage message to the AI Assistant block inspector (design proposed it over the block description, but I think we can only show it under the description, so I proceeded this way)
  • Change sidebar fair usage message style to a "muted" version (plan text, greyed style), as per proposed design
  • Fix the colors of the links on the fair usage message so they follow the same color as the text around them

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

p1HpG7-tUE-p2

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; } );
  • On all test cases below, confirm the UI you see matches the proposed design from p1HpG7-tUE-p2 and the links on the messages are using the same color of the text
  • Go to the block editor
  • Confirm the fair usage message is showing correctly on the Jetpack sidebar and the post sidebar, following the proposed design:
Screenshot 2024-08-28 at 13 52 56
  • Add an AI Assistant block
  • Confirm the fair usage message is showing correctly on block inspector, following the proposed design:
Screenshot 2024-08-28 at 13 53 12
  • Now let's confirm the link colors on already existing messages
  • Add an image block and click the "Generate with AI" button; confirm the link on the fair usage limit message is in the same color as the message text:
Screenshot 2024-08-28 at 13 52 08
  • Add an AI Assistant block; confirm the link on the fair usage limit message above it is in the same color as the message text
Screenshot 2024-08-28 at 13 52 00
  • Go to the post settings sidebar and look for the excerpt tool; confirm the link on the fair usage limit message is in the same color as the message text
Screenshot 2024-08-28 at 13 52 26
  • 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

@lhkowalski lhkowalski requested a review from a team August 28, 2024 15:40
@lhkowalski lhkowalski self-assigned this Aug 28, 2024
@lhkowalski lhkowalski added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Block] AI Assistant [Extension] AI Assistant Plugin labels Aug 28, 2024
Copy link
Contributor

github-actions bot commented Aug 28, 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-update-sidebar-fair-usage-messaging branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-update-sidebar-fair-usage-messaging
    

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.

@lhkowalski lhkowalski marked this pull request as ready for review August 28, 2024 17:00
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 6f04b20 into trunk Aug 28, 2024
62 of 63 checks passed
@lhkowalski lhkowalski deleted the update/jetpack-ai-update-sidebar-fair-usage-messaging branch August 28, 2024 18:07
@github-actions github-actions bot added this to the jetpack/13.8 milestone Aug 28, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Export the FairUsageNotice so we can use it outside the QuotaExceeded component logic

* Rename flag to make clear it is used for the fair usage notice

* Change position of fair usage notice on the sidebar, moving to top

* Add fair usage notice on the AI Assistant block inspector

* Add muted variant to the fair usage notice

* Use muted variant of fair usage message on block inspector and sidebar

* Fix links colors to use the same color as the text

* Changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] AI Assistant [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