Skip to content

[pubspec_parse] Preserve input maps and YamlMap source spans - #2653

Merged
kevmoo merged 2 commits into
mainfrom
fix-pubspec_parse
Oct 19, 2026
Merged

kevmoo merged 2 commits into
mainfrom
fix-pubspec_parse

Conversation

@kevmoo

@kevmoo kevmoo commented Oct 9, 2026

Copy link
Copy Markdown
Member

Preserve the original json map reference and YamlMap source spans across Pubspec.fromJson (lenient: true) and dependency.dart:

  • lib/src/pubspec.dart (Pubspec.fromJson):
    • Keep json pointing to the caller's original Map (typically a YamlMap from checkedYamlDecode) and mutate a local var currentJson = json; in the lenient retry loop.
    • Never strip the required 'name' key when lenient: true, preventing toParsedYamlException in package:checked_yaml from failing with type '_Map<dynamic, dynamic>' is not a subtype of type 'YamlMap' when 'name' is missing, null, or empty.
    • If a top-level CheckedFromJsonException is thrown against a modified currentJson copy (for example, name: "" failing validation in the Pubspec(...) constructor after an earlier pass stripped an invalid optional property), re-bind e.map back to the original json YamlMap so source spans are preserved.
  • lib/src/dependency.dart (parseDeps, GitDependency.fromData, HostedDetails.fromJson):
    • In parseDeps, only re-bind CheckedFromJsonException.map when the dependency value is not a Map, or when source is a YamlMap and e.map is not a YamlMap (preserving nested map/key context when Pubspec.fromJson is called with plain Dart Maps).
    • In GitDependency.fromData and HostedDetails.fromJson, parse string values directly instead of wrapping them in synthetic {'url': data} plain maps that lost YamlMap source spans.

kevmoo added 2 commits October 9, 2026 06:50
…nt: true

When `Pubspec.fromJson` is called with `lenient: true`, avoid removing the
required `'name'` key on error, and re-bind any top-level
`CheckedFromJsonException` thrown on a modified map copy back to the original
`json` (`YamlMap`) so `toParsedYamlException` in `package:checked_yaml` does
not fail with a `TypeError` (`_Map is not a subtype of YamlMap`).
- In `parseDeps`, only re-bind `CheckedFromJsonException.map` when the dependency value is not a `Map`, or when `source` is a `YamlMap` and `e.map` is not a `YamlMap` (so `Pubspec.fromJson` with plain Dart `Map`s preserves nested map/key context).
- In `GitDependency.fromData` and `HostedDetails.fromJson`, parse string values directly instead of wrapping them in synthetic `{'url': data}` plain maps that lost `YamlMap` source spans.
@kevmoo
kevmoo requested a review from a team October 9, 2026 07:06
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

PR Health

Coverage ✔️
File Coverage
pkgs/pubspec_parse/lib/src/dependency.dart 💚 82 % ⬆️ 0 %
pkgs/pubspec_parse/lib/src/pubspec.dart 💚 98 % ⬆️ 0 %

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

License Headers ✔️
// Copyright (c) 2026, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/html/test/differential_test.dart
pkgs/html/test/dom_parsing_test.dart
pkgs/html/test/mxss_test.dart
pkgs/html/test/noah_ark_clause_limit_test.dart

This check can be disabled by tagging the PR with skip-license-check.

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
pubspec_parse Non-Breaking 1.6.0 1.7.0-wip 1.7.0-wip ✔️

This check can be disabled by tagging the PR with skip-breaking-check.

Unused Dependencies ✔️
Package Status
pubspec_parse ✔️ All dependencies utilized correctly.

For details on how to fix these, see dependency_validator.

This check can be disabled by tagging the PR with skip-unused-dependencies-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbol Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request improves error handling and parsing behavior in pubspec_parse. Specifically, it fixes Pubspec.fromJson with lenient: true to preserve the input Map when the name is invalid or missing, and ensures nested Map keys and spans are preserved when dependency shorthands fail to parse. Feedback on the changes suggests removing an unnecessary null assertion operator (!) on e.className when throwing a CheckedFromJsonException to prevent potential runtime exceptions.

Comment thread pkgs/pubspec_parse/lib/src/pubspec.dart Resolved
@kevmoo
kevmoo requested a review from sigurdm October 19, 2026 14:48
@kevmoo
kevmoo merged commit f6c7a2d into main Oct 19, 2026
22 checks passed
@kevmoo
kevmoo deleted the fix-pubspec_parse branch October 19, 2026 14:59
copybara-service Bot pushed a commit to dart-lang/sdk that referenced this pull request Oct 20, 2026
…, web

Revisions updated by `dart tools/rev_sdk_deps.dart`.

core (https://github.com/dart-lang/core/compare/4d80610..72e71ca):
  72e71ca0  Mon Oct 19 21:57:11 2026 +0200  Jonas Finnemann Jensen  Optimize `HashSink` and `_MD5Sink.updateHash` (RFC impl) (dart-lang/core#1013)

dartdoc (https://github.com/dart-lang/dartdoc/compare/e1859cf..c0e19cf):
  c0e19cf6  Mon Oct 19 11:41:42 2026 -0700  Konstantin Scheglov  Import analyzer ast with explicit show. (dart-lang/dartdoc#4300)

ecosystem (https://github.com/dart-lang/ecosystem/compare/622ef61..0ab0cfd):
  0ab0cfd  Mon Oct 19 15:44:26 2026 +0200  Moritz  fix(firehose): bump dependency_validator to support analyzer 14 (dart-lang/ecosystem#453)
  44a0768  Wed Oct 14 09:37:29 2026 -0700  Nate Bosch  Improve firehose publish validation log output (dart-lang/ecosystem#468)

http (https://github.com/dart-lang/http/compare/7d7aae2..a8a24a0):
  a8a24a0  Mon Oct 19 13:31:34 2026 -0700  Kevin Moore  docs(web_socket): remove non-user-visible changelog entry (dart-lang/http#2023)
  6f6ac5f  Mon Oct 19 16:29:43 2026 -0400  Mouad Debbar  [http_multi_server] Retry `loopback(0)` when IPv6 port is already bound (dart-lang/http#2025)
  6e91ce3  Tue Oct 13 16:25:39 2026 -0700  Kevin Moore  Sync root README.md package table from pubspec.yaml files (dart-lang/http#2024)

native (https://github.com/dart-lang/native/compare/cc7e4b0..3cbe319):
  3cbe319e3  Tue Oct 13 15:47:18 2026 +0200  Daco Harkes  [hooks_runner] Fail eagerly when file locking is not supported on file system (dart-lang/native#3679)

shelf (https://github.com/dart-lang/shelf/compare/b2cb503..b66665b):
  b66665b  Fri Oct 16 15:12:05 2026 -0700  Kevin Moore  chore: add health workflow and prepare shelf 1.4.3, shelf_router 1.1.5, and shelf_static 1.2.0 (dart-lang/shelf#546)

test (https://github.com/dart-lang/test/compare/9bf69a8..d1afeb1):
  d1afeb14  Fri Oct 16 20:41:51 2026 -0400  Mouad Debbar  Confirmation that `tearDown` is called on timeout (dart-lang/test#2798)
  3f6c2f14  Thu Oct 15 18:21:35 2026 -0700  Jacob MacDonald  Enable asserts in the cli compiler (dart-lang/test#2795)

tools (https://github.com/dart-lang/tools/compare/c1471db..f6c7a2d):
  f6c7a2d62  Mon Oct 19 07:59:24 2026 -0700  Kevin Moore  [pubspec_parse] Preserve input maps and YamlMap source spans (dart-lang/tools#2653)
  f1a55d953  Mon Oct 19 07:53:51 2026 -0700  Kevin Moore  [yaml] Fix tag URI decoding, numeric tag RangeErrors, and dead checks (dart-lang/tools#2630)
  340ded284  Mon Oct 19 07:43:31 2026 -0700  Kevin Moore  [unified_analytics] Prepare for 8.2.0 release (dart-lang/tools#2689)
  a73703543  Fri Oct 16 11:55:03 2026 -0700  Kevin Moore  [unified_analytics] Bump version to 8.2.0-wip (dart-lang/tools#2688)

web (https://github.com/dart-lang/web/compare/63e6662..4e60e61):
  4e60e61  Mon Oct 19 10:02:22 2026 -0700  dependabot[bot]  Bump source-map-js from 1.2.1 to 1.2.2 in /web_generator (dart-lang/web#591)
  7d63637  Mon Oct 19 09:50:26 2026 -0700  Kevin Moore  Add an api.txt golden for package:web (dart-lang/web#590)

[email protected]

Change-Id: Ibe6ac8a8246a27caa8a4846ea1acc78c801ee2ae
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/566781
Commit-Queue: Nate Bosch <[email protected]>
Reviewed-by: Brian Quinlan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants