Skip to content

[native_assets_cli] Prevent EncodedAsset and Metadata hashcode changing #2131

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

Merged
merged 1 commit into from
Mar 26, 2025

Conversation

dcharkes
Copy link
Collaborator

Closes: #2045

We have two types of classes in the semantic API:

  1. Pure views on top of a JSON.
    These classes are mirrored by a builder class.
    Objects from these classes cannot be passed from input to output in hooks.
    These classes do not override hashCode and operator ==.
    Examples: CodeConfig, BuildInput.
  2. Data classes that eagerly copy all fields out of the JSON.
    These classes have a public constructor with it's constituent fields.
    Objects from these classes may be passed from input to output in hooks.
    These classes do override hashCode and operator ==.
    Examples: CodeAsset, Architecture, OS, DataAsset.

This changes Metadata and EncodedAsset to follow pattern 2 fully:

  • All data is copied on construction.
  • The map accessors do not allow modification.

This means the hashCode and operator == are now correct.

We could consider changing Metadata and EncodedAsset to pattern 1, but I didn't want to refactor that code in this PR. For more details:

Copy link

PR Health

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

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

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/jni/lib/src/third_party/generated_bindings.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

@dcharkes dcharkes force-pushed the deprecate-output-directory branch from dea58ed to d5e3137 Compare March 26, 2025 07:13
Base automatically changed from deprecate-output-directory to main March 26, 2025 07:24
@auto-submit auto-submit bot merged commit e2bd08e into main Mar 26, 2025
40 checks passed
@auto-submit auto-submit bot deleted the equals-override branch March 26, 2025 07:36
@coveralls
Copy link

Coverage Status

coverage: 86.021% (+0.004%) from 86.017%
when pulling 694ab24 on equals-override
into 781fc27 on main.

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.

[native_assets_cli] EncodedAsset is not immutable but overrides hashCode
3 participants