@quenty/datastore 3.6.0 → 4.0.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.
 
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@3.6.0...@quenty/datastore@4.0.0) (2022-03-06)
+
+
+### Features
+
+* Can add removing promises to datastore before save ([653bef8](https://github.com/Quenty/NevermoreEngine/commit/653bef8717e4470cf94340e67ff69eab1b7269f6))
+
+
+
+
+
 # [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@3.5.1...@quenty/datastore@3.6.0) (2022-01-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,10 +26,10 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.5.0",
-    "@quenty/loader": "^3.4.0",
+    "@quenty/baseobject": "^4.0.0",
+    "@quenty/loader": "^4.0.0",
     "@quenty/maid": "^2.1.0",
-    "@quenty/promise": "^3.6.0",
+    "@quenty/promise": "^4.0.0",
     "@quenty/signal": "^2.1.0",
     "@quenty/symbol": "^2.0.1",
     "@quenty/table": "^2.1.1"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
+  "gitHead": "dd428cab58282c975a4c082957dc8f58e3186905"
 }

package/src/Server/DataStore.lua

@@ -131,15 +131,24 @@ function DataStore:Save()
 		return Promise.rejected("Load not successful, not saving")
 	end
 
-	if not self:HasWritableData() then
-		-- Nothing to save, don't update anything
-		if DEBUG_WRITING then
-			print("[DataStore.Save] - Not saving, nothing staged")
-		end
-		return Promise.resolved(nil)
+	if DEBUG_WRITING then
+		print("[DataStore.Save] - Starting save routine")
 	end
 
-	return self:_saveData(self:GetNewWriter())
+	-- Avoid constructing promises for every callback down the datastore
+	-- upon save.
+	return (self:_promiseInvokeSavingCallbacks() or Promise.resolved())
+		:Then(function()
+			if not self:HasWritableData() then
+				-- Nothing to save, don't update anything
+				if DEBUG_WRITING then
+					print("[DataStore.Save] - Not saving, nothing staged")
+				end
+				return nil
+			else
+				return self:_saveData(self:GetNewWriter())
+			end
+		end)
 end
 
 --[=[

package/src/Server/Modules/DataStoreStage.lua

@@ -16,6 +16,7 @@ local DataStoreWriter = require("DataStoreWriter")
 local Promise = require("Promise")
 local Table = require("Table")
 local Signal = require("Signal")
+local PromiseUtils = require("PromiseUtils")
 
 local DataStoreStage = setmetatable({}, BaseObject)
 DataStoreStage.ClassName = "DataStoreStage"
@@ -35,12 +36,65 @@ function DataStoreStage.new(loadName, loadParent)
 	self._loadName = loadName
 	self._loadParent = loadParent
 
+	self._savingCallbacks = {} -- [func, ...]
 	self._takenKeys = {} -- [name] = true
 	self._stores = {} -- [name] = dataSubStore
 
 	return self
 end
 
+-- Also returns nil for speedyness
+function DataStoreStage:_promiseInvokeSavingCallbacks()
+	if not next(self._savingCallbacks) then
+		return nil
+	end
+
+	local removingPromises = {}
+	for _, func in pairs(self._savingCallbacks) do
+		local result = func()
+		if Promise.isPromise(result) then
+			table.insert(removingPromises, result)
+		end
+	end
+
+	for _, substore in pairs(self._stores) do
+		local promise = substore:_promiseInvokeSavingCallbacks()
+		if promise then
+			table.insert(removingPromises, promise)
+		end
+	end
+
+	return PromiseUtils.all(removingPromises)
+end
+
+--[=[
+	Adds a callback to be called before save. This may return a promise.
+	@param callback function -- May return a promise
+	@return function -- Call to remove
+]=]
+function DataStoreStage:AddSavingCallback(callback)
+	assert(type(callback) == "function", "Bad callback")
+
+	table.insert(self._savingCallbacks, callback)
+
+	return function()
+		self:RemoveSavingCallback(callback)
+	end
+end
+
+--[=[
+	Removes a saving callback from the data store stage
+	@param callback function
+]=]
+function DataStoreStage:RemoveSavingCallback(callback)
+	assert(type(callback) == "function", "Bad callback")
+
+	local index = table.find(self._savingCallbacks, callback)
+	if index then
+		table.remove(self._savingCallbacks, index)
+	end
+end
+
 --[=[
 	Gets an event that will fire off whenever something is stored at this level
 	@return Signal

package/src/Server/PlayerDataStoreManager.lua

@@ -15,6 +15,7 @@ local DataStore = require("DataStore")
 local PromiseUtils = require("PromiseUtils")
 local PendingPromiseTracker = require("PendingPromiseTracker")
 local Maid = require("Maid")
+local Promise = require("Promise")
 
 local PlayerDataStoreManager = setmetatable({}, BaseObject)
 PlayerDataStoreManager.ClassName = "PlayerDataStoreManager"
@@ -69,7 +70,7 @@ end
 
 --[=[
 	Adds a callback to be called before save on removal
-	@param callback function
+	@param callback function -- May return a promise
 ]=]
 function PlayerDataStoreManager:AddRemovingCallback(callback)
 	table.insert(self._removingCallbacks, callback)
@@ -142,14 +143,22 @@ function PlayerDataStoreManager:_removePlayerDataStore(player)
 
 	self._removing[player] = true
 
+	local removingPromises = {}
 	for _, func in pairs(self._removingCallbacks) do
-		func(player)
+		local result = func(player)
+		if Promise.isPromise(result) then
+			table.insert(removingPromises, result)
+		end
 	end
 
-	datastore:Save():Finally(function()
-		datastore:Destroy()
-		self._removing[player] = nil
-	end)
+	PromiseUtils.all(removingPromises)
+		:Then(function()
+			return datastore:Save()
+		end)
+		:Finally(function()
+			datastore:Destroy()
+			self._removing[player] = nil
+		end)
 
 	-- Prevent double removal or additional issues
 	self._datastores[player] = nil

package/src/Server/PlayerDataStoreService.lua

@@ -85,7 +85,7 @@ end
 
 --[=[
 	Adds a removing callback to the manager.
-	@param callback function
+	@param callback function -- May return a promise
 	@return Promise
 ]=]
 function PlayerDataStoreService:PromiseAddRemovingCallback(callback)