charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(weaver): Warning for multiple write/read functions for the same type (#2453)

Browse Source 
* fix(weaver): Warning for multiple write/read functions for the same type

Adding warning message when trying to register a write or read function for a type that is already in dictionary. Previously weaver would be silent about this making it hard to know when an extension method overrides another one.

* test for warnings
This commit is contained in:
James Frowen 2020-11-22 02:42:53 +00:00 committed by GitHub
parent fd9a7b0561
commit 301e791d9d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 57 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Assets/Mirror/Editor/Weaver/Readers.cs
View File

@ -17,6 +17,12 @@ public static void Init()
internal static void Register(TypeReference dataType, MethodReference methodReference)
{
string typeName = dataType.FullName;
if (readFuncs.ContainsKey(typeName))
{
Weaver.Warning($"Registering a Read method for {typeName} when one already exists", methodReference);
}
readFuncs[dataType.FullName] = methodReference;
}

8
Assets/Mirror/Editor/Weaver/Writers.cs
View File

@ -17,7 +17,13 @@ public static void Init()
public static void Register(TypeReference dataType, MethodReference methodReference)
{
writeFuncs[dataType.FullName] = methodReference;
string typeName = dataType.FullName;
if (writeFuncs.ContainsKey(typeName))
{
Weaver.Warning($"Registering a Write method for {typeName} when one already exists", methodReference);
}
writeFuncs[typeName] = methodReference;
}
static void RegisterWriteFunc(TypeReference typeReference, MethodDefinition newWriterFunc)

1
Assets/Mirror/Tests/Editor/Weaver/.WeaverTests.csproj
View File

@ -133,6 +133,7 @@
<Compile Include="WeaverCommandTests~\ErrorForOptionalNetworkConnectionThatIsNotSenderConnection.cs" />
<Compile Include="WeaverGeneralTests~\RecursionCount.cs" />
<Compile Include="WeaverGeneralTests~\TestingScriptableObjectArraySerialization.cs" />
<Compile Include="WeaverGeneratedReaderWriterTests~\GivesWarningWhenRegisteringExistingExtensionMethod.cs" />
<Compile Include="WeaverMessageTests~\AbstractMessageMethods.cs" />
<Compile Include="WeaverMessageTests~\MessageMemberGeneric.cs" />
<Compile Include="WeaverMessageTests~\MessageMemberInterface.cs" />

11
Assets/Mirror/Tests/Editor/Weaver/WeaverGeneratedReaderWriterTests.cs
View File

@ -203,5 +203,16 @@ public void GivesErrorForInvalidListType()
//HasError("Cannot generate reader for List because element MonoBehaviour does not have a reader. Use a supported type or provide a custom reader",
// "System.Collections.Generic.List`1<UnityEngine.MonoBehaviour>");
}
[Test]
public void GivesWarningWhenRegisteringExistingExtensionMethod()
{
const string typeName = "GeneratedReaderWriter.GivesWarningWhenRegisteringExistingExtensionMethod.MyType";
HasNoErrors();
HasWarning($"Registering a Write method for {typeName} when one already exists",
"System.Void GeneratedReaderWriter.GivesWarningWhenRegisteringExistingExtensionMethod.ReadWriteExtension::WriteMyType2(Mirror.NetworkWriter,GeneratedReaderWriter.GivesWarningWhenRegisteringExistingExtensionMethod.MyType)");
HasWarning($"Registering a Read method for {typeName} when one already exists",
"GeneratedReaderWriter.GivesWarningWhenRegisteringExistingExtensionMethod.MyType GeneratedReaderWriter.GivesWarningWhenRegisteringExistingExtensionMethod.ReadWriteExtension::ReadMyType2(Mirror.NetworkReader)");
}
}
}

32
Assets/Mirror/Tests/Editor/Weaver/WeaverGeneratedReaderWriterTests~/GivesWarningWhenRegisteringExistingExtensionMethod.cs Normal file
View File

@ -0,0 +1,32 @@
using Mirror;
namespace GeneratedReaderWriter.GivesWarningWhenRegisteringExistingExtensionMethod
{
public struct MyType
{
public int number;
}
public static class ReadWriteExtension
{
public static void WriteMyType(this NetworkWriter writer, MyType data)
{
writer.WriteInt32(data.number);
}
public static void WriteMyType2(this NetworkWriter writer, MyType data)
{
writer.WriteInt32(data.number);
}
public static MyType ReadMyType(this NetworkReader reader)
{
return new MyType { number = reader.ReadInt32() };
}
public static MyType ReadMyType2(this NetworkReader reader)
{
return new MyType { number = reader.ReadInt32() };
}
}
}