perf: Fix memory cleanup in Tie + Rogue Properties to try to address memory consumption

Author: Quenty

src/animations/src/Shared/AnimationTrackPlayer.lua

@@ -135,7 +135,7 @@ end
 	@param fadeTime number
 ]=]
 function AnimationTrackPlayer:SetWeightTargetIfNotSet(weight: number, fadeTime: number)
-	self._maid._adjustWeight = self:_onEachTrack(function(_maid, track)
+	self._maid._adjustWeight = self:_onEachTrack(function(track)
 		if track.WeightTarget ~= weight then
 			track:AdjustWeight(weight, fadeTime)
 		end
@@ -159,7 +159,7 @@ function AnimationTrackPlayer:Play(fadeTime: number, weight: number, speed: numb
 	end
 
 	self._maid._stop = nil
-	self._maid._play = self:_onEachTrack(function(_maid, track)
+	self._maid._play = self:_onEachTrack(function(track)
 		track:Play(fadeTime, weight, speed)
 	end)
 end
@@ -171,7 +171,7 @@ end
 ]=]
 function AnimationTrackPlayer:Stop(fadeTime: number)
 	self._maid._play = nil
-	self._maid._stop = self:_onEachTrack(function(_maid, track)
+	self._maid._stop = self:_onEachTrack(function(track)
 		track:Stop(fadeTime)
 	end)
 end
@@ -183,7 +183,7 @@ end
 	@param fadeTime number
 ]=]
 function AnimationTrackPlayer:AdjustWeight(weight: number, fadeTime: number)
-	self._maid._adjustWeight = self:_onEachTrack(function(_maid, track)
+	self._maid._adjustWeight = self:_onEachTrack(function(track)
 		track:AdjustWeight(weight, fadeTime)
 	end)
 end
@@ -195,7 +195,7 @@ end
 	@param fadeTime number
 ]=]
 function AnimationTrackPlayer:AdjustSpeed(speed: number, fadeTime: number)
-	self._maid._adjustSpeed = self:_onEachTrack(function(_maid, track)
+	self._maid._adjustSpeed = self:_onEachTrack(function(track)
 		track:AdjustSpeed(speed, fadeTime)
 	end)
 end
@@ -215,17 +215,11 @@ function AnimationTrackPlayer:IsPlaying(): boolean
 end
 
 function AnimationTrackPlayer:_onEachTrack(callback)
-	return self._currentTrack
-		:ObserveBrio(function(track)
-			return track ~= nil
-		end)
-		:Subscribe(function(brio)
-			if brio:IsDead() then
-				return
+	return self._currentTrack:Observe()
+		:Subscribe(function(track)
+			if track ~= nil then
+				callback(track)
 			end
-
-			local track = brio:GetValue()
-			callback(brio:ToMaid(), track)
 		end)
 end
 

src/brio/src/Shared/Brio.lua

@@ -208,7 +208,7 @@ function Brio.ToMaid<T...>(self: Brio<T...>): Maid.Maid
 	local maid = Maid.new()
 
 	maid:GiveTask(self:GetDiedSignal():Connect(function()
-		maid:DoCleaning()
+		maid:Destroy()
 	end))
 
 	return maid

src/performanceutils/src/Shared/PerformanceUtils.lua

@@ -115,6 +115,9 @@ end
 function PerformanceUtils.countObject(label: string, object: any): ()
 	PerformanceUtils.countCalls(label .. "_new", object, "new")
 	PerformanceUtils.countCalls(label .. "_destroy", object, "Destroy")
+	PerformanceUtils.setLabelFormat(label .. "_total", function()
+		return tostring(PerformanceUtils.readCounter(label .. "_new") - PerformanceUtils.readCounter(label .. "_destroy"))
+	end)
 end
 
 function PerformanceUtils.trackObjectConstruction(object: any): () -> ()

src/rogue-properties/src/Shared/Cache/RoguePropertyCache.lua

@@ -4,14 +4,19 @@
 	@class RoguePropertyCache
 ]=]
 
+local require = require(script.Parent.loader).load(script)
+
+local WEAK_KV = { __mode = "kv" }
+
 local RoguePropertyCache = {}
 RoguePropertyCache.ClassName = "RoguePropertyCache"
 RoguePropertyCache.__index = RoguePropertyCache
 
-function RoguePropertyCache.new()
+function RoguePropertyCache.new(debugName: string)
 	local self = setmetatable({}, RoguePropertyCache)
 
-	self._cache = setmetatable({}, { __mode = "v" })
+	self._debugName = debugName
+	self._cache = setmetatable({}, WEAK_KV)
 
 	return self
 end

src/rogue-properties/src/Shared/Cache/RoguePropertyCacheService.lua

@@ -14,25 +14,27 @@ local ServiceBag = require("ServiceBag")
 local RoguePropertyCacheService = {}
 RoguePropertyCacheService.ServiceName = "RoguePropertyCacheService"
 
+local WEAK_K_TABLE = { __mode = "k" }
+
 function RoguePropertyCacheService:Init(serviceBag: ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
-	self._cache = setmetatable({}, { __mode = "k" })
+	self._cache = setmetatable({}, WEAK_K_TABLE)
 end
 
 function RoguePropertyCacheService:GetCache(roguePropertyDefinition)
 	if not self._cache then
 		assert(not RunService:IsRunning(), "Not in test mode")
 		-- Test mode
-		return RoguePropertyCache.new()
+		return RoguePropertyCache.new(roguePropertyDefinition:GetName())
 	end
 
 	if self._cache[roguePropertyDefinition] then
 		return self._cache[roguePropertyDefinition]
 	end
 
-	local cache = RoguePropertyCache.new()
+	local cache = RoguePropertyCache.new(roguePropertyDefinition:GetName())
 	self._cache[roguePropertyDefinition] = cache
 	return cache
 end

src/tie/src/Shared/Members/Methods/TieMethodImplementation.lua

@@ -25,6 +25,15 @@ function TieMethodImplementation.new(memberDefinition, parent: Instance, initial
 
 	self:SetImplementation(initialValue)
 
+	-- Since "actualSelf" can be quite large, we clean up our stuff aggressively for GC.
+	self._maid:GiveTask(function()
+		self._maid:DoCleaning()
+
+		for key, _ in pairs(self) do
+			rawset(self, key, nil)
+		end
+	end)
+
 	return self
 end
 

src/tie/src/Shared/Members/Properties/TiePropertyImplementation.lua

@@ -38,13 +38,23 @@ function TiePropertyImplementation.new(memberDefinition, folder: Folder, initial
 
 	self:SetImplementation(initialValue)
 
+	-- Since "actualSelf" can be quite large, we clean up our stuff aggressively for GC.
+	self._maid:GiveTask(function()
+		self._maid:DoCleaning()
+
+		for key, _ in pairs(self) do
+			rawset(self, key, nil)
+		end
+	end)
+
 	return self
 end
 
 function TiePropertyImplementation:SetImplementation(implementation)
-	local maid = Maid.new()
 	self._maid._current = nil
 
+	local maid = Maid.new()
+
 	-- override with default value on nil case
 	if implementation == nil then
 		implementation = self._memberDefinition:GetDefaultValue()

src/tie/src/Shared/Members/Signals/TieSignalImplementation.lua

@@ -26,6 +26,15 @@ function TieSignalImplementation.new(memberDefinition, implParent, initialValue)
 
 	self:SetImplementation(initialValue)
 
+	-- Since "actualSelf" can be quite large, we clean up our stuff aggressively for GC.
+	self._maid:GiveTask(function()
+		self._maid:DoCleaning()
+
+		for key, _ in pairs(self) do
+			rawset(self, key, nil)
+		end
+	end)
+
 	return self
 end
 

src/tie/src/Shared/TieImplementation.lua

@@ -50,6 +50,15 @@ function TieImplementation.new(
 
 	self._implParent.Parent = self._adornee
 
+	-- Since "actualSelf" can be quite large, we clean up our stuff aggressively for GC.
+	self._maid:GiveTask(function()
+		self._maid:DoCleaning()
+
+		for key, _ in pairs(self) do
+			rawset(self, key, nil)
+		end
+	end)
+
 	return self
 end