@quenty/valueobject 13.7.0 → 13.8.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [13.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@13.7.0...@quenty/valueobject@13.8.0) (2024-10-04)
+
+
+### Performance Improvements
+
+* ValueObject uses no Maid, reducing table construction. Also defers construction of GoodSignal until needed ([5701538](https://github.com/Quenty/NevermoreEngine/commit/5701538fbc8c8be5dc4dad94023acb6b7be5477e))
+
+
+
+
+
 # [13.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@13.6.0...@quenty/valueobject@13.7.0) (2024-09-25)
 
 **Note:** Version bump only for package @quenty/valueobject

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valueobject",
-  "version": "13.7.0",
+  "version": "13.8.0",
   "description": "To work like value objects in Roblox and track a single item with .Changed events",
   "keywords": [
     "Roblox",
@@ -26,16 +26,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.7.0",
-    "@quenty/ducktype": "^5.5.0",
-    "@quenty/loader": "^10.5.0",
-    "@quenty/maid": "^3.3.0",
-    "@quenty/rx": "^13.7.0",
-    "@quenty/signal": "^7.6.0",
-    "@quenty/valuebaseutils": "^13.7.0"
+    "@quenty/brio": "^14.8.0",
+    "@quenty/ducktype": "^5.6.0",
+    "@quenty/loader": "^10.6.0",
+    "@quenty/maid": "^3.4.0",
+    "@quenty/rx": "^13.8.0",
+    "@quenty/signal": "^7.7.0",
+    "@quenty/valuebaseutils": "^13.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9b17fe79cddd071f0f06a9d35184e76b44bd6fe6"
+  "gitHead": "035abfa088c854a73e1c65b350267eaa17669646"
 }

package/src/Shared/ValueObject.lua

@@ -6,13 +6,14 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local GoodSignal = require("GoodSignal")
+local Brio = require("Brio")
+local DuckTypeUtils = require("DuckTypeUtils")
 local Maid = require("Maid")
+local MaidTaskUtils = require("MaidTaskUtils")
 local Observable = require("Observable")
-local ValueBaseUtils = require("ValueBaseUtils")
 local RxValueBaseUtils = require("RxValueBaseUtils")
-local Brio = require("Brio")
-local DuckTypeUtils = require("DuckTypeUtils")
+local Signal = require("Signal")
+local ValueBaseUtils = require("ValueBaseUtils")
 
 local EMPTY_FUNCTION = function() end
 
@@ -22,35 +23,36 @@ ValueObject.ClassName = "ValueObject"
 --[=[
 	Constructs a new value object
 	@param baseValue T
-	@param checkType string | nil
+	@param checkType string | nil | (value: T) -> (boolean, string)
 	@return ValueObject
 ]=]
 function ValueObject.new(baseValue, checkType)
-	local self = {
+	local self = setmetatable({
 		_value = baseValue;
 		_checkType = checkType;
-		_maid = Maid.new();
-	}
+	}, ValueObject)
 
-	if checkType and typeof(baseValue) ~= checkType then
-		error(string.format("Expected value of type %q, got %q instead", checkType, typeof(baseValue)))
+	if type(checkType) == "stirng" then
+		if typeof(baseValue) ~= checkType then
+			error(string.format("Expected value of type %q, got %q instead", checkType, typeof(baseValue)))
+		end
+	elseif type(checkType) == "function" then
+		assert(checkType(baseValue))
 	end
 
+	return self
+end
+
 --[=[
 	Event fires when the value's object value change
 	@prop Changed Signal<T> -- fires with oldValue, newValue, ...
 	@within ValueObject
 ]=]
-	self.Changed = self._maid:Add(GoodSignal.new()) -- :Fire(newValue, oldValue, ...)
-
-	return setmetatable(self, ValueObject)
-end
-
 
 --[=[
 	Returns the current check type, if any
 
-	@return string | nil
+	@return string | nil | (value: T) -> (boolean, string)
 ]=]
 function ValueObject:GetCheckType()
 	return rawget(self, "_checkType")
@@ -96,6 +98,7 @@ function ValueObject:_toMountableObservable(value)
 
 	return nil
 end
+
 --[=[
 	Mounts the value to the observable. Overrides the last mount.
 
@@ -105,29 +108,21 @@ end
 function ValueObject:Mount(value)
 	local observable = self:_toMountableObservable(value)
 	if observable then
-		self._maid._mount = nil
-
-		local maid = Maid.new()
+		self:_cleanupLastMountedSub()
 
-		maid:GiveTask(observable:Subscribe(function(...)
+		local sub = observable:Subscribe(function(...)
 			self:SetValue(...)
-		end))
-
-		maid:GiveTask(function()
-			if self._maid._mount == maid then
-				self._maid._mount = nil
-			end
 		end)
 
-		self._maid._mount = maid
+		rawset(self, "_lastMountedSub", sub)
 
 		return function()
-			if self._maid._mount == maid then
-				self._maid._mount = nil
+			if rawget(self, "_lastMountedSub") == sub then
+				self:_cleanupLastMountedSub()
 			end
 		end
 	else
-		self._maid._mount = nil
+		self:_cleanupLastMountedSub()
 
 		self:SetValue(value)
 
@@ -135,12 +130,25 @@ function ValueObject:Mount(value)
 	end
 end
 
+function ValueObject:_cleanupLastMountedSub()
+	local lastSub = rawget(self, "_lastMountedSub")
+	if lastSub then
+		rawset(self, "_lastMountedSub", nil)
+		MaidTaskUtils.doTask(lastSub)
+	end
+end
+
 --[=[
 	Observes the current value of the ValueObject
 	@return Observable<T>
 ]=]
 function ValueObject:Observe()
-	return Observable.new(function(sub)
+	local found = rawget(self, "_observable")
+	if found then
+		return found
+	end
+
+	local created = Observable.new(function(sub)
 		if not self.Destroy then
 			warn("[ValueObject.observeValue] - Connecting to dead ValueObject")
 			-- No firing, we're dead
@@ -148,21 +156,24 @@ function ValueObject:Observe()
 			return
 		end
 
-		local connection
-
-		connection = self.Changed:Connect(function(newValue, _, ...)
+		local connection = self.Changed:Connect(function(newValue, _, ...)
 			sub:Fire(newValue, ...)
 		end)
 
 		local args = rawget(self, "_lastEventContext")
+		local value = rawget(self, "_value")
 		if args then
-			sub:Fire(self.Value, table.unpack(args, 1, args.n))
+			sub:Fire(value, table.unpack(args, 1, args.n))
 		else
-			sub:Fire(self.Value)
+			sub:Fire(value)
 		end
 
 		return connection
 	end)
+
+	-- We use a lot of these so let's cache the result which reduces the number of tables we have here
+	rawset(self, "_observable", created)
+	return created
 end
 
 --[=[
@@ -228,8 +239,12 @@ function ValueObject:SetValue(value, ...)
 	local previous = rawget(self, "_value")
 	local checkType = rawget(self, "_checkType")
 
-	if checkType and typeof(value) ~= checkType then
-		error(string.format("Expected value of type %q, got %q instead", checkType, typeof(value)))
+	if type(checkType) == "string" then
+		if typeof(value) ~= checkType then
+			error(string.format("Expected value of type %q, got %q instead", checkType, typeof(value)))
+		end
+	elseif typeof(checkType) == "function" then
+		assert(checkType(value))
 	end
 
 	if previous ~= value then
@@ -240,8 +255,10 @@ function ValueObject:SetValue(value, ...)
 		end
 
 		rawset(self, "_value", value)
-
-		self.Changed:Fire(value, previous, ...)
+		local changed = rawget(self, "Changed")
+		if changed then
+			changed:Fire(value, previous, ...)
+		end
 	end
 end
 
@@ -251,10 +268,19 @@ end
 	@within ValueObject
 ]=]
 function ValueObject:__index(index)
-	if index == "Value" then
-		return self._value
-	elseif ValueObject[index] then
+	if ValueObject[index] then
 		return ValueObject[index]
+	elseif index == "Value" then
+		return self._value
+	elseif index == "Changed" then
+		-- Defer construction of Changed event until something needs it, since a lot
+		-- of times we don't need it
+
+		local signal = Signal.new() -- :Fire(newValue, oldValue, ...)
+
+		rawset(self, "Changed", signal)
+
+		return signal
 	elseif index == "LastEventContext" then
 		local args = rawget(self, "_lastEventContext")
 		if args then
@@ -287,7 +313,15 @@ end
 ]=]
 function ValueObject:Destroy()
 	rawset(self, "_value", nil)
-	self._maid:DoCleaning()
+
+	self:_cleanupLastMountedSub()
+
+	-- Avoid using a maid here because we make a LOT of ValueObjects
+	local changed = rawget(self, "Changed")
+	if changed then
+		changed:Destroy()
+	end
+
 	setmetatable(self, nil)
 end