com.wallstop-studios.dxmessaging 2.0.0-rc25 → 2.0.0-rc26

package/README.md

@@ -39,15 +39,15 @@ For UntargetedMessages, DxMessaging is significantly faster (roughly 2x) than Un
 
 | Message Tech | Operations / Second | Allocations? |
 | ------------ | ------------------- | ------------ | 
-| Unity | 2,670,600 | Yes |
-| DxMessaging (GameObject) - Normal | 2,722,400 | No |
-| DxMessaging (Component) - Normal | 2,738,800 | No |
-| DxMessaging (GameObject) - No-Copy | 2,871,800 | No |
-| DxMessaging (Component) - No-Copy | 2,876,600 | No |
-| DxMessaging (Untargeted) - No-Copy | 4,480,200 | No |
-| Reflexive (One Argument) | 2,287,800 | No |
-| Reflexive (Two Arguments) | 1,009,000 | No |
-| Reflexive (Three Arguments) | 1,000,400 | No |
+| Unity | 2,649,000 | Yes |
+| DxMessaging (GameObject) - Normal | 2,672,800 | No |
+| DxMessaging (Component) - Normal | 2,665,600 | No |
+| DxMessaging (GameObject) - No-Copy | 2,778,800 | No |
+| DxMessaging (Component) - No-Copy | 2,783,800 | No |
+| DxMessaging (Untargeted) - No-Copy | 4,205,600 | No |
+| Reflexive (One Argument) | 2,394,800 | No |
+| Reflexive (Two Arguments) | 1,000,400 | No |
+| Reflexive (Three Arguments) | 993,800 | No |
 
 # Functionality
 While not as fast, DxMessaging offers *additional functionality* as compared to Unity's messaging solution.

package/Runtime/Core/Helper/MessageCache.cs

@@ -22,7 +22,7 @@
 
             public bool MoveNext()
             {
-                while (++_index < _cache._values.Length)
+                while (++_index < _cache._values.Count)
                 {
                     _current = _cache._values[_index];
                     if (_current != null)
@@ -48,20 +48,40 @@
             public void Dispose() { }
         }
 
-        private readonly TValue[] _values = new TValue[DxMessagingRuntime.TotalMessageTypes];
+        private readonly List<TValue> _values = new();
 
         public TValue GetOrAdd<TMessage>()
             where TMessage : IMessage
         {
+            TValue value;
             int index = MessageHelperIndexer<TMessage>.SequentialId;
-            TValue value = _values[index];
-            if (value != null)
+            if (0 <= index)
             {
-                return value;
+                while (_values.Count <= index)
+                {
+                    _values.Add(null);
+                }
+                value = _values[index];
+                if (value != null)
+                {
+                    return value;
+                }
+
+                value = new TValue();
+                _values[index] = value;
+            }
+            else
+            {
+                index = MessageHelperIndexer.TotalMessages++;
+                MessageHelperIndexer<TMessage>.SequentialId = index;
+                while (_values.Count < index)
+                {
+                    _values.Add(null);
+                }
+                value = new TValue();
+                _values.Add(value);
             }
 
-            value = new TValue();
-            _values[index] = value;
             return value;
         }
 
@@ -69,22 +89,47 @@
             where TMessage : IMessage
         {
             int index = MessageHelperIndexer<TMessage>.SequentialId;
-            _values[index] = value;
+            if (0 <= index)
+            {
+                while (_values.Count <= index)
+                {
+                    _values.Add(null);
+                }
+                _values[index] = value;
+                return;
+            }
+
+            index = MessageHelperIndexer.TotalMessages++;
+            MessageHelperIndexer<TMessage>.SequentialId = index;
+            while (_values.Count < index)
+            {
+                _values.Add(null);
+            }
+            _values.Add(value);
         }
 
         public bool TryGetValue<TMessage>(out TValue value)
             where TMessage : IMessage
         {
             int index = MessageHelperIndexer<TMessage>.SequentialId;
-            value = _values[index];
-            return value != null;
+            if (0 <= index && index < _values.Count)
+            {
+                value = _values[index];
+                return value != null;
+            }
+
+            value = default;
+            return false;
         }
 
         public void Remove<TMessage>()
             where TMessage : IMessage
         {
             int index = MessageHelperIndexer<TMessage>.SequentialId;
-            _values[index] = null;
+            if (0 <= index && index < _values.Count)
+            {
+                _values[index] = null;
+            }
         }
 
         public MessageCacheEnumerator GetEnumerator()

package/Runtime/Core/Helper/MessageHelperIndexer.cs

@@ -1,5 +1,10 @@
 namespace DxMessaging.Core.Helper
 {
+    public static class MessageHelperIndexer
+    {
+        internal static int TotalMessages = 0;
+    }
+
     public static class MessageHelperIndexer<TMessage>
         where TMessage : IMessage
     {

package/Runtime/Core/MessageBus/MessageBus.cs

@@ -138,14 +138,6 @@
 
         private readonly RegistrationLog _log = new();
 
-        static MessageBus()
-        {
-            if (!DxMessagingRuntime.Initialized)
-            {
-                DxMessagingRuntime.Initialize();
-            }
-        }
-
         public Action RegisterUntargeted<T>(MessageHandler messageHandler, int priority = 0)
             where T : IUntargetedMessage
         {
@@ -724,13 +716,12 @@
             Dictionary<InstanceId, HandlerCache<int, HandlerCache>> targetedHandlers;
             HandlerCache<int, HandlerCache> sortedHandlers;
 
-            if (typeof(TMessage) == typeof(DxReflexiveMessage))
+            if (typeof(TMessage) == typeof(ReflexiveMessage))
             {
 #if UNITY_2017_1_OR_NEWER
-                ref DxReflexiveMessage reflexiveMessage = ref Unsafe.As<
-                    TMessage,
-                    DxReflexiveMessage
-                >(ref typedMessage);
+                ref ReflexiveMessage reflexiveMessage = ref Unsafe.As<TMessage, ReflexiveMessage>(
+                    ref typedMessage
+                );
 
                 GameObject go;
                 bool found;
@@ -761,12 +752,14 @@
                 {
                     _recipientCache.Clear();
                     bool sentInADirection = false;
-                    if (reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Upwards))
+                    ReflexiveSendMode sendMode = reflexiveMessage.sendMode;
+                    if (sendMode.HasFlagNoAlloc(ReflexiveSendMode.Upwards))
                     {
                         sentInADirection = true;
                         if (
-                            !reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Downwards)
-                            && !reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Flat)
+                            !sendMode.HasFlagNoAlloc(ReflexiveSendMode.Downwards)
+                            && !sendMode.HasFlagNoAlloc(ReflexiveSendMode.Flat)
+                            && !sendMode.HasFlagNoAlloc(ReflexiveSendMode.OnlyIncludeActive)
                         )
                         {
                             switch (reflexiveMessage.parameters.Length)
@@ -786,17 +779,17 @@
                                 }
                                 default:
                                 {
-                                    Component[] parentComponents = go.GetComponentsInParent(
-                                        typeof(MonoBehaviour),
-                                        true
-                                    );
-                                    foreach (Component component in parentComponents)
+                                    Transform current = go.transform;
+                                    do
                                     {
-                                        if (component is MonoBehaviour script)
+                                        _componentCache.Clear();
+                                        current.GetComponents(_componentCache);
+                                        foreach (MonoBehaviour script in _componentCache)
                                         {
-                                            SendMessage(script, ref reflexiveMessage);
+                                            SendMessage(script, ref reflexiveMessage, false);
                                         }
-                                    }
+                                        current = current.parent;
+                                    } while (current != null);
 
                                     break;
                                 }
@@ -804,24 +797,25 @@
                         }
                         else
                         {
-                            Component[] parentComponents = go.GetComponentsInParent(
-                                typeof(MonoBehaviour)
-                            );
-                            foreach (Component component in parentComponents)
+                            Transform current = go.transform;
+                            do
                             {
-                                if (component is MonoBehaviour script)
+                                _componentCache.Clear();
+                                current.GetComponents(_componentCache);
+                                foreach (MonoBehaviour script in _componentCache)
                                 {
-                                    SendMessage(script, ref reflexiveMessage);
+                                    SendMessage(script, ref reflexiveMessage, true);
                                 }
-                            }
+                                current = current.parent;
+                            } while (current != null);
                         }
                     }
-                    if (reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Downwards))
+                    if (sendMode.HasFlagNoAlloc(ReflexiveSendMode.Downwards))
                     {
-                        sentInADirection = true;
                         if (
-                            !reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Upwards)
-                            && !reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Flat)
+                            !sendMode.HasFlagNoAlloc(ReflexiveSendMode.Upwards)
+                            && !sendMode.HasFlagNoAlloc(ReflexiveSendMode.Flat)
+                            && !sendMode.HasFlagNoAlloc(ReflexiveSendMode.OnlyIncludeActive)
                         )
                         {
                             switch (reflexiveMessage.parameters.Length)
@@ -845,7 +839,7 @@
                                     go.GetComponentsInChildren(true, _componentCache);
                                     foreach (MonoBehaviour parentComponent in _componentCache)
                                     {
-                                        SendMessage(parentComponent, ref reflexiveMessage);
+                                        SendMessage(parentComponent, ref reflexiveMessage, false);
                                     }
 
                                     break;
@@ -858,39 +852,49 @@
                             go.GetComponentsInChildren(_componentCache);
                             foreach (MonoBehaviour parentComponent in _componentCache)
                             {
-                                SendMessage(parentComponent, ref reflexiveMessage);
+                                SendMessage(parentComponent, ref reflexiveMessage, true);
                             }
                         }
                     }
-                    else if (
-                        !sentInADirection
-                        && reflexiveMessage.sendMode.HasFlagNoAlloc(ReflexiveSendMode.Flat)
-                    )
+                    else if (!sentInADirection && sendMode.HasFlagNoAlloc(ReflexiveSendMode.Flat))
                     {
-                        switch (reflexiveMessage.parameters.Length)
+                        if (!sendMode.HasFlagNoAlloc(ReflexiveSendMode.OnlyIncludeActive))
                         {
-                            case 0:
-                            {
-                                go.SendMessage(reflexiveMessage.method);
-                                break;
-                            }
-                            case 1:
-                            {
-                                go.SendMessage(
-                                    reflexiveMessage.method,
-                                    reflexiveMessage.parameters[0]
-                                );
-                                break;
-                            }
-                            default:
+                            switch (reflexiveMessage.parameters.Length)
                             {
-                                _componentCache.Clear();
-                                go.GetComponents(_componentCache);
-                                foreach (MonoBehaviour component in _componentCache)
+                                case 0:
                                 {
-                                    SendMessage(component, ref reflexiveMessage);
+                                    go.SendMessage(reflexiveMessage.method);
+                                    break;
+                                }
+                                case 1:
+                                {
+                                    go.SendMessage(
+                                        reflexiveMessage.method,
+                                        reflexiveMessage.parameters[0]
+                                    );
+                                    break;
+                                }
+                                default:
+                                {
+                                    _componentCache.Clear();
+                                    go.GetComponents(_componentCache);
+                                    foreach (MonoBehaviour component in _componentCache)
+                                    {
+                                        SendMessage(component, ref reflexiveMessage, false);
+                                    }
+
+                                    break;
                                 }
-                                break;
+                            }
+                        }
+                        else
+                        {
+                            _componentCache.Clear();
+                            go.GetComponents(_componentCache);
+                            foreach (MonoBehaviour component in _componentCache)
+                            {
+                                SendMessage(component, ref reflexiveMessage, true);
                             }
                         }
                     }
@@ -3392,8 +3396,17 @@
         }
 #endif
 
-        private void SendMessage(MonoBehaviour recipient, ref DxReflexiveMessage message)
+        private void SendMessage(
+            MonoBehaviour recipient,
+            ref ReflexiveMessage message,
+            bool onlyActive
+        )
         {
+            if (onlyActive && !recipient.enabled)
+            {
+                return;
+            }
+
             if (!_recipientCache.Add(recipient))
             {
                 return;

package/Runtime/Core/MessageHandler.cs

@@ -48,14 +48,6 @@
         /// </note>
         private readonly List<MessageCache<object>> _handlersByTypeByMessageBus;
 
-        static MessageHandler()
-        {
-            if (!DxMessagingRuntime.Initialized)
-            {
-                DxMessagingRuntime.Initialize();
-            }
-        }
-
         public MessageHandler(InstanceId owner)
         {
             this.owner = owner;

package/Runtime/Core/Messages/{DxReflexiveMessage.cs → ReflexiveMessage.cs}

@@ -10,6 +10,7 @@
         Flat = 1 << 0,
         Downwards = 1 << 1,
         Upwards = 1 << 2,
+        OnlyIncludeActive = 1 << 3,
     }
 
     public readonly struct MethodSignatureKey : IEquatable<MethodSignatureKey>
@@ -84,9 +85,9 @@
         }
     }
 
-    public readonly struct DxReflexiveMessage : ITargetedMessage<DxReflexiveMessage>
+    public readonly struct ReflexiveMessage : ITargetedMessage<ReflexiveMessage>
     {
-        public Type MessageType => typeof(DxReflexiveMessage);
+        public Type MessageType => typeof(ReflexiveMessage);
 
         public readonly string method;
         public readonly ReflexiveSendMode sendMode;
@@ -96,7 +97,7 @@
 
         public readonly MethodSignatureKey signatureKey;
 
-        public DxReflexiveMessage(
+        public ReflexiveMessage(
             string method,
             ReflexiveSendMode sendMode,
             params object[] parameters

package/Tests/Runtime/Benchmarks/PerformanceTests.cs

@@ -31,7 +31,7 @@
             Debug.Log("| ------------ | ------------------- | ------------ | ");
 
             ComplexTargetedMessage message = new(Guid.NewGuid());
-            DxReflexiveMessage reflexiveMessage = new(
+            ReflexiveMessage reflexiveMessage = new(
                 nameof(SimpleMessageAwareComponent.HandleSlowComplexTargetedMessage),
                 ReflexiveSendMode.Flat,
                 message
@@ -249,7 +249,7 @@
                 component = go.AddComponent<SimpleMessageAwareComponent>();
             }
             component.reflexiveThreeArgumentHandler = () => ++count;
-            DxReflexiveMessage message = new(
+            ReflexiveMessage message = new(
                 nameof(SimpleMessageAwareComponent.HandleReflexiveMessageThreeArguments),
                 ReflexiveSendMode.Flat,
                 1,
@@ -290,7 +290,7 @@
                 component = go.AddComponent<SimpleMessageAwareComponent>();
             }
             component.reflexiveTwoArgumentHandler = () => ++count;
-            DxReflexiveMessage message = new(
+            ReflexiveMessage message = new(
                 nameof(SimpleMessageAwareComponent.HandleReflexiveMessageTwoArguments),
                 ReflexiveSendMode.Flat,
                 1,
@@ -326,7 +326,7 @@
             Stopwatch timer,
             TimeSpan timeout,
             GameObject go,
-            DxReflexiveMessage message
+            ReflexiveMessage message
         )
         {
             int count = 0;

package/Tests/Runtime/Core/GenericMessageTests.cs

@@ -0,0 +1,47 @@
+namespace DxMessaging.Tests.Runtime.Core
+{
+    using DxMessaging.Core;
+    using DxMessaging.Core.Extensions;
+    using NUnit.Framework;
+    using Scripts.Components;
+    using Scripts.Messages;
+    using UnityEngine;
+
+    public sealed class GenericMessageTests : MessagingTestBase
+    {
+        [Test]
+        public void MultipleGenericTypesWork()
+        {
+            GameObject go = new(
+                nameof(MultipleGenericTypesWork),
+                typeof(SimpleMessageAwareComponent)
+            );
+            _spawned.Add(go);
+
+            SimpleMessageAwareComponent messaging = go.GetComponent<SimpleMessageAwareComponent>();
+            MessageRegistrationToken token = GetToken(messaging);
+
+            int totalCount = 0;
+            token.RegisterUntargeted((ref GenericUntargetedMessage<int> _) => totalCount++);
+            token.RegisterUntargeted((ref GenericUntargetedMessage<float> _) => totalCount++);
+            token.RegisterUntargeted((ref GenericUntargetedMessage<string> _) => totalCount++);
+            token.RegisterUntargeted((ref GenericUntargetedMessage<Vector3> _) => totalCount++);
+
+            GenericUntargetedMessage<int> intMessage = new();
+            intMessage.EmitUntargeted();
+            Assert.AreEqual(1, totalCount);
+            GenericUntargetedMessage<float> floatMessage = new();
+            floatMessage.EmitUntargeted();
+            Assert.AreEqual(2, totalCount);
+            GenericUntargetedMessage<string> stringMessage = new();
+            stringMessage.EmitUntargeted();
+            Assert.AreEqual(3, totalCount);
+            GenericUntargetedMessage<Vector3> vector3Message = new();
+            vector3Message.EmitUntargeted();
+            Assert.AreEqual(4, totalCount);
+            GenericUntargetedMessage<Vector4> vector4Message = new();
+            vector4Message.EmitUntargeted();
+            Assert.AreEqual(4, totalCount);
+        }
+    }
+}

package/Tests/Runtime/Core/GenericMessageTests.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: fb614d7b47a04a1aa6c6aa87ad1faf1f
+timeCreated: 1745368524

package/Tests/Runtime/Core/MessagingTestBase.cs

@@ -5,7 +5,6 @@
     using System.Collections.Generic;
     using System.Diagnostics;
     using System.Linq;
-    using System.Reflection;
     using DxMessaging.Core;
     using DxMessaging.Core.MessageBus;
     using NUnit.Framework;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.wallstop-studios.dxmessaging",
-  "version": "2.0.0-rc25",
+  "version": "2.0.0-rc26",
   "displayName": "DxMessaging",
   "description": "Synchronous Event Bus for Unity",
   "unity": "2021.3",

package/Runtime/Core/Helper/DxMessagingRuntime.cs

@@ -1,201 +0,0 @@
-namespace DxMessaging.Core.Helper
-{
-    using System;
-    using System.Collections.Generic;
-    using System.Reflection;
-    using Core;
-    using Messages;
-#if UNITY_2017_1_OR_NEWER
-    using UnityEngine;
-#endif
-    public static class DxMessagingRuntime
-    {
-        public static int TotalMessageTypes { get; private set; }
-
-        public static bool Initialized
-        {
-            get
-            {
-                lock (InitializationLock)
-                {
-                    return _isInitialized;
-                }
-            }
-        }
-
-        private static bool _isInitialized;
-        private static readonly object InitializationLock = new();
-
-        static DxMessagingRuntime()
-        {
-            Initialize();
-        }
-
-#if UNITY_2017_1_OR_NEWER
-        [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
-#endif
-        public static void Initialize()
-        {
-            lock (InitializationLock)
-            {
-                if (_isInitialized)
-                {
-                    return;
-                }
-
-                Log(() => "DxMessagingRuntime Initializing...", isError: false);
-
-                HashSet<Type> uniqueTypes = new();
-                List<Type> messageTypes = new();
-                Assembly[] assemblies = AppDomain.CurrentDomain.GetAssemblies();
-
-                foreach (Assembly assembly in assemblies)
-                {
-                    Type[] types;
-                    try
-                    {
-                        types = assembly.GetTypes();
-                    }
-                    catch (ReflectionTypeLoadException ex)
-                    {
-                        types = ex.Types;
-                    }
-                    catch
-                    {
-                        continue;
-                    }
-
-                    foreach (Type type in types)
-                    {
-                        try
-                        {
-                            if (type == null)
-                            {
-                                continue;
-                            }
-
-                            if (!typeof(IMessage).IsAssignableFrom(type))
-                            {
-                                continue;
-                            }
-
-                            if (type.IsGenericTypeDefinition)
-                            {
-                                continue;
-                            }
-
-                            if (uniqueTypes.Add(type))
-                            {
-                                messageTypes.Add(type);
-                            }
-                        }
-                        catch (Exception e)
-                        {
-                            Log(
-                                () =>
-                                    $"Error checking if {type?.FullName} is assignable from IMessage: {e}",
-                                isError: true
-                            );
-                        }
-                    }
-                }
-
-                if (uniqueTypes.Add(typeof(IMessage)))
-                {
-                    messageTypes.Add(typeof(IMessage));
-                }
-                if (uniqueTypes.Add(typeof(ITargetedMessage)))
-                {
-                    messageTypes.Add(typeof(ITargetedMessage));
-                }
-                if (uniqueTypes.Add(typeof(IBroadcastMessage)))
-                {
-                    messageTypes.Add(typeof(IBroadcastMessage));
-                }
-                if (uniqueTypes.Add(typeof(IUntargetedMessage)))
-                {
-                    messageTypes.Add(typeof(IUntargetedMessage));
-                }
-
-                messageTypes.Sort(
-                    (a, b) =>
-                        string.Compare(a.FullName, b.FullName, StringComparison.OrdinalIgnoreCase)
-                );
-
-                TotalMessageTypes = messageTypes.Count;
-                Type helperIndexerGenericDef = typeof(MessageHelperIndexer<>);
-
-                for (int i = 0; i < TotalMessageTypes; ++i)
-                {
-                    Type messageType = messageTypes[i];
-                    try
-                    {
-                        Type specificHelperType = helperIndexerGenericDef.MakeGenericType(
-                            messageType
-                        );
-
-                        FieldInfo idField = specificHelperType.GetField(
-                            "SequentialId",
-                            BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic
-                        );
-                        if (idField != null)
-                        {
-                            idField.SetValue(null, i);
-                        }
-                        else
-                        {
-                            Log(
-                                () =>
-                                    $"Error: Could not find field for SequentialId on MessageHelperIndexer<{messageType.FullName}>.",
-                                isError: true
-                            );
-                        }
-                    }
-                    catch (Exception ex)
-                    {
-                        Log(
-                            () => $"Error setting SequentialId for {messageType.FullName}: {ex}",
-                            isError: true
-                        );
-                    }
-                }
-
-                _isInitialized = true;
-                Log(
-                    () =>
-                        $"DxMessagingRuntime Initialized. Found {TotalMessageTypes} message types.",
-                    isError: false
-                );
-            }
-        }
-
-        private static void Log(Func<string> messageProducer, bool isError)
-        {
-            try
-            {
-                string message = messageProducer();
-#if UNITY_2017_1_OR_NEWER
-                if (isError)
-                {
-                    Debug.LogError(message);
-                }
-                else
-                {
-                    Debug.Log(message);
-                }
-#else
-                Console.WriteLine(message);
-#endif
-            }
-            catch (Exception e)
-            {
-                string errorMessage = $"Error logging message: {e}";
-#if UNITY_2017_1_OR_NEWER
-                Debug.LogError(errorMessage);
-#else
-                Console.WriteLine(errorMessage);
-#endif
-            }
-        }
-    }
-}

package/Runtime/Core/Helper/DxMessagingRuntime.cs.meta

@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: 84077988aa394abb9c9608cb46690a75
-timeCreated: 1745099950