Move snippets package back into flutter repo #147690

gspencergoog · 2024-05-02T01:29:06Z

Description

This moves the snippets package back into the Flutter repo so that API documentation generation can happen without the use of dart pub global run because pub run doesn't handle concurrency well.

The change modifies the dartdoc building process to include building an executable from the snippets tool and installing that in the cache directory for use during docs generation.

The snippets tool will reside in dev/snippets, where it originally resided before being moved to https://github.com/flutter/assets-for-api-docs.

The snippets code itself is unchanged from the code that is in https://github.com/flutter/assets-for-api-docs/packages/snippets.

Related Issues

Tests

Added snippets tests to the overall testing build.

sigurdm

Using global activate for running the documentation step was very messy to say the least. It modifies user-configuration to do a temporary setup.

I think there's more we can do for supporting concurrency with dart pub global run but I don't think it is the right solution for you.

An alternative to this PR if you want to keep snippets in a package would be to

make snippets a dev-dependency in dev/tools/pubspec.yaml,
compile it manually before running dartdoc.

Currently there is no really good way of resolving bin/<X>.dart given a package.
But it is not much more than searching package_config.json for the package name, and going relative from its rootUri.

gspencergoog · 2024-05-02T16:16:37Z

make snippets a dev-dependency in dev/tools/pubspec.yaml.

compile it manually before running dartdoc.

Can you clarify what this would look like @sigurdm? I don't know what the command would be that would generate the executable from a dev dependency on the tool. Do I need to create a new dart package that has a executable: clause and that package depends on snippets? And why would it be a dev dependency and not a dependency?

goderbauer

LGTM, but the analyzer is unhappy.

dev/bots/docs.sh

dev/bots/test.dart

dev/snippets/README.md

dev/snippets/lib/snippets.dart

goderbauer · 2024-05-02T16:29:07Z

Can you also send a PR to delete the tool from https://github.com/flutter/assets-for-api-docs/tree/main/packages/snippets so we are not confused about the two copies?

Should we also mark https://pub.dev/packages/snippets as discontinued since we are probably not going to publish any new versions there?

gspencergoog · 2024-05-03T02:14:27Z

Can you also send a PR to delete the tool from flutter/assets-for-api-docs@main/packages/snippets so we are not confused about the two copies?

Yes, will do.

Should we also mark pub.dev/packages/snippets as discontinued since we are probably not going to publish any new versions there?

Yes, that too.

auto-submit · 2024-05-03T03:48:06Z

auto label is removed for flutter/flutter/147690, due to - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

sigurdm · 2024-05-03T07:42:24Z

Can you clarify what this would look like @sigurdm? I don't know what the command would be that would generate the executable from a dev dependency on the tool. Do I need to create a new dart package that has a executable: clause and that package depends on snippets? And why would it be a dev dependency and not a dependency?

Yeah - that's the trouble, I don't think we currently have a command that will do it. (Hopefully we'll get that soon)

More details:

I would

make snippets a dev-dependency in dev/tools/pubspec.yaml,
(in Dart code, in the docs script before running dartdoc)
- load package_config.json (via https://api.dart.dev/stable/3.3.4/dart-isolate/Isolate/packageConfigSync.html)
- decode the json
- iterate config['packages'] to find the entry named 'snippets'.
- Join the snippets['rootDir'] with 'bin/snippets.dart' => snippetDart.
- compile that file by invoking Process.runSync(Platform.resolvedExecutable, ['--snapshot', outputLocation, snippetDart])

…#147690)

flutter/flutter@bf7191f...f1037a0 2024-05-03 [email protected] Roll Flutter Engine from 445c3bfc0d5b to 8cce00433073 (1 revision) (flutter/flutter#147778) 2024-05-03 [email protected] Roll Flutter Engine from 1f9edbeeceb3 to 445c3bfc0d5b (1 revision) (flutter/flutter#147776) 2024-05-03 [email protected] Roll Flutter Engine from 75eb18090510 to 1f9edbeeceb3 (1 revision) (flutter/flutter#147769) 2024-05-03 [email protected] Improved documentation for SpringSimulation (flutter/flutter#146674) 2024-05-03 [email protected] Roll Flutter Engine from b8d81a4f6e5a to 75eb18090510 (1 revision) (flutter/flutter#147766) 2024-05-03 [email protected] Roll Flutter Engine from d8c8cf4384f0 to b8d81a4f6e5a (2 revisions) (flutter/flutter#147765) 2024-05-03 [email protected] Move snippets package back into flutter repo (flutter/flutter#147690) 2024-05-03 [email protected] Roll Flutter Engine from 98a800b00cfc to d8c8cf4384f0 (2 revisions) (flutter/flutter#147763) 2024-05-03 [email protected] Roll Flutter Engine from c380e9fd4122 to 98a800b00cfc (3 revisions) (flutter/flutter#147761) 2024-05-03 [email protected] Roll Flutter Engine from fc71b650a70a to c380e9fd4122 (4 revisions) (flutter/flutter#147759) 2024-05-03 [email protected] Roll pub packages (flutter/flutter#147741) 2024-05-03 [email protected] Roll Flutter Engine from 3f1f81915620 to fc71b650a70a (2 revisions) (flutter/flutter#147753) 2024-05-02 [email protected] Roll Flutter Engine from 5088f63ecee2 to 3f1f81915620 (3 revisions) (flutter/flutter#147748) 2024-05-02 [email protected] [web] skip debug mode CanvasKit e2e tests due to flakiness; unskip all other modes (flutter/flutter#147736) 2024-05-02 [email protected] Control flow collections: `flutter_tools/` (flutter/flutter#147450) 2024-05-02 [email protected] Add default arguments to `AnimatedPhysicalModel` (flutter/flutter#147424) 2024-05-02 [email protected] Roll Flutter Engine from 9982b5ffd913 to 5088f63ecee2 (3 revisions) (flutter/flutter#147740) 2024-05-02 [email protected] `_RenderDecorator.computeDryBaseline` (flutter/flutter#146365) 2024-05-02 [email protected] Roll Flutter Engine from e1126e59b698 to 9982b5ffd913 (1 revision) (flutter/flutter#147727) 2024-05-02 [email protected] [web] increase chromedriver logging level (flutter/flutter#147687) 2024-05-02 [email protected] Roll Flutter Engine from 1fb36ac9d718 to e1126e59b698 (1 revision) (flutter/flutter#147720) 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 Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

This moves the snippets package back into the Flutter repo so that API documentation generation can happen without the use of `dart pub global run` because `pub run` doesn't handle concurrency well. The change modifies the dartdoc building process to include building an executable from the snippets tool and installing that in the cache directory for use during docs generation. The snippets tool will reside in dev/snippets, where it originally resided before being moved to https://github.com/flutter/assets-for-api-docs. The snippets code itself is unchanged from the code that is in https://github.com/flutter/assets-for-api-docs/packages/snippets. - flutter#144408 - flutter#147609 - flutter#147645 - Added snippets tests to the overall testing build.

flutter/flutter@bf7191f...f1037a0 2024-05-03 [email protected] Roll Flutter Engine from 445c3bfc0d5b to 8cce00433073 (1 revision) (flutter/flutter#147778) 2024-05-03 [email protected] Roll Flutter Engine from 1f9edbeeceb3 to 445c3bfc0d5b (1 revision) (flutter/flutter#147776) 2024-05-03 [email protected] Roll Flutter Engine from 75eb18090510 to 1f9edbeeceb3 (1 revision) (flutter/flutter#147769) 2024-05-03 [email protected] Improved documentation for SpringSimulation (flutter/flutter#146674) 2024-05-03 [email protected] Roll Flutter Engine from b8d81a4f6e5a to 75eb18090510 (1 revision) (flutter/flutter#147766) 2024-05-03 [email protected] Roll Flutter Engine from d8c8cf4384f0 to b8d81a4f6e5a (2 revisions) (flutter/flutter#147765) 2024-05-03 [email protected] Move snippets package back into flutter repo (flutter/flutter#147690) 2024-05-03 [email protected] Roll Flutter Engine from 98a800b00cfc to d8c8cf4384f0 (2 revisions) (flutter/flutter#147763) 2024-05-03 [email protected] Roll Flutter Engine from c380e9fd4122 to 98a800b00cfc (3 revisions) (flutter/flutter#147761) 2024-05-03 [email protected] Roll Flutter Engine from fc71b650a70a to c380e9fd4122 (4 revisions) (flutter/flutter#147759) 2024-05-03 [email protected] Roll pub packages (flutter/flutter#147741) 2024-05-03 [email protected] Roll Flutter Engine from 3f1f81915620 to fc71b650a70a (2 revisions) (flutter/flutter#147753) 2024-05-02 [email protected] Roll Flutter Engine from 5088f63ecee2 to 3f1f81915620 (3 revisions) (flutter/flutter#147748) 2024-05-02 [email protected] [web] skip debug mode CanvasKit e2e tests due to flakiness; unskip all other modes (flutter/flutter#147736) 2024-05-02 [email protected] Control flow collections: `flutter_tools/` (flutter/flutter#147450) 2024-05-02 [email protected] Add default arguments to `AnimatedPhysicalModel` (flutter/flutter#147424) 2024-05-02 [email protected] Roll Flutter Engine from 9982b5ffd913 to 5088f63ecee2 (3 revisions) (flutter/flutter#147740) 2024-05-02 [email protected] `_RenderDecorator.computeDryBaseline` (flutter/flutter#146365) 2024-05-02 [email protected] Roll Flutter Engine from e1126e59b698 to 9982b5ffd913 (1 revision) (flutter/flutter#147727) 2024-05-02 [email protected] [web] increase chromedriver logging level (flutter/flutter#147687) 2024-05-02 [email protected] Roll Flutter Engine from 1fb36ac9d718 to e1126e59b698 (1 revision) (flutter/flutter#147720) 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 Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

## Description Since the snippets tool has been moved to the Flutter repo in flutter/flutter#147690, this code is redundant, and no longer needed. ## Related Issues - flutter/flutter#144408

…#147690)

gspencergoog requested review from christopherfujino and goderbauer May 2, 2024 01:29

sigurdm reviewed May 2, 2024

View reviewed changes

sigurdm mentioned this pull request May 2, 2024

Linux docs_test is failing, closing the tree #147609

Closed

goderbauer approved these changes May 2, 2024

View reviewed changes

gspencergoog mentioned this pull request May 3, 2024

Remove snippets tool. flutter/assets-for-api-docs#245

Merged

gspencergoog added 6 commits May 2, 2024 19:35

Move snippets package back into flutter repo

01c1d70

Move test execution into regular test flow

9305a30

Move into snippets dir

5abb07a

Fix Copyrights

9c322d8

Review Changes

3ad2d6d

Fix analyzer issues

430694d

gspencergoog force-pushed the move_snippets branch from 70734a7 to 430694d Compare May 3, 2024 02:36

gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label May 3, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 3, 2024

gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label May 3, 2024

auto-submit bot merged commit 183bc15 into flutter:master May 3, 2024

engine-flutter-autoroll mentioned this pull request May 3, 2024

Roll Flutter from bf7191fd3884 to f1037a01b796 (21 revisions) flutter/packages#6641

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 3, 2024

183bc15 Move snippets package back into flutter repo (flutter/flutter…

919573f

…#147690)

Piinks mentioned this pull request May 15, 2024

flutter analyze --flutter-repo broken locally #148436

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 6, 2024

183bc15 Move snippets package back into flutter repo (flutter/flutter…

5d9fc7f

…#147690)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Move snippets package back into flutter repo #147690

Move snippets package back into flutter repo #147690

Uh oh!

gspencergoog commented May 2, 2024

Uh oh!

sigurdm left a comment

Uh oh!

gspencergoog commented May 2, 2024

Uh oh!

goderbauer left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

goderbauer commented May 2, 2024

Uh oh!

gspencergoog commented May 3, 2024

Uh oh!

auto-submit bot commented May 3, 2024

Uh oh!

sigurdm commented May 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Move snippets package back into flutter repo #147690

Move snippets package back into flutter repo #147690

Uh oh!

Conversation

gspencergoog commented May 2, 2024

Description

Related Issues

Tests

Uh oh!

sigurdm left a comment

Choose a reason for hiding this comment

Uh oh!

gspencergoog commented May 2, 2024

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

goderbauer commented May 2, 2024

Uh oh!

gspencergoog commented May 3, 2024

Uh oh!

auto-submit bot commented May 3, 2024

Uh oh!

sigurdm commented May 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants