Skip to content

Testing: Trim block fixture HTML when generating other test fixture files #30981

Merged
gziolo merged 1 commit intoWordPress:trunkfrom
ramonjd:update/block-fixtures-trim-html-before-parsing
Apr 20, 2021
Merged

Testing: Trim block fixture HTML when generating other test fixture files #30981
gziolo merged 1 commit intoWordPress:trunkfrom
ramonjd:update/block-fixtures-trim-html-before-parsing

Conversation

@ramonjd
Copy link
Member

@ramonjd ramonjd commented Apr 20, 2021 •
edited
Loading

Description

Over in #30951 (comment) we noticed that when a new line exists at the end of an html fixture file, the parser interprets this as an empty block. 😱

The result is an empty block object in the parsed JSON (*.parsed.json files).

   {
        "blockName": null,
        "attrs": {},
        "innerBlocks": [],
        "innerHTML": "\n",
        "innerContent": [
            "\n"
        ]
    }

Trimming the output string of the HTML prevents this from occurring.

This PR trims the fixture HTML and regenerates our suite of fixtures to removing the hanging, empty blocks. 👍

How has this been tested?

By running the fixtures tests again:

npm run fixtures:regenerate test/integration/full-content/full-content.test.js

And making sure the fixtures are still valid.

And the unit tests just in case:

npm run test-unit

Types of changes

Non-breaking changes to fixture generation.

@ramonjd
When a new line exists at the end of an HTML fixture file the parser …
15122e1 
…interprets this as an empty block. The result is an empty block object in the resulting parsed JSON.

Trimming the output string of the HTML prevents this from occurring.
We're also re-generating the fixtures to remove the empty blocks.
@ramonjd ramonjd mentioned this pull request Apr 20, 2021
Merged
gziolo
gziolo approved these changes Apr 20, 2021
View reviewed changes
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Interesting one, thank you for the fix 👍🏻

@gziolo gziolo added [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Code Quality Issues or PRs that relate to code quality labels Apr 20, 2021
@gziolo gziolo changed the title Block fixtures: trim block fixture HTML when generating fixtures Testing: Trim block fixture HTML when generating other test fixture files Apr 20, 2021
@gziolo gziolo merged commit b3fe0be into WordPress:trunk Apr 20, 2021
@github-actions github-actions bot added this to the Gutenberg 10.5 milestone Apr 20, 2021
ramonjd added a commit to ramonjd/gutenberg that referenced this pull request Jul 20, 2021
@ramonjd
Regenerating fixtures after the trim fix in WordPress#30981
f1b9240
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gziolo gziolo gziolo approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@nerrad nerrad Awaiting requested review from nerrad nerrad is a code owner

@ntwb ntwb Awaiting requested review from ntwb ntwb is a code owner

Assignees

No one assigned

Labels

[Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Code Quality Issues or PRs that relate to code quality

Projects

None yet

Milestone

Gutenberg 10.5

Development

Successfully merging this pull request may close these issues.

2 participants

@ramonjd @gziolo