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.

Sign up for GitHub

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

Jump to bottom

Build: Include entire lib/ folder in plugin bundle #20736

Merged
merged 1 commit into from
Mar 9, 2020
Merged

Build: Include entire lib/ folder in plugin bundle #20736

merged 1 commit into from
Mar 9, 2020

Conversation

aduth
Copy link
Member

@aduth aduth commented Mar 9, 2020

This pull request seeks to resolve an issue where warnings are logged in the Gutenberg 7.7.0 RC1 release.

<br />
<b>Warning</b>:  file_get_contents(/var/www/src/wp-content/plugins/gutenberg-1/lib/patterns/text-two-columns.json): failed to open stream: No such file or directory in <b>/var/www/src/wp-content/plugins/gutenberg-1/lib/client-assets.php</b> on line <b>639</b>
...

The underlying cause is due to the fact that these files are not whitelisted for inclusion in the built plugin ZIP file. This has been a common source of issues in the past (see #20225, #19072, f09bb3e, #9799).

The proposed changes opt to include the entire lib folder, rather than add additional patterns to match these files. It's not clear by the initial introduction of this pattern in #985 whether there were any files intended to be omitted from this directory, since at the time all files would have been matched anyways.

In the future, we should consider options for being more proactive in accounting for these errors. Specifically, we should try to incorporate the built plugin as part of the Travis build, perhaps as part of the end-to-end tasks (see #14289 (comment) and “Pregenerate the plugin build to use across tasks” task of #15159).

Testing Instructions:

Run npm run bundle-plugin.

Verify that all expected files in lib are included:

...
  adding: lib/ (stored 0%)
  adding: lib/blocks.php (deflated 70%)
  adding: lib/widgets.php (deflated 73%)
  adding: lib/load.php (deflated 68%)
  adding: lib/block-directory.php (deflated 57%)
  adding: lib/global-styles.php (deflated 75%)
  adding: lib/edit-site-page.php (deflated 68%)
  adding: lib/templates.php (deflated 72%)
  adding: lib/experiments-page.php (deflated 71%)
  adding: lib/patterns/ (stored 0%)
  adding: lib/patterns/text-two-columns.json (deflated 50%)
  adding: lib/patterns/cover-abc.json (deflated 44%)
  adding: lib/patterns/two-buttons.json (deflated 62%)
  adding: lib/rest-api.php (deflated 61%)
  adding: lib/demo-block-templates/ (stored 0%)
  adding: lib/demo-block-templates/front-page.html (deflated 69%)
  adding: lib/template-parts.php (deflated 70%)
  adding: lib/class-wp-rest-widget-forms.php (deflated 67%)
  adding: lib/client-assets.php (deflated 73%)
  adding: lib/demo.php (deflated 64%)
  adding: lib/class-experimental-wp-widget-blocks-manager.php (deflated 76%)
  adding: lib/customizer.php (deflated 63%)
  adding: lib/template-canvas.php (deflated 40%)
  adding: lib/class-wp-block-styles-registry.php (deflated 76%)
  adding: lib/template-loader.php (deflated 70%)
  adding: lib/class-wp-customize-widget-blocks-control.php (deflated 54%)
  adding: lib/class-wp-rest-block-directory-controller.php (deflated 73%)
  adding: lib/widgets-page.php (deflated 63%)
  adding: lib/compat.php (deflated 67%)
  adding: lib/class-wp-rest-widget-areas-controller.php (deflated 75%)
  adding: lib/demo-block-template-parts/ (stored 0%)
  adding: lib/demo-block-template-parts/header.html (deflated 21%)
...

@aduth aduth added the [Type] Build Tooling Issues or PRs related to build tooling label Mar 9, 2020
@aduth aduth added this to the Gutenberg 7.7 milestone Mar 9, 2020
@aduth aduth requested a review from mcsf March 9, 2020 18:04
@github-actions
Copy link

github-actions bot commented Mar 9, 2020

Size Change: 0 B

Total Size: 864 kB

ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.01 kB 0 B
build/annotations/index.js 3.43 kB 0 B
build/api-fetch/index.js 3.39 kB 0 B
build/autop/index.js 2.58 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.02 kB 0 B
build/block-directory/style-rtl.css 760 B 0 B
build/block-directory/style.css 760 B 0 B
build/block-editor/index.js 105 kB 0 B
build/block-editor/style-rtl.css 10.6 kB 0 B
build/block-editor/style.css 10.5 kB 0 B
build/block-library/editor-rtl.css 7.36 kB 0 B
build/block-library/editor.css 7.36 kB 0 B
build/block-library/index.js 115 kB 0 B
build/block-library/style-rtl.css 7.47 kB 0 B
build/block-library/style.css 7.48 kB 0 B
build/block-library/theme-rtl.css 669 B 0 B
build/block-library/theme.css 671 B 0 B
build/block-serialization-default-parser/index.js 1.65 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 57.7 kB 0 B
build/components/index.js 191 kB 0 B
build/components/style-rtl.css 15.5 kB 0 B
build/components/style.css 15.5 kB 0 B
build/compose/index.js 5.75 kB 0 B
build/core-data/index.js 10.6 kB 0 B
build/data-controls/index.js 1.03 kB 0 B
build/data/index.js 8.22 kB 0 B
build/date/index.js 5.36 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.06 kB 0 B
build/edit-post/index.js 91.3 kB 0 B
build/edit-post/style-rtl.css 8.64 kB 0 B
build/edit-post/style.css 8.64 kB 0 B
build/edit-site/index.js 4.64 kB 0 B
build/edit-site/style-rtl.css 2.48 kB 0 B
build/edit-site/style.css 2.48 kB 0 B
build/edit-widgets/index.js 4.44 kB 0 B
build/edit-widgets/style-rtl.css 2.58 kB 0 B
build/edit-widgets/style.css 2.58 kB 0 B
build/editor/editor-styles-rtl.css 381 B 0 B
build/editor/editor-styles.css 382 B 0 B
build/editor/index.js 43.8 kB 0 B
build/editor/style-rtl.css 3.98 kB 0 B
build/editor/style.css 3.97 kB 0 B
build/element/index.js 4.45 kB 0 B
build/escape-html/index.js 734 B 0 B
build/format-library/index.js 7.09 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 1.92 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.49 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 2.3 kB 0 B
build/keycodes/index.js 1.68 kB 0 B
build/list-reusable-blocks/index.js 2.99 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 4.85 kB 0 B
build/notices/index.js 1.57 kB 0 B
build/nux/index.js 3.01 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.54 kB 0 B
build/primitives/index.js 1.49 kB 0 B
build/priority-queue/index.js 780 B 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/rich-text/index.js 14.3 kB 0 B
build/server-side-render/index.js 2.55 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4 kB 0 B
build/viewport/index.js 1.61 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.18 kB 0 B

compressed-size-action

mcsf
mcsf approved these changes Mar 9, 2020
View reviewed changes
Copy link
Contributor

@mcsf mcsf left a comment

Choose a reason for hiding this comment

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

Thanks for the fix.

@aduth aduth merged commit c01bb1e into master Mar 9, 2020
@aduth aduth deleted the fix/plugin-bundle-patterns branch March 9, 2020 21:26
youknowriad pushed a commit that referenced this pull request Mar 11, 2020
@aduth @youknowriad
Build: Include entire lib/ folder in plugin bundle (#20736)
25139b0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcsf mcsf mcsf approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@nerrad nerrad Awaiting requested review from nerrad

@ntwb ntwb Awaiting requested review from ntwb

Assignees
No one assigned
Labels
[Type] Build Tooling Issues or PRs related to build tooling
Projects
None yet
Milestone
Gutenberg 7.7
Development

Successfully merging this pull request may close these issues.
2 participants
@aduth @mcsf