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: split component disabled prop #40210

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from

Conversation

CGastrell
Copy link
Contributor

@CGastrell CGastrell commented Nov 15, 2024

The AiModalPromptInput has a single disabled prop to control both the action button and the input. When the post is empty (no title, no content), the Featured Image generator not only disables the action button, but also the prompt input. While it remains an edge case (generating a Featured Image for an empty post) there is no reason we should not allow for a user to generate a featured image on such conditions.

Proposed changes:

This PR adds a secondary actionDisabled prop to control them separately.
For this, it moves all the prompt state logic to the tip of the component tree, removing secondary (and likely contradictory) logic on the shared component AiModalPromptInput.

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

#40198 (review)

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

No

Testing instructions:

Generator modals (Logo AI generator, General Image AI generator, Featured Image AI generator) should remain usable, open each and confirm enabling/disabling conditions for both input and action button. Generate some image to confirm functionality with both prompt and contextual data.

Empty post (no title, no content) (worth noting, logo block and image block don't count as content):

  • All modals: should enable the action button as soon as the prompt has more than 3 characters
  • Featured image modal should not auto-start generating an mage
  • Input should be enabled at all times (except when generating)

Post with content (title and/or text blocks):

  • Logo and General image modals should enable the action button as soon as the prompt has more than 3 characters
  • Featured image modal should auto-start generating. When done, a revised prompt derived from the post content should be set
  • Featured image modal should NOT disable the action button when prompt is empty (allow for generation based on post content/title)
  • Input should be enabled at all times (except when generating)

@CGastrell CGastrell added [Status] Needs Team Review [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [JS Package] AI Client labels Nov 15, 2024
@CGastrell CGastrell requested a review from a team November 15, 2024 18:26
@CGastrell CGastrell self-assigned this Nov 15, 2024
Copy link
Contributor

github-actions bot commented Nov 15, 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 add/jetpack-ai-prompt-input-disabled-prop branch.

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

    bin/jetpack-downloader test jetpack add/jetpack-ai-prompt-input-disabled-prop
    

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 none scheduled (scheduled code freeze on undefined).

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. Nice change!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants