Repository navigation
Milestone 3.5: widen system/address UID int32 -> int64 (Artery prerequisite) #8317
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,47 @@ | ||
| ## 1. Core type + generation | ||
|
|
||
| - [x] 1.1 Widen `AddressUid.Uid` (field) + `AddressUidExtension.Uid(ActorSystem)` `int → long` | ||
| - [x] 1.2 Add a netstandard2.0-safe 64-bit RNG; default generation stays in `[0, int.MaxValue]` | ||
| - [x] 1.3 Config switch to enable full 64-bit uid generation (default off; documented "all nodes v1.6 first" precondition) — `akka.remote.use-64bit-system-uids` | ||
|
|
||
| ## 2. Cluster | ||
|
|
||
| - [x] 2.1 `UniqueAddress(Address, long uid)` + `long Uid`; fix identity/sort/hash (`Member`) | ||
| - [x] 2.2 Verify gossip vector-clock node name (`VclockName` = address + "-" + uid decimal string) — behavior unchanged (string-only, `ClusterDaemon.VclockName`; hash also value-identical for int-range uids) | ||
| - [x] 2.3 `ClusterDaemon` `Quarantined(new UniqueAddress(addr, long uid))` | ||
|
|
||
| ## 3. Remoting state machine (internal `int → long`) | ||
|
|
||
| - [x] 3.1 `HandshakeInfo` ctor + `Uid`; `AkkaProtocolTransport` refuseUid path | ||
| - [x] 3.2 `EndpointRegistry` (register/quarantine/refuseUid) | ||
| - [x] 3.3 `Endpoint.cs`: `HopelessAssociation`, `ReliableDeliverySupervisor`, `GotUid`, `EndpointWriter` uid fields/params | ||
| - [x] 3.4 `EndpointManager` messages: `Pass`, `Quarantined`, `Quarantine`, `ResendState` | ||
|
|
||
| ## 4. RemoteWatcher | ||
|
|
||
| - [x] 4.1 `HeartbeatRsp(long addressUid)` + `long AddressUid`; `_addressUids: Dictionary<Address,long>`; `ReceiveHeartbeatRsp` | ||
| - [x] 4.2 `Quarantine(Address, long? addressUid)` | ||
|
|
||
| ## 5. Quarantine API (hard re-type) | ||
|
|
||
| - [x] 5.1 `IRemoteActorRefProvider.Quarantine(Address, long? uid)` | ||
| - [x] 5.2 `RemoteActorRefProvider.Quarantine`, `RemoteTransport.Quarantine`, `Remoting.Quarantine` | ||
| - [x] 5.3 `QuarantinedEvent(Address, long uid)` + `long Uid` | ||
|
|
||
| ## 6. Wire + serializers | ||
|
|
||
| - [x] 6.1 `ClusterMessages.proto` `UniqueAddress.uid` `uint32 → uint64`; regenerate (Grpc.Tools at build time) | ||
| - [x] 6.2 Remove narrowing casts: `ClusterMessageSerializer`, `MiscMessageSerializer`, `AkkaPduCodec`, DData `SerializationSupport.UniqueAddressFromProto` | ||
| - [x] 6.3 Coordinate `serializer-v2` schema to emit/read 64-bit uid (Decision 11 in serializer-v2 design.md) | ||
|
|
||
| ## 7. API approval + build | ||
|
|
||
| - [x] 7.1 Update `Akka.API.Tests` approved files (`ApproveRemote.*`, `ApproveCluster.*`) for the hard break | ||
| - [x] 7.2 `dotnet build -warnaserror` clean | ||
| - [x] 7.3 Akka.Remote + Akka.Cluster + DistributedData tests green (391 / 376 / 190 passed, 0 failed, net10.0 Release) | ||
|
|
||
| ## 8. Compatibility + docs | ||
|
|
||
| - [x] 8.1 Rolling-upgrade test: v1.5 ↔ v1.6 gossip with int-range uids — no truncation, cluster forms (wire-level simulation via uint32/uint64 varint cross-parse in `UniqueAddressWireCompatSpec`; a live mixed-version cluster cannot be exercised in-repo) | ||
| - [x] 8.2 Full-range generation test (all-v1.6) — >32-bit uids round-trip (gossip, heartbeat, handshake PDU, DData; generation range tests in `AddressUidExtensionSpecs`) | ||
| - [x] 8.3 Add `BREAKING_CHANGES_V1.6.md` entry (API + Wire rows) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| //----------------------------------------------------------------------- | ||
| // <copyright file="UniqueAddressSerializationSupportSpec.cs" company="Akka.NET Project"> | ||
| // Copyright (C) 2009-2022 Lightbend Inc. <http://www.lightbend.com> | ||
| // Copyright (C) 2013-2025 .NET Foundation <https://github.com/akkadotnet/akka.net> | ||
| // </copyright> | ||
| //----------------------------------------------------------------------- | ||
|
|
||
| using Akka.Actor; | ||
| using Akka.Configuration; | ||
| using Akka.DistributedData.Serialization; | ||
| using FluentAssertions; | ||
| using Xunit; | ||
| using Address = Akka.Actor.Address; | ||
| using UniqueAddress = Akka.Cluster.UniqueAddress; | ||
|
|
||
| namespace Akka.DistributedData.Tests.Serialization | ||
| { | ||
| /// <summary> | ||
| /// Task 8.2: DData's <see cref="Proto.Msg.UniqueAddress"/> wire field was already <c>int64</c> | ||
| /// (ReplicatorMessages.proto) before the widen-system-uid-to-64bit change - only the C# narrowing cast in | ||
| /// <see cref="SerializationSupport.UniqueAddressFromProto"/> was removed. This verifies >32-bit uids | ||
| /// round-trip cleanly through <see cref="SerializationSupport.UniqueAddressToProto"/> / | ||
| /// <see cref="SerializationSupport.UniqueAddressFromProto"/>. | ||
| /// </summary> | ||
| [Collection("DistributedDataSpec")] | ||
| public class UniqueAddressSerializationSupportSpec : TestKit.Xunit.TestKit | ||
| { | ||
| private static readonly Config BaseConfig = ConfigurationFactory.ParseString(@" | ||
| akka.actor { | ||
| provider=""Akka.Cluster.ClusterActorRefProvider, Akka.Cluster"" | ||
| } | ||
| akka.remote.dot-netty.tcp.port = 0").WithFallback(DistributedData.DefaultConfig()); | ||
|
|
||
| private readonly SerializationSupport _support; | ||
|
|
||
| public UniqueAddressSerializationSupportSpec(ITestOutputHelper output) | ||
| : base(BaseConfig, "UniqueAddressSerializationSupportSpec", output) | ||
| { | ||
| _support = new SerializationSupport((ExtendedActorSystem)Sys); | ||
| } | ||
|
|
||
| [Theory(DisplayName = "Should_round_trip_unchanged_When_SerializationSupport_converts_a_64_bit_uid")] | ||
| [InlineData(12345L)] | ||
| [InlineData(long.MaxValue)] | ||
| [InlineData(unchecked((long)0x8000_0000_0000_0001))] // negative | ||
| [InlineData(1L << 40)] | ||
| public void Should_round_trip_unchanged_When_SerializationSupport_converts_a_64_bit_uid(long uid) | ||
| { | ||
| var address = new UniqueAddress(new Address("akka.tcp", Sys.Name, "some.host.org", 4711), uid); | ||
|
|
||
| var proto = SerializationSupport.UniqueAddressToProto(address); | ||
| var roundTripped = _support.UniqueAddressFromProto(proto); | ||
|
|
||
| roundTripped.Should().Be(address); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DData's
UniqueAddress.uidinReplicatorMessages.protowas alreadyint64before this change, so this is just the C#(int)narrowing coming off.UniqueAddressSerializationSupportSpecadds a >32-bit round-trip overUniqueAddressToProto/UniqueAddressFromPrototo lock that in.