[CP] Pub delete stray package configs in directories between the package root and workspace packages

[sigurdm]

Commit(s) to merge

dart-lang/pub#4446
Rolled into main in: https://dart-review.googlesource.com/c/sdk/+/398400

Target

stable

Prepared changelist for beta/stable

https://dart-review.googlesource.com/c/sdk/+/399906

Issue Description

When migrating a monorepo to use pub workspaces one might have old .dart_tool/package_config.json files in directories between the workspace root and the workspace packages.

These will be picked up by the vm and analyzer, resulting in obscore error messages. This is hard to debug, as .dart_tool usually is hidden and gitignored. (see flutter/devtools#8211)

What is the fix

Delete the stray package_config files after resolution.

pubspec.lock files are also deleted.

If pubspec.yaml files are present in such directories, the resolution fails with an error message.

Why cherry-pick

pub workspaces are officially launching in 3.6, making that the point where users migrate to workspaces, and therefore the highest risk period for confusions like described above.

Risk

medium-low.

Issue link(s)

dart-lang/pub#4445

Extra Info

No response

[dart-github-bot]

Summary: Stray .dart_tool/package_config.json files in monorepos cause obscure errors. The fix deletes these files after pub workspace resolution.

[jonasfj]

LGTM,

But I think it's fair to argue that this is not critical. The workspace feature will work without this. This feature mostly aims to prevent accidental scenarios where left-over files causes the workspace resolution to be ignored.

It's not necessarily super common, and not expected that all mono-repositories migrating to workspace will run into this issue.

[sigurdm]

It's not necessarily super common, and not expected that all mono-repositories migrating to workspace will run into this issue.

While this is true - cherry picking will support the first impression at the moment where most people are expected to migrate...