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.

Sign up for GitHub

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

Jump to bottom

Jetpack AI: use custom input placeholders on the Jetpack Form AI Extension #39482

Merged
merged 8 commits into from
Sep 23, 2024
Merged

Jetpack AI: use custom input placeholders on the Jetpack Form AI Extension #39482

merged 8 commits into from
Sep 23, 2024

Conversation

lhkowalski
Copy link
Contributor

@lhkowalski lhkowalski commented Sep 20, 2024 •
edited
Loading

Fixes #39439.

Proposed changes:

  • Support custom placeholders on the AI Assistant input component
  • Support custom placeholders on the Block Handler class
  • Add custom placeholders on the Jetpack Form Block Handler class, aware of the form block context, so we can switch between form creation and form edition placeholders

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:

  • There are two things to test:
    • the extension keeps working as before for all other blocks except the form block
    • the form block behavior is correct and appropriate

Let's start testing the extension behavior on all other blocks.

  • Ask the AI Assistant block to generate some sample content about a topic, including headings, paragaphs and lists
  • Test all the cases below:
    • paragraph block
    • list block
    • list item block
    • heading block
  • On all the cases, confirm:
    • the AI extension will load as expected
    • the placeholder is still Ask Jetpack AI to edit…
    • the placeholder of the quick actions is being set as expected (Example, Simplify for the respective action)

Now, let's test the new placeholder for the Jetpack Form block

  • Add a Jetpack Form block
  • Open the AI extension on it
  • Confirm you see a different placeholder, one of the following:
    • Example: a contact form with name, email, and message fields
    • Example: a pizza ordering form with name, address, phone number and toppings
    • Example: a survey form with multiple choice questions
    • the value is random, so when you close the extension and open it again, you may see a different value
  • Ask for a form and, when it is ready, check the placeholder on the extension
  • It will be one of the following:
    • Example: remove email field
    • Example: make email optional
    • Example: add message field and make it required
    • again, the value is random, so when you close the extension and open it again, you may see a different value
  • Confirm the examples and the behavior make sense

@lhkowalski lhkowalski added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Extension] AI Assistant labels Sep 20, 2024
@lhkowalski lhkowalski requested a review from a team September 20, 2024 18:50
@lhkowalski lhkowalski self-assigned this Sep 20, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 20, 2024 •
edited
Loading

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-custom-placeholders-on-form-extension branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-add-custom-placeholders-on-form-extension

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

@github-actions GitHub Actions
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.

@lhkowalski lhkowalski marked this pull request as ready for review September 20, 2024 19:18
dhasilva
dhasilva previously approved these changes Sep 20, 2024
View reviewed changes
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, works well!

@lhkowalski lhkowalski merged commit 2a290e3 into trunk Sep 23, 2024
57 checks passed
@lhkowalski lhkowalski deleted the update/jetpack-ai-add-custom-placeholders-on-form-extension branch September 23, 2024 15:41
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 23, 2024
anomiex added a commit to Automattic/wp-calypso that referenced this pull request Sep 23, 2024
@anomiex
e2e: Fix random Form AI placeholders
c94c035 
Automattic/jetpack#39482 changed the placeholder for the form AI
assistant. Update the test to match the different possible placeholders.
@anomiex anomiex mentioned this pull request Sep 23, 2024
Merged
7 tasks
anomiex added a commit to Automattic/wp-calypso that referenced this pull request Sep 23, 2024
@anomiex
e2e: Fix random Form AI placeholders (#94824)
9543efb 
Automattic/jetpack#39482 changed the placeholder for the form AI
assistant. Update the test to match the different possible placeholders.
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
@lhkowalski @dhasilva @gogdzl
Jetpack AI: use custom input placeholders on the Jetpack Form AI Exte…
da73f4d 
…nsion (#39482)

* Support custom placeholder getter on the BlockHandler class

* Implement a custom placeholder getter for the Jetpack Form block handler

* Expose the custom placeholder getter on the block handler getter

* Support custom placeholder prop on the AI Assistant Input component

* Provide the custom placeholder to the AI Assistant input, when it exists

* Changelog

* Rename custom placeholder method to refer to the extension input

* Use null instead of undefined as the prop when a custom placeholder is not set

Co-authored-by: Douglas Henri <[email protected]>

---------

Co-authored-by: Douglas Henri <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhasilva dhasilva dhasilva approved these changes

Assignees

@lhkowalski lhkowalski

Labels
[Block] AI Assistant [Extension] AI Assistant [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Milestone
jetpack/13.9
Development

Successfully merging this pull request may close these issues.

Missing a clearer distinction between creating and editing forms
2 participants
@lhkowalski @dhasilva