@quenty/datastore 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@5.2.0...@quenty/datastore@5.3.0) (2022-07-31)
+
+
+### Bug Fixes
+
+* Add DataStore SetCacheTime (not implemented yet) ([906e723](https://github.com/Quenty/NevermoreEngine/commit/906e72397075200e8cb8b98bc8b7b7f96d992907))
+
+
+### Features
+
+* Add GameDataStoreService service for global game data ([5f6d52c](https://github.com/Quenty/NevermoreEngine/commit/5f6d52ca9f2be811c426714cd6d94d9794f366b5))
+* Support StoreOnValueChange with non ValueBase instances. ([ab45498](https://github.com/Quenty/NevermoreEngine/commit/ab4549833f41f2b3d8b43202965fd3202b649770))
+
+
+
+
+
 # [5.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@5.1.0...@quenty/datastore@5.2.0) (2022-07-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,10 +26,10 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^5.0.0",
+    "@quenty/baseobject": "^5.1.0",
     "@quenty/loader": "^5.0.0",
-    "@quenty/maid": "^2.3.0",
-    "@quenty/promise": "^5.0.0",
+    "@quenty/maid": "^2.4.0",
+    "@quenty/promise": "^5.1.0",
     "@quenty/signal": "^2.2.0",
     "@quenty/symbol": "^2.1.0",
     "@quenty/table": "^3.1.0"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "de33c83e7f897e2b0887c77aeb1fc7963756f234"
+  "gitHead": "e31b3a35aa475bb5699a24898a8639e107165b36"
 }

package/src/Server/DataStore.lua

@@ -38,6 +38,7 @@ local DEBUG_WRITING = false
 local AUTO_SAVE_TIME = 60*5
 local CHECK_DIVISION = 15
 local JITTER = 20 -- Randomly assign jitter so if a ton of players join at once we don't hit the datastore at once
+local DEFAULT_CACHE_TIME_SECONDS = math.huge
 
 local DataStore = setmetatable({}, DataStoreStage)
 DataStore.ClassName = "DataStore"
@@ -53,6 +54,7 @@ function DataStore.new(robloxDataStore, key)
 
 	self._key = key or error("No key")
 	self._robloxDataStore = robloxDataStore or error("No robloxDataStore")
+	self._cacheTimeSeconds = DEFAULT_CACHE_TIME_SECONDS
 
 --[=[
 	Prop that fires when saving. Promise will resolve once saving is complete.
@@ -89,6 +91,16 @@ function DataStore.new(robloxDataStore, key)
 	return self
 end
 
+--[=[
+	Sets how long the datastore will cache for
+	@param cacheTimeSeconds number?
+]=]
+function DataStore:SetCacheTime(cacheTimeSeconds)
+	assert(type(cacheTimeSeconds) == "number" or cacheTimeSeconds == nil, "Bad cacheTimeSeconds")
+
+	self._cacheTimeSeconds = cacheTimeSeconds or DEFAULT_CACHE_TIME_SECONDS
+end
+
 --[=[
 	Returns the full path for the datastore
 	@return string

package/src/Server/GameDataStoreService.lua

@@ -0,0 +1,82 @@
+--[=[
+	Service which manages central access to datastore. This datastore will refresh pretty frequently and
+	can be used for configuration and other components, such as Twitter codes or global settings.
+
+	@class GameDataStoreService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService = game:GetService("RunService")
+
+local DataStore = require("DataStore")
+local DataStorePromises = require("DataStorePromises")
+local Maid = require("Maid")
+
+local GameDataStoreService = {}
+
+function GameDataStoreService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._maid = Maid.new()
+end
+
+--[=[
+	For if you want to disable saving in studio for faster close time!
+]=]
+function GameDataStoreService:DisableSaveOnCloseStudio()
+	assert(RunService:IsStudio())
+
+	self._disableSavingInStudio = true
+end
+
+function GameDataStoreService:Start()
+	game:BindToClose(function()
+		if self._disableSavingInStudio then
+			return
+		end
+
+		return self:PromiseDataStore()
+			:Then(function(dataStore)
+				return dataStore:Save()
+			end)
+			:Wait()
+	end)
+end
+
+function GameDataStoreService:PromiseDataStore()
+	if self._dataStorePromise then
+		return self._dataStorePromise
+	end
+
+	self._dataStorePromise = self:_promiseRobloxDataStore()
+		:Then(function(robloxDataStore)
+			local dataStore = DataStore.new(robloxDataStore, self:_getKey())
+			self._maid._datastore = dataStore
+
+			return dataStore
+		end)
+
+	return self._dataStorePromise
+end
+
+function GameDataStoreService:_promiseRobloxDataStore()
+	if self._robloxDataStorePromise then
+		return self._robloxDataStorePromise
+	end
+
+	self._robloxDataStorePromise = self._maid:GivePromise(DataStorePromises.promiseDataStore("GameDataStore", "Version1"))
+
+	return self._robloxDataStorePromise
+end
+
+function GameDataStoreService:_getKey()
+	return "version1"
+end
+
+function GameDataStoreService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return GameDataStoreService

package/src/Server/Modules/DataStoreStage.lua

@@ -245,7 +245,7 @@ end
 ]=]
 function DataStoreStage:StoreOnValueChange(name, valueObj)
 	assert(type(name) == "string", "Bad name")
-	assert(typeof(valueObj) == "Instance", "Bad valueObj")
+	assert(typeof(valueObj) == "Instance" or (type(valueObj) == "table" and valueObj.Changed), "Bad valueObj")
 
 	if self._takenKeys[name] then
 		error(("[DataStoreStage] - Already have a writer for %q"):format(name))