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: Only display "turn list into table" menu item for top level lists #40177

Merged
merged 4 commits into from
Nov 15, 2024

Conversation

mwatson
Copy link
Contributor

@mwatson mwatson commented Nov 13, 2024

Fixes #40137

Proposed changes:

  • Currently the "Turn List Into Table" menu item is displayed for sub-lists, however the transform action does not work for sub-lists (also it would cause us to insert a table into a list, which is illegal)
  • This removes that option in the drop down unless we are in the parent list

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

N/A but this was mentioned in the previous PR.

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

No

Testing instructions:

Once you've checked out the branch and built Jetpack, you will need to enable the feature via a snippet or similar means:

define( 'JETPACK_BLOCKS_VARIATION', 'beta' );
add_filter( 'list_to_table_transform_enabled', '__return_true' );

Once that's done, create a new post and create a list with multiple sub-lists, like so:

Screenshot 2024-11-13 at 5 22 24 PM

Validate:

  • Upon clicking the AI Assistant icon on the root list you should see an option in the dropdown that says "Turn list into a table"
  • If you click the AI Assistant icon at any other level of the list the option should not be present.

@mwatson mwatson requested a review from a team November 13, 2024 22:26
@mwatson mwatson self-assigned this Nov 13, 2024
Copy link
Contributor

github-actions bot commented Nov 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-list-to-table-top-level-only branch.

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

    bin/jetpack-downloader test jetpack change/jetpack-ai-list-to-table-top-level-only
    

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 bot added [Block] AI Assistant [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Nov 13, 2024
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.

disabled = false,
onAskAiAssistant,
onRequestSuggestion,
}: AiAssistantToolbarDropdownContentProps ): ReactElement {
const blockQuickActions = quickActionsList[ blockType ] ?? [];

const { getBlockParents } = select( 'core/block-editor' );
const blockParents = getBlockParents( clientId );
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The other option we can do is to always display the transform option and just find the root list and transform the entire thing every time, regardless of where they click AI Assistant.

Copy link
Contributor

Choose a reason for hiding this comment

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

This sounds interesting, do you think is doable without refactoring too much? Can we explore it? UX wise I think it'd be much more comfortable for the user

CGastrell
CGastrell previously approved these changes Nov 14, 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.

I like the idea of automating the trigger from root of list, but I'll leave it up for your consideration. Otherwise, this worked fine for me!

@mwatson mwatson force-pushed the change/jetpack-ai-list-to-table-top-level-only branch from ec01784 to eb1fd2d Compare November 14, 2024 15:17
@mwatson
Copy link
Contributor Author

mwatson commented Nov 14, 2024

Adding missing property to AiAssistantToolbarDropdownContentProps which I think will fix the JS tests issue. Going to see if I can make it so it always transforms the top level list as discussed. Will timebox it for a few hours just in case.

@CGastrell CGastrell self-requested a review November 15, 2024 13:21
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.

LGTM!

@mwatson mwatson merged commit 4053cca into trunk Nov 15, 2024
56 checks passed
@mwatson mwatson deleted the change/jetpack-ai-list-to-table-top-level-only branch November 15, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] AI Assistant [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.

Do not display "Turn List Into Table" item when we're not focused on the top level list
2 participants