@quenty/datastore 6.0.1 → 6.2.0-canary.4096cd9.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.2.0-canary.4096cd9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@6.1.0...@quenty/datastore@6.2.0-canary.4096cd9.0) (2022-09-08)
+
+
+### Features
+
+* Add BindToCloseService package and implement across places binding to close ([afdd829](https://github.com/Quenty/NevermoreEngine/commit/afdd829538c9d0ce2d6f51ad9fee9063f0f5bd24))
+
+
+
+
+
+# [6.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@6.0.1...@quenty/datastore@6.1.0) (2022-08-22)
+
+**Note:** Version bump only for package @quenty/datastore
+
+
+
+
+
 ## [6.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@6.0.0...@quenty/datastore@6.0.1) (2022-08-16)
 
 **Note:** Version bump only for package @quenty/datastore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "6.0.1",
+  "version": "6.2.0-canary.4096cd9.0",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,16 +26,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^5.1.1",
-    "@quenty/loader": "^5.0.1",
-    "@quenty/maid": "^2.4.0",
-    "@quenty/promise": "^5.1.1",
-    "@quenty/signal": "^2.2.0",
-    "@quenty/symbol": "^2.1.0",
-    "@quenty/table": "^3.1.0"
+    "@quenty/baseobject": "5.1.1",
+    "@quenty/bindtocloseservice": "1.1.0-canary.4096cd9.0",
+    "@quenty/loader": "5.0.1",
+    "@quenty/maid": "2.4.0",
+    "@quenty/promise": "5.2.0-canary.4096cd9.0",
+    "@quenty/signal": "2.3.0",
+    "@quenty/symbol": "2.1.0",
+    "@quenty/table": "3.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "340ac324c03fb3b844bbbe7ca57ee88874a724c9"
+  "gitHead": "4096cd94d2c38d382b7aafe8cb2fcb8bb340d051"
 }

package/src/Server/GameDataStoreService.lua

@@ -7,8 +7,6 @@
 
 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")
@@ -20,30 +18,9 @@ function GameDataStoreService:Init(serviceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
-	self._maid = Maid.new()
-end
+	self._bindToCloseService = self._serviceBag:GetService(require("BindToCloseService"))
 
---[=[
-	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)
+	self._maid = Maid.new()
 end
 
 function GameDataStoreService:PromiseDataStore()
@@ -54,7 +31,11 @@ function GameDataStoreService:PromiseDataStore()
 	self._dataStorePromise = self:_promiseRobloxDataStore()
 		:Then(function(robloxDataStore)
 			local dataStore = DataStore.new(robloxDataStore, self:_getKey())
-			self._maid._datastore = dataStore
+			self._maid:GiveTask(dataStore)
+
+			self._maid:GiveTask(self._bindToCloseService:RegisterPromiseOnCloseCallback(function()
+				return dataStore:Save()
+			end))
 
 			return dataStore
 		end)

package/src/Server/PlayerDataStoreManager.lua

@@ -1,5 +1,6 @@
 --[=[
-	DataStore manager for player that automatically saves on player leave and game close.
+	DataStore manager for player that automatically saves on player leave and game close. Consider using
+	[PlayerDataStoreService] instead.
 
 	@server
 	@class PlayerDataStoreManager
@@ -23,13 +24,17 @@ PlayerDataStoreManager.__index = PlayerDataStoreManager
 
 --[=[
 	Constructs a new PlayerDataStoreManager.
+
 	@param robloxDataStore DataStore
 	@param keyGenerator (player) -> string -- Function that takes in a player, and outputs a key
+	@param skipBindingToClose boolean?
 	@return PlayerDataStoreManager
 ]=]
-function PlayerDataStoreManager.new(robloxDataStore, keyGenerator)
+function PlayerDataStoreManager.new(robloxDataStore, keyGenerator, skipBindingToClose)
 	local self = setmetatable(BaseObject.new(), PlayerDataStoreManager)
 
+	assert(type(skipBindingToClose) == "boolean" or skipBindingToClose == nil, "Bad skipBindingToClose")
+
 	self._robloxDataStore = robloxDataStore or error("No robloxDataStore")
 	self._keyGenerator = keyGenerator or error("No keyGenerator")
 
@@ -48,13 +53,15 @@ function PlayerDataStoreManager.new(robloxDataStore, keyGenerator)
 		self:_removePlayerDataStore(player)
 	end))
 
-	game:BindToClose(function()
-		if self._disableSavingInStudio then
-			return
-		end
+	if skipBindingToClose ~= true then
+		game:BindToClose(function()
+			if self._disableSavingInStudio then
+				return
+			end
 
-		self:PromiseAllSaves():Wait()
-	end)
+			self:PromiseAllSaves():Wait()
+		end)
+	end
 
 	return self
 end

package/src/Server/PlayerDataStoreService.lua

@@ -24,6 +24,9 @@ function PlayerDataStoreService:Init(serviceBag)
 
 	self._maid = Maid.new()
 
+	-- External
+	self._bindToCloseService = self._serviceBag:GetService(require("BindToCloseService"))
+
 	self._started = Promise.new()
 	self._maid:GiveTask(self._started)
 
@@ -115,7 +118,14 @@ function PlayerDataStoreService:PromiseManager()
 				dataStore,
 				function(player)
 					return tostring(player.UserId)
-				end)
+				end,
+				true)
+
+			-- A lot safer if we're hot reloading or need to monitor bind to close calls
+			self._maid:GiveTask(self._bindToCloseService:RegisterPromiseOnCloseCallback(function()
+				return manager:PromiseAllSaves()
+			end))
+
 			self._maid:GiveTask(manager)
 			return manager
 		end)