Requireable WorkerId (#1016)

Author: Paul Balaji

CHANGELOG.md

@@ -5,15 +5,16 @@
 ### Breaking Changes
 
 - Renamed the `buildTarget` command line argument to `buildEnvironment`. [#1012](https://github.com/spatialos/gdk-for-unity/pull/1012)
-- All GDK packages now have an `io.improbable` prefix instead of `com.improbable`.
+- All GDK packages now have an `io.improbable` prefix instead of `com.improbable`. [#894](https://github.com/spatialos/gdk-for-unity/pull/894)
 
 ### Added
 
 - Added the `LinkedGameObjectMap` class for finding the `GameObject`(s) linked with a specified `EntityId`. [#1013](https://github.com/spatialos/gdk-for-unity/pull/1013)
     - This can be used with the `[Require]` annotation to inject it into your `MonoBehaviours` provided you are using the `GameObjectCreation` feature module. For example: `[Require] private LinkedGameObjectMap gameObjectMap;`
 - Added the ability for the build system to build specific targets of a given build environment. [#1012](https://github.com/spatialos/gdk-for-unity/pull/1012)
     - Use the `buildTargetFilter` command line argument to pass in a comma delimited list of build targets to filter for. For example, `+buildTargetFilter win,macos`.
-- Added two new GDK packages: `io.improbable.worker.sdk` and `io.improbable.worker.sdk.mobile` which contain the underlying Worker SDK packages for Windows/MacOS/Linux and Android/iOS respectively.
+- Added two new GDK packages: `io.improbable.worker.sdk` and `io.improbable.worker.sdk.mobile` which contain the underlying Worker SDK packages for Windows/MacOS/Linux and Android/iOS respectively. [#894](https://github.com/spatialos/gdk-for-unity/pull/894)
+- You may now `[Require]` a `WorkerId` in MonoBehaviours. For example: `[Require] private WorkerId workerId;`. [#1016](https://github.com/spatialos/gdk-for-unity/pull/1016)
 
 
 ### Changed
@@ -26,9 +27,9 @@
 
 ### Internal
 
-- Stopped throwing a `Test Exception` in playground.
-- The embedded `DownloadCoreSdk` `dotnet` project has been removed from `Improbable.Gdk.Tools`.
-- The `PluginPostprocessor` tool has been removed from `Improbable.Gdk.Tools`.
+- Stopped throwing a `Test Exception` in playground. [#1011](https://github.com/spatialos/gdk-for-unity/pull/1011)
+- The embedded `DownloadCoreSdk` `dotnet` project has been removed from `Improbable.Gdk.Tools`. [#894](https://github.com/spatialos/gdk-for-unity/pull/894)
+- The `PluginPostprocessor` tool has been removed from `Improbable.Gdk.Tools`. [#894](https://github.com/spatialos/gdk-for-unity/pull/894)
 
 ## `0.2.4` - 2019-06-28
 

workers/unity/Assets/Playground/Resources/Prefabs/Common/Character.prefab

@@ -16,6 +16,7 @@ GameObject:
   - component: {fileID: 114894172867123548}
   - component: {fileID: 114602415406350378}
   - component: {fileID: 2643701918418317171}
+  - component: {fileID: -663445870753195477}
   m_Layer: 9
   m_Name: Character
   m_TagString: Untagged
@@ -136,6 +137,18 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 0d4dfc82aab7b1d43b523a4a5172d6f8, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+--- !u!114 &-663445870753195477
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1292271339760838}
+  m_Enabled: 0
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 5053c3754e6a48118a61672cedc67dec, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
 --- !u!1 &1494660013534148
 GameObject:
   m_ObjectHideFlags: 0

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

@@ -0,0 +1,17 @@
+using Improbable.Gdk.Subscriptions;
+using UnityEngine;
+
+namespace Playground
+{
+    public class WorkerIdTest : MonoBehaviour
+    {
+#pragma warning disable 649
+        [Require] private WorkerId workerId;
+#pragma warning restore 649
+
+        private void OnEnable()
+        {
+            Debug.Log($"Testing [Require] WorkerId: {workerId}");
+        }
+    }
+}

workers/unity/Assets/Playground/Scripts/MonoBehaviours/WorkerIdTest.cs.meta

@@ -0,0 +1,80 @@
+using System;
+using Improbable.Gdk.Core;
+using Unity.Entities;
+
+namespace Improbable.Gdk.Subscriptions
+{
+    [AutoRegisterSubscriptionManager]
+    public class WorkerIdSubscriptionManager : SubscriptionManager<WorkerId>
+    {
+        private readonly World world;
+        private Subscription<WorkerId> cachedSubscription;
+
+        public WorkerIdSubscriptionManager(World world)
+        {
+            this.world = world;
+        }
+
+        public override Subscription<WorkerId> Subscribe(EntityId entityId)
+        {
+            if (cachedSubscription != null)
+            {
+                return cachedSubscription;
+            }
+
+            cachedSubscription = new Subscription<WorkerId>(this, new EntityId(0));
+            var workerId = world.GetExistingSystem<WorkerSystem>().WorkerId;
+            cachedSubscription.SetAvailable(new WorkerId(workerId));
+
+            return cachedSubscription;
+        }
+
+        public override void Cancel(ISubscription subscription)
+        {
+        }
+
+        public override void ResetValue(ISubscription subscription)
+        {
+        }
+    }
+
+    public readonly struct WorkerId : IEquatable<string>, IEquatable<WorkerId>
+    {
+        public readonly string Id;
+
+        public WorkerId(string id)
+        {
+            Id = id;
+        }
+
+        public bool Equals(WorkerId other)
+        {
+            if (Id == null)
+            {
+                throw new NullReferenceException();
+            }
+
+            return other.Id != null && Id.Equals(other.Id);
+        }
+
+        public bool Equals(string other)
+        {
+            if (Id == null)
+            {
+                throw new NullReferenceException();
+            }
+
+            return other != null && Id.Equals(other);
+        }
+
+        public override string ToString()
+        {
+            return Id;
+        }
+
+        public static implicit operator string(WorkerId workerId)
+        {
+            return workerId.Id;
+        }
+    }
+}

workers/unity/Assets/Plugins.meta

@@ -12,6 +12,7 @@ namespace Improbable.Gdk.Core.EditmodeTests.Subscriptions
     ///         - EntityId
     ///         - ECS Entity
     ///         - Log Dispatcher
+    ///         - WorkerId
     ///         - World Commands
     ///         - ECS World
     /// </summary>
@@ -54,6 +55,14 @@ public void Subscribe_to_log_dispatcher_should_always_be_available()
             Assert.AreEqual(LogDispatcher, logSubscription.Value);
         }
 
+        [Test]
+        public void Subscribe_to_worker_id_should_always_be_available()
+        {
+            var workerIdSubscription = SubscriptionSystem.Subscribe<WorkerId>(entityId);
+            Assert.True(workerIdSubscription.HasValue);
+            Assert.AreEqual("TestWorker", workerIdSubscription.Value);
+        }
+
         [Test]
         public void Subscribe_to_world_commands_should_not_be_available_if_the_entity_does_not_exist()
         {

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

@@ -0,0 +1,67 @@
+using Improbable.Gdk.Subscriptions;
+using NUnit.Framework;
+
+namespace Improbable.Gdk.Core.EditmodeTests.Subscriptions
+{
+    /// <summary>
+    ///     This tests the interoperability of the WorkerId struct with strings.
+    /// </summary>
+    [TestFixture]
+    public class WorkerIdEquatableTests
+    {
+        private readonly string workerIdString = "WorkerName-someR4nd0mch4r4ct3r5";
+
+        [Test]
+        public void WorkerId_can_be_implicitly_cast_to_string()
+        {
+            Assert.DoesNotThrow(() =>
+            {
+                string id = new WorkerId(workerIdString);
+            });
+        }
+
+        [Test]
+        public void WorkerId_implicitly_cast_to_string_has_the_same_string_contents()
+        {
+            string id = new WorkerId(workerIdString);
+
+            Assert.IsTrue(id.Equals(workerIdString));
+        }
+
+        [Test]
+        public void Identical_WorkerIds_are_equal()
+        {
+            WorkerId firstWorkerId = new WorkerId(workerIdString);
+            WorkerId secondWorkerId = new WorkerId(workerIdString);
+
+            Assert.IsTrue(firstWorkerId == secondWorkerId);
+        }
+
+        [Test]
+        public void Different_WorkerIds_are_not_equal()
+        {
+            WorkerId firstWorkerId = new WorkerId("some-workerId");
+            WorkerId secondWorkerId = new WorkerId("some-different-workerId");
+
+            Assert.IsFalse(firstWorkerId == secondWorkerId);
+        }
+
+        [Test]
+        public void WorkerId_struct_compared_to_equivalent_string()
+        {
+            string stringWorkerId = workerIdString;
+            WorkerId structWorkerId = new WorkerId(stringWorkerId);
+
+            Assert.IsTrue(stringWorkerId == structWorkerId);
+        }
+
+        [Test]
+        public void WorkerId_struct_compared_to_unequivalent_string()
+        {
+            string stringWorkerId = "some-workerId";
+            WorkerId structWorkerId = new WorkerId("some-different-workerId");
+
+            Assert.IsFalse(stringWorkerId == structWorkerId);
+        }
+    }
+}