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

Blocks: Upgrade simple-html-tokenizer dependency #15246

Merged
merged 1 commit into from
Apr 29, 2019

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Apr 29, 2019

Description

Originally raised by @swissspidy in #15138:

I am trying to use @wordpress/scripts for unit tests. Still running into #13364, but there's also another issue when running wp-scripts test-unit-js:

and further commented by @nerrad in #13364 after the previous discussion on WordPress.org Slack.

I'm guessing the issue here is that the import is coming from a specific es6 directory from the simple-html-tokenizer module:

import Tokenizer from 'simple-html-tokenizer/dist/es6/tokenizer';

We had this line added to Jest config:
https://github.com/WordPress/gutenberg/blob/master/test/unit/jest.config.js#L29
to ensure this unusual import statement works as expected with our test setup.

This PR tries to resolve this issue for projects which depend on @wordpress/blocks. It brings the latest version of the simple-html-tokenizer package and uses it as a usual npm module through the entry point rather than trying to use a file based on the filesystem structure.

Impact

There is only 1 kB difference in the size of uncompressed production build file which means we can ignore it for the benefit of fixing issues for 3rd party developers.

Before

Screen Shot 2019-04-29 at 10 58 04

After

Screen Shot 2019-04-29 at 11 06 02

Testing instructions

Based on #11771.

Verify that block invalidation is not triggered by encoding variations.

For example, inserting the following HTML as the contents of a post (in Text Mode, Classic Editor Text tab, or directly in the database) should not be presented as an invalid block when next viewing the Visual Mode of the editor:

<!-- wp:paragraph -->
<p>This works. &#128517;</p>
<!-- /wp:paragraph -->

@gziolo gziolo added [Type] Enhancement A suggestion for improvement. [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Package] Blocks /packages/blocks labels Apr 29, 2019
@gziolo gziolo self-assigned this Apr 29, 2019
@gziolo
Copy link
Member Author

gziolo commented Apr 29, 2019

@aduth - as you worked on #11771 which introduced the changes which enforced the exclusion of simple-html-tokenizer from Jest config in the transform ignores section, I would appreciate your review.

Copy link
Contributor

@nerrad nerrad left a comment

Choose a reason for hiding this comment

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

I think the 1kb size gain is reasonable considering the benefit to those that import this package. It was a gotcha that wasn't easily apparent on how to fix.

@@ -1,7 +1,7 @@
/**
* External dependencies
*/
import Tokenizer from 'simple-html-tokenizer/dist/es6/tokenizer';
Copy link
Member

Choose a reason for hiding this comment

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

I'm guessing by your measure of the size difference, it has not regressed (possibly because of better ES module support than they had previously†), but the reason it was originally written this way was to avoid the side effect of importing the very very large character reference set.

https://github.com/tildeio/simple-html-tokenizer/blob/9a894bd75545e107638272f3e1e812933815953f/src/index.ts#L2-L4

https://github.com/tildeio/simple-html-tokenizer/blob/master/src/generated/html5-named-char-refs.ts

† I'd forgot I made this pull request: tildeio/simple-html-tokenizer#49 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

It would explain why it works so well now 😍

@gziolo gziolo merged commit cafb57b into master Apr 29, 2019
@gziolo gziolo deleted the update/simple-html-tokenizer-upgrade branch April 29, 2019 20:12
@swissspidy
Copy link
Member

Thanks for merging this!

I assume for testing this in my project I need to manually apply the changes until new package versions are released?

@gziolo
Copy link
Member Author

gziolo commented Apr 30, 2019

@swissspidy, yes. I think the only thing you need to include is:

transformIgnorePatterns: [	
	'node_modules/(?!(simple-html-tokenizer)/)',	
],

in Jest config.

@swissspidy
Copy link
Member

Hmm I already had that in my config. But since I also had other issues with Babel and core-js, I probably have to wait for #15139 anyway.

Tug added a commit that referenced this pull request May 2, 2019
commit 1dddab4
Author: Stefanos Togkoulidis <[email protected]>
Date:   Wed May 1 00:00:50 2019 +0300

    Have Aztec delete the detected Enter key for paragraphs

    Aztec-Android doesn't swallow the Enter key (like the list handling does) so,
    instruct Aztec to delete it for the paragraph block.

commit 0936ca0
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 30 20:58:36 2019 +0300

    Just use onFormatChange which now defaults to "force"

commit 6358de3
Merge: a5282ce 5e4d627
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 30 20:23:57 2019 +0300

    Merge branch 'master' into rnmobile/fix-list-handling-android

commit 5e4d627
Author: Pascal Birchler <[email protected]>
Date:   Tue Apr 30 18:27:24 2019 +0200

    Update to Babel 7.4 and core-js 3 (#15139)

    * Specify core-js version when using useBuiltIns

    * Update to Babel 7.4 and core-js 3

    * setupFiles: fix path to async-iterator

    * Also update Babel packages in babel-preset-default

    * Update snapshot for babel-preset-default test

    * Manually include web.dom-collections.iterator in jest config

    * Regenerate package-lock.json file after latest changes applied

    * Upgrade ESLint related npm packages

    * Another cleanup in the package-lock.json file

    * Remove ESLint rules which throw error to fix linting

    * Add core-js/modules/web.dom.iterable to make e2e tests work

    * Update Babel packages to the latest version

    * Update ignore files in e2e tests config

    * Add changelog entries related to Babel and ESLint version bumps

commit 1d959ba
Author: Andrés <[email protected]>
Date:   Tue Apr 30 17:14:35 2019 +0200

    Remove not used state (#15224)

commit d715e93
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 16:29:09 2019 +0200

    Babel plugin JSX: Implement Fragment handling (#15120)

    Add imports for `<></>` JSX Fragments.

commit 96cad99
Author: Kelly Dwan <[email protected]>
Date:   Tue Apr 30 09:18:54 2019 -0400

    Fix incorrect ID in FocalPointPicker (#15255)

commit c1ba13e
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 13:44:50 2019 +0200

    Update Fragment imports in READMEs (#15262)

    Some Fragment imports were incorrect. Fix them.

commit 297c2f4
Author: etoledom <[email protected]>
Date:   Tue Apr 30 13:19:34 2019 +0200

    RNMobile: Fix autoscroll on ListBlock (#15048)

    * RNMobile: Add ability to send extra props (i.e. props needed just for mobile) to the list block.

    * Adding onCaretVerticalPositionChange to RichText via context

    * Passing onCaretVerticalPositionChange via context to RichText for all RichText based blocks

    This makes it not necessary to pass onCaretVerticalPositionChange as a prop directly to RichText from the block component.

    * Update jest snapshot for block-edit

commit 447dd27
Author: Jorge Costa <[email protected]>
Date:   Tue Apr 30 10:47:55 2019 +0100

    Fix copy paste and delete error core paragraph with locking (#14712)

    * Fix: Copy / Paste error core/paragraph with locking

    * Add test case.

    * Update packages/block-library/src/paragraph/edit.js

    Co-Authored-By: jorgefilipecosta <[email protected]>

commit 0b2eb1c
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 09:39:29 2019 +0200

    Dependency extraction webpack plugin: Change option name consistent with docs (#15260)

    In the docs, an option name was provided as `requestToHandle`, but the
    actual option in use was `requestToDependency`.

    Update the code and related tests to use `requestToHandle` as described
    in the documentation instead of `requestToDependency`.

commit 506827e
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 09:31:38 2019 +0200

    Read script dependencies from generated files (#15124)

    * Rework script registration to use generated deps

    * Deprecate static list of dependencies

    * Rework translation without packages-dependencies.php

    * Include build/*/*.deps.json in plugin zip

    * Add script dependencies undetectable by build tools

    Some scripts have dependencies that are undetectable by the webpack
    plugin used to generate the dependency files. Add these dependencies
    to the generated dependencies.

    * Add `wp-polyfill` dependency via webpack plugin

    Enable `injectPolyfill` option in the webpack plugin instead of manually
    injecting the dependency via PHP on script registration.

    This will enable the polyfill for consumers of wp-scripts default
    webpack config.

    * Improve deprecated message

    * Remove obsolete lib/packages-dependencies.php

commit c2c8276
Author: Daniel Richards <[email protected]>
Date:   Tue Apr 30 13:36:49 2019 +0800

    Use button block appender on group block (#14943)

    * Use button block appender on group block

    * Update group block e2e tests for the new button appender

    * Add additional margin to the appender when a group has a background color.

    * Use more opaque versions of the appender background color

    To ensure greater compatibility when layered on top of a block with a background color.

    * Block Library: Display ButtonBlockAppender only if selected or empty

    * Only render button appender when the group has no inner blocks

commit 1e96ec7
Author: Andrew Duthie <[email protected]>
Date:   Mon Apr 29 16:40:24 2019 -0400

    Build Tooling: Pass individual files as arguments from watch to build script (#15219)

commit cafb57b
Author: Grzegorz (Greg) Ziółkowski <[email protected]>
Date:   Mon Apr 29 22:12:08 2019 +0200

    Blocks: Upgrade simple-html-tokenizer dependency (#15246)

commit 5b3b3ab
Author: Andrew Duthie <[email protected]>
Date:   Mon Apr 29 13:38:09 2019 -0400

    Framework: Add REST API codeowners (#15215)

commit 64c48fd
Author: Ian Dunn <[email protected]>
Date:   Mon Apr 29 10:06:46 2019 -0700

    Correct name of `date_i18n()` PHP function. (#15204)

commit 8c28814
Author: Andrew Duthie <[email protected]>
Date:   Mon Apr 29 13:05:10 2019 -0400

    Framework: Remove TESTS.md (#15217)

commit 0f1fb57
Author: Emmanuel Hesry <[email protected]>
Date:   Mon Apr 29 17:34:22 2019 +0200

    fix typo in withDispatch documentation (#15251)

commit a5282ce
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 16:08:31 2019 +0300

    Revert "Trivial change to trigger Travis"

    This reverts commit e22ffde.

commit e22ffde
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 16:08:24 2019 +0300

    Trivial change to trigger Travis

commit 15a51f8
Author: Jorge Costa <[email protected]>
Date:   Fri Apr 19 15:33:15 2019 +0100

    chore: Fix: Lint error that makes unit tests (and CI tests) fail. (#15073)

commit 2b11074
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 12:42:55 2019 +0300

    Fix lint issues

commit 9c298c8
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 12:01:46 2019 +0300

    Need to specify firedAfterTextChanged on all Aztec events

commit 46e086d
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 03:59:59 2019 +0300

    Force Aztec update if "Enter" fired before text change

commit 724e295
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 03:11:52 2019 +0300

    Differentiate Android and iOS since assumptions diverged

    The iOS side still expects to just check against `this.lastContent` to
    force the change into Aztec.

commit 52386fa
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 01:55:22 2019 +0300

    Use a flag to signal Aztec-originated changes

    And assume that when that flag is false, component changes need to get
    sent/reflected down to Aztec.

commit c7aa381
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 23 17:30:45 2019 +0300

    Able to not lose content

commit 60c75b0
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 23 10:09:23 2019 +0300

    If text already changed, don't modify it
Tug added a commit that referenced this pull request May 2, 2019
commit 1dddab4
Author: Stefanos Togkoulidis <[email protected]>
Date:   Wed May 1 00:00:50 2019 +0300

    Have Aztec delete the detected Enter key for paragraphs

    Aztec-Android doesn't swallow the Enter key (like the list handling does) so,
    instruct Aztec to delete it for the paragraph block.

commit 0936ca0
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 30 20:58:36 2019 +0300

    Just use onFormatChange which now defaults to "force"

commit 6358de3
Merge: a5282ce 5e4d627
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 30 20:23:57 2019 +0300

    Merge branch 'master' into rnmobile/fix-list-handling-android

commit 5e4d627
Author: Pascal Birchler <[email protected]>
Date:   Tue Apr 30 18:27:24 2019 +0200

    Update to Babel 7.4 and core-js 3 (#15139)

    * Specify core-js version when using useBuiltIns

    * Update to Babel 7.4 and core-js 3

    * setupFiles: fix path to async-iterator

    * Also update Babel packages in babel-preset-default

    * Update snapshot for babel-preset-default test

    * Manually include web.dom-collections.iterator in jest config

    * Regenerate package-lock.json file after latest changes applied

    * Upgrade ESLint related npm packages

    * Another cleanup in the package-lock.json file

    * Remove ESLint rules which throw error to fix linting

    * Add core-js/modules/web.dom.iterable to make e2e tests work

    * Update Babel packages to the latest version

    * Update ignore files in e2e tests config

    * Add changelog entries related to Babel and ESLint version bumps

commit 1d959ba
Author: Andrés <[email protected]>
Date:   Tue Apr 30 17:14:35 2019 +0200

    Remove not used state (#15224)

commit d715e93
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 16:29:09 2019 +0200

    Babel plugin JSX: Implement Fragment handling (#15120)

    Add imports for `<></>` JSX Fragments.

commit 96cad99
Author: Kelly Dwan <[email protected]>
Date:   Tue Apr 30 09:18:54 2019 -0400

    Fix incorrect ID in FocalPointPicker (#15255)

commit c1ba13e
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 13:44:50 2019 +0200

    Update Fragment imports in READMEs (#15262)

    Some Fragment imports were incorrect. Fix them.

commit 297c2f4
Author: etoledom <[email protected]>
Date:   Tue Apr 30 13:19:34 2019 +0200

    RNMobile: Fix autoscroll on ListBlock (#15048)

    * RNMobile: Add ability to send extra props (i.e. props needed just for mobile) to the list block.

    * Adding onCaretVerticalPositionChange to RichText via context

    * Passing onCaretVerticalPositionChange via context to RichText for all RichText based blocks

    This makes it not necessary to pass onCaretVerticalPositionChange as a prop directly to RichText from the block component.

    * Update jest snapshot for block-edit

commit 447dd27
Author: Jorge Costa <[email protected]>
Date:   Tue Apr 30 10:47:55 2019 +0100

    Fix copy paste and delete error core paragraph with locking (#14712)

    * Fix: Copy / Paste error core/paragraph with locking

    * Add test case.

    * Update packages/block-library/src/paragraph/edit.js

    Co-Authored-By: jorgefilipecosta <[email protected]>

commit 0b2eb1c
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 09:39:29 2019 +0200

    Dependency extraction webpack plugin: Change option name consistent with docs (#15260)

    In the docs, an option name was provided as `requestToHandle`, but the
    actual option in use was `requestToDependency`.

    Update the code and related tests to use `requestToHandle` as described
    in the documentation instead of `requestToDependency`.

commit 506827e
Author: Jon Surrell <[email protected]>
Date:   Tue Apr 30 09:31:38 2019 +0200

    Read script dependencies from generated files (#15124)

    * Rework script registration to use generated deps

    * Deprecate static list of dependencies

    * Rework translation without packages-dependencies.php

    * Include build/*/*.deps.json in plugin zip

    * Add script dependencies undetectable by build tools

    Some scripts have dependencies that are undetectable by the webpack
    plugin used to generate the dependency files. Add these dependencies
    to the generated dependencies.

    * Add `wp-polyfill` dependency via webpack plugin

    Enable `injectPolyfill` option in the webpack plugin instead of manually
    injecting the dependency via PHP on script registration.

    This will enable the polyfill for consumers of wp-scripts default
    webpack config.

    * Improve deprecated message

    * Remove obsolete lib/packages-dependencies.php

commit c2c8276
Author: Daniel Richards <[email protected]>
Date:   Tue Apr 30 13:36:49 2019 +0800

    Use button block appender on group block (#14943)

    * Use button block appender on group block

    * Update group block e2e tests for the new button appender

    * Add additional margin to the appender when a group has a background color.

    * Use more opaque versions of the appender background color

    To ensure greater compatibility when layered on top of a block with a background color.

    * Block Library: Display ButtonBlockAppender only if selected or empty

    * Only render button appender when the group has no inner blocks

commit 1e96ec7
Author: Andrew Duthie <[email protected]>
Date:   Mon Apr 29 16:40:24 2019 -0400

    Build Tooling: Pass individual files as arguments from watch to build script (#15219)

commit cafb57b
Author: Grzegorz (Greg) Ziółkowski <[email protected]>
Date:   Mon Apr 29 22:12:08 2019 +0200

    Blocks: Upgrade simple-html-tokenizer dependency (#15246)

commit 5b3b3ab
Author: Andrew Duthie <[email protected]>
Date:   Mon Apr 29 13:38:09 2019 -0400

    Framework: Add REST API codeowners (#15215)

commit 64c48fd
Author: Ian Dunn <[email protected]>
Date:   Mon Apr 29 10:06:46 2019 -0700

    Correct name of `date_i18n()` PHP function. (#15204)

commit 8c28814
Author: Andrew Duthie <[email protected]>
Date:   Mon Apr 29 13:05:10 2019 -0400

    Framework: Remove TESTS.md (#15217)

commit 0f1fb57
Author: Emmanuel Hesry <[email protected]>
Date:   Mon Apr 29 17:34:22 2019 +0200

    fix typo in withDispatch documentation (#15251)

commit a5282ce
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 16:08:31 2019 +0300

    Revert "Trivial change to trigger Travis"

    This reverts commit e22ffde.

commit e22ffde
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 16:08:24 2019 +0300

    Trivial change to trigger Travis

commit 15a51f8
Author: Jorge Costa <[email protected]>
Date:   Fri Apr 19 15:33:15 2019 +0100

    chore: Fix: Lint error that makes unit tests (and CI tests) fail. (#15073)

commit 2b11074
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 12:42:55 2019 +0300

    Fix lint issues

commit 9c298c8
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 12:01:46 2019 +0300

    Need to specify firedAfterTextChanged on all Aztec events

commit 46e086d
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 03:59:59 2019 +0300

    Force Aztec update if "Enter" fired before text change

commit 724e295
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 03:11:52 2019 +0300

    Differentiate Android and iOS since assumptions diverged

    The iOS side still expects to just check against `this.lastContent` to
    force the change into Aztec.

commit 52386fa
Author: Stefanos Togkoulidis <[email protected]>
Date:   Thu Apr 25 01:55:22 2019 +0300

    Use a flag to signal Aztec-originated changes

    And assume that when that flag is false, component changes need to get
    sent/reflected down to Aztec.

commit c7aa381
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 23 17:30:45 2019 +0300

    Able to not lose content

commit 60c75b0
Author: Stefanos Togkoulidis <[email protected]>
Date:   Tue Apr 23 10:09:23 2019 +0300

    If text already changed, don't modify it
@youknowriad youknowriad added this to the 5.7 (Gutenberg) milestone May 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Blocks /packages/blocks [Type] Automated Testing Testing infrastructure changes impacting the execution of end-to-end (E2E) and/or unit tests. [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants