Add convenience method to the MockConnection (#1370)

Author: Jamie Brynes

CHANGELOG.md

@@ -30,6 +30,7 @@
 - Produce code coverage reports in tests [#1359](https://github.com/spatialos/gdk-for-unity/pull/1359)
 - Replaced code generated ReferenceProviders with generic version. [#1358](https://github.com/spatialos/gdk-for-unity/pull/1358)
 - Refactor callbacks API. [#1348](https://github.com/spatialos/gdk-for-unity/pull/1348)
+- Added a convenience method to the `MockConnection` for removing entities and their components. [#1370](https://github.com/spatialos/gdk-for-unity/pull/1370)
 
 ## `0.3.5` - 2020-04-23
 

test-project/Assets/EditmodeTests/Collections/ReferenceProviderTests.cs

@@ -17,13 +17,7 @@ public void Disposed_world_cleans_provider()
             {
                 mockWorld.Step(world =>
                 {
-                    world.Connection.CreateEntity(entityId, new EntityTemplate());
-
-                    world.Connection.AddComponent(entityId, Position.ComponentId,
-                        new Position.Update {Coords = Coordinates.Zero});
-
-                    world.Connection.AddComponent(entityId, Metadata.ComponentId,
-                        new Metadata.Update {EntityType = "EntityWithReferenceComponent"});
+                    world.Connection.CreateEntity(entityId, GetTemplate());
                 });
 
                 Assert.AreEqual(1, ReferenceProvider<string>.Count);
@@ -35,25 +29,30 @@ public void Disposed_world_cleans_provider()
         [Test]
         public void Removed_component_disposes_reference()
         {
+            var template = GetTemplate();
             using (var mockWorld = MockWorld.Create(new MockWorld.Options()))
             {
-                mockWorld.Step(world =>
-                {
-                    world.Connection.CreateEntity(entityId, new EntityTemplate());
-
-                    world.Connection.AddComponent(entityId, Position.ComponentId,
-                        new Position.Update {Coords = Coordinates.Zero});
-
-                    world.Connection.AddComponent(entityId, Metadata.ComponentId,
-                        new Metadata.Update {EntityType = "EntityWithReferenceComponent"});
-                }).Step(world =>
-                {
-                    Assert.AreEqual(1, ReferenceProvider<string>.Count);
-                    world.Connection.RemoveComponent(entityId, Metadata.ComponentId);
-                });
+                mockWorld
+                    .Step(world =>
+                    {
+                        world.Connection.CreateEntity(entityId, template);
+                    })
+                    .Step(world =>
+                    {
+                        Assert.AreEqual(1, ReferenceProvider<string>.Count);
+                        world.Connection.RemoveEntityAndComponents(entityId, template);
+                    });
 
                 Assert.AreEqual(0, ReferenceProvider<string>.Count);
             }
         }
+
+        private EntityTemplate GetTemplate()
+        {
+            var template = new EntityTemplate();
+            template.AddComponent(new Position.Snapshot(), "some-worker");
+            template.AddComponent(new Metadata.Snapshot("AReferenceType"), "some-worker");
+            return template;
+        }
     }
 }

workers/unity/Packages/io.improbable.gdk.core/Worker/ConnectionHandlers/MockConnectionHandler.cs

@@ -39,7 +39,7 @@ public class MockConnectionHandler : IConnectionHandler
 
         public void CreateEntity(long entityId, EntityTemplate template)
         {
-            var handler = new EntityTemplateDynamicHandler(template, entityId, currentDiff);
+            var handler = new CreateEntityTemplateDynamicHandler(template, entityId, currentDiff);
             Dynamic.ForEachComponent(handler);
         }
 
@@ -63,6 +63,14 @@ public void RemoveEntity(long entityId)
             currentDiff.RemoveEntity(entityId);
         }
 
+        public void RemoveEntityAndComponents(long entityId, EntityTemplate template)
+        {
+            var handler = new RemoveEntityTemplateDynamicHandler(template, entityId, currentDiff);
+            Dynamic.ForEachComponent(handler);
+
+            RemoveEntity(entityId);
+        }
+
         public void RemoveComponent(long entityId, uint componentId)
         {
             currentDiff.RemoveComponent(entityId, componentId);
@@ -129,13 +137,13 @@ public bool IsConnected()
 
         #endregion
 
-        private class EntityTemplateDynamicHandler : Dynamic.IHandler
+        private class CreateEntityTemplateDynamicHandler : Dynamic.IHandler
         {
-            private EntityTemplate template;
-            private ViewDiff viewDiff;
-            private long entityId;
+            private readonly EntityTemplate template;
+            private readonly long entityId;
+            private readonly ViewDiff viewDiff;
 
-            public EntityTemplateDynamicHandler(EntityTemplate template, long entityId, ViewDiff viewDiff)
+            public CreateEntityTemplateDynamicHandler(EntityTemplate template, long entityId, ViewDiff viewDiff)
             {
                 this.template = template;
                 this.viewDiff = viewDiff;
@@ -160,6 +168,30 @@ public void Accept<TUpdate, TSnapshot>(uint componentId, Dynamic.VTable<TUpdate,
             }
         }
 
+        private class RemoveEntityTemplateDynamicHandler : Dynamic.IHandler
+        {
+            private readonly EntityTemplate template;
+            private readonly long entityId;
+            private readonly ViewDiff viewDiff;
+
+            public RemoveEntityTemplateDynamicHandler(EntityTemplate template, long entityId, ViewDiff viewDiff)
+            {
+                this.template = template;
+                this.entityId = entityId;
+                this.viewDiff = viewDiff;
+            }
+
+            public void Accept<TUpdate, TSnapshot>(uint componentId, Dynamic.VTable<TUpdate, TSnapshot> vtable)
+                where TUpdate : struct, ISpatialComponentUpdate
+                where TSnapshot : struct, ISpatialComponentSnapshot
+            {
+                if (template.HasComponent<TSnapshot>())
+                {
+                    viewDiff.RemoveComponent(entityId, componentId);
+                }
+            }
+        }
+
         public void Dispose()
         {
         }