@quenty/settings 2.3.1 → 3.0.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@2.3.1...@quenty/settings@3.0.0) (2022-08-14)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
 ## [2.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@2.3.0...@quenty/settings@2.3.1) (2022-08-11)
 
 **Note:** Version bump only for package @quenty/settings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/settings",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -25,30 +25,31 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^6.2.0",
+    "@quenty/attributeutils": "^7.0.0",
     "@quenty/baseobject": "^5.1.0",
-    "@quenty/binder": "^6.3.0",
-    "@quenty/datastore": "^5.3.0",
+    "@quenty/binder": "^7.0.0",
+    "@quenty/datastore": "^6.0.0",
+    "@quenty/enumutils": "^2.0.0",
     "@quenty/jsonutils": "^5.1.0",
     "@quenty/loader": "^5.0.0",
     "@quenty/maid": "^2.4.0",
-    "@quenty/observablecollection": "^3.3.1",
-    "@quenty/playerbinder": "^6.3.0",
+    "@quenty/observablecollection": "^4.0.0",
+    "@quenty/playerbinder": "^7.0.0",
     "@quenty/remotefunctionutils": "^5.1.0",
     "@quenty/remoting": "^5.2.0",
-    "@quenty/rx": "^5.2.0",
-    "@quenty/rxbinderutils": "^6.3.0",
+    "@quenty/rx": "^6.0.0",
+    "@quenty/rxbinderutils": "^7.0.0",
     "@quenty/servicebag": "^5.1.0",
     "@quenty/signal": "^2.2.0",
-    "@quenty/statestack": "^6.2.0",
-    "@quenty/string": "^2.3.0",
+    "@quenty/statestack": "^7.0.0",
+    "@quenty/string": "^3.0.0",
     "@quenty/symbol": "^2.1.0",
     "@quenty/table": "^3.1.0",
     "@quenty/throttle": "^5.0.0",
-    "@quenty/valueobject": "^5.2.0"
+    "@quenty/valueobject": "^6.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "45ffe88b893e29690163a42c3830c983f6098a59"
+  "gitHead": "dbb62609f980983cc32da90acfef13e30ed41113"
 }

package/src/Client/SettingsServiceClient.lua

@@ -16,7 +16,7 @@ function SettingsServiceClient:Init(serviceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
 	-- Internal
-	self._serviceBag:GetService(require("SettingServiceBridge")):RegisterSettingService(self)
+	self._serviceBag:GetService(require("SettingRegistryServiceShared")):RegisterSettingService(self)
 	self._binders = self._serviceBag:GetService(require("SettingsBindersClient"))
 end
 

package/src/Server/Player/PlayerHasSettings.lua

@@ -40,7 +40,7 @@ function PlayerHasSettings:_promiseLoadSettings()
 				:Then(function(settings)
 					for settingName, value in pairs(settings) do
 						local attributeName = PlayerSettingsUtils.getAttributeName(settingName)
-						self._settings:SetAttribute(attributeName, value)
+						self._settings:SetAttribute(attributeName, PlayerSettingsUtils.encodeForAttribute(value))
 					end
 
 					self._maid:GiveTask(self._settings.AttributeChanged:Connect(function(attributeName)
@@ -64,7 +64,7 @@ function PlayerHasSettings:_handleAttributeChanged(subStore, attributeName)
 
 	-- Write the new value
 	local settingName = PlayerSettingsUtils.getSettingName(attributeName)
-	local newValue = self._settings:GetAttribute(attributeName)
+	local newValue = PlayerSettingsUtils.decodeForAttribute(self._settings:GetAttribute(attributeName))
 	subStore:Store(settingName, newValue)
 end
 

package/src/Server/Player/PlayerSettings.lua

@@ -7,7 +7,7 @@ local require = require(script.Parent.loader).load(script)
 local PlayerSettingsBase = require("PlayerSettingsBase")
 local PlayerSettingsConstants = require("PlayerSettingsConstants")
 local PlayerSettingsUtils = require("PlayerSettingsUtils")
-local SettingServiceBridge = require("SettingServiceBridge")
+local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
 
 local PlayerSettings = setmetatable({}, PlayerSettingsBase)
 PlayerSettings.ClassName = "PlayerSettings"
@@ -16,7 +16,8 @@ PlayerSettings.__index = PlayerSettings
 function PlayerSettings.new(obj, serviceBag)
 	local self = setmetatable(PlayerSettingsBase.new(obj, serviceBag), PlayerSettings)
 
-	self._bridge = self._serviceBag:GetService(SettingServiceBridge)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._settingRegistryServiceShared = self._serviceBag:GetService(SettingRegistryServiceShared)
 
 	self._remoteFunction = Instance.new("RemoteFunction")
 	self._remoteFunction.Name = PlayerSettingsConstants.REMOTE_FUNCTION_NAME
@@ -28,7 +29,7 @@ function PlayerSettings.new(obj, serviceBag)
 		return self:_handleServerInvoke(...)
 	end
 
-	self._maid:GiveTask(self._bridge:ObserveRegisteredDefinitionsBrio():Subscribe(function(brio)
+	self._maid:GiveTask(self._settingRegistryServiceShared:ObserveRegisteredDefinitionsBrio():Subscribe(function(brio)
 		if brio:IsDead() then
 			return
 		end
@@ -46,7 +47,7 @@ function PlayerSettings:EnsureInitialized(settingName, defaultValue)
 	local attributeName = PlayerSettingsUtils.getAttributeName(settingName)
 
 	if self._obj:GetAttribute(attributeName) == nil then
-		self._obj:SetAttribute(attributeName, defaultValue)
+		self._obj:SetAttribute(attributeName, PlayerSettingsUtils.encodeForAttribute(defaultValue))
 	end
 end
 
@@ -69,12 +70,12 @@ function PlayerSettings:_setSettings(settingsMap)
 		local attributeName = PlayerSettingsUtils.getAttributeName(settingName)
 
 		if self._obj:GetAttribute(attributeName) == nil then
-			warn("[PlayerSettings] - Cannot set setting on attribute that is not defined on the server")
+			warn(("[PlayerSettings] - Cannot set setting %q on attribute that is not defined on the server."):format(attributeName))
 			continue
 		end
 
 		local decoded = PlayerSettingsUtils.decodeForNetwork(value)
-		self._obj:SetAttribute(attributeName, decoded)
+		self._obj:SetAttribute(attributeName, PlayerSettingsUtils.encodeForAttribute(decoded))
 	end
 end
 

package/src/Server/SettingsService.lua

@@ -18,7 +18,7 @@ function SettingsService:Init(serviceBag)
 
 	-- Internal
 	self._binders = self._serviceBag:GetService(require("SettingsBindersServer"))
-	self._serviceBag:GetService(require("SettingServiceBridge")):RegisterSettingService(self)
+	self._serviceBag:GetService(require("SettingRegistryServiceShared")):RegisterSettingService(self)
 end
 
 function SettingsService:ObservePlayerSettingsBrio(player)

package/src/Shared/Player/PlayerSettingsBase.lua

@@ -8,6 +8,7 @@ local BaseObject = require("BaseObject")
 local PlayerSettingsUtils = require("PlayerSettingsUtils")
 local RxAttributeUtils = require("RxAttributeUtils")
 local SettingDefinition = require("SettingDefinition")
+local Rx = require("Rx")
 
 local PlayerSettingsBase = setmetatable({}, BaseObject)
 PlayerSettingsBase.ClassName = "PlayerSettingsBase"
@@ -45,13 +46,13 @@ end
 	@param defaultValue any
 	@return SettingProperty
 ]=]
-function PlayerSettingsBase:GetSetting(settingName, defaultValue)
+function PlayerSettingsBase:GetSettingProperty(settingName, defaultValue)
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(defaultValue ~= nil, "defaultValue cannot be nil")
 
 	self:EnsureInitialized(settingName, defaultValue)
 
-	return SettingDefinition.new(settingName, defaultValue):Get(self._serviceBag, self:GetPlayer())
+	return SettingDefinition.new(settingName, defaultValue):GetSettingProperty(self._serviceBag, self:GetPlayer())
 end
 
 --[=[
@@ -69,7 +70,7 @@ function PlayerSettingsBase:GetValue(settingName, defaultValue)
 
 	self:EnsureInitialized(settingName, defaultValue)
 
-	local value = self._obj:GetAttribute(attributeName)
+	local value = PlayerSettingsUtils.decodeForAttribute(self._obj:GetAttribute(attributeName))
 	if value == nil then
 		return defaultValue
 	end
@@ -89,7 +90,7 @@ function PlayerSettingsBase:SetValue(settingName, value)
 
 	local attributeName = PlayerSettingsUtils.getAttributeName(settingName)
 
-	self._obj:SetAttribute(attributeName, value)
+	self._obj:SetAttribute(attributeName, PlayerSettingsUtils.encodeForAttribute(value))
 end
 
 --[=[
@@ -108,6 +109,9 @@ function PlayerSettingsBase:ObserveValue(settingName, defaultValue)
 	self:EnsureInitialized(settingName, defaultValue)
 
 	return RxAttributeUtils.observeAttribute(self._obj, attributeName, defaultValue)
+		:Pipe({
+			Rx.map(PlayerSettingsUtils.decodeForAttribute)
+		})
 end
 
 function PlayerSettingsBase:RestoreDefault(settingName, defaultValue)

package/src/Shared/Player/PlayerSettingsUtils.lua

@@ -10,6 +10,7 @@ local RxBinderUtils = require("RxBinderUtils")
 local BinderUtils = require("BinderUtils")
 local Binder = require("Binder")
 local RxStateStackUtils = require("RxStateStackUtils")
+local EnumUtils = require("EnumUtils")
 
 local PlayerSettingsUtils = {}
 
@@ -68,6 +69,8 @@ function PlayerSettingsUtils.encodeForNetwork(settingValue)
 
 	if settingValue == nil then
 		return "<NIL_SETTING_VALUE>"
+	elseif typeof(settingValue) == "EnumItem" then
+		return EnumUtils.encodeAsString(settingValue)
 	else
 		return settingValue
 	end
@@ -76,6 +79,24 @@ end
 function PlayerSettingsUtils.decodeForNetwork(settingValue)
 	if settingValue == "<NIL_SETTING_VALUE>" then
 		return nil
+	elseif EnumUtils.isEncodedEnum(settingValue) then
+		return EnumUtils.decodeFromString(settingValue)
+	else
+		return settingValue
+	end
+end
+
+function PlayerSettingsUtils.decodeForAttribute(settingValue)
+	if EnumUtils.isEncodedEnum(settingValue) then
+		return EnumUtils.decodeFromString(settingValue)
+	else
+		return settingValue
+	end
+end
+
+function PlayerSettingsUtils.encodeForAttribute(settingValue)
+	if typeof(settingValue) == "EnumItem" then
+		return EnumUtils.encodeAsString(settingValue)
 	else
 		return settingValue
 	end

package/src/Shared/Setting/SettingDefinition.lua

@@ -7,11 +7,11 @@ local require = require(script.Parent.loader).load(script)
 local Players = game:GetService("Players")
 
 local SettingProperty = require("SettingProperty")
-local SettingServiceBridge = require("SettingServiceBridge")
 local ServiceBag = require("ServiceBag")
 
 local SettingDefinition = {}
 SettingDefinition.ClassName = "SettingDefinition"
+SettingDefinition.ServiceName = "SettingDefinition"
 SettingDefinition.__index = SettingDefinition
 
 --[=[
@@ -30,6 +30,8 @@ function SettingDefinition.new(settingName, defaultValue)
 	self._settingName = settingName
 	self._defaultValue = defaultValue
 
+	self.ServiceName = self._settingName
+
 	return self
 end
 
@@ -75,36 +77,4 @@ function SettingDefinition:GetDefaultValue()
 	return self._defaultValue
 end
 
---[=[
-	Optional registration to the service bag. If registered, ensures all existing
-	players and all new players get this setting defined. This may be necessary for
-	replication.
-
-	@param serviceBag ServiceBag
-]=]
-function SettingDefinition:Init(serviceBag)
-	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
-	-- not strictly necessary... but...
-
-	serviceBag:GetService(SettingServiceBridge):RegisterDefinition(self)
-end
-
---[=[
-	Optional registration to the service bag
-
-	@param serviceBag ServiceBag
-]=]
-function SettingDefinition:RegisterToService(serviceBag)
-	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
-
-	local settingServiceBridge = serviceBag:GetService(SettingServiceBridge)
-
-	if serviceBag:IsStarted() and not serviceBag:HasService(self) then
-		-- We've already started so let's ensure
-		settingServiceBridge:RegisterDefinition(self)
-	else
-		settingServiceBridge:RegisterDefinition(serviceBag:GetService(self))
-	end
-end
-
 return SettingDefinition

package/src/Shared/Setting/SettingDefinitionProvider.lua

@@ -4,10 +4,12 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local SettingServiceBridge = require("SettingServiceBridge")
+local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
+local Maid = require("Maid")
 
 local SettingDefinitionProvider = {}
 SettingDefinitionProvider.ClassName = "SettingDefinitionProvider"
+SettingDefinitionProvider.ServiceName = "SettingDefinitionProvider"
 SettingDefinitionProvider.__index = SettingDefinitionProvider
 
 function SettingDefinitionProvider.new(settingDefinitions)
@@ -26,11 +28,13 @@ end
 
 function SettingDefinitionProvider:Init(serviceBag)
 	assert(serviceBag, "No serviceBag")
+	assert(not self._maid, "Already initialized")
 
-	serviceBag:GetService(SettingServiceBridge)
+	self._maid = Maid.new()
 
+	local settingRegistryServiceShared = serviceBag:GetService(SettingRegistryServiceShared)
 	for _, settingDefinition in pairs(self._settingDefinitions) do
-		settingDefinition:RegisterToService(serviceBag)
+		self._maid:GiveTask(settingRegistryServiceShared:RegisterSettingDefinition(settingDefinition))
 	end
 end
 
@@ -45,7 +49,7 @@ end
 function SettingDefinitionProvider:__index(index)
 	if SettingDefinitionProvider[index] then
 		return SettingDefinitionProvider[index]
-	elseif index == "_lookup" or index == "_settingDefinitions" then
+	elseif index == "_lookup" or index == "_settingDefinitions" or index == "_maid" then
 		return rawget(self, index)
 	elseif type(index) == "string" then
 		local lookup = rawget(self, "_lookup")
@@ -64,4 +68,8 @@ function SettingDefinitionProvider:Get(settingName)
 	return self._lookup[settingName]
 end
 
+function SettingDefinitionProvider:Destroy()
+	self._maid:DoCleaning()
+end
+
 return SettingDefinitionProvider

package/src/Shared/Setting/SettingProperty.lua

@@ -4,7 +4,7 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local SettingServiceBridge = require("SettingServiceBridge")
+local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
 local Rx = require("Rx")
 
 local SettingProperty = {}
@@ -15,7 +15,7 @@ function SettingProperty.new(serviceBag, player, definition)
 	local self = setmetatable({}, SettingProperty)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
-	self._bridge = self._serviceBag:GetService(SettingServiceBridge)
+	self._bridge = self._serviceBag:GetService(SettingRegistryServiceShared)
 
 	self._player = assert(player, "No player")
 	self._definition = assert(definition, "No definition")

package/src/Shared/{SettingServiceBridge.lua → SettingRegistryServiceShared.lua}

@@ -1,5 +1,7 @@
 --[=[
-	@class SettingServiceBridge
+	Shared between client and server, letting us centralize definitions in one place.
+
+	@class SettingRegistryServiceShared
 ]=]
 
 local require = require(script.Parent.loader).load(script)
@@ -8,9 +10,9 @@ local ValueObject = require("ValueObject")
 local Rx = require("Rx")
 local ObservableSet = require("ObservableSet")
 
-local SettingServiceBridge = {}
+local SettingRegistryServiceShared = {}
 
-function SettingServiceBridge:Init(serviceBag)
+function SettingRegistryServiceShared:Init(serviceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
@@ -18,29 +20,29 @@ function SettingServiceBridge:Init(serviceBag)
 	self._settingDefinitions = ObservableSet.new()
 end
 
-function SettingServiceBridge:RegisterSettingService(settingService)
+function SettingRegistryServiceShared:RegisterSettingService(settingService)
 	self._settingService.Value = settingService
 end
 
-function SettingServiceBridge:RegisterDefinition(definition)
+function SettingRegistryServiceShared:RegisterSettingDefinition(definition)
 	assert(definition, "No definition")
 
 	return self._settingDefinitions:Add(definition)
 end
 
-function SettingServiceBridge:ObserveRegisteredDefinitionsBrio()
+function SettingRegistryServiceShared:ObserveRegisteredDefinitionsBrio()
 	return self._settingDefinitions:ObserveItemsBrio()
 end
 
-function SettingServiceBridge:GetSettingsService()
+function SettingRegistryServiceShared:GetSettingsService()
 	return self._settingService.Value
 end
 
-function SettingServiceBridge:ObserveSettingsService()
+function SettingRegistryServiceShared:ObserveSettingsService()
 	return self._settingService:Observe()
 end
 
-function SettingServiceBridge:ObservePlayerSettings(player)
+function SettingRegistryServiceShared:ObservePlayerSettings(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self:ObserveSettingsService():Pipe({
@@ -54,7 +56,7 @@ function SettingServiceBridge:ObservePlayerSettings(player)
 	})
 end
 
-function SettingServiceBridge:PromisePlayerSettings(player)
+function SettingRegistryServiceShared:PromisePlayerSettings(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return Rx.toPromise(self._settingService:Observe():Pipe({
@@ -67,7 +69,7 @@ function SettingServiceBridge:PromisePlayerSettings(player)
 		end)
 end
 
-function SettingServiceBridge:GetPlayerSettings(player)
+function SettingRegistryServiceShared:GetPlayerSettings(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	local settingService = self._settingService.Value
@@ -78,4 +80,4 @@ function SettingServiceBridge:GetPlayerSettings(player)
 	end
 end
 
-return SettingServiceBridge
+return SettingRegistryServiceShared

package/test/scripts/Server/ServerMain.server.lua

@@ -8,6 +8,7 @@ local packages = require(loader).bootstrapGame(ServerScriptService.settings)
 
 local serviceBag = require(packages.ServiceBag).new()
 serviceBag:GetService(packages.SettingsService)
+local bridge = serviceBag:GetService(packages.SettingsServiceBridge)
 
 local SettingDefinition = require(packages.SettingDefinition)
 
@@ -20,10 +21,10 @@ serviceBag:Start()
 
 
 local volumeDefinition = SettingDefinition.new("Volume", 1)
-volumeDefinition:RegisterToService(serviceBag)
+bridge:RegisterSettingDefinition(volumeDefinition)
 
 local rumbleDefinition = SettingDefinition.new("Rumble", true)
-rumbleDefinition:RegisterToService(serviceBag)
+bridge:RegisterSettingDefinition(rumbleDefinition)
 
 
 local function handlePlayer(player)