com.unity.netcode.gameobjects@1.0.1

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). ## [1.0.1] - 2022-08-23 ### Changed - Changed version to 1.0.1. (#2131) - Updated dependency on `com.unity.transport` to 1.2.0. (#2129) - When using `UnityTransport`, _reliable_ payloads are now allowed to exceed the configured 'Max Payload Size'. Unreliable payloads remain bounded by this setting. (#2081) - Preformance improvements for cases with large number of NetworkObjects, by not iterating over all unchanged NetworkObjects ### Fixed - Fixed an issue where reading/writing more than 8 bits at a time with BitReader/BitWriter would write/read from the wrong place, returning and incorrect result. (#2130) - Fixed issue with the internal `NetworkTransformState.m_Bitset` flag not getting cleared upon the next tick advancement. (#2110) - Fixed interpolation issue with `NetworkTransform.Teleport`. (#2110) - Fixed issue where the authoritative side was interpolating its transform. (#2110) - Fixed Owner-written NetworkVariable infinitely write themselves (#2109) - Fixed NetworkList issue that showed when inserting at the very end of a NetworkList (#2099) - Fixed issue where a client owner of a `NetworkVariable` with both owner read and write permissions would not update the server side when changed. (#2097) - Fixed issue when attempting to spawn a parent `GameObject`, with `NetworkObject` component attached, that has one or more child `GameObject`s, that are inactive in the hierarchy, with `NetworkBehaviour` components it will no longer attempt to spawn the associated `NetworkBehaviour`(s) or invoke ownership changed notifications but will log a warning message. (#2096) - Fixed an issue where destroying a NetworkBehaviour would not deregister it from the parent NetworkObject, leading to exceptions when the parent was later destroyed. (#2091) - Fixed issue where `NetworkObject.NetworkHide` was despawning and destroying, as opposed to only despawning, in-scene placed `NetworkObject`s. (#2086) - Fixed `NetworkAnimator` synchronizing transitions twice due to it detecting the change in animation state once a transition is started by a trigger. (#2084) - Fixed issue where `NetworkAnimator` would not synchronize a looping animation for late joining clients if it was at the very end of its loop. (#2076) - Fixed issue where `NetworkAnimator` was not removing its subscription from `OnClientConnectedCallback` when despawned during the shutdown sequence. (#2074) - Fixed IsServer and IsClient being set to false before object despawn during the shutdown sequence. (#2074) - Fixed NetworkList Value event on the server. PreviousValue is now set correctly when a new value is set through property setter. (#2067) - Fixed NetworkLists not populating on client. NetworkList now uses the most recent list as opposed to the list at the end of previous frame, when sending full updates to dynamically spawned NetworkObject. The difference in behaviour is required as scene management spawns those objects at a different time in the frame, relative to updates. (#2062)
2022-08-23 00:00:00 +00:00
parent 18ffd5fdc8
commit e15bd056c5
58 changed files with 2192 additions and 1676 deletions
--- a/Tests/Editor/Messaging/MessageRegistrationTests.cs
+++ b/Tests/Editor/Messaging/MessageRegistrationTests.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using NUnit.Framework;

@@ -179,5 +180,122 @@ namespace Unity.Netcode.EditorTests
                Assert.AreEqual(handlerFour, systemThree.MessageHandlers[systemThree.GetMessageType(typeof(TestMessageFour))]);
            }
        }
+
+        internal class AAAEarlyLexicographicNetworkMessage : INetworkMessage
+        {
+            public void Serialize(FastBufferWriter writer)
+            {
+            }
+
+            public bool Deserialize(FastBufferReader reader, ref NetworkContext context)
+            {
+                return true;
+            }
+
+            public void Handle(ref NetworkContext context)
+            {
+            }
+        }
+
+#pragma warning disable IDE1006
+        internal class zzzLateLexicographicNetworkMessage : AAAEarlyLexicographicNetworkMessage
+        {
+        }
+#pragma warning restore IDE1006
+
+        internal class OrderingMessageProvider : IMessageProvider
+        {
+            public List<MessagingSystem.MessageWithHandler> GetMessages()
+            {
+                var listMessages = new List<MessagingSystem.MessageWithHandler>();
+
+                var messageWithHandler = new MessagingSystem.MessageWithHandler();
+
+                messageWithHandler.MessageType = typeof(zzzLateLexicographicNetworkMessage);
+                listMessages.Add(messageWithHandler);
+
+                messageWithHandler.MessageType = typeof(ConnectionRequestMessage);
+                listMessages.Add(messageWithHandler);
+
+                messageWithHandler.MessageType = typeof(ConnectionApprovedMessage);
+                listMessages.Add(messageWithHandler);
+
+                messageWithHandler.MessageType = typeof(OrderingMessage);
+                listMessages.Add(messageWithHandler);
+
+                messageWithHandler.MessageType = typeof(AAAEarlyLexicographicNetworkMessage);
+                listMessages.Add(messageWithHandler);
+
+                return listMessages;
+            }
+        }
+
+        [Test]
+        public void MessagesGetPrioritizedCorrectly()
+        {
+            var sender = new NopMessageSender();
+            var provider = new OrderingMessageProvider();
+            var messagingSystem = new MessagingSystem(sender, null, provider);
+
+            // the 3 priority messages should appear first, in lexicographic order
+            Assert.AreEqual(messagingSystem.MessageTypes[0], typeof(ConnectionApprovedMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[1], typeof(ConnectionRequestMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[2], typeof(OrderingMessage));
+
+            // the other should follow after
+            Assert.AreEqual(messagingSystem.MessageTypes[3], typeof(AAAEarlyLexicographicNetworkMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[4], typeof(zzzLateLexicographicNetworkMessage));
+
+            // there should not be any extras
+            Assert.AreEqual(messagingSystem.MessageHandlerCount, 5);
+
+            // reorder the zzz one to position 3
+            messagingSystem.ReorderMessage(3, XXHash.Hash32(typeof(zzzLateLexicographicNetworkMessage).FullName));
+
+            // the 3 priority messages should still appear first, in lexicographic order
+            Assert.AreEqual(messagingSystem.MessageTypes[0], typeof(ConnectionApprovedMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[1], typeof(ConnectionRequestMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[2], typeof(OrderingMessage));
+
+            // the other should follow after, but reordered
+            Assert.AreEqual(messagingSystem.MessageTypes[3], typeof(zzzLateLexicographicNetworkMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[4], typeof(AAAEarlyLexicographicNetworkMessage));
+
+            // there should still not be any extras
+            Assert.AreEqual(messagingSystem.MessageHandlerCount, 5);
+
+            // verify we get an exception when asking for an invalid position
+            try
+            {
+                messagingSystem.ReorderMessage(-1, XXHash.Hash32(typeof(zzzLateLexicographicNetworkMessage).FullName));
+                Assert.Fail();
+            }
+            catch (ArgumentException)
+            {
+            }
+
+            // reorder the zzz one to position 3, again, to check nothing bad happens
+            messagingSystem.ReorderMessage(3, XXHash.Hash32(typeof(zzzLateLexicographicNetworkMessage).FullName));
+
+            // the two non-priority should not have moved
+            Assert.AreEqual(messagingSystem.MessageTypes[3], typeof(zzzLateLexicographicNetworkMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[4], typeof(AAAEarlyLexicographicNetworkMessage));
+
+            // there should still not be any extras
+            Assert.AreEqual(messagingSystem.MessageHandlerCount, 5);
+
+            // 4242 is a random hash that should not match anything
+            messagingSystem.ReorderMessage(3, 4242);
+
+            // that should result in an extra entry
+            Assert.AreEqual(messagingSystem.MessageHandlerCount, 6);
+
+            // with a null handler
+            Assert.AreEqual(messagingSystem.MessageHandlers[3], null);
+
+            // and it should have bumped the previous messages down
+            Assert.AreEqual(messagingSystem.MessageTypes[4], typeof(zzzLateLexicographicNetworkMessage));
+            Assert.AreEqual(messagingSystem.MessageTypes[5], typeof(AAAEarlyLexicographicNetworkMessage));
+        }
    }
 }