Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pub_semver] Discourage modification of properties intended to be unmodifiable #2020

Merged
merged 4 commits into from
Mar 6, 2025

Conversation

parlough
Copy link
Member

No description provided.

Copy link

github-actions bot commented Feb 17, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
pub_semver None 2.1.5 2.1.6 2.1.5 ✔️
Changelog Entry ✔️
Package Changed Files

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

Coverage ✔️
File Coverage
pkgs/pub_semver/lib/src/version.dart 💚 95 % ⬆️ 0 %
pkgs/pub_semver/lib/src/version_constraint.dart 💚 81 %
pkgs/pub_semver/lib/src/version_union.dart 💚 92 %

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

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 symbols
License Headers ✔️
// Copyright (c) 2025, 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/bazel_worker/benchmark/benchmark.dart
pkgs/bazel_worker/example/client.dart
pkgs/bazel_worker/example/worker.dart
pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart
pkgs/boolean_selector/example/example.dart
pkgs/clock/lib/clock.dart
pkgs/clock/lib/src/clock.dart
pkgs/clock/lib/src/default.dart
pkgs/clock/lib/src/stopwatch.dart
pkgs/clock/lib/src/utils.dart
pkgs/clock/test/clock_test.dart
pkgs/clock/test/default_test.dart
pkgs/clock/test/stopwatch_test.dart
pkgs/clock/test/utils.dart
pkgs/coverage/lib/src/coverage_options.dart
pkgs/coverage/test/collect_coverage_config_test.dart
pkgs/coverage/test/config_file_locator_test.dart
pkgs/html/example/main.dart
pkgs/html/lib/dom.dart
pkgs/html/lib/dom_parsing.dart
pkgs/html/lib/html_escape.dart
pkgs/html/lib/parser.dart
pkgs/html/lib/src/constants.dart
pkgs/html/lib/src/encoding_parser.dart
pkgs/html/lib/src/html_input_stream.dart
pkgs/html/lib/src/list_proxy.dart
pkgs/html/lib/src/query_selector.dart
pkgs/html/lib/src/token.dart
pkgs/html/lib/src/tokenizer.dart
pkgs/html/lib/src/treebuilder.dart
pkgs/html/lib/src/utils.dart
pkgs/html/test/dom_test.dart
pkgs/html/test/parser_feature_test.dart
pkgs/html/test/parser_test.dart
pkgs/html/test/query_selector_test.dart
pkgs/html/test/selectors/level1_baseline_test.dart
pkgs/html/test/selectors/level1_lib.dart
pkgs/html/test/selectors/selectors.dart
pkgs/html/test/support.dart
pkgs/html/test/tokenizer_test.dart
pkgs/pubspec_parse/test/git_uri_test.dart
pkgs/stack_trace/example/example.dart
pkgs/watcher/test/custom_watcher_factory_test.dart
pkgs/yaml_edit/example/example.dart

@devoncarew devoncarew requested a review from sigurdm February 18, 2025 15:40
Copy link
Contributor

@sigurdm sigurdm left a comment

Choose a reason for hiding this comment

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

Same as #2021 I'm not sure the potential slight breakage is worth the benefits of slightly lower memory pressure.

Do we have situations where the memory consumption of Version objects is significant or causing problems?

@parlough parlough changed the title [pub_semver] Reduce memory footprint of non-prerelease versions [pub_semver] Discourage modification of properties intended to be unmodifiable Feb 26, 2025
@parlough
Copy link
Member Author

Same as #2021 I'm not sure the potential slight breakage is worth the benefits of slightly lower memory pressure.

I think that's fair. I've instead repurposed the PR to discourage modification in the doc comments and changelog. I doubt anyone is doing so right now anyway, but if they are, hopefully this can help avoid new usages and make the change easier to make in the future.

@kevmoo
Copy link
Member

kevmoo commented Feb 27, 2025

holy cow, great find @parlough

Copy link
Member

@devoncarew devoncarew left a comment

Choose a reason for hiding this comment

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

FYI -

@parlough
Copy link
Member Author

parlough commented Mar 4, 2025

I don't have write access to this repo, so feel free to merge if the changes look good to you :)

Thanks for the reviews!

@sigurdm sigurdm merged commit 04667d7 into dart-lang:main Mar 6, 2025
12 checks passed
@parlough parlough deleted the feat/pub-semver-version-memory branch March 6, 2025 19:36
copybara-service bot pushed a commit to dart-lang/sdk that referenced this pull request Mar 7, 2025
…, tools, vector_math, web, webdriver

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

dartdoc (https://github.com/dart-lang/dartdoc/compare/34561d6..6c770bf):
  6c770bfb  2025-03-01  dependabot[bot]  Bump the github-actions group with 5 updates (dart-lang/dartdoc#4011)
  06233c76  2025-02-26  Parker Lougheed  Use nested scss in nav and footer styles (dart-lang/dartdoc#4006)
  4847677c  2025-02-26  Sam Rawlins  Support the stats flag when documenting the testing package (dart-lang/dartdoc#4008)

ecosystem (https://github.com/dart-lang/ecosystem/compare/06bbbff..a3cc42d):
  a3cc42d  2025-03-06  Devon Carew  Update publish_internal.yaml (dart-lang/ecosystem#345)
  25f0fb2  2025-03-04  Devon Carew  Update README.md (dart-lang/ecosystem#344)
  331d35d  2025-03-01  dependabot[bot]  Bump the github-actions group with 5 updates (dart-lang/ecosystem#343)

i18n (https://github.com/dart-lang/i18n/compare/06a664f..bdeec25):
  bdeec25  2025-03-04  Moritz  Publish `package:intl4x: 0.11.0` (dart-lang/i18n#953)
  d84a927  2025-03-04  Moritz  Update publishing workflow
  547ce9f  2025-03-01  dependabot[bot]  Bump the github-actions group with 2 updates (dart-lang/i18n#952)
  c6b911b  2025-02-21  dependabot[bot]  Bump the github-actions group across 1 directory with 4 updates (dart-lang/i18n#949)
  c3e9fe2  2025-02-21  Moritz  Update to new native_assets (dart-lang/i18n#941)

protobuf (https://github.com/dart-lang/protobuf/compare/610943a..7838e44):
  7838e44  2025-03-07  Ömer Sinan Ağacan  Prefix grpc method 'call' and 'request' arguments with '$' to avoid shadowing user methods with the same name (google/protobuf.dart#964)
  125fe9c  2025-03-02  dependabot[bot]  Bump dart-lang/setup-dart from 1.7.0 to 1.7.1 (google/protobuf.dart#965)
  fb77c7c  2025-03-02  dependabot[bot]  Bump actions/cache from 4.2.0 to 4.2.2 (google/protobuf.dart#966)

shelf (https://github.com/dart-lang/shelf/compare/b39e611..2af8529):
  2af8529  2025-03-04  Devon Carew  Update publish.yaml (dart-lang/shelf#473)
  f5ae797  2025-03-01  dependabot[bot]  Bump the github-actions group with 2 updates (dart-lang/shelf#471)

sync_http (https://github.com/dart-lang/sync_http/compare/47e6b26..dc54465):
  dc54465  2025-03-02  dependabot[bot]  Bump dart-lang/setup-dart from 1.7.0 to 1.7.1 (google/sync_http.dart#54)

test (https://github.com/dart-lang/test/compare/a833663..9e349d0):
  9e349d0e  2025-03-06  Jonas Finnemann Jensen  Suggest using `dart pub add dev:checks` (dart-lang/test#2467)
  e941dbac  2025-03-04  Devon Carew  Update publish.yaml (dart-lang/test#2465)
  32bf9b73  2025-03-01  dependabot[bot]  Bump the github-actions group with 5 updates (dart-lang/test#2462)

tools (https://github.com/dart-lang/tools/compare/b51f39d..d67cd00):
  d67cd002  2025-03-07  Parker Lougheed  [pub_semver] Remove dependency on `package:meta` (dart-lang/tools#2021)
  04667d7e  2025-03-06  Parker Lougheed  [pub_semver] Discourage modification of properties intended to be unmodifiable (dart-lang/tools#2020)
  b23129b9  2025-03-04  Devon Carew  Update publish.yaml (dart-lang/tools#2025)
  9765c2aa  2025-02-25  Parker Lougheed  [package_config] Implement relational operators for `LanguageVersion` (dart-lang/tools#2016)

vector_math (https://github.com/google/vector_math.dart/compare/533c513..f08d7d2):
  f08d7d2  2025-03-01  dependabot[bot]  Bump dart-lang/setup-dart in the github-actions group (google/vector_math.dart#340)

web (https://github.com/dart-lang/web/compare/c2d5f63..4854093):
  4854093  2025-03-04  Srujan Gaddam  Add pull request and id-token write permissions to publish.yaml (dart-lang/web#351)
  33ed133  2025-03-01  dependabot[bot]  Bump the github-actions group with 2 updates (dart-lang/web#349)
  6031c1f  2025-02-26  Kevin Moore  Delete all deprecated members (dart-lang/web#347)
  5a39fdc  2025-02-26  Kevin Moore  Merge tag 'web-v1.1.1'
  222164b  2025-02-26  Kevin Moore  Deprecate a few more things before we launch v2 (dart-lang/web#348)
  b90b63d  2025-02-25  Kevin Moore  Update APIs and docs (dart-lang/web#345)
  5caa92e  2025-02-25  Srujan Gaddam  Add catch and finally to bannedNames (dart-lang/web#346)
  e2f9741  2025-02-25  Olzhas Suleimen  Add variadic arguments (dart-lang/web#343)

webdriver (https://github.com/google/webdriver.dart/compare/b4fd859..f52afbf):
  f52afbf  2025-03-06  Parker Lougheed  Utilize switch expressions (google/webdriver.dart#327)
  ee311e0  2025-03-02  dependabot[bot]  Bump dart-lang/setup-dart from 1.7.0 to 1.7.1 (google/webdriver.dart#328)
  b0cb6a9  2025-02-27  Kevin Moore  Update to Dart/Flutter team lints and fix (google/webdriver.dart#322)
  d080ebf  2025-02-27  Kevin Moore  Update a number of APIs to return Uint8List (google/webdriver.dart#323)
  0400c06  2025-02-27  Kevin Moore  Re-enable Firefox on CI (google/webdriver.dart#324)
  38a6646  2025-02-24  Parker Lougheed  Minor cleanup for new and future lints (google/webdriver.dart#321)

Change-Id: Ied703b048f85dd78e30084ffa8bffcaab5bab67b
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/414301
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Commit-Queue: Devon Carew <devoncarew@google.com>
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.

4 participants