Merge pull request o3de#17469 from aws-lumberyard-dev/LYN-19166_RemoveMeshAndMaterialFromServerSpawnable

Remove Visual Components from Headless Spawnable Assets

Author: AMZN-Gene

Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/PrefabSystemComponent.cpp

@@ -18,6 +18,7 @@
 #include <AzToolsFramework/Prefab/Instance/InstanceEntityIdMapper.h>
 #include <AzToolsFramework/Prefab/Instance/InstanceSerializer.h>
 #include <AzToolsFramework/Prefab/PrefabDomUtils.h>
+#include <AzToolsFramework/Prefab/Spawnable/AssetPlatformComponentRemover.h>
 #include <AzToolsFramework/Prefab/Spawnable/EditorInfoRemover.h>
 #include <AzToolsFramework/Prefab/Spawnable/PrefabCatchmentProcessor.h>
 #include <AzToolsFramework/Prefab/Spawnable/PrefabConversionPipeline.h>
@@ -68,6 +69,7 @@ namespace AzToolsFramework
             Instance::Reflect(context);
             AzToolsFramework::Prefab::PrefabConversionUtils::PrefabConversionPipeline::Reflect(context);
             AzToolsFramework::Prefab::PrefabConversionUtils::PrefabCatchmentProcessor::Reflect(context);
+            AzToolsFramework::Prefab::PrefabConversionUtils::AssetPlatformComponentRemover::Reflect(context);
             AzToolsFramework::Prefab::PrefabConversionUtils::EditorInfoRemover::Reflect(context);
             PrefabPublicRequestHandler::Reflect(context);
             PrefabPublicNotificationHandler::Reflect(context);

Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/Spawnable/AssetPlatformComponentRemover.cpp

@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project.
+ * For complete copyright and license terms please see the LICENSE at the root of this distribution.
+ *
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+#include "AssetPlatformComponentRemover.h"
+
+#include <AzCore/Component/ComponentApplicationBus.h>
+#include <AzCore/RTTI/ReflectContext.h>
+#include <AzCore/Serialization/SerializeContext.h>
+#include <AzToolsFramework/Prefab/Spawnable/PrefabDocument.h>
+
+
+namespace AzToolsFramework::Prefab::PrefabConversionUtils
+{
+    void AssetPlatformComponentRemover::Reflect(AZ::ReflectContext* context)
+    {
+        if (auto* serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
+        {
+            serializeContext->Class<AssetPlatformComponentRemover, PrefabProcessor>()
+                ->Version(1)
+                ->Field("PlatformExcludedComponents", &AssetPlatformComponentRemover::m_platformExcludedComponents)
+                ;
+        }
+    }
+
+    void AssetPlatformComponentRemover::Process(PrefabProcessorContext& prefabProcessorContext)
+    {
+        AZ::PlatformTagSet platformTags = prefabProcessorContext.GetPlatformTags();
+        AZStd::set<AZ::Uuid> excludedComponents;
+        for (const auto& platforms : m_platformExcludedComponents)
+        {
+            if (platformTags.contains(AZ::Crc32(platforms.first)))
+            {
+                excludedComponents.insert_range(platforms.second);
+            }
+        }
+
+        if (excludedComponents.empty())
+        {
+            // No need to remove any components.
+            return;
+        }
+
+        // Iterate over every entity, in every prefab
+        prefabProcessorContext.ListPrefabs(
+            [&prefabProcessorContext, &excludedComponents](PrefabDocument& prefab) -> void
+            {
+                prefab.GetInstance().GetAllEntitiesInHierarchy(
+                    [&prefab, &prefabProcessorContext, &excludedComponents](AZStd::unique_ptr<AZ::Entity>& entity) -> bool
+                    {
+                        // Loop over an entity's components backwards and pop-off components that shouldn't exist.
+                        AZStd::vector<AZ::Component*> components = entity->GetComponents();
+                        const int oldComponentCount = components.size();
+                        for (int i = oldComponentCount - 1; i >= 0; --i)
+                        {
+                            AZ::Component* component = components[i];
+                            if (excludedComponents.contains(component->GetUnderlyingComponentType()))
+                            {
+                                entity->RemoveComponent(component);
+                                delete component;
+                            }
+                        }
+
+                        // Make sure we didn't remove any components that another component dependends on
+                        if (oldComponentCount != entity->GetComponents().size())
+                        {
+                            if (entity->EvaluateDependencies() == AZ::Entity::DependencySortResult::MissingRequiredService)
+                            {
+                                AZ_Error( "AssetPlatformComponentRemover", false,
+                                    "Processing prefab '%s' failed! Removing components on entity '%s' has broken component "
+                                    "dependency. Make sure you also remove any dependent components. If dependent component is actually required, "
+                                    "then keep the provider. Please update Amazon/Tools/Prefab/Processing/PlatformExcludedComponents settings registry (.setreg).",
+                                    prefab.GetName().c_str(),
+                                    entity->GetName().c_str()
+                                );
+
+                                prefabProcessorContext.ErrorEncountered();
+                            }
+                        }
+
+                        // continue iterating over entities...
+                        return true;
+                    });
+            });
+    }
+} // namespace AzToolsFramework::Prefab::PrefabConversionUtils

Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/Spawnable/AssetPlatformComponentRemover.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project.
+ * For complete copyright and license terms please see the LICENSE at the root of this distribution.
+ *
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+#pragma once
+
+#include <AzCore/Memory/SystemAllocator.h>
+#include <AzCore/std/containers/map.h>
+#include <AzCore/std/containers/set.h>
+#include <AzToolsFramework/Prefab/Spawnable/PrefabProcessor.h>
+
+namespace AZ
+{
+    class ReflectContext;
+}
+
+// Predefinition for unit test friend class
+namespace UnitTest
+{
+    class PrefabProcessingTestFixture;
+}
+
+namespace AzToolsFramework::Prefab::PrefabConversionUtils
+{
+    //! A prefab processor for removing a spawnable's components based on asset tags.
+    //! For example, a headless server shouldn't need to load a mesh or material asset,
+    //!   so remove any MeshComponents from the server asset spawnable.
+    //! Excluded components are defined inside of Registry/prefab.tools.setreg
+    class AssetPlatformComponentRemover
+        : public PrefabProcessor
+    {
+        friend class UnitTest::PrefabProcessingTestFixture;
+
+    public:
+        AZ_CLASS_ALLOCATOR(AssetPlatformComponentRemover, AZ::SystemAllocator);
+        AZ_RTTI(AzToolsFramework::Prefab::PrefabConversionUtils::AssetPlatformComponentRemover,
+            "{25D9A8A6-908F-4B26-A752-EBAF7DC074F8}", PrefabProcessor);
+
+        static void Reflect(AZ::ReflectContext* context);
+        ~AssetPlatformComponentRemover() override = default;
+
+        void Process(PrefabProcessorContext& prefabProcessorContext) override;
+
+    private:
+        AZStd::map<AZStd::string, AZStd::set<AZ::Uuid>> m_platformExcludedComponents;
+    };
+} // namespace AzToolsFramework::Prefab::PrefabConversionUtils

Code/Framework/AzToolsFramework/AzToolsFramework/aztoolsframework_files.cmake

@@ -895,6 +895,8 @@ set(FILES
     Prefab/PrefabUndoHelpers.h
     Prefab/Spawnable/ComponentRequirementsValidator.h
     Prefab/Spawnable/ComponentRequirementsValidator.cpp
+    Prefab/Spawnable/AssetPlatformComponentRemover.h
+    Prefab/Spawnable/AssetPlatformComponentRemover.cpp
     Prefab/Spawnable/EditorInfoRemover.h
     Prefab/Spawnable/EditorInfoRemover.cpp
     Prefab/Spawnable/EditorOnlyEntityHandler/EditorOnlyEntityHandler.h