Files
sdk/pkg
Jonas Finnemann Jensen bd2770e9eb Ignore internal errors in YamlEditor
When we landed null-safety we accidentally disabled internal self-testing in YamlEditor.
We fixed this in: https://github.com/dart-lang/tools/pull/2284

But this was reverted because this test broke. With this we should able to land:
https://github.com/dart-lang/tools/pull/2299

TL;DR: `YamlEditor.update` may throw `AssertionError` if it has an internal error.

Internal errors in `YamlEditor` should not happen, but we have bugs.
There is open PRs to fix some of those bugs, but in practice it's not unlikely
that there will always be bugs. We're modifying YAML source using `SourceSpan`s
from the YAML parser. Changes in the parser, surprising corner cases, complex modifications
or combinations of these can probably cause internal errors.

These internal errors happens when:
 * The result YAML output is invalid YAML.
 * The resulting YAML doesn't match the same semantic modification on the original YAML structure, when compared with deep equals.

Change-Id: I159b37e9a9f039f92c82881ccac2c4826332f816
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/471460
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Commit-Queue: Jonas Jensen <jonasfj@google.com>
2026-01-12 04:15:02 -08:00
..
2025-10-28 10:58:01 -07:00
2026-01-09 11:46:01 -08:00
2026-01-06 06:39:17 -08:00

Package validation

The packages in pkg/ are automatically validated on the LUCI CI bots. The validation is largely done by the tools/package_deps package; it can be tested locally via:

dart tools/package_deps/bin/package_deps.dart

Packages which are published

There are several packages developed in pkg/ which are published to pub. Validation of these packages is particularly important because the pub tools are not used for these packages during development; we get our dependency versions from the DEPS file. It's very easy for the dependencies specified in a package's pubspec file to get out of date wrt the packages and versions actually used.

In order to better ensure we're publishing correct packages, we validate some properties of the pubspec files on our CI system. These validations include:

  • that the dependencies listed in the pubspec are used in the package
  • that all the packages used by the source are listed in the pubspec
  • that we don't use relative path deps to pkg/ or third_party/ packages

Packages which are not published

For packages in pkg/ which we do not intend to be published, we put the following comment in the pubspec.yaml file:

# This package is not intended for consumption on pub.dev. DO NOT publish.
publish_to: none

These pubspecs are still validated by the package validation tool. The contents are more informational as the pubspecs for these packages are not consumed by the pub tool or ecosystem.

We validate:

  • that the dependencies listed in the pubspec are used in the package
  • that all the packages used by the source are listed in the pubspec
  • that a reference to a pkg/ package is done via a relative path dependency

Adding new packages

Run gclient sync to re-generate .dart_tool/package_config.json after adding a new package.

Testing packages

Currently dart test can't be used to run the tests, use test.py as usual. E.g. the command ./tools/test.py -n...<path> runs all tests with prefix <path>.