fix: InScenePlaced edge cases

com.unity.netcode.gameobjects/Editor/InScenePlacedProcessor.cs

@@ -1,3 +1,4 @@
+using Unity.Netcode.Logging;
 using UnityEditor;
 using UnityEditor.Build;
 using UnityEditor.Build.Reporting;
@@ -19,8 +20,22 @@
         public int callbackOrder => 0;
         public void OnProcessScene(Scene scene, BuildReport report)
         {
+            var log = new ContextualLogger();
+            log.AddInfo(scene.name, scene.handle);
             foreach (var networkObject in FindObjects.FromSceneByType<NetworkObject>(scene, true))
             {
+                if (networkObject.SceneOrigin.IsValid() && networkObject.SceneOrigin.handle != scene.handle)
+                {
+                    log.Warning(new Context(LogLevel.Developer, $"{nameof(NetworkObject)}'s SceneOrigin doesn't match current scene being processed! Skipping processing.").AddInfo("SceneOrigin", networkObject.SceneOriginHandle).AddNetworkObject(networkObject));
+                    continue;
+                }
+
+                if (networkObject.HasBeenSpawned)
+                {
+                    log.Error(new Context(LogLevel.Normal, $"Processing {nameof(NetworkObject)} that has already been spawned! This should not be possible. Skipping processing.").AddNetworkObject(networkObject));
+                    continue;
+                }
+
                 networkObject.InScenePlaced = true;
             }
         }

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkPrefab.cs

@@ -166,6 +166,22 @@
                     return false;
                 }
 
+                if (networkObject.InScenePlaced)
+                {
+                    if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
+                    {
+                        NetworkLog.LogWarning($"{NetworkPrefabHandler.PrefabDebugHelper(this)} InScenePlaced {nameof(NetworkObject)} is being registered as a Prefab. This can cause issues!");
+                    }
+                }
+
+                if (networkObject.IsSpawned)
+                {
+                    if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
+                    {
+                        NetworkLog.LogWarning($"{NetworkPrefabHandler.PrefabDebugHelper(this)} Currently spawned {nameof(NetworkObject)} is being registered as a Prefab. This can cause issues!");
+                    }
+                }
+
                 return true;
             }
 

com.unity.netcode.gameobjects/Runtime/Core/NetworkObject.cs

@@ -5,6 +5,7 @@
 using System.Runtime.CompilerServices;
 using System.Text;
 using Unity.Netcode.Components;
+using Unity.Netcode.Logging;
 using Unity.Netcode.Runtime;
 #if UNITY_EDITOR
 using UnityEditor;
@@ -106,6 +107,9 @@
         /// </summary>
         public NetworkObject CurrentParent { get; private set; }
 
+        private int m_SpawnCount;
+        internal bool HasBeenSpawned => m_SpawnCount > 0;
+
 #if UNITY_EDITOR
         private const string k_GlobalIdTemplate = "GlobalObjectId_V1-{0}-{1}-{2}-{3}";
 
@@ -1448,12 +1452,16 @@
 
             set
             {
+                if (SceneOriginHandle.IsEmpty() && value.IsValid() && value.isLoaded)
+                {
+                    SceneOriginHandle = value.handle;
+                }
+
                 // The scene origin should only be set once.
                 // Once set, it should never change.
-                if (SceneOriginHandle.IsEmpty() && value.IsValid() && value.isLoaded)
+                if (!m_SceneOrigin.IsValid())
                 {
                     m_SceneOrigin = value;
-                    SceneOriginHandle = value.handle;
                 }
             }
         }
@@ -1782,7 +1790,7 @@
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal void SpawnInternal(bool destroyWithScene, ulong ownerClientId, bool playerObject)
+        private void SpawnInternal(bool destroyWithScene, ulong ownerClientId, bool playerObject)
         {
             if (NetworkManagerOwner == null)
             {
@@ -1853,7 +1861,28 @@
                 }
             }
 
-            if (!NetworkManagerOwner.SpawnManager.AuthorityLocalSpawn(this, NetworkManagerOwner.SpawnManager.GetNetworkObjectId(), InScenePlaced, playerObject, ownerClientId, destroyWithScene))
+
+            // Calculate the legacy IsSceneObject value as the public field is obsolete with warning
+            // We can't break the public behavior of the field.
+#pragma warning disable CS0618 // Type or member is obsolete
+            var legacyIsSceneObject = IsSceneObject.HasValue && IsSceneObject.Value;
+#pragma warning restore CS0618 // Type or member is obsolete
+
+            // If SpawnInternal is being called on an object that is marked as InScenePlaced,
+            // The scene object was never automatically spawned when the scene was loaded.
+            // Count this object as a dynamically spawned object.
+            // TODO-[MTT-15388]: Actually support disabled/not spawned InScenePlaced NetworkObjects
+            if (InScenePlaced && m_SpawnCount == 0)
+            {
+                if (NetworkManagerOwner.NetworkConfig.EnableSceneManagement && NetworkManagerOwner.LogLevel <= LogLevel.Developer)
+                {
+                    Debug.LogWarning($"[{name}][SceneOrigin={SceneOriginHandle}] Dynamically spawning InScenePlaced network object. This can cause issues!", this);
+                }
+
+                InScenePlaced = false;
+            }
+
+            if (!NetworkManagerOwner.SpawnManager.AuthorityLocalSpawn(this, NetworkManagerOwner.SpawnManager.GetNetworkObjectId(), legacyIsSceneObject, playerObject, ownerClientId, destroyWithScene))
             {
                 if (NetworkManagerOwner.LogLevel <= LogLevel.Normal)
                 {
@@ -2053,6 +2082,7 @@
             // When spawned, previous owner is always the first assigned owner
             PreviousOwnerId = ownerClientId;
             m_HasAuthority = NetworkManagerOwner.DistributedAuthorityMode ? OwnerClientId == NetworkManagerOwner.LocalClientId : NetworkManagerOwner.IsServer;
+            m_SpawnCount++;
             IsSpawned = true;
 
             // If this is the player, and the client is the owner, then lock ownership by default
@@ -3466,11 +3496,7 @@
 
             if (serializedObject.NetworkObjectId == default)
             {
-                if (networkManager.LogLevel <= LogLevel.Error)
-                {
-                    NetworkLog.LogErrorServer($"[{nameof(GlobalObjectIdHash)}={serializedObject.Hash}] Received spawn request with invalid {nameof(NetworkObjectId)} {serializedObject.NetworkObjectId}. This should not happen!");
-                }
-
+                NetworkLog.LogErrorServer(new Context(LogLevel.Error, $"Received spawn request with invalid {nameof(NetworkObjectId)}. This should not happen!").AddInfo(nameof(NetworkObjectId), serializedObject.NetworkObjectId).AddInfo(nameof(GlobalObjectIdHash), serializedObject.Hash));
                 reader.Seek(endOfSynchronizationData);
                 return null;
             }
@@ -3627,17 +3653,17 @@
                     NetworkSceneHandle = SceneOriginHandle;
                 }
             }
-            else // Otherwise, the client did not find the client to server scene handle
-                if (NetworkManagerOwner.LogLevel <= LogLevel.Developer)
-                {
-                    // There could be a scenario where a user has some client-local scene loaded that they migrate the NetworkObject
-                    // into, but that scenario seemed very edge case and under most instances a user should be notified that this
-                    // server - client scene handle mismatch has occurred. It also seemed pertinent to make the message replicate to
-                    // the server-side too.
-                    NetworkLog.LogWarningServer($"[Client-{NetworkManagerOwner.LocalClientId}][{name}] Server - " +
-                        $"client scene mismatch detected! Client-side scene handle ({SceneOriginHandle}) for scene ({gameObject.scene.name})" +
-                        $"has no associated server side (network) scene handle!");
-                }
+            // Otherwise, the client did not find the client to server scene handle
+            else if (NetworkManagerOwner.LogLevel <= LogLevel.Developer)
+            {
+                // There could be a scenario where a user has some client-local scene loaded that they migrate the NetworkObject
+                // into, but that scenario seemed very edge case and under most instances a user should be notified that this
+                // server - client scene handle mismatch has occurred. It also seemed pertinent to make the message replicate to
+                // the server-side too.
+                NetworkLog.LogWarningServer($"[Client-{NetworkManagerOwner.LocalClientId}][{name}] Server - " +
+                    $"client scene mismatch detected! Client-side scene handle ({SceneOriginHandle}) for scene ({gameObject.scene.name})" +
+                    $"has no associated server side (network) scene handle!");
+            }
             OnMigratedToNewScene?.Invoke();
 
             // Only the authority side will notify clients of non-parented NetworkObject scene changes

com.unity.netcode.gameobjects/Runtime/Logging/NetworkLog.cs

@@ -103,6 +103,8 @@
         /// <param name="message">The message to log</param>
         [HideInCallstack]
         public static void LogErrorServer(string message) => s_Log.ErrorServer(new Context(LogLevel.Error, message, true));
+        [HideInCallstack]
+        internal static void LogErrorServer(Context context) => s_Log.ErrorServer(context);
 
         internal static LogType GetMessageLogType(UnityEngine.LogType engineLogType)
         {
@@ -115,14 +117,14 @@
             };
         }
 
-
         private const string k_SenderId = "SenderId";
         internal static Context BuildContextForServerMessage([NotNull] NetworkManager networkManager, LogLevel level, ulong senderId, string message)
         {
-            var ctx = new Context(level, message, true).AddInfo(k_SenderId, senderId);
-            if (TryGetNetworkObjectName(networkManager, message, out var name))
+            var ctx = new Context(level, message, true).AddTag("Received log from client").AddInfo(k_SenderId, senderId);
+            var networkObject = TryGetNetworkObject(networkManager, message);
+            if (networkObject != null)
             {
-                ctx.AddTag(name);
+                ctx.AddNetworkObject(networkObject);
             }
             return ctx;
         }
@@ -135,29 +137,41 @@
             None
         }
 
-        private static readonly Regex k_GlobalObjectIdHash = new($@"\[{nameof(NetworkObject.GlobalObjectIdHash)}=(\d+)\]", RegexOptions.Compiled);
+        private static readonly Regex k_NetworkObjectId = new($@"\[{nameof(NetworkObject.NetworkObjectId)}:(\d+)\]", RegexOptions.Compiled);
+        private static readonly Regex k_GlobalObjectIdHash = new($@"\[{nameof(NetworkObject.GlobalObjectIdHash)}:(\d+)\]", RegexOptions.Compiled);
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        private static bool TryGetNetworkObjectName([NotNull] NetworkManager networkManager, string message, out string name)
+        private static NetworkObject TryGetNetworkObject([NotNull] NetworkManager networkManager, string message)
         {
-            name = null;
+            if (k_NetworkObjectId.IsMatch(message))
+            {
+                var stringId = k_NetworkObjectId.Match(message).Groups[1].Value;
+                if (ulong.TryParse(stringId, out var networkObjectId) && networkObjectId > 0 && networkManager.SpawnManager.SpawnedObjects.TryGetValue(networkObjectId, out var networkObject))
+                {
+                    return networkObject;
+                }
+            }
+
             if (!k_GlobalObjectIdHash.IsMatch(message))
             {
-                return false;
+                return null;
             }
 
             var stringHash = k_GlobalObjectIdHash.Match(message).Groups[1].Value;
             if (!ulong.TryParse(stringHash, out var globalObjectIdHash))
             {
-                return false;
+                return null;
             }
 
-            if (!networkManager.SpawnManager.SpawnedObjects.TryGetValue(globalObjectIdHash, out var networkObject))
+            NetworkObject matchingObject = null;
+            foreach (var networkObject in networkManager.SpawnManager.SpawnedObjectsList)
             {
-                return false;
+                if (networkObject.GlobalObjectIdHash == globalObjectIdHash)
+                {
+                    matchingObject = networkObject;
+                }
             }
 
-            name = networkObject.name;
-            return true;
+            return matchingObject;
         }
 
         [HideInCallstack]

com.unity.netcode.gameobjects/Runtime/Spawning/NetworkSpawnManager.cs

@@ -907,10 +907,7 @@
             // If not, then there is an issue (user possibly didn't register the prefab properly?)
             if (networkPrefabReference == null)
             {
-                if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
-                {
-                    NetworkLog.LogErrorServer($"[{nameof(globalObjectIdHash)}={globalObjectIdHash}] Failed to create object locally. {nameof(NetworkPrefab)} could not be found. Is the prefab registered with {NetworkManager.name}?");
-                }
+                NetworkManager.Log.ErrorServer(new Context(LogLevel.Error, $"Failed to create object locally. {nameof(NetworkPrefab)} could not be found. Is the prefab registered with this {nameof(NetworkManager)}").AddInfo(nameof(NetworkObject.GlobalObjectIdHash), globalObjectIdHash).AddTag(NetworkManager.name));
                 return null;
             }
 
@@ -957,6 +954,7 @@
         /// <remarks>
         /// For most cases this is client-side only, except when the server is spawning a player.
         /// </remarks>
+        [return: MaybeNull]
         internal NetworkObject CreateLocalNetworkObject(NetworkObject.SerializedObject serializedObject, byte[] instantiationData = null)
         {
             NetworkObject networkObject = null;
@@ -977,11 +975,7 @@
                 networkObject = NetworkManager.SceneManager.GetSceneRelativeInSceneNetworkObject(globalObjectIdHash, serializedObject.NetworkSceneHandle);
                 if (networkObject == null)
                 {
-                    if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
-                    {
-                        NetworkLog.LogError($"{nameof(NetworkPrefab)} hash was not found! In-Scene placed {nameof(NetworkObject)} soft synchronization failure for Hash: {globalObjectIdHash}!");
-                    }
-
+                    NetworkLog.LogErrorServer(new Context(LogLevel.Error, $"{nameof(NetworkPrefab)} hash was not found! In-Scene placed {nameof(NetworkObject)} soft synchronization failure!").AddInfo(nameof(NetworkObject.GlobalObjectIdHash), globalObjectIdHash));
                     return null;
                 }
 
@@ -1122,7 +1116,14 @@
                 return false;
             }
 
-            if (!sceneObject && NetworkManager.LogLevel <= LogLevel.Error)
+            if (playerObject && networkObject.InScenePlaced)
+            {
+                NetworkLog.LogError(new Context(LogLevel.Developer, "Player prefab is marked as belonging to a scene. This may cause issues.").AddNetworkObject(networkObject).AddInfo("SceneName", networkObject.SceneOrigin.name));
+                networkObject.InScenePlaced = false;
+            }
+            NetworkLog.InternalAssert(sceneObject == networkObject.InScenePlaced, "Legacy sceneObject value should match calculated InScenePlaced value.");
+
+            if (!networkObject.InScenePlaced && NetworkManager.LogLevel <= LogLevel.Error)
             {
                 var networkObjectChildren = networkObject.GetComponentsInChildren<NetworkObject>();
                 if (networkObjectChildren.Length > 1)
@@ -1137,7 +1138,7 @@
             networkObject.NetworkManagerOwner = NetworkManager;
             networkObject.InvokeBehaviourNetworkPreSpawn();
 
-            if (NetworkManager.DistributedAuthorityMode && NetworkManager.NetworkConfig.EnableSceneManagement && sceneObject)
+            if (NetworkManager.DistributedAuthorityMode && NetworkManager.NetworkConfig.EnableSceneManagement && networkObject.InScenePlaced)
             {
                 networkObject.SceneOriginHandle = networkObject.gameObject.scene.handle;
                 networkObject.NetworkSceneHandle = NetworkManager.SceneManager.ClientSceneHandleToServerSceneHandle[networkObject.gameObject.scene.handle];
@@ -1175,10 +1176,7 @@
         {
             if (SpawnedObjects.ContainsKey(serializedObject.NetworkObjectId))
             {
-                if (NetworkManager.LogLevel <= LogLevel.Error)
-                {
-                    NetworkLog.LogWarning($"Trying to spawn a {nameof(NetworkObject)} with a {nameof(NetworkObject.NetworkObjectId)} of {serializedObject.NetworkObjectId} but an object with that id is already in the spawned list. This should not happen!");
-                }
+                NetworkManager.Log.Warning(new Context(LogLevel.Error, $"Trying to spawn a {nameof(NetworkObject)} but an object with that {nameof(NetworkObject.NetworkObjectId)} is already in the spawned list. This should not happen!"));
                 networkObject = null;
                 return false;
             }
@@ -1195,14 +1193,11 @@
             // Log the error that the NetworkObject failed to construct
             if (networkObject == null)
             {
-                if (NetworkManager.LogLevel <= LogLevel.Normal)
-                {
-                    NetworkLog.LogError($"[{nameof(NetworkObject.GlobalObjectIdHash)}={serializedObject.Hash}] Failed to spawn {nameof(NetworkObject)}!");
-                }
-
+                NetworkManager.Log.ErrorServer(new Context(LogLevel.Normal, $"Failed to spawn {nameof(NetworkObject)}!").AddInfo(nameof(NetworkObject.GlobalObjectIdHash), serializedObject.Hash));
                 return false;
             }
 
+            networkObject.InScenePlaced = serializedObject.IsSceneObject;
             networkObject.NetworkManagerOwner = NetworkManager;
 
             // This will get set again when the NetworkObject is spawned locally, but we set it here ahead of spawning
@@ -1227,11 +1222,7 @@
 
             if (networkObject.IsSpawned)
             {
-                if (NetworkManager.LogLevel <= LogLevel.Error)
-                {
-                    NetworkLog.LogErrorServer($"[{networkObject.name}] Object-{networkObject.NetworkObjectId} is already spawned!");
-                }
-
+                NetworkManager.Log.ErrorServer(new Context(LogLevel.Normal, $"{nameof(NetworkObject)} is already spawned!").AddNetworkObject(networkObject));
                 // Mark the spawn as a success if the object is already spawned
                 return true;
             }