@quenty/blend 12.6.0 → 12.8.0

package/CHANGELOG.md

@@ -3,6 +3,31 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [12.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@12.7.0...@quenty/blend@12.8.0) (2024-10-04)
+
+
+### Bug Fixes
+
+* Avoid additional table construction in Blend.Computed for performance gain ([40ff0c0](https://github.com/Quenty/NevermoreEngine/commit/40ff0c05ed62fec4d6033bdabd477223bbc96a6a))
+* Blend unparents children before destruction saving any instances that need to be reparented ([2728331](https://github.com/Quenty/NevermoreEngine/commit/272833178a1cbe833b35121c707ec8061c3891aa))
+
+
+### Performance Improvements
+
+* Avoid connecting to Rx if not needed in SpringObject ([a5ca4b8](https://github.com/Quenty/NevermoreEngine/commit/a5ca4b8cd4e4855b58a61478c9ecf9ff4a8a2cfe))
+
+
+
+
+
+# [12.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@12.6.0...@quenty/blend@12.7.0) (2024-09-25)
+
+**Note:** Version bump only for package @quenty/blend
+
+
+
+
+
 # [12.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@12.5.2...@quenty/blend@12.6.0) (2024-09-25)
 
 **Note:** Version bump only for package @quenty/blend

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/blend",
-  "version": "12.6.0",
+  "version": "12.8.0",
   "description": "Declarative UI system.",
   "keywords": [
     "Roblox",
@@ -28,23 +28,23 @@
   },
   "dependencies": {
     "@quenty/acceltween": "^2.5.0",
-    "@quenty/brio": "^14.6.0",
-    "@quenty/ducktype": "^5.5.0",
-    "@quenty/instanceutils": "^13.6.0",
-    "@quenty/loader": "^10.5.0",
-    "@quenty/maid": "^3.3.0",
-    "@quenty/promise": "^10.5.0",
-    "@quenty/rx": "^13.6.0",
-    "@quenty/signal": "^7.5.0",
-    "@quenty/spring": "^10.5.0",
+    "@quenty/brio": "^14.8.0",
+    "@quenty/ducktype": "^5.6.0",
+    "@quenty/instanceutils": "^13.8.0",
+    "@quenty/loader": "^10.6.0",
+    "@quenty/maid": "^3.4.0",
+    "@quenty/promise": "^10.6.0",
+    "@quenty/rx": "^13.8.0",
+    "@quenty/signal": "^7.7.0",
+    "@quenty/spring": "^10.6.0",
     "@quenty/steputils": "^3.5.0",
     "@quenty/string": "^3.3.0",
-    "@quenty/valuebaseutils": "^13.6.0",
-    "@quenty/valueobject": "^13.6.0"
+    "@quenty/valuebaseutils": "^13.8.0",
+    "@quenty/valueobject": "^13.8.0"
   },
   "devDependencies": {
-    "@quenty/contentproviderutils": "^12.6.0",
-    "@quenty/playerthumbnailutils": "^10.5.0"
+    "@quenty/contentproviderutils": "^12.8.0",
+    "@quenty/playerthumbnailutils": "^10.6.0"
   },
-  "gitHead": "41715b15e2b48b2d22ff4f5277a8d4b7a0d32ef3"
+  "gitHead": "035abfa088c854a73e1c65b350267eaa17669646"
 }

package/src/Shared/Blend/Blend.lua

@@ -20,7 +20,6 @@ local Signal = require("Signal")
 local StepUtils = require("StepUtils")
 local ValueBaseUtils = require("ValueBaseUtils")
 local ValueObject = require("ValueObject")
-local ValueObjectUtils = require("ValueObjectUtils")
 local RxBrioUtils = require("RxBrioUtils")
 local SpringObject
 
@@ -49,23 +48,23 @@ local Blend = {}
 	@param className string
 	@return (props: { [string]: any; }) -> Observable<Instance>
 ]=]
-function Blend.New(className)
+function Blend.New(className: string)
 	assert(type(className) == "string", "Bad className")
 
-	local defaults = BlendDefaultProps[className]
-
 	return function(props)
 		return Observable.new(function(sub)
 			local instance = Instance.new(className)
 
-			if defaults then
-				for key, value in pairs(defaults) do
+			if BlendDefaultProps[className] then
+				for key, value in pairs(BlendDefaultProps[className]) do
 					instance[key] = value
 				end
 			end
 
 			local maid = Blend.mount(instance, props)
-			maid:GiveTask(instance)
+			maid:GiveTask(function()
+				Blend._safeCleanupInstance(instance)
+			end)
 
 			sub:Fire(instance)
 
@@ -159,30 +158,32 @@ end
 	@return Observable<T>
 ]=]
 function Blend.Computed(...)
-	local values = {...}
 	local n = select("#", ...)
-	local compute = values[n]
-
+	local compute = select(n, ...)
 	assert(type(compute) == "function", "Bad compute")
 
-	local args = {}
-	for i=1, n - 1 do
-		local observable = Blend.toPropertyObservable(values[i])
-		if observable then
-			args[i] = observable
-		else
-			args[i] = Rx.of(values[i])
-		end
-	end
-
-	if #args == 0 then
+	if n == 1 then
 		-- static value?
 		return Observable.new(function(sub)
 			sub:Fire(compute())
 		end)
-	elseif #args == 1 then
-		return Rx.map(compute)(args[1])
+	elseif n == 2 then
+		local arg = ...
+		local observable = Blend.toPropertyObservable(arg) or Rx.of(arg)
+		return Rx.map(compute)(observable)
 	else
+		local args = table.create(n - 1)
+
+		for i=1, n - 1 do
+			local found = select(i, ...)
+			local observable = Blend.toPropertyObservable(found)
+			if observable then
+				args[i] = observable
+			else
+				args[i] = found
+			end
+		end
+
 		return Rx.combineLatest(args)
 			:Pipe({
 				Rx.map(function(result)
@@ -269,17 +270,16 @@ end
 function Blend.Attached(constructor)
 	return function(parent)
 		return Observable.new(function(sub)
-			local maid = Maid.new()
-
 			local resource = constructor(parent)
 
+			local cleanup = nil
 			if MaidTaskUtils.isValidTask(resource) then
-				maid:GiveTask(resource)
+				cleanup = resource
 			end
 
 			sub:Fire(resource)
 
-			return maid
+			return cleanup
 		end)
 	end;
 end
@@ -414,14 +414,12 @@ function Blend.Spring(source, speed, damper)
 	end
 
 	return Observable.new(function(sub)
-		local maid = Maid.new()
-
-		local spring = maid:Add(SpringObject.new(source, speed, damper))
+		local spring = SpringObject.new(source, speed, damper)
 		spring.Epsilon = 1e-3
 
-		maid:GiveTask(spring:Observe():Subscribe(sub:GetFireFailComplete()))
+		spring._maid:GiveTask(spring:Observe():Subscribe(sub:GetFireFailComplete()))
 
-		return maid
+		return spring
 	end)
 end
 
@@ -432,24 +430,26 @@ end
 	@return Observable?
 ]=]
 function Blend.toPropertyObservable(value)
-	if Observable.isObservable(value) then
-		return value
-	elseif typeof(value) == "Instance" then
-		-- IntValue, ObjectValue, et cetera
-		if ValueBaseUtils.isValueBase(value) then
-			return RxValueBaseUtils.observeValue(value)
-		end
-	elseif type(value) == "table" then
-		if ValueObject.isValueObject(value) then
-			return ValueObjectUtils.observeValue(value)
+	if type(value) == "table" then
+		if Observable.isObservable(value) then
+			return value
 		elseif Promise.isPromise(value) then
 			return Rx.fromPromise(value)
 		elseif value.Observe then
 			return value:Observe()
+		else
+			return nil
 		end
+	elseif typeof(value) == "Instance" then
+		-- IntValue, ObjectValue, et cetera
+		if ValueBaseUtils.isValueBase(value) then
+			return RxValueBaseUtils.observeValue(value)
+		else
+			return nil
+		end
+	else
+		return nil
 	end
-
-	return nil
 end
 
 --[=[
@@ -578,11 +578,11 @@ function Blend.Children(parent, value)
 	local observe = Blend._observeChildren(value, parent)
 
 	if observe then
-		return observe:Pipe({
-			Rx.tap(function(child)
-				child.Parent = parent;
-			end);
-		})
+		return Observable.new(function(_sub)
+			return observe:Subscribe(function(child)
+				child.Parent = parent
+			end)
+		end)
 	else
 		return Rx.EMPTY
 	end
@@ -682,35 +682,42 @@ function Blend.Find(className)
 		-- Return observable and assume we're being used in anexternal context
 		-- TODO: Maybe not this
 		if props.Parent then
-			local propertyObservable = Blend.toPropertyObservable(props.Parent) or Rx.of(props.Parent)
+			local propertyObservable = Blend.toPropertyObservable(props.Parent)
 
-			return propertyObservable:Pipe({
-				RxBrioUtils.toBrio();
-				RxBrioUtils.where(function(parent)
-					return parent ~= nil
-				end);
-				RxBrioUtils.switchMapBrio(function(parent)
-					assert(typeof(parent) == "Instance", "Bad parent retrieved during find spec")
+			local function handleChildBrio(brio)
+				if brio:IsDead() then
+					return
+				end
 
-					return RxInstanceUtils.observeChildrenOfNameBrio(parent, className, props.Name)
-				end);
-				Rx.flatMap(function(brio)
-					if brio:IsDead() then
-						return
-					end
+				local maid, instance = brio:ToMaidAndValue()
 
-					local maid = brio:ToMaid()
-					local instance = brio:GetValue()
-					maid:GiveTask(Blend.mount(instance, props))
+				maid:GiveTask(Blend.mount(instance, props))
 
-					if brio:IsDead() then
-						maid:DoCleaning()
-					end
+				if brio:IsDead() then
+					maid:DoCleaning()
+				end
 
-					-- Emit back found value (we're used in property scenario)
-					return Rx.of(instance)
-				end);
-			})
+				-- Emit back found value (we're used in property scenario)
+				return Rx.of(instance)
+			end
+
+			if propertyObservable then
+				return propertyObservable:Pipe({
+					RxBrioUtils.switchToBrio(function(parent)
+						return parent ~= nil
+					end);
+					RxBrioUtils.switchMapBrio(function(parent)
+						assert(typeof(parent) == "Instance", "Bad parent retrieved during find spec")
+
+						return RxInstanceUtils.observeChildrenOfNameBrio(parent, className, props.Name)
+					end);
+					Rx.flatMap(handleChildBrio);
+				})
+			else
+				return RxInstanceUtils.observeChildrenOfNameBrio(props.Parent, className, props.Name):Pipe({
+					Rx.flatMap(handleChildBrio);
+				})
+			end
 		end
 
 		-- Return callback
@@ -730,8 +737,8 @@ function Blend._mountToFinding(props)
 			return
 		end
 
-		local maid = brio:ToMaid()
-		local instance = brio:GetValue()
+		local maid, instance = brio:ToMaidAndValue()
+
 		maid:GiveTask(Blend.mount(instance, props))
 
 		-- Dead after mounting? Clean up...
@@ -858,6 +865,14 @@ function Blend.Single(observable)
 	end)
 end
 
+function Blend._safeCleanupInstance(result)
+	-- Unparent all children incase we want to resurrect them
+	for _, child in pairs(result:GetChildren()) do
+		child.Parent = nil
+	end
+	result:Destroy()
+end
+
 --[=[
 	Observes children and ensures that the value is cleaned up
 	afterwards.
@@ -943,7 +958,9 @@ function Blend._observeChildren(value, parent)
 			local result = value:GetValue()
 			if typeof(result) == "Instance" then
 				local maid = value:ToMaid()
-				maid:GiveTask(result)
+				maid:GiveTask(function()
+					Blend._safeCleanupInstance(result)
+				end)
 				sub:Fire(result)
 
 				return maid
@@ -990,7 +1007,9 @@ function Blend._observeChildren(value, parent)
 			maid:GiveTask(value:Subscribe(function(result)
 				if typeof(result) == "Instance" then
 					-- lifetime of subscription
-					maid:GiveTask(result)
+					maid:GiveTask(function()
+						Blend._safeCleanupInstance(result)
+					end)
 					sub:Fire(result)
 					return
 				end
@@ -1089,6 +1108,7 @@ function Blend.mount(instance, props)
 
 	local parent = nil
 	local dependentObservables = {}
+	local children = {}
 
 	for key, value in pairs(props) do
 		if type(key) == "string" then
@@ -1098,14 +1118,16 @@ function Blend.mount(instance, props)
 				local observable = Blend.toPropertyObservable(value)
 				if observable then
 					maid:GiveTask(observable:Subscribe(function(result)
-						task.spawn(function()
-							instance[key] = result
-						end)
+						instance[key] = result
+						-- task.spawn(function()
+						-- 	instance[key] = result
+						-- end)
 					end))
 				else
-					task.spawn(function()
-						instance[key] = value
-					end)
+					-- task.spawn(function()
+					-- 	instance[key] = value
+					-- end)
+					instance[key] = value
 				end
 			end
 		elseif type(key) == "function" then
@@ -1119,12 +1141,17 @@ function Blend.mount(instance, props)
 		elseif type(key) == "number" then
 			-- Treat this as an implicit children contract
 			-- Thus, we don't need an explicit [Blend.Children] call.
-			table.insert(dependentObservables, { Blend.Children(instance, value), value })
+			table.insert(children, value)
 		else
 			warn(string.format("Unable to apply property %q", tostring(key)))
 		end
 	end
 
+
+	if #children > 0 then
+		maid:GiveTask(Blend.Children(instance, children):Subscribe())
+	end
+
 	-- Subscribe dependentObservables (which includes adding children)
 	for _, event in pairs(dependentObservables) do
 		maid:GiveTask(event[1]:Subscribe(Blend.toEventHandler(event[2])))

package/src/Shared/Blend/SpringObject.lua

@@ -13,7 +13,6 @@ local DuckTypeUtils = require("DuckTypeUtils")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local Promise = require("Promise")
-local Rx = require("Rx")
 local Signal = require("Signal")
 local Spring = require("Spring")
 local SpringUtils = require("SpringUtils")
@@ -265,30 +264,36 @@ end
 function SpringObject:SetTarget(target, doNotAnimate)
 	assert(target ~= nil, "Bad target")
 
-	local observable = Blend.toPropertyObservable(target) or Rx.of(target)
+	local observable = Blend.toPropertyObservable(target)
+	if not observable then
+		self._maid._targetSub = nil
+		self:_applyTarget(target, doNotAnimate)
+		return
+	end
 
 	if doNotAnimate then
 		local isFirst = true
-
 		self._maid._targetSub = observable:Subscribe(function(unconverted)
 			local converted = SpringUtils.toLinearIfNeeded(unconverted)
 			assert(converted, "Not a valid converted target")
 
-			local spring = self:_getSpringForType(converted)
-			spring:SetTarget(converted, isFirst)
+			local wasFirst = isFirst
 			isFirst = false
-
-			self.Changed:Fire()
+			self:_applyTarget(unconverted, wasFirst)
 		end)
 	else
 		self._maid._targetSub = observable:Subscribe(function(unconverted)
-			local converted = SpringUtils.toLinearIfNeeded(unconverted)
-			self:_getSpringForType(converted).Target = converted
-			self.Changed:Fire()
+			self:_applyTarget(unconverted, doNotAnimate)
 		end)
 	end
 end
 
+function SpringObject:_applyTarget(unconverted, doNotAnimate)
+	local converted = SpringUtils.toLinearIfNeeded(unconverted)
+	self:_getSpringForType(converted):SetTarget(converted, doNotAnimate)
+	self.Changed:Fire()
+end
+
 --[=[
 	Sets the velocity for the spring
 
@@ -297,14 +302,22 @@ end
 function SpringObject:SetVelocity(velocity)
 	assert(velocity ~= nil, "Bad velocity")
 
-	local observable = Blend.toPropertyObservable(velocity) or Rx.of(velocity)
+	local observable = Blend.toPropertyObservable(velocity)
+	if not observable then
+		self._maid._velocitySub = nil
+		self:_applyVelocity(velocity)
+	else
+		self._maid._velocitySub = observable:Subscribe(function(unconverted)
+			self:_applyVelocity(unconverted)
+		end)
+	end
+end
 
-	self._maid._velocitySub = observable:Subscribe(function(unconverted)
-		local converted = SpringUtils.toLinearIfNeeded(unconverted)
+function SpringObject:_applyVelocity(unconverted)
+	local converted = SpringUtils.toLinearIfNeeded(unconverted)
 
-		self:_getSpringForType(0*converted).Velocity = converted
-		self.Changed:Fire()
-	end)
+	self:_getSpringForType(0*converted).Velocity = converted
+	self.Changed:Fire()
 end
 
 --[=[
@@ -315,13 +328,21 @@ end
 function SpringObject:SetPosition(position)
 	assert(position ~= nil, "Bad position")
 
-	local observable = Blend.toPropertyObservable(position) or Rx.of(position)
+	local observable = Blend.toPropertyObservable(position)
+	if not observable then
+		self._maid._positionSub = nil
+		self:_applyPosition(position)
+	else
+		self._maid._positionSub = observable:Subscribe(function(unconverted)
+			self:_applyPosition(unconverted)
+		end)
+	end
+end
 
-	self._maid._positionSub = observable:Subscribe(function(unconverted)
-		local converted = SpringUtils.toLinearIfNeeded(unconverted)
-		self:_getSpringForType(converted).Value = converted
-		self.Changed:Fire()
-	end)
+function SpringObject:_applyPosition(unconverted)
+	local converted = SpringUtils.toLinearIfNeeded(unconverted)
+	self:_getSpringForType(converted).Value = converted
+	self.Changed:Fire()
 end
 
 --[=[
@@ -332,20 +353,29 @@ end
 function SpringObject:SetDamper(damper)
 	assert(damper ~= nil, "Bad damper")
 
-	local observable = assert(Blend.toNumberObservable(damper), "Invalid damper")
+	if type(damper) == "number" then
+		self._maid._damperSub = nil
+		self:_applyDamper(damper)
+	else
+		local observable = assert(Blend.toPropertyObservable(damper), "Invalid damper")
 
-	self._maid._damperSub = observable:Subscribe(function(unconverted)
-		assert(type(unconverted) == "number", "Bad damper")
+		self._maid._damperSub = observable:Subscribe(function(unconverted)
+			self:_applyDamper(unconverted)
+		end)
+	end
+end
 
-		local currentSpring = rawget(self, "_currentSpring")
-		if currentSpring then
-			currentSpring.Damper = unconverted
-		else
-			self:_getInitInfo().Damper = unconverted
-		end
+function SpringObject:_applyDamper(unconverted)
+	assert(type(unconverted) == "number", "Bad damper")
 
-		self.Changed:Fire()
-	end)
+	local currentSpring = rawget(self, "_currentSpring")
+	if currentSpring then
+		currentSpring.Damper = unconverted
+	else
+		self:_getInitInfo().Damper = unconverted
+	end
+
+	self.Changed:Fire()
 end
 
 --[=[
@@ -356,20 +386,29 @@ end
 function SpringObject:SetSpeed(speed)
 	assert(speed ~= nil, "Bad speed")
 
-	local observable = assert(Blend.toNumberObservable(speed), "Invalid speed")
+	if type(speed) == "number" then
+		self._maid._speedSub = nil
+		self:_applySpeed(speed)
+	else
+		local observable = assert(Blend.toPropertyObservable(speed), "Invalid speed")
 
-	self._maid._speedSub = observable:Subscribe(function(unconverted)
-		assert(type(unconverted) == "number", "Bad damper")
+		self._maid._speedSub = observable:Subscribe(function(unconverted)
+			self:_applySpeed(unconverted)
+		end)
+	end
+end
 
-		local currentSpring = rawget(self, "_currentSpring")
-		if currentSpring then
-			currentSpring.Speed = unconverted
-		else
-			self:_getInitInfo().Speed = unconverted
-		end
+function SpringObject:_applySpeed(unconverted)
+	assert(type(unconverted) == "number", "Bad damper")
 
-		self.Changed:Fire()
-	end)
+	local currentSpring = rawget(self, "_currentSpring")
+	if currentSpring then
+		currentSpring.Speed = unconverted
+	else
+		self:_getInitInfo().Speed = unconverted
+	end
+
+	self.Changed:Fire()
 end
 
 --[=[