[flutter_plugin_tools] Reimplements the excerpt system inline in the tool, rather than relying on a separate package. by Hixie · Pull Request #4417 · flutter/packages

Hixie · 2023-07-10T05:00:37Z

Allows excerpts to come from any package, not just examples.
Fixes a bug in the excerpting logic that was causing a stray } to appear in one example.
Removes the need for build.excerpt.yaml files.
Remove the dependency on build_runner for excerpts.
Reduces the time to generate the excerpts from about 10 minutes to about 5 seconds.
Almost certainly fixes[plugins] Obscure failure when using update-excerpts while IDE is open flutter#107180 (untested).

The new logic is not quite backwards compatible; the path-base feature now specifies a real path to the actual source directories, rather than a path into the invisible generated excerpts/ directory with its special structure. Also, a number of features from the previous package that were not actually used in this repository are no longer supported (such as having multiple section names per #docregion pragma).

Pre-launch Checklist

Hixie · 2023-07-10T05:18:10Z

If this lands I'll update https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#readme-code

Hixie · 2023-07-10T20:03:24Z

Reduces the time to generate the excerpts from about 10 minutes to about 5 seconds.
O.o
Any idea why the package is so slow? Is there something that we should fix upstream to improve the website repo CI?

Well, the old code using build_runner, the Dart compiler, codegen, stored all the extracts on disk, and had two separate processes for extracting and injecting. The new code does none of that. Not running code is faster than running code.

I'm not sure if it makes sense to upstream this because I don't fully understand the website repo's use case so it's hard to say whether this code addresses the same needs.

Hixie · 2023-07-10T20:12:13Z

Proposed new documentation for the wiki:
Nice! A few comments, but generally looks good.

Added a bit about path-base's default.

Hixie · 2023-07-10T20:12:56Z

updated, PTAL.

tarrinneal

This is a welcome change, thank you!

stuartmorgan-g

LGTM, thanks!

I saw from your comments in the rfw PR that we may need to iterate more for that specific case, but I think we should land this as-is and then iterate from there in follow-ups since this is already a big quality of life improvement over the current implementation.

stuartmorgan-g · 2023-07-11T15:22:02Z

I would vote for removing things we have no intention of ever using (scss and ts).

Hixie · 2023-07-11T17:04:27Z

I will remove scss and ts and land it. Thanks for the reviews!

…ng on a separate package. * Allows excerpts to come from any package, not just examples. * Fixes a bug in the excerpting logic that was causing a stray `}` to appear in one example. * Removes the need for `build.excerpt.yaml` files. * Remove the dependency on build_runner for excerpts. * Reduces the time to generate the excerpts from about 10 minutes to about 5 seconds. The new logic is not quite backwards compatible; the `path-base` feature now specifies a real path to the actual source directories, rather than a path into the invisible generated `excerpts/` directory with its special structure. Also, a number of features from the previous package that were not actually used in this repository are no longer supported (such as having multiple section names per `#docregion` pragma).

… in the tool, rather than relying on a separate package. (flutter/packages#4417)

flutter/packages@188a846...2508714 2023-07-12 39314023+wer-mathurin@users.noreply.github.com ADD appBarBreakpoint (flutter/packages#4434) 2023-07-12 engine-flutter-autoroll@skia.org Roll Flutter from 65ff3cb to 3ec96a8 (5 revisions) (flutter/packages#4415) 2023-07-12 tarrinneal@gmail.com [image_picker] Roll dependancies to avoid error (flutter/packages#4431) 2023-07-12 49699333+dependabot[bot]@users.noreply.github.com [in_app_pur]: Bump com.android.billingclient:billing from 6.0.0 to 6.0.1 in /packages/in_app_purchase/in_app_purchase_android/android (flutter/packages#4422) 2023-07-12 ditman@gmail.com [file_selector] Avoids using path_provider in web example app. (flutter/packages#4445) 2023-07-12 ian@hixie.ch [rfw] Add some more documentation for RFW (flutter/packages#4349) 2023-07-12 stuartmorgan@google.com [ci] Enable LUCI legacy analysis (flutter/packages#4435) 2023-07-11 ian@hixie.ch [webview_flutter_wkwebview] NSError.toString (flutter/packages#4441) 2023-07-11 stuartmorgan@google.com [ci] Remove unused Chromium setup (flutter/packages#4437) 2023-07-11 ian@hixie.ch [flutter_plugin_tools] Reimplements the excerpt system inline in the tool, rather than relying on a separate package. (flutter/packages#4417) 2023-07-11 10687576+bparrishMines@users.noreply.github.com [ci] Remove webview_flutter implementation opt outs for custom analysis (flutter/packages#4438) 2023-07-11 stuartmorgan@google.com [palette_generator] Add web support to unit tests (flutter/packages#4440) 2023-07-11 stuartmorgan@google.com [tool] Conditionalize color on `stdout` (flutter/packages#4436) 2023-07-11 47866232+chunhtai@users.noreply.github.com [go_router_builder] Cleans up builder code. (flutter/packages#4356) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…tool, rather than relying on a separate package. (flutter#4417) * Allows excerpts to come from any package, not just examples. * Fixes a bug in the excerpting logic that was causing a stray `}` to appear in one example. * Removes the need for `build.excerpt.yaml` files. * Remove the dependency on build_runner for excerpts. * Reduces the time to generate the excerpts from about 10 minutes to about 5 seconds. * Almost certainly fixesflutter/flutter#107180 (untested). The new logic is not quite backwards compatible; the `path-base` feature now specifies a real path to the actual source directories, rather than a path into the invisible generated `excerpts/` directory with its special structure. Also, a number of features from the previous package that were not actually used in this repository are no longer supported (such as having multiple section names per `#docregion` pragma).

Hixie requested review from bparrishMines, ditman, domesticmouse, gmackall, gspencergoog, jonahwilliams, reidbaker, stuartmorgan-g and tarrinneal as code owners July 10, 2023 05:00

Hixie mentioned this pull request Jul 10, 2023
[plugins] Obscure failure when using update-excerpts while IDE is open flutter/flutter#107180
Closed

Hixie force-pushed the excerpt_2 branch from c87a1de to 78c3c7aCompare July 10, 2023 05:16

Hixie force-pushed the excerpt_2 branch 2 times, most recently from 01dfdcd to f026326Compare July 10, 2023 05:29

stuartmorgan-g mentioned this pull request Jul 10, 2023
Migrate flutter/packages Cirrus tasks to LUCI flutter/flutter#114373
Closed
51 tasks

Hixie force-pushed the excerpt_2 branch from f026326 to ec5a473Compare July 10, 2023 19:58

Hixie force-pushed the excerpt_2 branch from ec5a473 to 76988dbCompare July 10, 2023 20:12

tarrinneal approved these changes Jul 10, 2023
View reviewed changes

Hixie force-pushed the excerpt_2 branch 4 times, most recently from 248fc71 to 81b0b51Compare July 11, 2023 00:23

domesticmouse approved these changes Jul 11, 2023
View reviewed changes

Hixie mentioned this pull request Jul 11, 2023
[rfw] Add some more documentation for RFW #4349
Merged
11 tasks

stuartmorgan-g approved these changes Jul 11, 2023
View reviewed changes

Hixie force-pushed the excerpt_2 branch from 81b0b51 to 58b4afaCompare July 11, 2023 17:05

Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 11, 2023

auto-submitBot merged commit bd5d191 into flutter:mainJul 11, 2023

engine-flutter-autoroll mentioned this pull request Jul 12, 2023
Roll Packages from 188a8468f557 to a5cfa609362a (13 revisions) flutter/flutter#130416
Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 12, 2023
bd5d191[flutter_plugin_tools] Reimplements the excerpt system inline…
c8fe91c
… in the tool, rather than relying on a separate package. (flutter/packages#4417)

engine-flutter-autoroll mentioned this pull request Jul 12, 2023
Roll Packages from 188a8468f557 to 250871431bed (14 revisions) flutter/flutter#130418
Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 12, 2023
bd5d191[flutter_plugin_tools] Reimplements the excerpt system inline…
784a2d9
… in the tool, rather than relying on a separate package. (flutter/packages#4417)

reidbaker mentioned this pull request Jul 14, 2023
[tooling] mark infra steps as infra steps in yaml files #4473
Merged
11 tasks

reidbaker mentioned this pull request Jul 26, 2023
[Tooling] Add google owned cache for dependencies as an option in ci #4567
Merged
11 tasks

reidbaker mentioned this pull request Aug 4, 2023
[All] Expand artifact hub to all plugins #4645
Merged
11 tasks

Navigation Menu

Uh oh!

[flutter_plugin_tools] Reimplements the excerpt system inline in the tool, rather than relying on a separate package. - #4417

[flutter_plugin_tools] Reimplements the excerpt system inline in the tool, rather than relying on a separate package.#4417
auto-submit[bot] merged 1 commit into
flutter:mainfrom
Hixie:excerpt_2

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

tarrinneal left a comment

Uh oh!

stuartmorgan-g left a comment

Uh oh!

stuartmorgan-gJul 11, 2023

Uh oh!

Hixie commented Jul 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

Hixie commented Jul 10, 2023

Pre-launch Checklist

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

Hixie commented Jul 10, 2023

Uh oh!

tarrinneal left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-gJul 11, 2023

Choose a reason for hiding this comment

Uh oh!

Hixie commented Jul 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants