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 thumbs up/down component to AI logo generator #40610

Merged
merged 10 commits into from
Dec 20, 2024

Conversation

mwatson
Copy link
Contributor

@mwatson mwatson commented Dec 13, 2024

Fixes #40572
Fixes #40611

Proposed changes:

  • Adds the thumbs up/thumbs down rating component to the logo generator

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

Slack thread about some limitations: p1734103605310639-slack-C054LN8RNVA
PS with designs: p1HpG7-uzm-p2

Does this pull request change what data or activity we track or use?

Nope

Testing instructions:

  • Check out the branch and rebuild as usual
  • Create a new post, insert a logo block, and use the AI logo generator to generate a new logo or browse your existing logos
  • Verify that there are no thumbs next to the "Use on block" button
  • Enable the feature:
define( 'JETPACK_BLOCKS_VARIATION', 'beta' );
add_filter( 'ai_response_feedback_enabled', '__return_true' );
  • Reload your post and open the logo generator again
  • Verify that a thumbs up/down appears next to the "Use on block" button
  • You should be able to click on the thumbs up or down and observe that the thumb changes color
  • Viewing other logos you have should show their rating (which will likely be no rating), and if you go back to a logo you already rated the same rating should be present.
  • Additionally: when you click the thumbs up or down you should be able to observe Tracks events that submit the rating, blog ID, and a type parameter that should be logo-generator
  • You can enter localStorage.setItem('debug', '*') in the console to see the above events
  • Check that ratings are persisted after reload

Screenshot

Screenshot 2024-12-13 at 1 56 31 PM

Copy link
Contributor

github-actions bot commented Dec 13, 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 change/jetpack-ai-rate-logo-generator branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack change/jetpack-ai-rate-logo-generator
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin change/jetpack-ai-rate-logo-generator
    

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 Dec 13, 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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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 semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for January 7, 2025 (scheduled code freeze on undefined).

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

@mwatson mwatson requested a review from a team December 13, 2024 18:59
@github-actions github-actions bot added [Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Dec 13, 2024
@dhasilva dhasilva force-pushed the change/jetpack-ai-rate-logo-generator branch from 9fe000c to 1950287 Compare December 20, 2024 00:21
@dhasilva dhasilva self-assigned this Dec 20, 2024
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.

"Mostly" works. Implementation is good, thanks for moving the files to the ai-client package.

Feedback works, they send out the events and the logos change color to reflect the feedback sent. However, if you navigate to another logo and go back to one you've sent feedback already, the feedback is not reflected. Reloading, hence loading again from localStorage, fixes it. The rated feedback is stored on the localstorage stash, but it's only loaded on first modal open and then never refreshed?

Nit: add the logo media library ID to the event props and maybe also the prompt used to generate the logo (as mentioned by @ederrengifo )

@dhasilva dhasilva force-pushed the change/jetpack-ai-rate-logo-generator branch from 1950287 to 691c09a Compare December 20, 2024 18:42
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.

Looking good! Working nicely! :shipit:

@dhasilva dhasilva merged commit fc13aac into trunk Dec 20, 2024
75 checks passed
@dhasilva dhasilva deleted the change/jetpack-ai-rate-logo-generator branch December 20, 2024 20:34
@github-actions github-actions bot added this to the jetpack/14.2 milestone Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants