Validation issues with block.json in a few core blocks #35902

mkaz · 2021-10-24T14:53:41Z

What problem does this address?

When adding the schema definition to core blocks in #35900 it highlighted the following validation errors in a few core blocks.

I'm not sure if the issues are with the schema definition or invalid properties in the block.json each will need to be investigated, adding this ticket so they are not lost.

Button block - spacing - padding - horizontal - invalid value
Column block: templateLock - type missing
Cover block: templateLock - type missing
File block: viewScript - invalid property
Group block: templateLock - type missing
Navigation block: viewScript - invalid property
Post-Comment-content block - spacing - padding - horizontal - invalid value
Post-comments-form block - style - invalid type

gziolo · 2021-10-25T08:36:27Z

It looks like changes proposed in #35900 helped to find valid issues. I can confirm that templateLock is missing a type. @oandregal, can you help validate the reported violation for the Global Styles related support?

viewScript is a new property waiting to be included in WordPress 5.9 and it still needs to be documented. The work on it is being tracked in #33542. We need to include it in the block schema. It is documented in the REST API endpoint for the block type:
https://github.com/WordPress/wordpress-develop/blob/2238c302f9598b6f8f4ab0c27b175fd9ca7370fd/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php#L529-L535
also in the WP_Block_Type class:
https://github.com/WordPress/wordpress-develop/blob/2238c302f9598b6f8f4ab0c27b175fd9ca7370fd/src/wp-includes/class-wp-block-type.php#L174-L180

Let me also highlight again my question from #35843 (comment):

Out of curiosity, how much work it would be to keep the schema in Gutenberg repository, possibly inside @wordpress/blocks package (or we could create another one with schemas to include also theme.json) and sync it somehow to another place that we could use instead?

I love the idea of having a schema that could be used for validation and I'd be in favor of tighter integration into the existing tooling. One immediate idea for a follow-up for this PR would be to run block.json validation on scaffolded test block on CI as part of:

https://github.com/WordPress/gutenberg/blob/trunk/bin/test-create-block.sh

Now, that we plan to add schema to all core blocks, we could also create an integration test that would validate all block.json files against the schema.

gziolo · 2021-10-25T08:46:06Z

@ryanwelcher, this could be also useful to add the block.json schema to the blocks present in https://github.com/WordPress/gutenberg-examples.

ryanwelcher · 2021-10-25T12:52:56Z

@ryanwelcher, this could be also useful to add the block.json schema to the blocks present in https://github.com/WordPress/gutenberg-examples

The schema property was added with WordPress/gutenberg-examples#167 - thanks @mkaz !

mkaz · 2021-10-25T13:01:28Z

@gziolo I like the idea of having it internal to Gutenberg repo.
What do you recommend a "@wordpress/schemas" package?

We would also want to include the theme.json schema. We can mirror any changes to the SchemaStore URL so any old URLs would still work, plus get better exposure if people look there first,. But the master version would live in Gutenberg repo.

Also, in Gutenberg it would get automatic versioning with the tags/branches of each release,
Using a URL like one could validate against whatever version they were targeting:
https://github.com/WordPress/gutenberg/tree/wp/5.8/packages/schemas/block.json

gziolo · 2021-10-25T13:32:40Z

@gziolo I like the idea of having it internal to Gutenberg repo. What do you recommend a "@wordpress/schemas" package?

That's one of the options that could help with maintenance. There are also i18n related config files for block.json and theme.json that we could move there:
https://github.com/WordPress/gutenberg/blob/trunk/packages/blocks/src/api/i18n-block.json
https://github.com/WordPress/gutenberg/blob/trunk/lib/theme-i18n.json

Unless @mkaz or @ajlende know how to annotate the translatable fields directly in the schema definition 😄

ajlende · 2021-10-25T15:45:05Z

We could add custom fields to the schema file to indicate if the field is translatable or not. Some of the schemas in SchemaStore use a custom markdownDescription field (used by VS Code) that isn't part of the schema spec, so I'd expect that most validators would just ignore invalid values rather than halting.

oandregal · 2021-10-25T15:48:37Z

Button block - spacing - padding - horizontal - invalid value

Checked this one, which was added at #33859 and it appears that horizontal & vertical are proper values. Checked the PR to schemastore and those values are also there. Unfamiliar with the schemastore syntax but probably we'd need to update the schema to allow the existing values (see comment).

oandregal · 2021-10-25T15:49:46Z

Post-Comment-content block - spacing - padding - horizontal - invalid value

Same as button above.

ajlende · 2021-10-25T16:09:17Z

Button block - spacing - padding - horizontal - invalid value
Post-Comment-content block - spacing - padding - horizontal - invalid value

Fix in SchemaStore/schemastore#1903

ryanwelcher · 2021-10-25T17:56:27Z

I've also got a PR to address some items being moved into typopgraphy - SchemaStore/schemastore#1898

gziolo · 2021-11-02T11:44:25Z

Post-comments-form block - style - invalid type

We need to extend the schema to allow string and string[] for style and editorStyle. @aristath is it something we will land in WordPress 5.9 or is it the plugin for the time being?

gziolo · 2021-11-02T11:48:30Z

Column block: templateLock - type missing
Cover block: templateLock - type missing
Group block: templateLock - type missing

Fix in #36140

aristath · 2021-11-02T11:52:26Z

We need to extend the schema to allow string and string[] for style and editorStyle. @aristath is it something we will land in WordPress 5.9 or is it the plugin for the time being?

AFAIK this will land in 5.9 👍

gziolo · 2021-11-03T13:14:34Z

I opened #36175 to add viewScript in schema and docs to the Gutenberg repo.

gziolo · 2021-11-04T07:21:13Z

I opened #36175 to add viewScript in schema and docs to the Gutenberg repo.

I opened a follow-up PR SchemaStore/schemastore#1915.

I will take care of the last item now:

Post-comments-form block - style - invalid type.

gziolo · 2021-11-04T15:00:59Z

I will take care of the last item now:

Post-comments-form block - style - invalid type.

PR ready to review: #36218. That is the last task which should conclude this issue 🎉

The `templateLock` attribute is mixed between boolean and string. Setting the type as string introduces an regression that will remove `false` on save. The original PR (#36140) tried to fix a validation issue reported in #35902 The schema error is incorrect. The attribute definition is required to have either a `type` or an `enum`.

walbo · 2021-11-05T16:20:58Z

Column block: templateLock - type missing

Cover block: templateLock - type missing

Group block: templateLock - type missing

Fix in #36140

Created an PR (#36264) to fix a regression in that PR.

Part of #35902. Update the block.json schema to require either a `type` or an `enum` prop.

gziolo · 2021-11-08T09:23:02Z

Great catch @walbo. I see that you already relaxed the schema validation in #36267. It looks like we need to allow also an array of strings as the type in block attributes. Anyone knows how to code it? 😃

walbo · 2021-11-08T09:25:42Z

Yes. I'll create a PR so type can both be a string or an array.

gziolo · 2021-11-08T10:20:49Z

We still have some changes to sync with https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/block.json to be able to consider this issue as done.

* Revert "Block Library: Fix incorrect attributes definitions #36140" The `templateLock` attribute is mixed between boolean and string. Setting the type as string introduces an regression that will remove `false` on save. The original PR (#36140) tried to fix a validation issue reported in #35902 The schema error is incorrect. The attribute definition is required to have either a `type` or an `enum`. * Spesify type as string or boolean * Add unit test

ajlende · 2021-11-14T16:56:32Z

With SchemaStore/schemastore#1930 merged, the SchemaStore file should reference this one. So we don't have to worry about opening a PR for both of them anymore, and I think this can be marked as complete 🙂

gziolo · 2021-11-15T06:51:51Z

@ajlende, thank you so much 🎉

mkaz added [Type] Code Quality Issues or PRs that relate to code quality Good First Issue An issue that's suitable for someone looking to contribute for the first time labels Oct 24, 2021

gziolo added the [Package] Block library /packages/block-library label Oct 25, 2021

mkaz mentioned this issue Oct 25, 2021

Create a Schemas Package #35927

Closed

oandregal mentioned this issue Oct 25, 2021

Add JSON Schema for WordPress block.json files SchemaStore/schemastore#1879

Merged

gziolo mentioned this issue Nov 2, 2021

Block Library: Fix incorrect attributes definitions #36140

Merged

gziolo mentioned this issue Nov 3, 2021

Blocks: Add view script to block schema and docs #36175

Merged

7 tasks

gziolo mentioned this issue Nov 4, 2021

Blocks: Document changes to style and editorStyle in block.json #36218

Merged

walbo mentioned this issue Nov 5, 2021

Block Library: Fix incorrect attributes definitions #36264

Merged

7 tasks

walbo pushed a commit that referenced this issue Nov 5, 2021

Blocks: Update schema to require either a type or an enum

3d96cf6

Part of #35902. Update the block.json schema to require either a `type` or an `enum` prop.

walbo mentioned this issue Nov 5, 2021

Blocks: Update schema to require either a type or an enum #36267

Merged

7 tasks

fabiankaegy pushed a commit that referenced this issue Nov 5, 2021

Blocks: Update schema to require either a type or an enum (#36267)

63630f3

Part of #35902. Update the block.json schema to require either a `type` or an `enum` prop.

ajlende closed this as completed Nov 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validation issues with block.json in a few core blocks #35902

Validation issues with block.json in a few core blocks #35902

mkaz commented Oct 24, 2021 •

edited by gziolo

Loading

gziolo commented Oct 25, 2021

gziolo commented Oct 25, 2021

ryanwelcher commented Oct 25, 2021

mkaz commented Oct 25, 2021

gziolo commented Oct 25, 2021

ajlende commented Oct 25, 2021

oandregal commented Oct 25, 2021 •

edited

Loading

oandregal commented Oct 25, 2021

ajlende commented Oct 25, 2021

ryanwelcher commented Oct 25, 2021

gziolo commented Nov 2, 2021

gziolo commented Nov 2, 2021

aristath commented Nov 2, 2021

gziolo commented Nov 3, 2021

gziolo commented Nov 4, 2021 •

edited

Loading

gziolo commented Nov 4, 2021

walbo commented Nov 5, 2021 •

edited

Loading

gziolo commented Nov 8, 2021

walbo commented Nov 8, 2021

gziolo commented Nov 8, 2021

ajlende commented Nov 14, 2021

gziolo commented Nov 15, 2021

Validation issues with block.json in a few core blocks #35902

Validation issues with block.json in a few core blocks #35902

Comments

mkaz commented Oct 24, 2021 • edited by gziolo Loading

What problem does this address?

gziolo commented Oct 25, 2021

gziolo commented Oct 25, 2021

ryanwelcher commented Oct 25, 2021

mkaz commented Oct 25, 2021

gziolo commented Oct 25, 2021

ajlende commented Oct 25, 2021

oandregal commented Oct 25, 2021 • edited Loading

oandregal commented Oct 25, 2021

ajlende commented Oct 25, 2021

ryanwelcher commented Oct 25, 2021

gziolo commented Nov 2, 2021

gziolo commented Nov 2, 2021

aristath commented Nov 2, 2021

gziolo commented Nov 3, 2021

gziolo commented Nov 4, 2021 • edited Loading

gziolo commented Nov 4, 2021

walbo commented Nov 5, 2021 • edited Loading

gziolo commented Nov 8, 2021

walbo commented Nov 8, 2021

gziolo commented Nov 8, 2021

ajlende commented Nov 14, 2021

gziolo commented Nov 15, 2021

mkaz commented Oct 24, 2021 •

edited by gziolo

Loading

oandregal commented Oct 25, 2021 •

edited

Loading

gziolo commented Nov 4, 2021 •

edited

Loading

walbo commented Nov 5, 2021 •

edited

Loading