Removed all usages and support for Authority.AuthorityLossImminent (#1451)

* Removed all usages and support for Authority.AuthorityLossImminent

Author: zeroZshadow

CHANGELOG.md

@@ -9,6 +9,8 @@
 - ComponentUpdateSystem no longer has the API `GetAuthority`, `GetComponent`, and `HasComponent`. [#1364](https://github.com/spatialos/gdk-for-unity/pull/1364)
   - Use the Unity Entities `EntityManager` instead.
 - The GDK now depends on .NET Core v3.1.3xx instead of v2.2.2xx. [#1443](https://github.com/spatialos/gdk-for-unity/pull/1443)
+- Removed APIs for AuthorityLossImminent. [#1451](https://github.com/spatialos/gdk-for-unity/pull/1451)
+  - All authority changes to `AuthorityLossImminent` will now be dropped, and callbacks will no longer trigger.
 
 ### Added
 

UPGRADE_GUIDE.md

@@ -2,6 +2,12 @@
 
 ## From `0.3.9` to `0.3.10`
 
+### AuthorityLossImminent support removed
+
+The GDK for Unity no longer supports the `AuthorityLossImminent` authority state. If this feature is currently enabled, it will not trigger the authority state for any reader or writer. The methods to `Ack` the authority state have also been removed.
+
+To disable the feature for your worker types, please follow the [documentation](https://documentation.improbable.io/spatialos-overview/docs/component-settings).
+
 ### ComponentUpdateSystem API changes
 
 The methods `GetAuthority`, `GetComponent`, and `HasComponent` have been removed from the `ComponentUpdateSystem`.

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/CallbackManagers/AuthorityConstraintCallbackManager.cs

@@ -5,7 +5,7 @@
 
 namespace Improbable.Gdk.Subscriptions
 {
-    internal class AuthorityConstraintCallbackManager : IAuthorityCallbackManager
+    internal class AuthorityConstraintCallbackManager : ICallbackManager
     {
         private readonly CallbackCollection<AuthorityChangeReceived> callbackCollection = new CallbackCollection<AuthorityChangeReceived>();
         private readonly uint componentId;
@@ -35,18 +35,6 @@ public void InvokeCallbacks()
             }
         }
 
-        public void InvokeLossImminentCallbacks()
-        {
-            var changes = componentUpdateSystem.GetAuthorityChangesReceived(componentId);
-            for (var i = 0; i < changes.Count; ++i)
-            {
-                if (changes[i].Authority == Authority.AuthorityLossImminent)
-                {
-                    callbackCollection.InvokeAllReverse(changes[i]);
-                }
-            }
-        }
-
         public ulong RegisterCallback(Action<AuthorityChangeReceived> callback)
         {
             callbackCollection.Add(nextCallbackId, callback);

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/CallbackManagers/ComponentAuthorityCallbackManager.cs

@@ -5,7 +5,7 @@
 
 namespace Improbable.Gdk.Subscriptions
 {
-    internal class ComponentAuthorityCallbackManager : IAuthorityCallbackManager
+    internal class ComponentAuthorityCallbackManager : ICallbackManager
     {
         private readonly EntityCallbacks<Authority> callbacks = new EntityCallbacks<Authority>();
         private readonly uint componentId;
@@ -34,18 +34,6 @@ public void InvokeCallbacks()
             }
         }
 
-        public void InvokeLossImminentCallbacks()
-        {
-            var changes = componentUpdateSystem.GetAuthorityChangesReceived(componentId);
-            for (var i = 0; i < changes.Count; ++i)
-            {
-                if (changes[i].Authority == Authority.AuthorityLossImminent)
-                {
-                    callbacks.InvokeAllReverse(changes[i].EntityId, changes[i].Authority);
-                }
-            }
-        }
-
         public ulong RegisterCallback(EntityId entityId, Action<Authority> callback)
         {
             return callbacks.Add(entityId, callback);

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/CallbackManagers/IAuthorityCallbackManager.cs

@@ -74,17 +74,12 @@ public bool UnregisterCallback(ulong callbackKey)
             return keyAndManager.Item2.UnregisterCallback(keyAndManager.Item1);
         }
 
-        internal void InvokeNoLossImminent()
+        internal void InvokeCallbacks()
         {
             componentCallbackManagers.InvokeEach(manager => manager.InvokeCallbacks());
             authorityCallbackManagers.InvokeEach(manager => manager.InvokeCallbacks());
         }
 
-        internal void InvokeLossImminent()
-        {
-            authorityCallbackManagers.InvokeEach(manager => manager.InvokeLossImminentCallbacks());
-        }
-
         protected override void OnCreate()
         {
             base.OnCreate();

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/CallbackManagers/IAuthorityCallbackManager.cs.meta

@@ -42,7 +42,7 @@ protected override void OnUpdate()
         {
             componentConstraintsCallbackSystem.Invoke();
 
-            componentCallbackSystem.InvokeNoLossImminent();
+            componentCallbackSystem.InvokeCallbacks();
 
             if (behavioursToEnable.Count > 0)
             {
@@ -59,8 +59,6 @@ protected override void OnUpdate()
                 behavioursToEnable.Clear();
             }
 
-            componentCallbackSystem.InvokeLossImminent();
-
             commandCallbackSystem.InvokeCallbacks();
             workerFlagCallbackSystem.InvokeCallbacks();
         }

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/Systems/ComponentCallbackSystem.cs

@@ -70,11 +70,6 @@ public List<EntityId> GetComponentsRemoved(uint componentId)
             return manager.GetComponentsRemoved();
         }
 
-        public void AcknowledgeAuthorityLoss(EntityId entityId, uint componentId)
-        {
-            worker.MessagesToSend.AcknowledgeAuthorityLoss(entityId.Id, componentId);
-        }
-
         protected override void OnCreate()
         {
             base.OnCreate();

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/Systems/RequireLifecycleSystem.cs

@@ -35,9 +35,6 @@ private static class MessagesToSendMetadata
 
         private readonly WorldCommandsToSendStorage worldCommandStorage = new WorldCommandsToSendStorage();
 
-        private readonly MessageList<EntityComponent> authorityLossAcks =
-            new MessageList<EntityComponent>();
-
         private readonly MessageList<LogMessageToSend> logsToSend = new MessageList<LogMessageToSend>();
 
         private readonly List<Metrics> metricsToSend = new List<Metrics>();
@@ -90,16 +87,10 @@ public void Clear()
                 storage.Clear();
             }
 
-            authorityLossAcks.Clear();
             logsToSend.Clear();
             metricsToSend.Clear();
         }
 
-        public void AcknowledgeAuthorityLoss(long entityId, uint componentId)
-        {
-            authorityLossAcks.Add(new EntityComponent(entityId, componentId));
-        }
-
         public void AddComponentUpdate<T>(in T update, long entityId)
             where T : ISpatialComponentUpdate
         {
@@ -152,11 +143,6 @@ internal List<Metrics> GetMetrics()
             return metricsToSend;
         }
 
-        internal MessageList<EntityComponent> GetAuthorityLossAcknowledgements()
-        {
-            return authorityLossAcks;
-        }
-
         internal IComponentDiffStorage GetComponentDiffStorage(uint componentId)
         {
             if (!componentIdToComponentStorage.TryGetValue(componentId, out var storage))

workers/unity/Packages/io.improbable.gdk.core/Systems/ComponentUpdateSystem.cs

@@ -42,9 +42,6 @@ public class SerializedMessagesToSend
 
         private readonly List<Metrics> metricsToSend = new List<Metrics>();
 
-        private readonly MessageList<EntityComponent> authorityLossAcks =
-            new MessageList<EntityComponent>();
-
         private readonly List<IComponentSerializer> componentSerializers = new List<IComponentSerializer>();
         private readonly List<ICommandSerializer> commandSerializers = new List<ICommandSerializer>();
 
@@ -106,8 +103,6 @@ public void SerializeFrom(MessagesToSend messages, CommandMetaData commandMetaDa
 
             messages.GetLogMessages().CopyTo(logMessages);
 
-            messages.GetAuthorityLossAcknowledgements().CopyTo(authorityLossAcks);
-
             foreach (var serializer in componentSerializers)
             {
                 serializer.Serialize(messages, this);
@@ -126,7 +121,6 @@ public void Clear()
             entityQueryRequests.Clear();
             metricsToSend.Clear();
             logMessages.Clear();
-            authorityLossAcks.Clear();
             netFrameStats.Clear();
         }
 
@@ -203,13 +197,6 @@ public void SendAndClear(Connection connection, CommandMetaData commandMetaData,
                     logMessage.EntityId);
             }
 
-            for (var i = 0; i < authorityLossAcks.Count; ++i)
-            {
-                ref readonly var entityComponent = ref authorityLossAcks[i];
-                connection.SendAuthorityLossImminentAcknowledgement(entityComponent.EntityId,
-                    entityComponent.ComponentId);
-            }
-
             frameStats.Merge(netFrameStats);
             Clear();
         }

workers/unity/Packages/io.improbable.gdk.core/Worker/MessagesToSend.cs

@@ -168,7 +168,12 @@ public void SetAuthority(long entityId, uint componentId, Authority authority)
             {
                 throw new ArgumentException(
                     $"Can not set authority over component with ID {componentId} for entity with ID {entityId}. " +
-                    $"Unknown component ID");
+                    "Unknown component ID");
+            }
+
+            if (authority == Authority.AuthorityLossImminent)
+            {
+                return;
             }
 
             ((IDiffAuthorityStorage) authorityStorage).AddAuthorityChange(

workers/unity/Packages/io.improbable.gdk.core/Worker/SerializedMessagesToSend.cs

@@ -258,13 +258,6 @@ private static TypeBlock GenerateComponentWriter(UnityComponentDetails component
 }}
 ");
                     }
-
-                    writer.Line($@"
-public void AcknowledgeAuthorityLoss()
-{{
-    ComponentUpdateSystem.AcknowledgeAuthorityLoss(EntityId, {componentDetails.Name}.ComponentId);
-}}
-");
                 });
         }
     }