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

Fix block exception throw in Site Editor #33350

Merged
merged 2 commits into from
Sep 28, 2023

Conversation

monsieur-z
Copy link
Contributor

@monsieur-z monsieur-z commented Sep 27, 2023

Fixes Automattic/wp-calypso#82023

Proposed changes:

Some recently refactored blocks (Business Hours and beta blocks) caused the following exception to be thrown in the site editor.
Screenshot 2023-09-27 at 9 29 37 AM

In the refactoring, moving the title from the settings argument passed to registerJetpackBlock to a block.json metadata file caused the title to be undefined in the callback of the blocks.registerBlockType filter hook. This PR fixes this by adding guards in the callback to prevent undefined settings from calling methods.

While this prevents the above exception, the The block "jetpack/block-name" must have a title. errors can be seen in the console. However, this doesn't seem to affect how blocks are rendered and behave, and blocks can be searched by their name in the block inserter.

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

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

No.

Testing instructions:

  • Spin up a test site with this branch.
  • Visit wp-admin/site-editor.php?canvas=edit.
  • The above exception should not be thrown anymore.
  • The following blocks should behave as expected: Business Hours, AI Chat, Amazon, Blogroll, Google Docs Embed (Google Docs, Google Sheets, and Google Slides), Recipe, Create with Voice.

@monsieur-z monsieur-z added [Status] In Progress [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack labels Sep 27, 2023
@monsieur-z monsieur-z self-assigned this Sep 27, 2023
@github-actions github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Sep 27, 2023
@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.


Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

  • Next scheduled release: October 10, 2023.
  • Scheduled code freeze: October 9, 2023.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 27, 2023

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 > Jetpack and enable the fix/blocks-site-editor-exception branch.

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

    bin/jetpack-downloader test jetpack fix/blocks-site-editor-exception
    

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

@fullofcaffeine
Copy link
Contributor

fullofcaffeine commented Sep 27, 2023

Not urgent as I know this is supposed to be a hotfix! However, if you could update the description later to better explain why this happened and how it's is being solved, it'd be great :)

Thank you!

@monsieur-z monsieur-z force-pushed the fix/blocks-site-editor-exception branch from 5e384a1 to 576527c Compare September 28, 2023 01:49
Copy link
Contributor

@andrii-lysenko andrii-lysenko left a comment

Choose a reason for hiding this comment

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

Due to some technical issues I can't check it locally, however, changes look reasonable to me. Just to unblock I'm approving this PR, but if it waits until some time tomorrow, it could be additionally tested...

@monsieur-z monsieur-z merged commit c68c82c into trunk Sep 28, 2023
54 checks passed
@monsieur-z monsieur-z deleted the fix/blocks-site-editor-exception branch September 28, 2023 13:05
@github-actions github-actions bot added this to the jetpack/12.7 milestone Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Gutenberg 16.7 RC: blank templates with only Pattern Placeholder in the block structure
3 participants