Remove the View

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+- The `Authority` field on Readers and Writers has been changed to `HasAuthority`. It now returns a bool to indicate whether you have authority over the component it represents.  [#1364](https://github.com/spatialos/gdk-for-unity/pull/1364)
+  - This no longer supports AuthorityImminentLoss.
+- 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.
+
 ### Added
 
 - Added capability to test commands through the `MockConnectionHandler`. [#1437](https://github.com/spatialos/gdk-for-unity/pull/1437)
@@ -21,6 +28,7 @@
 
 - Added C# bindings for C Event Tracing API. [#1440](https://github.com/spatialos/gdk-for-unity/pull/1440)
 - Added native classes for IO operations in Event Tracing API. [#1444](https://github.com/spatialos/gdk-for-unity/pull/1444)
+- Removed the `View` class and its generated storage classes. [#1364](https://github.com/spatialos/gdk-for-unity/pull/1364)
 
 ## `0.3.9` - 2020-07-24
 

UPGRADE_GUIDE.md

@@ -1,5 +1,22 @@
 # Upgrade Guide
 
+## From `0.3.9` to `0.3.10`
+
+### ComponentUpdateSystem API changes
+
+The methods `GetAuthority`, `GetComponent`, and `HasComponent` have been removed from the `ComponentUpdateSystem`.
+They can be replaced by similar usage of the `EntityManager`.
+
+* `componentUpdateSystem.GetAuthority(entityId, componentId)` to `EntityManager.HasComponent<ComponentType.Authority>(entity)`.
+* `componentUpdateSystem.GetComponent<ComponentType.Snapshot>(entityId)` to `EntityManager.GetComponentData<ComponentType.Component>(entity)`.
+* `componentUpdateSystem.HasComponent(componentId, entityId)` to `EntityManager.HasComponent<ComponentType.Component>(entity)`
+
+The `WorkerSystem` and `ComponentDatabase` can be used to convert from `entityId` to `entity`, and from `componentId` to a component type.
+
+### Readers and Writers Authority
+
+The `Reader` and `Writer` classes have had their `public Authority Authority` property changed to `public bool HasAuthority`. `HasAuthority` now indicates whether you have authority over the given component or not.
+
 ## From `0.3.7` to `0.3.8`
 
 ### Asset based entity representation

workers/unity/Assets/Playground/Scripts/MonoBehaviours/ToggleRotationCommandSender.cs

@@ -1,6 +1,5 @@
 using Improbable.Gdk.Core;
 using Improbable.Gdk.Subscriptions;
-using Improbable.Worker.CInterop;
 using UnityEngine;
 
 namespace Playground.MonoBehaviours
@@ -16,7 +15,7 @@ public class ToggleRotationCommandSender : MonoBehaviour
 
         private void Update()
         {
-            if (reader.Authority != Authority.NotAuthoritative)
+            if (reader.HasAuthority)
             {
                 // Perform sending logic only on non-authoritative workers.
                 return;

workers/unity/Packages/io.improbable.gdk.core/.codegen/Source/CoreCodegenJob.cs

@@ -56,7 +56,6 @@ public CoreCodegenJob(CodegenJobOptions options, IFileSystem fileSystem, Details
                 c => ($"{c.Name}EcsViewManager.cs", UnityEcsViewManagerGenerator.Generate),
                 c => ($"{c.Name}ComponentDiffStorage.cs", ComponentDiffStorageGenerator.Generate),
                 c => ($"{c.Name}ComponentDiffDeserializer.cs", ComponentDiffDeserializerGenerator.Generate),
-                c => ($"{c.Name}ViewStorage.cs", ViewStorageGenerator.Generate),
                 c => ($"{c.Name}Metaclass.cs", MetaclassGenerator.Generate));
 
             Logger.Trace("Adding job targets for commands.");

workers/unity/Packages/io.improbable.gdk.core/.codegen/Source/Generators/Core/MetaclassGenerator.cs

@@ -45,7 +45,6 @@ public static CodeWriter Generate(UnityComponentDetails componentDetails)
 public Type DiffDeserializer {{ get; }} = typeof({rootNamespace}.DiffComponentDeserializer);
 
 public Type DiffStorage {{ get; }} = typeof({rootNamespace}.DiffComponentStorage);
-public Type ViewStorage {{ get; }} = typeof({rootNamespace}.{componentDetails.Name}ViewStorage);
 public Type EcsViewManager {{ get; }} = typeof({rootNamespace}.EcsViewManager);
 public Type DynamicInvokable {{ get; }} = typeof({rootNamespace}.{componentDetails.Name}Dynamic);
 ");

workers/unity/Packages/io.improbable.gdk.core/Components/IComponentMetaclass.cs

@@ -18,7 +18,6 @@ public interface IComponentMetaclass
         Type DiffDeserializer { get; }
 
         Type DiffStorage { get; }
-        Type ViewStorage { get; }
         Type EcsViewManager { get; }
         Type DynamicInvokable { get; }
 

workers/unity/Packages/io.improbable.gdk.core/Dynamic/ComponentDatabase.cs

@@ -43,6 +43,16 @@ public static IComponentMetaclass GetMetaclass(uint componentId)
             return metaclass;
         }
 
+        public static IComponentMetaclass GetMetaclass<T>() where T : ISpatialComponentData
+        {
+            if (!ComponentsToIds.TryGetValue(typeof(T), out var id))
+            {
+                throw new ArgumentException($"Can not find Metaclass for unregistered SpatialOS component {nameof(T)}.");
+            }
+
+            return Metaclasses[id];
+        }
+
         public static uint GetComponentId<T>() where T : ISpatialComponentData
         {
             if (!ComponentsToIds.TryGetValue(typeof(T), out var id))

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/CommandSenderReceiverSubscriptionManagerBase.cs

@@ -124,19 +124,21 @@ public override void ResetValue(ISubscription subscription)
     public abstract class CommandReceiverSubscriptionManagerBase<T> : SubscriptionManager<T>
         where T : ICommandReceiver
     {
-        private readonly ComponentUpdateSystem componentUpdateSystem;
+        private readonly EntityManager entityManager;
 
         private Dictionary<EntityId, HashSet<Subscription<T>>> entityIdToReceiveSubscriptions;
 
         private HashSet<EntityId> entitiesMatchingRequirements = new HashSet<EntityId>();
         private HashSet<EntityId> entitiesNotMatchingRequirements = new HashSet<EntityId>();
 
-        private readonly uint componentId;
+        private readonly ComponentType componentAuthType;
 
         protected CommandReceiverSubscriptionManagerBase(World world, uint componentId) : base(world)
         {
-            this.componentId = componentId;
-            componentUpdateSystem = world.GetExistingSystem<ComponentUpdateSystem>();
+            var componentMetaClass = ComponentDatabase.GetMetaclass(componentId);
+            componentAuthType = componentMetaClass.Authority;
+
+            entityManager = world.EntityManager;
 
             var constraintSystem = world.GetExistingSystem<ComponentConstraintsCallbackSystem>();
 
@@ -196,8 +198,7 @@ public override Subscription<T> Subscribe(EntityId entityId)
             }
 
             if (WorkerSystem.TryGetEntity(entityId, out var entity)
-                && componentUpdateSystem.HasComponent(componentId, entityId)
-                && componentUpdateSystem.GetAuthority(entityId, componentId) != Authority.NotAuthoritative)
+                && entityManager.HasComponent(entity, componentAuthType))
             {
                 entitiesMatchingRequirements.Add(entityId);
                 subscription.SetAvailable(CreateReceiver(World, entity, entityId));

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/Reader.cs

@@ -17,7 +17,9 @@ public abstract class Reader<TComponent, TUpdate> : IRequireable
         protected readonly EntityManager EntityManager;
         protected readonly Entity Entity;
         protected readonly EntityId EntityId;
+
         private static readonly uint ComponentId = ComponentDatabase.GetComponentId<TComponent>();
+        private static readonly ComponentType ComponentAuthType = ComponentDatabase.GetMetaclass<TComponent>().Authority;
 
         private Dictionary<Action<Authority>, ulong> authorityCallbackToCallbackKey;
         private Dictionary<Action<TUpdate>, ulong> updateCallbackToCallbackKey;
@@ -35,16 +37,16 @@ public TComponent Data
             }
         }
 
-        public Authority Authority
+        public bool HasAuthority
         {
             get
             {
                 if (!IsValid)
                 {
-                    throw new InvalidOperationException("Cannot read authority when Reader is not valid");
+                    throw new InvalidOperationException($"Cannot read {nameof(HasAuthority)} when Reader is not valid");
                 }
 
-                return ComponentUpdateSystem.GetAuthority(EntityId, ComponentId);
+                return EntityManager.HasComponent(Entity, ComponentAuthType);
             }
         }
 

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/StandardSubscriptionManagers/WorkerFlagSubscriptionManager.cs

@@ -41,15 +41,15 @@ public class WorkerFlagReader
         public bool IsValid;
 
         private readonly WorkerFlagCallbackSystem callbackSystem;
-        private readonly View view;
+        private readonly WorkerSystem workerSystem;
 
         private Dictionary<Action<string, string>, ulong> callbackToKey;
 
         public WorkerFlagReader(World world)
         {
             IsValid = true;
             callbackSystem = world.GetExistingSystem<WorkerFlagCallbackSystem>();
-            view = world.GetExistingSystem<WorkerSystem>().View;
+            workerSystem = world.GetExistingSystem<WorkerSystem>();
         }
 
         public event Action<string, string> OnWorkerFlagChange
@@ -92,7 +92,7 @@ public event Action<string, string> OnWorkerFlagChange
 
         public string GetFlag(string name)
         {
-            return view.GetWorkerFlag(name);
+            return workerSystem.GetWorkerFlag(name);
         }
 
         internal void RemoveAllCallbacks()

workers/unity/Packages/io.improbable.gdk.core/Subscriptions/WriterSubscriptionManager.cs

@@ -9,17 +9,18 @@ namespace Improbable.Gdk.Subscriptions
     public abstract class WriterSubscriptionManager<TComponent, TWriter> : SubscriptionManager<TWriter>
         where TWriter : IRequireable where TComponent : ISpatialComponentData
     {
-        private readonly ComponentUpdateSystem componentUpdateSystem;
+        private readonly EntityManager entityManager;
         private Dictionary<EntityId, HashSet<Subscription<TWriter>>> entityIdToWriterSubscriptions;
 
         private readonly HashSet<EntityId> entitiesMatchingRequirements = new HashSet<EntityId>();
         private readonly HashSet<EntityId> entitiesNotMatchingRequirements = new HashSet<EntityId>();
 
         private static readonly uint ComponentId = ComponentDatabase.GetComponentId<TComponent>();
+        private static readonly ComponentType ComponentAuthType = ComponentDatabase.GetMetaclass<TComponent>().Authority;
 
         protected WriterSubscriptionManager(World world) : base(world)
         {
-            componentUpdateSystem = world.GetExistingSystem<ComponentUpdateSystem>();
+            entityManager = World.EntityManager;
 
             RegisterComponentCallbacks();
         }
@@ -84,8 +85,7 @@ public override Subscription<TWriter> Subscribe(EntityId entityId)
             }
 
             if (WorkerSystem.TryGetEntity(entityId, out var entity)
-                && componentUpdateSystem.HasComponent(ComponentId, entityId)
-                && componentUpdateSystem.GetAuthority(entityId, ComponentId) != Authority.NotAuthoritative)
+                && entityManager.HasComponent(entity, ComponentAuthType))
             {
                 entitiesMatchingRequirements.Add(entityId);
                 subscription.SetAvailable(CreateWriter(entity, entityId));

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

@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using Improbable.Worker.CInterop;
 using Unity.Entities;
 
 namespace Improbable.Gdk.Core
@@ -12,7 +11,6 @@ public class ComponentUpdateSystem : ComponentSystem
 
         public void SendUpdate<T>(in T update, EntityId entityId) where T : struct, ISpatialComponentUpdate
         {
-            worker.View.UpdateComponent(entityId, in update);
             worker.MessagesToSend.AddComponentUpdate(in update, entityId.Id);
         }
 
@@ -72,26 +70,11 @@ public List<EntityId> GetComponentsRemoved(uint componentId)
             return manager.GetComponentsRemoved();
         }
 
-        public Authority GetAuthority(EntityId entityId, uint componentId)
-        {
-            return worker.View.GetAuthority(entityId, componentId);
-        }
-
-        public T GetComponent<T>(EntityId entityId) where T : struct, ISpatialComponentSnapshot
-        {
-            return worker.View.GetComponent<T>(entityId);
-        }
-
         public void AcknowledgeAuthorityLoss(EntityId entityId, uint componentId)
         {
             worker.MessagesToSend.AcknowledgeAuthorityLoss(entityId.Id, componentId);
         }
 
-        public bool HasComponent(uint componentId, EntityId entityId)
-        {
-            return worker.View.HasComponent(entityId, componentId);
-        }
-
         protected override void OnCreate()
         {
             base.OnCreate();

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

@@ -17,8 +17,6 @@ public class EntitySystem : ComponentSystem
 
         private ProfilerMarker applyDiffMarker = new ProfilerMarker("EntitySystem.ApplyDiff");
 
-        private WorkerSystem workerSystem;
-
         public List<EntityId> GetEntitiesAdded()
         {
             return entitiesAdded;
@@ -29,11 +27,6 @@ public List<EntityId> GetEntitiesRemoved()
             return entitiesRemoved;
         }
 
-        public HashSet<EntityId> GetEntitiesInView()
-        {
-            return workerSystem.View.GetEntityIds();
-        }
-
         internal void ApplyDiff(ViewDiff diff)
         {
             using (applyDiffMarker.Auto())
@@ -59,13 +52,6 @@ internal void ApplyDiff(ViewDiff diff)
             }
         }
 
-        protected override void OnCreate()
-        {
-            base.OnCreate();
-
-            workerSystem = World.GetExistingSystem<WorkerSystem>();
-        }
-
         protected override void OnUpdate()
         {
             entitiesAdded.Clear();

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

@@ -12,7 +12,7 @@ namespace Improbable.Gdk.Core
     [UpdateInGroup(typeof(SpatialOSReceiveGroup.InternalSpatialOSReceiveGroup))]
     public class SpatialOSReceiveSystem : ComponentSystem
     {
-        private WorkerSystem worker;
+        private WorkerSystem workerSystem;
         private EcsViewSystem ecsViewSystem;
         private EntitySystem entitySystem;
         private NetworkStatisticsSystem networkStatisticsSystem;
@@ -21,7 +21,7 @@ protected override void OnCreate()
         {
             base.OnCreate();
 
-            worker = World.GetExistingSystem<WorkerSystem>();
+            workerSystem = World.GetExistingSystem<WorkerSystem>();
             ecsViewSystem = World.GetOrCreateSystem<EcsViewSystem>();
             entitySystem = World.GetOrCreateSystem<EntitySystem>();
             networkStatisticsSystem = World.GetOrCreateSystem<NetworkStatisticsSystem>();
@@ -31,17 +31,16 @@ protected override void OnUpdate()
         {
             try
             {
-                worker.Tick();
+                workerSystem.Tick();
 
-                var diff = worker.Diff;
-                worker.View.ApplyDiff(diff);
+                var diff = workerSystem.Diff;
                 ecsViewSystem.ApplyDiff(diff);
                 entitySystem.ApplyDiff(diff);
                 networkStatisticsSystem.ApplyDiff(diff);
             }
             catch (Exception e)
             {
-                worker.LogDispatcher.HandleLog(LogType.Exception, new LogEvent("Exception:")
+                workerSystem.LogDispatcher.HandleLog(LogType.Exception, new LogEvent("Exception:")
                     .WithException(e));
             }
         }

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

@@ -30,11 +30,11 @@ public class WorkerSystem : ComponentSystem
         /// </summary>
         public bool IsConnected => Worker.IsConnected;
 
-        internal readonly View View;
+        public IReadOnlyDictionary<string, string> WorkerFlags => Worker.WorkerFlags;
 
         internal readonly Dictionary<EntityId, Entity> EntityIdToEntity = new Dictionary<EntityId, Entity>();
 
-        internal WorkerInWorld Worker;
+        internal readonly WorkerInWorld Worker;
 
         internal ViewDiff Diff => Worker.ViewDiff;
         internal MessagesToSend MessagesToSend => Worker.MessagesToSend;
@@ -50,7 +50,6 @@ public WorkerSystem(WorkerInWorld worker)
             WorkerType = worker.WorkerType;
             WorkerId = worker.WorkerId;
             Origin = worker.Origin;
-            View = worker.View;
         }
 
         /// <summary>
@@ -94,6 +93,16 @@ public void SendLogMessage(string message, string loggerName, LogLevel logLevel,
             Worker.MessagesToSend.AddLogMessage(new LogMessageToSend(message, loggerName, logLevel, entityId?.Id));
         }
 
+        /// <summary>
+        ///     Gets the value for a given worker flag.
+        /// </summary>
+        /// <param name="key">The key of the worker flag.</param>
+        /// <returns>The value of the flag, if it exists, null otherwise.</returns>
+        public string GetWorkerFlag(string key)
+        {
+            return Worker.GetWorkerFlag(key);
+        }
+
         public void SendMetrics(Metrics metrics)
         {
             Worker.MessagesToSend.AddMetrics(metrics);