Merge branch 'develop' into singleton-removal-network-object

Author: TwoTenPvP

.yamato/_triggers.yml

@@ -1,6 +1,5 @@
 {% metadata_file .yamato/project.metafile %}
 ---
-
 develop_nightly_trigger:
   name: Develop Branch Nightly Trigger
   triggers:
@@ -20,6 +19,7 @@ develop_nightly_trigger:
 pull_request_trigger:
   name: Pull Request Trigger on {{ test_editors.first }} (master, develop, & release branches)
   dependencies:
+    - .yamato/project-standards.yml#standards_{{ projects.first.name }}
 {% for project in projects -%}
 {% for package in project.packages -%}
     - .yamato/project-tests.yml#validate_{{ package.name }}_{{ test_platforms.first.name }}_{{ test_editors.first }}

.yamato/project-standards.yml

@@ -0,0 +1,16 @@
+{% metadata_file .yamato/project.metafile %}
+---
+standards_{{ projects.first.name }}:
+  name: Standards Check {{ projects.first.name }}
+  agent:
+    type: Unity::VM
+    image: desktop/logging-testing-linux:stable
+    flavor: b1.small
+  commands:
+    - dotnet --version
+    - $HOME/.dotnet/tools/dotnet-format --version
+    - python3 --version
+    - pip install unity-downloader-cli --upgrade --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple
+    - unity-downloader-cli -u {{ test_editors.first }} -c editor --wait --fast
+    - .Editor/Unity -batchmode -nographics -logFile - -executeMethod Packages.Rider.Editor.RiderScriptEditor.SyncSolution -projectPath {{ projects.first.path }} -quit
+    - ./standards.py --tool-path $HOME/.dotnet/tools/dotnet-format --project-path {{ projects.first.path }} --yamato

com.unity.multiplayer.mlapi/Editor/NetworkManagerEditor.cs

@@ -36,7 +36,7 @@ public class NetworkManagerEditor : UnityEditor.Editor
         private SerializedProperty m_TimeResyncIntervalProperty;
         private SerializedProperty m_EnableNetworkVariableProperty;
         private SerializedProperty m_EnsureNetworkVariableLengthSafetyProperty;
-        private SerializedProperty m_ForceSamePrefabsProperty;        
+        private SerializedProperty m_ForceSamePrefabsProperty;
         private SerializedProperty m_EnableSceneManagementProperty;
         private SerializedProperty m_RecycleNetworkIdsProperty;
         private SerializedProperty m_NetworkIdRecycleDelayProperty;
@@ -112,7 +112,7 @@ private void Initialize()
             m_EnableTimeResyncProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableTimeResync");
             m_TimeResyncIntervalProperty = m_NetworkConfigProperty.FindPropertyRelative("TimeResyncInterval");
             m_EnableNetworkVariableProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableNetworkVariable");
-            m_EnsureNetworkVariableLengthSafetyProperty = m_NetworkConfigProperty.FindPropertyRelative("EnsureNetworkVariableLengthSafety");            
+            m_EnsureNetworkVariableLengthSafetyProperty = m_NetworkConfigProperty.FindPropertyRelative("EnsureNetworkVariableLengthSafety");
             m_ForceSamePrefabsProperty = m_NetworkConfigProperty.FindPropertyRelative("ForceSamePrefabs");
             m_EnableSceneManagementProperty = m_NetworkConfigProperty.FindPropertyRelative("EnableSceneManagement");
             m_RecycleNetworkIdsProperty = m_NetworkConfigProperty.FindPropertyRelative("RecycleNetworkIds");
@@ -133,7 +133,7 @@ private void CheckNullProperties()
             m_RunInBackgroundProperty = serializedObject.FindProperty(nameof(NetworkManager.RunInBackground));
             m_LogLevelProperty = serializedObject.FindProperty(nameof(NetworkManager.LogLevel));
             m_NetworkConfigProperty = serializedObject.FindProperty(nameof(NetworkManager.NetworkConfig));
-            
+
             // NetworkConfig properties
             m_PlayerPrefabProperty = m_NetworkConfigProperty.FindPropertyRelative(nameof(NetworkConfig.PlayerPrefab));
             m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");

com.unity.multiplayer.mlapi/Runtime/Core/NetworkBehaviour.cs

@@ -385,8 +385,6 @@ public virtual void OnGainedOwnership() { }
         /// </summary>
         public virtual void OnLostOwnership() { }
 
-        #region NetworkVariable
-
         private bool m_VarInit = false;
 
         private readonly List<HashSet<int>> m_ChannelMappedNetworkVariableIndexes = new List<HashSet<int>>();
@@ -999,8 +997,6 @@ internal static void SetNetworkVariableData(List<INetworkVariable> networkVariab
             }
         }
 
-        #endregion
-
         /// <summary>
         /// Gets the local instance of a object with a given NetworkId
         /// </summary>

com.unity.multiplayer.mlapi/Runtime/Core/NetworkManager.cs

@@ -1154,8 +1154,6 @@ internal void HandleIncomingData(ulong clientId, NetworkChannel networkChannel,
                     return;
                 }
 
-                #region INTERNAL MESSAGE
-
                 switch (messageType)
                 {
                     case NetworkConstants.CONNECTION_REQUEST:
@@ -1312,8 +1310,6 @@ internal void HandleIncomingData(ulong clientId, NetworkChannel networkChannel,
                         break;
                 }
 
-                #endregion
-
 #if !UNITY_2020_2_OR_NEWER
                 NetworkProfiler.EndEvent();
 #endif

com.unity.multiplayer.mlapi/Runtime/Messaging/CustomMessageManager.cs

@@ -23,8 +23,6 @@ internal CustomMessagingManager(NetworkManager networkManager)
             m_NetworkManager = networkManager;
         }
 
-        #region Unnamed
-
         /// <summary>
         /// Delegate used for incoming unnamed messages
         /// </summary>
@@ -73,10 +71,6 @@ public void SendUnnamedMessage(ulong clientId, NetworkBuffer buffer, NetworkChan
             PerformanceDataManager.Increment(ProfilerConstants.UnnamedMessageSent);
         }
 
-        #endregion
-
-        #region Named
-
         /// <summary>
         /// Delegate used to handle named messages
         /// </summary>
@@ -215,7 +209,5 @@ public void SendNamedMessage(string name, List<ulong> clientIds, Stream stream,
                 PerformanceDataManager.Increment(ProfilerConstants.NamedMessageSent);
             }
         }
-
-        #endregion
     }
 }

com.unity.multiplayer.mlapi/Runtime/Spawning/NetworkSpawnManager.cs

@@ -196,7 +196,7 @@ internal NetworkObject CreateLocalNetworkObject(bool softCreate, uint prefabHash
                 {
                     // See if there is a valid registered NetworkPrefabOverrideLink associated with the provided prefabHash
                     GameObject networkPrefabReference = null;
-                    if(NetworkManager.NetworkConfig.NetworkPrefabOverrideLinks.ContainsKey(prefabHash))
+                    if (NetworkManager.NetworkConfig.NetworkPrefabOverrideLinks.ContainsKey(prefabHash))
                     {
                         switch (NetworkManager.NetworkConfig.NetworkPrefabOverrideLinks[prefabHash].Override)
                         {

com.unity.multiplayer.mlapi/Tests/Editor/NetworkManagerMessageSenderTests.cs

@@ -21,7 +21,7 @@ public void MessageSenderAssigned()
             networkManager.NetworkConfig = new NetworkConfig()
             {
                 // Set the current scene to prevent unexpected log messages which would trigger a failure
-                RegisteredScenes = new List<string>() {SceneManager.GetActiveScene().name}
+                RegisteredScenes = new List<string>() { SceneManager.GetActiveScene().name }
             };
 
             // Set dummy transport that does nothing

com.unity.multiplayer.mlapi/Tests/Editor/NetworkManagerSceneManagerTests.cs

@@ -21,7 +21,7 @@ public void SceneManagerAssigned()
             networkManager.NetworkConfig = new NetworkConfig()
             {
                 // Set the current scene to prevent unexpected log messages which would trigger a failure
-                RegisteredScenes = new List<string>() {SceneManager.GetActiveScene().name}
+                RegisteredScenes = new List<string>() { SceneManager.GetActiveScene().name }
             };
 
             // Set dummy transport that does nothing

com.unity.multiplayer.mlapi/Tests/Runtime/NetworkManagerHelper.cs

@@ -75,7 +75,7 @@ public static bool StartNetworkManager(out NetworkManager networkManager, Networ
                 NetworkManagerObject.NetworkConfig = new Configuration.NetworkConfig
                 {
                     EnableSceneManagement = false,
-                    RegisteredScenes = new List<string>(){SceneManager.GetActiveScene().name}
+                    RegisteredScenes = new List<string>() { SceneManager.GetActiveScene().name }
                 };
                 unetTransport.ConnectAddress = "127.0.0.1";
                 unetTransport.ConnectPort = 7777;

standards.py

@@ -3,14 +3,22 @@
 import os
 import sys
 import stat
+import glob
 import argparse
+import datetime
+
 
 parser = argparse.ArgumentParser()
 
 parser.add_argument("--hook", action="store_true")
 parser.add_argument("--unhook", action="store_true")
 parser.add_argument("--check", action="store_true")
 parser.add_argument("--fix", action="store_true")
+parser.add_argument("--yamato", action="store_true")
+
+parser.add_argument("--tool-path", default="dotnet-format")
+parser.add_argument("--project-path", default="testproject")
+parser.add_argument("--project-glob", default="Unity.Multiplayer.MLAPI*.csproj")
 
 if len(sys.argv) == 1:
     parser.print_help(sys.stderr)
@@ -23,57 +31,105 @@
 hook_exec = f"python3 {os.path.basename(sys.argv[0])} --check"
 
 if args.hook:
-    print("execute hook")
+    print("hook: execute")
 
     if os.path.exists(hook_path):
-        exit(
-            f"fail: git pre-push hook file already exists: `{hook_path}`\n"
-            "please make sure to backup and delete the existing pre-push hook file"
-        )
+        print(f"hook: git pre-push hook file already exists: `{hook_path}`")
+        print("hook: please make sure to backup and delete the existing pre-push hook file")
+        exit("hook: failed")
 
-    print("write git pre-push hook file contents")
+    print("hook: write git pre-push hook file contents")
     hook_file = open(hook_path, "w")
     hook_file.write(f"#!/bin/sh\n\n{hook_exec}\n")
     hook_file.close()
 
-    print("make git pre-push hook file executable")
+    print("hook: make git pre-push hook file executable")
     hook_stat = os.stat(hook_path)
     os.chmod(hook_path, hook_stat.st_mode | stat.S_IEXEC)
 
-    print("succeed: git pre-push hook created!")
+    print("hook: succeeded")
 
 
 if args.unhook:
-    print("execute unhook")
+    print("unhook: execute")
 
     hook_path = "./.git/hooks/pre-push"
     if os.path.isfile(hook_path):
-        print(f"found `{hook_path}`")
+        print(f"unhook: found file -> `{hook_path}`")
         delete = False
         hook_file = open(hook_path, "r")
         if hook_exec in hook_file.read():
             delete = True
         else:
-            exit(f"fail: existing git pre-push hook file was not created by this script")
+            print("unhook: existing git pre-push hook file was not created by this script")
+            exit("unhook: failed")
         hook_file.close()
         if delete:
             os.remove(hook_path)
-            print(f"delete file: `{hook_path}`")
+            print(f"unhook: delete file -> `{hook_path}`")
+
+    print("unhook: succeeded")
+
 
-    print("succeed: git pre-push hook removed!")
+if args.check or args.fix or args.yamato:
+    glob_match = os.path.join(args.project_path, args.project_glob)
+    glob_files = glob.glob(glob_match)
+    print(f"glob: found {len(glob_files)} files matching -> {glob_match}")
+
+    if len(glob_files) == 0:
+        print("glob: no project files found!")
+        print("glob: \tdid you forget to generate your solution and project files in Unity?")
+        print("glob: \tdid you double-check --project-path and/or --project-glob arguments?")
+        exit(f"glob: failed")
+
+    any_old = False
+    for project_file in glob_files:
+        file_stat = os.stat(project_file)
+        check_days = 7
+        modified_time = datetime.datetime.fromtimestamp(file_stat.st_mtime)
+        days_ago_time = datetime.datetime.now() - datetime.timedelta(days=check_days)
+        if modified_time < days_ago_time:
+            any_old = True
+            print(f"glob: last modified more than {check_days} days ago -> {project_file}")
+    if any_old:
+        print(f"glob: some project files are not modified for more than {check_days} days ago")
+        print("glob: please consider regenerating project files in Unity")
 
 
 if args.check:
-    print("execute check")
+    print("check: execute")
+
+    any_error = False
+    for project_file in glob_files:
+        print(f"check: project -> {project_file}")
+        any_error = 0 != os.system(f"{args.tool_path} {project_file} --fix-whitespace --fix-style error --check")
 
-    check_exec = os.system("dotnet-format ./testproject/testproject.sln --fix-whitespace --fix-style error --check")
-    if check_exec != 0:
-        exit(f"check_exec failed, exit code: {check_exec}")
+    if any_error:
+        exit(f"check: failed")
+
+    print("check: succeeded")
 
 
 if args.fix:
-    print("execute fix")
+    print("fix: execute")
+
+    any_error = False
+    for project_file in glob_files:
+        print(f"fix: project -> {project_file}")
+        any_error = 0 != os.system(f"{args.tool_path} {project_file} --fix-whitespace --fix-style error")
+
+    if any_error:
+        exit(f"fix: failed")
+
+    print("fix: succeeded")
+
+if args.yamato:
+    print("yamato: execute")
+
+    for project_file in glob_files:
+        print(f"yamato: project -> {project_file}")
+        yamato_exec = os.system(f"{args.tool_path} {project_file} --fix-style error --check")
+        if yamato_exec != 0:
+            exit(f"yamato: failed, exit code -> {yamato_exec}")
 
-    fix_exec = os.system("dotnet-format ./testproject/testproject.sln --fix-whitespace --fix-style error")
-    if fix_exec != 0:
-        exit(f"fix_exec failed, exit code: {fix_exec}")
+    print("yamato: succeeded")