Test-Multiplayer/Library/PackageCache/com.unity.dedicated-server@5a2666836321/MultiplayerRoles/Editor/ReferenceTracker.cs

using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using UnityEngine.SceneManagement;
using System.Linq;

namespace Unity.Multiplayer.Editor
{
    internal struct ReferenceTracker
    {
        private HashSet<int> m_StrippedObjectsInstanceIds; // Objects that should be stripped
        private HashSet<int> m_ReferencesInstanceIds; // Objects referenced by any other not stripped object
        private List<Vector2Int> m_ReferencePairs; // Pairs of (reference, referencer) -- where the referencer is not stripped
        private GameObject[] m_GameObjects; // Objects to collect data from
        private MultiplayerRoleFlags m_ActiveMultiplayerRoleMask;
        private List<Component> m_ComponentsCache;

        public ReferenceTracker(MultiplayerRoleFlags activeMultiplayerRoleMask, GameObject[] gameObjects)
        {
            m_ComponentsCache = new List<Component>();
            m_StrippedObjectsInstanceIds = new HashSet<int>();
            m_ReferencesInstanceIds = new HashSet<int>();
            m_ReferencePairs = new List<Vector2Int>();
            m_GameObjects = gameObjects;
            m_ActiveMultiplayerRoleMask = activeMultiplayerRoleMask;
        }

        public ReferenceTracker(MultiplayerRoleFlags activeMultiplayerRoleMask, Scene scene) : this(activeMultiplayerRoleMask, scene.GetRootGameObjects()) { }

        private void TrackStrippedObject(Object obj)
        {
            m_StrippedObjectsInstanceIds.Add(obj.GetInstanceID());
        }

        private void TrackReference(Object referencer, Object reference)
        {
            if (reference == null)
                return;

            var referencerInstanceId = referencer.GetInstanceID();
            var referenceInstanceId = reference.GetInstanceID();

            m_ReferencesInstanceIds.Add(referenceInstanceId);
            m_ReferencePairs.Add(new Vector2Int(referenceInstanceId, referencerInstanceId));
        }

        public void Collect()
        {
            foreach (var gameObject in m_GameObjects)
                CollectRecursive(gameObject.transform, false);
        }

        private void CollectRecursive(Transform transform, bool parentStripped)
        {
            transform.gameObject.GetComponents(m_ComponentsCache);

            parentStripped = parentStripped || EditorMultiplayerRolesManager.ShouldStrip(m_ActiveMultiplayerRoleMask, transform.gameObject);

            if (parentStripped)
                TrackStrippedObject(transform.gameObject);

            foreach (var component in m_ComponentsCache)
            {
                if (component == null)
                    continue;

                if (component is MultiplayerRolesData)
                    continue;

                if (parentStripped || EditorMultiplayerRolesManager.ShouldStrip(m_ActiveMultiplayerRoleMask, component))
                {
                    TrackStrippedObject(component);
                    continue;
                }

                using var serializedObject = new SerializedObject(component);
                var property = serializedObject.GetIterator();
                while (property.Next(true))
                {
                    if (property.propertyType == SerializedPropertyType.ObjectReference)
                        TrackReference(component, property.objectReferenceValue);
                }
            }
        }

        public void WarnBrokenReferencesIfNeeded()
        {
            var brokenReferences = m_ReferencesInstanceIds.Intersect(m_StrippedObjectsInstanceIds);
            if (brokenReferences.Count() == 0)
                return;

            var message = $"The following objects are stripped for the current multiplayer role ({m_ActiveMultiplayerRoleMask}) but they are referenced by other objects in the scene. This could lead to null reference errors.\n";

            foreach (var referencePair in m_ReferencePairs)
            {
                if (brokenReferences.Contains(referencePair.x))
                {
                    var reference = EditorUtility.InstanceIDToObject(referencePair.x);
                    var referencer = EditorUtility.InstanceIDToObject(referencePair.y);
                    message += $"- {reference.name} ({reference.GetType().Name}) referenced by {referencer.name} ({referencer.GetType().Name})\n";
                }
            }

            Debug.LogWarning(message);
        }
    }
}