feat: allow for generic NetworkBehaviors (#519)

This would allow network behaviours to be used together with generics. It doesn't allow for the generic to be used in a syncvar or RPC methods. Also removed Test that checks if generic behaviours are blocked.
MirageNet · Jan 5, 2021 · 2858ff4 · 2858ff4
1 parent 0ecfcea
commit 2858ff4
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 10 deletions.
diff --git a/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/NetworkBehaviourProcessor.cs
@@ -39,13 +39,6 @@ public bool Process()
             }
             Weaver.DLog(netBehaviourSubclass, "Found NetworkBehaviour " + netBehaviourSubclass.FullName);
 
-            if (netBehaviourSubclass.HasGenericParameters)
-            {
-                Weaver.Error($"{netBehaviourSubclass.Name} cannot have generic parameters", netBehaviourSubclass);
-                // originally Process returned true in every case, except if already processed.
-                // maybe return false here in the future.
-                return true;
-            }
             Weaver.DLog(netBehaviourSubclass, "Process Start");
             MarkAsProcessed(netBehaviourSubclass);
 

diff --git a/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/RpcProcessor.cs
@@ -176,6 +176,12 @@ static bool ValidateParameter(MethodReference method, ParameterDefinition param,
                 return false;
             }
 
+            if (param.ParameterType.IsGenericParameter)
+            {
+                Weaver.Error($"{method.Name} cannot have generic parameters", method);
+                return false;
+            }
+
             if (IsNetworkConnection(param.ParameterType))
             {
                 if (callType == RemoteCallType.ClientRpc && firstParam)

diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/SyncObjectProcessor.cs
@@ -18,6 +18,11 @@ public void ProcessSyncObjects(TypeDefinition td)
         {
             foreach (FieldDefinition fd in td.Fields)
             {
+                if (fd.FieldType.IsGenericParameter) // Just ignore all generic objects.
+                {
+                    continue;
+                }
+
                 if (fd.FieldType.Resolve().ImplementsInterface<ISyncObject>())
                 {
                     if (fd.IsStatic)

diff --git a/Assets/Mirror/Editor/Weaver/Processors/SyncVarProcessor.cs b/Assets/Mirror/Editor/Weaver/Processors/SyncVarProcessor.cs
@@ -294,6 +294,12 @@ public void ProcessSyncVars(TypeDefinition td)
                     continue;
                 }
 
+                if (fd.FieldType.IsGenericParameter)
+                {
+                    Weaver.Error($"{fd.Name} cannot be synced since it's a generic parameter", fd);
+                    continue;
+                }
+
                 if ((fd.Attributes & FieldAttributes.Static) != 0)
                 {
                     Weaver.Error($"{fd.Name} cannot be static", fd);

diff --git a/Assets/Tests/Editor/Weaver/WeaverNetworkBehaviourTests.cs b/Assets/Tests/Editor/Weaver/WeaverNetworkBehaviourTests.cs
@@ -19,8 +19,20 @@ public void NetworkBehaviourAbstractBaseValid()
         [Test]
         public void NetworkBehaviourGeneric()
         {
-            HasError("NetworkBehaviourGeneric`1 cannot have generic parameters",
-                "WeaverNetworkBehaviourTests.NetworkBehaviourGeneric.NetworkBehaviourGeneric`1");
+            IsSuccess();
+        }
+
+        [Test]
+        public void NetworkBehaviourGenericInherit()
+        {
+            IsSuccess();
+        }
+
+        [Test]
+        public void NetworkBehaviourCmdGenericArgument()
+        {
+            HasError("CmdCantHaveGeneric cannot have generic parameters",
+                "System.Void WeaverNetworkBehaviourTests.NetworkBehaviourCmdGenericArgument.NetworkBehaviourCmdGenericArgument`1::CmdCantHaveGeneric(T)");
         }
 
         [Test]
@@ -44,6 +56,13 @@ public void NetworkBehaviourCmdVoidReturn()
                 "System.Int32 WeaverNetworkBehaviourTests.NetworkBehaviourCmdVoidReturn.NetworkBehaviourCmdVoidReturn::CmdCantHaveNonVoidReturn()");
         }
 
+        [Test]
+        public void NetworkBehaviourClientRpcGenericArgument()
+        {
+            HasError("RpcCantHaveGeneric cannot have generic parameters",
+                "System.Void WeaverNetworkBehaviourTests.NetworkBehaviourClientRpcGenericArgument.NetworkBehaviourClientRpcGenericArgument`1::RpcCantHaveGeneric(T)");
+        }
+
         [Test]
         public void NetworkBehaviourClientRpcGenericParam()
         {

diff --git a/...ts/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourClientRpcGenericArgument.cs b/...ts/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourClientRpcGenericArgument.cs
@@ -0,0 +1,10 @@
+using Mirror;
+
+namespace WeaverNetworkBehaviourTests.NetworkBehaviourClientRpcGenericArgument
+{
+    class NetworkBehaviourClientRpcGenericArgument<T> : NetworkBehaviour
+    {
+        [ClientRpc]
+        public void RpcCantHaveGeneric(T arg) { }
+    }
+}
diff --git a/...ts/Tests/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourCmdGenericArgument.cs b/...ts/Tests/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourCmdGenericArgument.cs
@@ -0,0 +1,10 @@
+using Mirror;
+
+namespace WeaverNetworkBehaviourTests.NetworkBehaviourCmdGenericArgument
+{
+    class NetworkBehaviourCmdGenericArgument<T> : NetworkBehaviour
+    {
+        [ServerRpc]
+        public void CmdCantHaveGeneric(T arg) { }
+    }
+}
diff --git a/Assets/Tests/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourGeneric.cs b/Assets/Tests/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourGeneric.cs
@@ -4,6 +4,6 @@ namespace WeaverNetworkBehaviourTests.NetworkBehaviourGeneric
 {
     class NetworkBehaviourGeneric<T> : NetworkBehaviour
     {
-        T genericsNotAllowed;
+        T genericAllowed;
     }
 }
diff --git a/Assets/Tests/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourGenericInherit.cs b/Assets/Tests/Editor/Weaver/WeaverNetworkBehaviourTests~/NetworkBehaviourGenericInherit.cs
@@ -0,0 +1,11 @@
+using Mirror;
+
+namespace WeaverNetworkBehaviourTests.NetworkBehaviourGenericInherit
+{
+    class NetworkBehaviourGenericInherit<T> : NetworkBehaviour
+    {
+        protected T generic;
+    }
+
+	class NetworkBehaviourGenericChild : NetworkBehaviourGenericInherit<NetworkBehaviourGenericChild> { }
+}
diff --git a/Assets/Tests/Editor/Weaver/WeaverSyncVarTests.cs b/Assets/Tests/Editor/Weaver/WeaverSyncVarTests.cs
@@ -29,6 +29,13 @@ public void SyncVarsStatic()
                 "System.Int32 WeaverSyncVarTests.SyncVarsStatic.SyncVarsStatic::invalidVar");
         }
 
+        [Test]
+        public void SyncVarsGenericField()
+        {
+            HasError("invalidVar cannot be synced since it's a generic parameter",
+                "T WeaverSyncVarTests.SyncVarGenericFields.SyncVarGenericFields`1::invalidVar");
+        }
+
         [Test]
         public void SyncVarsGenericParam()
         {

diff --git a/Assets/Tests/Editor/Weaver/WeaverSyncVarTests~/SyncVarsGenericField.cs b/Assets/Tests/Editor/Weaver/WeaverSyncVarTests~/SyncVarsGenericField.cs
@@ -0,0 +1,10 @@
+using Mirror;
+
+namespace WeaverSyncVarTests.SyncVarGenericFields
+{
+    class SyncVarGenericFields<T> : NetworkBehaviour
+    {
+        [SyncVar]
+        T invalidVar;
+    }
+}