fix: wrong avatar base destruction (Angzaar teleport) (#4014)

Author: dalkia

Explorer/Assets/DCL/Infrastructure/Global/StaticContainer.cs

@@ -254,7 +254,7 @@ await UniTask.WhenAll(
                 new MaterialsPlugin(sharedDependencies, videoTexturePool),
                 textureResolvePlugin,
                 new AssetsCollidersPlugin(sharedDependencies, container.PhysicsTickProvider),
-                new AvatarShapePlugin(globalWorld),
+                new AvatarShapePlugin(globalWorld, componentsContainer.ComponentPoolsRegistry),
                 new AvatarAttachPlugin(globalWorld, container.MainPlayerAvatarBaseProxy, componentsContainer.ComponentPoolsRegistry, container.EntityParticipantTableProxy),
                 new PrimitivesRenderingPlugin(sharedDependencies),
                 new VisibilityPlugin(),

Explorer/Assets/DCL/PluginSystem/World/AvatarShapePlugin.cs

@@ -1,21 +1,25 @@
 using Arch.SystemGroups;
 using DCL.ECSComponents;
+using DCL.Optimization.Pools;
 using DCL.PluginSystem.World.Dependencies;
 using DCL.SDKComponents.AvatarShape.Systems;
 using ECS.LifeCycle;
 using ECS.LifeCycle.Systems;
 using ECS.Unity.AvatarShape.Systems;
 using System.Collections.Generic;
+using UnityEngine;
 
 namespace DCL.PluginSystem.World
 {
     public class AvatarShapePlugin : IDCLWorldPlugin
     {
         private readonly Arch.Core.World globalWorld;
+        public IComponentPool<Transform> globalTransformPool;
 
-        public AvatarShapePlugin(Arch.Core.World globalWorld)
+        public AvatarShapePlugin(Arch.Core.World globalWorld, IComponentPoolsRegistry poolRegistry)
         {
             this.globalWorld = globalWorld;
+            this.globalTransformPool = poolRegistry.GetReferenceTypePool<Transform>();
         }
 
         public void Dispose()
@@ -26,7 +30,7 @@ public void Dispose()
         public void InjectToWorld(ref ArchSystemsWorldBuilder<Arch.Core.World> builder, in ECSWorldInstanceSharedDependencies sharedDependencies, in PersistentEntities persistentEntities, List<IFinalizeWorldSystem> finalizeWorldSystems, List<ISceneIsCurrentListener> sceneIsCurrentListeners)
         {
             ResetDirtyFlagSystem<PBAvatarShape>.InjectToWorld(ref builder);
-            var avatarShapeHandlerSystem = AvatarShapeHandlerSystem.InjectToWorld(ref builder, globalWorld);
+            var avatarShapeHandlerSystem = AvatarShapeHandlerSystem.InjectToWorld(ref builder, globalWorld, globalTransformPool);
             finalizeWorldSystems.Add(avatarShapeHandlerSystem);
             UpdateAvatarShapeInterpolateMovementSystem.InjectToWorld(ref builder, globalWorld, sharedDependencies.SceneData.SceneShortInfo.BaseParcel);
         }

Explorer/Assets/DCL/SDKComponents/AvatarShape/Systems/AvatarShapeHandlerSystem.cs

@@ -8,13 +8,15 @@
 using DCL.CharacterMotion.Components;
 using DCL.Diagnostics;
 using DCL.ECSComponents;
+using DCL.Optimization.Pools;
 using ECS.Abstract;
 using ECS.LifeCycle;
 using ECS.LifeCycle.Components;
 using ECS.Prioritization.Components;
 using ECS.Unity.AvatarShape.Components;
 using ECS.Unity.Groups;
 using ECS.Unity.Transforms.Components;
+using UnityEngine;
 using Utility.Arch;
 
 namespace ECS.Unity.AvatarShape.Systems
@@ -25,10 +27,12 @@ namespace ECS.Unity.AvatarShape.Systems
     public partial class AvatarShapeHandlerSystem : BaseUnityLoopSystem, IFinalizeWorldSystem
     {
         private readonly World globalWorld;
+        private readonly IComponentPool<Transform> globalTransformPool;
 
-        public AvatarShapeHandlerSystem(World world, World globalWorld) : base(world)
+        public AvatarShapeHandlerSystem(World world, World globalWorld, IComponentPool<Transform> globalTransformPool) : base(world)
         {
             this.globalWorld = globalWorld;
+            this.globalTransformPool = globalTransformPool;
         }
 
         protected override void Update(float t)
@@ -44,9 +48,14 @@ protected override void Update(float t)
         [None(typeof(SDKAvatarShapeComponent), typeof(DeleteEntityIntention))]
         private void LoadAvatarShape(Entity entity, ref PBAvatarShape pbAvatarShape, ref PartitionComponent partitionComponent, ref TransformComponent transformComponent)
         {
+            // We have to create a global transform to hold the CharacterTransform. Using the Transform from the TransformComponent
+            // may lead to unexpected consequences, since that one is disposed by the scene, while the avatar lives in the global world
+            Transform globalTransform = globalTransformPool.Get();
+            globalTransform.SetParent(transformComponent.Transform);
+
             var globalWorldEntity = globalWorld.Create(
                 pbAvatarShape, partitionComponent,
-                new CharacterTransform(transformComponent.Transform),
+                new CharacterTransform(globalTransform),
                 new CharacterInterpolationMovementComponent(transformComponent.Transform.position, transformComponent.Transform.position, transformComponent.Transform.rotation),
                 new CharacterAnimationComponent(),
                 new CharacterEmoteComponent());
@@ -95,8 +104,8 @@ public void FinalizeComponents(in Query query) =>
 
         public void MarkGlobalWorldEntityForDeletion(Entity globalEntity)
         {
-            // Has to be removed, otherwise scene loading may break after teleportation (no error anywhere to know why)
-            globalWorld.Remove<CharacterTransform>(globalEntity);
+            // Need to remove parenting, since it may unintenionally deleted when
+            globalWorld.Get<CharacterTransform>(globalEntity).Transform.SetParent(null);
 
             // Has to be deferred because many times it happens that the entity is marked for deletion AFTER the
             // AvatarCleanUpSystem.Update() and BEFORE the DestroyEntitiesSystem.Update(), probably has to do with

Explorer/Assets/DCL/SDKComponents/AvatarShape/Tests/AvatarShapeHandlerSystemShould.cs

@@ -7,6 +7,9 @@
 using ECS.Unity.AvatarShape.Systems;
 using NUnit.Framework;
 using DCL.Character.Components;
+using DCL.Optimization.Pools;
+using NSubstitute;
+using UnityEngine;
 
 namespace ECS.Unity.AvatarShape.Tests
 {
@@ -17,7 +20,9 @@ public class AvatarShapeHandlerSystemShould : UnitySystemTestBase<AvatarShapeHan
         public void SetUp()
         {
             globalWorld = World.Create();
-            system = new AvatarShapeHandlerSystem(world, globalWorld);
+            IComponentPool<Transform> pool = Substitute.For<IComponentPool<Transform>>();
+            pool.Get().Returns(new GameObject().transform);
+            system = new AvatarShapeHandlerSystem(world, globalWorld, pool);
 
             entity = world.Create(PartitionComponent.TOP_PRIORITY);
             AddTransformToEntity(entity);