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: remove default style parameter from jetpack-ai-image requests #39494

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

CGastrell
Copy link
Contributor

Proposed changes:

Stop sending a default style parameter on image (featured and general) generation requests. The default is handled on backend and we'll need the parameter to be optional yet deliberate once we implement the styles.

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)?

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

No

Testing instructions:

Sandbox public-api.

Without checking out the branch, I recommend you trigger an image generation from our usual 3 spots:

  • logo block
  • image block
  • featured image sidebar

Then checkout the branch, build/watch both js-packages/ai-client and plugins/jetpack, then reload and repeat the 3 generation requests (same prompts).

Observe:

  • while non-deterministic, images should look similar between the 2 generations (meaning the lack of style parameter didn't change anything)
  • check the requests (jetpack-ai-image) payloads to see the style parameter is not present on the requests

@CGastrell CGastrell requested a review from a team September 23, 2024 15:34
@CGastrell CGastrell self-assigned this Sep 23, 2024
Copy link
Contributor

github-actions bot commented Sep 23, 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 remove/jetpack-ai-image-generator-style-parameter branch.

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

    bin/jetpack-downloader test jetpack remove/jetpack-ai-image-generator-style-parameter
    

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 semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for October 1, 2024 (scheduled code freeze on September 30, 2024).

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

Copy link
Contributor

@lhkowalski lhkowalski left a comment

Choose a reason for hiding this comment

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

Working as expected:

Feature Before After
Featured Image Screenshot 2024-09-23 at 12 53 44 Screenshot 2024-09-23 at 12 57 20
General Image Screenshot 2024-09-23 at 12 54 25 Screenshot 2024-09-23 at 12 57 59
Logo (style was not there in the first place) Screenshot 2024-09-23 at 12 55 43 Screenshot 2024-09-23 at 12 58 25

Did not notice any change on the quality/style of the generated images, so the backend is handling properly the default style.

@CGastrell CGastrell merged commit 469ba8e into trunk Sep 23, 2024
59 checks passed
@CGastrell CGastrell deleted the remove/jetpack-ai-image-generator-style-parameter branch September 23, 2024 16:04
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants