@quenty/tie 10.8.0 → 10.10.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.
 
+# [10.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/tie@10.9.0...@quenty/tie@10.10.0) (2024-10-04)
+
+
+### Features
+
+* Use configuration instead of folder. While this forces a datamodel event to fire, it means we scan less classes on the client, and it's easier to see in the explorer ([06a342f](https://github.com/Quenty/NevermoreEngine/commit/06a342f5726282c46174ddec3dc7f54eeb768c46))
+* Use RxSignal for the TiePropertyInterface ([5ea04b8](https://github.com/Quenty/NevermoreEngine/commit/5ea04b85402e994f13a81a9b32e5971e1a262eb5))
+
+
+### Performance Improvements
+
+* TieImplementation uses Folder on client instead of camera, which results in a memory improvement ([bc55d76](https://github.com/Quenty/NevermoreEngine/commit/bc55d76fd296c8923e47c3830145c8e75d8a7b69))
+
+
+
+
+
+# [10.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/tie@10.8.0...@quenty/tie@10.9.0) (2024-09-25)
+
+**Note:** Version bump only for package @quenty/tie
+
+
+
+
+
 # [10.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/tie@10.7.0...@quenty/tie@10.8.0) (2024-09-25)
 
 **Note:** Version bump only for package @quenty/tie

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/tie",
-  "version": "10.8.0",
+  "version": "10.10.0",
   "description": "Tie allows interfaces to be defined between Lua OOP and Roblox objects.",
   "keywords": [
     "Roblox",
@@ -28,28 +28,29 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^14.6.0",
-    "@quenty/baseobject": "^10.5.0",
-    "@quenty/brio": "^14.6.0",
-    "@quenty/collectionserviceutils": "^8.6.0",
-    "@quenty/instanceutils": "^13.6.0",
-    "@quenty/loader": "^10.5.0",
-    "@quenty/maid": "^3.3.0",
-    "@quenty/rx": "^13.6.0",
-    "@quenty/statestack": "^14.7.0",
+    "@quenty/attributeutils": "^14.8.0",
+    "@quenty/baseobject": "^10.6.0",
+    "@quenty/brio": "^14.8.0",
+    "@quenty/collectionserviceutils": "^8.8.0",
+    "@quenty/instanceutils": "^13.8.0",
+    "@quenty/loader": "^10.6.0",
+    "@quenty/maid": "^3.4.0",
+    "@quenty/rx": "^13.8.0",
+    "@quenty/rxsignal": "^7.8.0",
+    "@quenty/statestack": "^14.9.0",
     "@quenty/string": "^3.3.0",
-    "@quenty/symbol": "^3.1.0",
+    "@quenty/symbol": "^3.2.0",
     "@quenty/table": "^3.5.0",
-    "@quenty/tuple": "^1.2.0",
-    "@quenty/valuebaseutils": "^13.6.0",
-    "@quenty/valueobject": "^13.6.0"
+    "@quenty/tuple": "^1.3.0",
+    "@quenty/valuebaseutils": "^13.8.0",
+    "@quenty/valueobject": "^13.8.0"
   },
   "devDependencies": {
-    "@quenty/promise": "^10.5.0",
-    "@quenty/signal": "^7.5.0"
+    "@quenty/promise": "^10.6.0",
+    "@quenty/signal": "^7.7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "41715b15e2b48b2d22ff4f5277a8d4b7a0d32ef3"
+  "gitHead": "035abfa088c854a73e1c65b350267eaa17669646"
 }

package/src/Shared/Members/Properties/TiePropertyInterface.lua

@@ -11,14 +11,13 @@ local Observable = require("Observable")
 local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
+local RxSignal = require("RxSignal")
 local String = require("String")
 local Symbol = require("Symbol")
-local TiePropertyChangedSignalConnection = require("TiePropertyChangedSignalConnection")
+local TieMemberInterface = require("TieMemberInterface")
 local TiePropertyImplementationUtils = require("TiePropertyImplementationUtils")
 local TieUtils = require("TieUtils")
 local ValueBaseUtils = require("ValueBaseUtils")
-local ValueObject = require("ValueObject")
-local TieMemberInterface = require("TieMemberInterface")
 
 local UNSET_VALUE = Symbol.named("unsetValue")
 
@@ -48,18 +47,22 @@ end
 function TiePropertyInterface:Observe()
 	return self:_observeValueBaseBrio():Pipe({
 		Rx.switchMap(function(brio)
-			if brio:IsDead() then
-				return Rx.of(nil)
-			end
-			local valueBase = brio:GetValue()
-			if not valueBase then
-				return Rx.of(nil)
-			end
-
 			return Observable.new(function(sub)
-				local maid = Maid.new()
+				if brio:IsDead() then
+					sub:Fire(nil)
+					sub:Complete()
+					return
+				end
+
+				local valueBase = brio:GetValue()
+				if not valueBase then
+					sub:Fire(nil)
+					sub:Complete()
+					return
+				end
+
+				local maid = brio:ToMaid()
 
-				sub:Fire(valueBase.Value)
 				maid:GiveTask(valueBase.Changed:Connect(function()
 					sub:Fire(valueBase.Value)
 				end))
@@ -70,6 +73,8 @@ function TiePropertyInterface:Observe()
 					end
 				end))
 
+				sub:Fire(valueBase.Value)
+
 				return maid
 			end)
 		end);
@@ -119,21 +124,9 @@ function TiePropertyInterface:_getFullName()
 end
 
 function TiePropertyInterface:_getChangedEvent()
-	return {
-		Connect = function(_, callback)
-			assert(type(callback) == "function", "Bad callback")
-			return TiePropertyChangedSignalConnection.new(function(connMaid)
-				local valueObject = connMaid:Add(ValueObject.new(nil)		)
-
-				connMaid:GiveTask(self:Observe():Subscribe(function(value)
-					valueObject.Value = value
-				end))
-
-				-- After observing, so we can emit only changes.
-				connMaid:GiveTask(valueObject.Changed:Connect(callback))
-			end)
-		end;
-	}
+	return RxSignal.new(self:Observe():Pipe({
+		Rx.skip(1)
+	}))
 end
 
 local IMPLEMENTATION_TYPES = {
@@ -196,29 +189,29 @@ function TiePropertyInterface:_observeFromImplParent(implParent)
 			end
 		end
 
-		-- Subscribe to named children
-		topMaid:GiveTask(RxInstanceUtils.observeChildrenOfNameBrio(implParent, "Instance", self._memberDefinition:GetMemberName())
-			:Subscribe(function(brio)
-				if brio:IsDead() then
-					return
-				end
-
-				local innerMaid = brio:ToMaid()
-				local child = brio:GetValue()
+		-- Subscribe to named children, assuming no name changes...
+		topMaid:GiveTask(RxInstanceUtils.observeChildrenBrio(implParent, function(value)
+			return value.Name == memberName
+		end):Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
 
-				innerMaid:GiveTask(function()
-					local index = table.find(validNamedChildren, child)
+			local innerMaid, child = brio:ToMaidAndValue()
 
-					if index then
-						table.remove(validNamedChildren, index)
-					end
+			innerMaid:GiveTask(function()
+				local index = table.find(validNamedChildren, child)
 
-					update()
-				end)
+				if index then
+					table.remove(validNamedChildren, index)
+				end
 
-				table.insert(validNamedChildren, child)
 				update()
-			end))
+			end)
+
+			table.insert(validNamedChildren, child)
+			update()
+		end))
 
 		topMaid:GiveTask(implParent:GetAttributeChangedSignal(memberName):Connect(update))
 		update()

package/src/Shared/TieDefinition.lua

@@ -89,6 +89,7 @@ function TieDefinition.new(definitionName, members)
 	local self = setmetatable({}, TieDefinition)
 
 	self._definitionName = assert(definitionName, "No definitionName")
+	self._validContainerNameSetWeakCache = setmetatable({}, {__mode = "kv"})
 	self._memberMap = {}
 	self._defaultTieRealm = TieRealms.SHARED
 
@@ -156,8 +157,41 @@ function TieDefinition:GetImplementations(adornee: Instance, tieRealm)
 	return implementations
 end
 
-function TieDefinition:GetImplClass()
-	return "Camera"
+function TieDefinition:GetNewImplClass(tieRealm)
+	assert(TieRealmUtils.isTieRealm(tieRealm), "Bad tieRealm")
+
+	if tieRealm == TieRealms.CLIENT then
+		return "Configuration"
+	else
+		return "Camera"
+	end
+end
+
+local IMPL_CLIENT_SET = table.freeze({
+	["Configuration"] = true;
+})
+
+local IMPL_SERVER_SET = table.freeze({
+	["Camera"] = true;
+})
+
+local IMPL_SHARED_SET = table.freeze({
+	["Camera"] = true;
+	["Configuration"] = true;
+})
+
+function TieDefinition:GetImplClassSet(tieRealm)
+
+	if tieRealm == TieRealms.CLIENT then
+		-- Shared implements both...
+		return IMPL_CLIENT_SET
+	elseif tieRealm == TieRealms.SERVER then
+		return IMPL_SERVER_SET
+	elseif tieRealm == TieRealms.SHARED then
+		return IMPL_SHARED_SET
+	else
+		error("Unknwon tieRealm")
+	end
 end
 
 function TieDefinition:GetImplementationParents(adornee, tieRealm)
@@ -464,10 +498,11 @@ function TieDefinition:ObserveValidContainerChildrenBrio(adornee, tieRealm)
 	assert(TieRealmUtils.isTieRealm(tieRealm), "Bad tieRealm")
 
 	local validContainerNameSet = self:GetValidContainerNameSet(tieRealm)
+	local validImplClassSet = self:GetImplClassSet(tieRealm)
 
 	return RxInstanceUtils.observeChildrenBrio(adornee, function(value)
 		-- Just assume our name doesn't change
-		return value:IsA(self:GetImplClass()) and validContainerNameSet[value.Name] and true or false
+		return validImplClassSet[value.ClassName] and validContainerNameSet[value.Name] and true or false
 	end)
 end
 
@@ -597,26 +632,34 @@ end
 ]=]
 function TieDefinition:GetValidContainerNameSet(tieRealm)
 	-- TODO: Still generate unique datamodel key here?
+	if self._validContainerNameSetWeakCache[tieRealm] then
+		return self._validContainerNameSetWeakCache[tieRealm]
+	end
 
 	if tieRealm == TieRealms.CLIENT then
 		-- Shared implements both...
-		return {
+		self._validContainerNameSetWeakCache[tieRealm] = table.freeze({
 			[self._definitionName .. "Client"] = true;
 			[self._definitionName .. "Shared"] = true;
-		}
+		})
+		return self._validContainerNameSetWeakCache[tieRealm]
 	elseif tieRealm == TieRealms.SERVER then
-		return {
+		self._validContainerNameSetWeakCache[tieRealm] = table.freeze({
 			[self._definitionName] = true;
 			[self._definitionName .. "Shared"] = true;
-		}
+		})
+		return self._validContainerNameSetWeakCache[tieRealm]
 	elseif tieRealm == TieRealms.SHARED then
 		-- Technically on the implementation shared is very strict,
 		-- but we allow any calls here for discovery
-		return {
+		self._validContainerNameSetWeakCache[tieRealm] = table.freeze({
 			[self._definitionName] = true;
 			[self._definitionName .. "Client"] = true;
 			[self._definitionName .. "Shared"] = true;
-		}
+		})
+		return self._validContainerNameSetWeakCache[tieRealm]
+	else
+		error("Unknwon tieRealm")
 	end
 end
 

package/src/Shared/TieImplementation.lua

@@ -27,7 +27,7 @@ function TieImplementation.new(tieDefinition, adornee, implementer, implementati
 	self._actualSelf = implementer or {}
 	self._implementationTieRealm = assert(implementationTieRealm, "Bad implementationTieRealm")
 
-	self._implParent = self._maid:Add(Instance.new(tieDefinition:GetImplClass()))
+	self._implParent = self._maid:Add(Instance.new(tieDefinition:GetNewImplClass(implementationTieRealm)))
 	self._implParent.Archivable = false
 
 	self._memberImplementations = {}

package/src/Shared/Members/Properties/TiePropertyChangedSignalConnection.lua

@@ -1,44 +0,0 @@
---[=[
-	@class TiePropertyChangedSignalConnection
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Maid = require("Maid")
-
-local TiePropertyChangedSignalConnection = {}
-TiePropertyChangedSignalConnection.ClassName = "TiePropertyChangedSignalConnection"
-TiePropertyChangedSignalConnection.__index = TiePropertyChangedSignalConnection
-
-function TiePropertyChangedSignalConnection.new(connect)
-	local self = setmetatable({}, TiePropertyChangedSignalConnection)
-
-	self._maid = Maid.new()
-
-	self._connected = true
-	connect(self._maid)
-
-	return self
-end
-
-function TiePropertyChangedSignalConnection:Disconnect()
-	self:Destroy()
-end
-
-function TiePropertyChangedSignalConnection:__index(index)
-	if index == "IsConnected" then
-		return self._connected
-	elseif TiePropertyChangedSignalConnection[index] then
-		return TiePropertyChangedSignalConnection[index]
-	else
-		error(string.format("Bad index %q for TiePropertyChangedSignalConnection", tostring(index)))
-	end
-end
-
-function TiePropertyChangedSignalConnection:Destroy()
-	self._connected = false
-	self._maid:DoCleaning()
-	-- Avoid setting the metatable so calling methods is always valid
-end
-
-return TiePropertyChangedSignalConnection