@quenty/datastore 13.19.1-canary.542.7609692.0 → 13.19.1

package/CHANGELOG.md

@@ -3,9 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [13.19.1-canary.542.7609692.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.19.0...@quenty/datastore@13.19.1-canary.542.7609692.0) (2025-03-13)
+## [13.19.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.19.0...@quenty/datastore@13.19.1) (2025-03-20)
 
-**Note:** Version bump only for package @quenty/datastore
+
+### Bug Fixes
+
+* Work around Roblox bug with OrderedDataStore never finishing ([#543](https://github.com/Quenty/NevermoreEngine/issues/543)) ([59b3c10](https://github.com/Quenty/NevermoreEngine/commit/59b3c10d7a20d0039a8dcaa5dfe288a3fcde6fa1))
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "13.19.1-canary.542.7609692.0",
+  "version": "13.19.1",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,21 +26,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "10.8.0",
-    "@quenty/bindtocloseservice": "8.16.1-canary.542.7609692.0",
-    "@quenty/loader": "10.8.0",
-    "@quenty/maid": "3.4.0",
-    "@quenty/math": "2.7.1-canary.542.7609692.0",
-    "@quenty/promise": "10.10.1-canary.542.7609692.0",
-    "@quenty/rx": "13.16.1-canary.542.7609692.0",
-    "@quenty/servicebag": "11.11.1-canary.542.7609692.0",
-    "@quenty/signal": "7.10.0",
-    "@quenty/symbol": "3.4.0",
-    "@quenty/table": "3.7.1-canary.542.7609692.0",
-    "@quenty/valueobject": "13.16.1-canary.542.7609692.0"
+    "@quenty/baseobject": "^10.8.0",
+    "@quenty/bindtocloseservice": "^8.16.0",
+    "@quenty/loader": "^10.8.0",
+    "@quenty/maid": "^3.4.0",
+    "@quenty/math": "^2.7.0",
+    "@quenty/pagesutils": "^5.11.0",
+    "@quenty/promise": "^10.10.0",
+    "@quenty/rx": "^13.16.0",
+    "@quenty/servicebag": "^11.11.0",
+    "@quenty/signal": "^7.10.0",
+    "@quenty/symbol": "^3.4.0",
+    "@quenty/table": "^3.7.0",
+    "@quenty/valueobject": "^13.16.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "76096921c6c965e5c4f9c796f97642d16d628c6b"
+  "gitHead": "67863b6715e6da8dc1477d07f1ec048c76717bce"
 }

package/src/Server/PlayerDataStoreService.lua

@@ -79,10 +79,11 @@ end
 	@param player Player
 	@return Promise<DataStore>
 ]=]
-function PlayerDataStoreService:PromiseDataStore(player: Player)
-	return self:PromiseManager():Then(function(manager)
-		return manager:GetDataStore(player)
-	end)
+function PlayerDataStoreService:PromiseDataStore(player)
+	return self:PromiseManager()
+		:Then(function(manager)
+			return manager:GetDataStore(player)
+		end)
 end
 
 --[=[
@@ -91,9 +92,10 @@ end
 	@return Promise
 ]=]
 function PlayerDataStoreService:PromiseAddRemovingCallback(callback)
-	return self:PromiseManager():Then(function(manager)
-		manager:AddRemovingCallback(callback)
-	end)
+	return self:PromiseManager()
+		:Then(function(manager)
+			manager:AddRemovingCallback(callback)
+		end)
 end
 
 --[=[
@@ -110,9 +112,12 @@ function PlayerDataStoreService:PromiseManager()
 			return DataStorePromises.promiseDataStore(self._dataStoreName, self._dataStoreScope)
 		end)
 		:Then(function(dataStore)
-			local manager = self._maid:Add(PlayerDataStoreManager.new(dataStore, function(player)
-				return tostring(player.UserId)
-			end, true))
+			local manager = self._maid:Add(PlayerDataStoreManager.new(
+				dataStore,
+				function(player)
+					return tostring(player.UserId)
+				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()
@@ -129,4 +134,4 @@ function PlayerDataStoreService:Destroy()
 	self._maid:DoCleaning()
 end
 
-return PlayerDataStoreService
+return PlayerDataStoreService

package/src/Server/Utility/DataStorePromises.lua

@@ -6,9 +6,12 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Promise = require("Promise")
 local DataStoreService = game:GetService("DataStoreService")
 
+local Promise = require("Promise")
+local PagesUtils = require("PagesUtils")
+local Table = require("Table")
+
 local DataStorePromises = {}
 
 --[=[
@@ -209,12 +212,33 @@ function DataStorePromises.promiseSortedPagesAsync(orderedDataStore, ascending,
 	end)
 end
 
+
 --[=[
 	@interface OrderedDataStoreEntry
 	.key any
 	.value any
 	@within DataStorePromises
 ]=]
+export type OrderedDataStoreEntry = {
+	key: string,
+	value: any,
+}
+
+local function toMap(data: { OrderedDataStoreEntry })
+	local keys = {}
+	for _, item in data do
+		keys[item.key] = item.value
+	end
+	return keys
+end
+
+local function areEquivalentPageData(data: { OrderedDataStoreEntry }, otherData: { OrderedDataStoreEntry }): boolean
+	local map = toMap(data)
+	local otherMap = toMap(otherData)
+
+	return Table.deepEquivalent(map, otherMap)
+end
+
 
 --[=[
 	Returns a DataStorePages object. The sort order is determined by ascending,
@@ -237,37 +261,41 @@ function DataStorePromises.promiseOrderedEntries(orderedDataStore, ascending, pa
 	return DataStorePromises.promiseSortedPagesAsync(orderedDataStore, ascending, pagesize, minValue, maxValue)
 		:Then(function(dataStorePages)
 			return Promise.spawn(function(resolve, reject)
-				local results = {}
-				local index = 0
-
-				while index < entries do
-					local initialIndex = index
+				local resultList = {}
 
-					for _, dataStoreEntry in pairs(dataStorePages:GetCurrentPage()) do
-						table.insert(results, dataStoreEntry)
-						index = index + 1
-						if index >= entries then
+				local pageData = dataStorePages:GetCurrentPage()
+				while pageData do
+					for _, data in pairs(pageData) do
+						if #resultList < entries then
+							table.insert(resultList, data)
+						else
 							break
 						end
 					end
 
-					-- Increment to next page if we need to/can
-					if initialIndex == index then
-						break -- no change
-					elseif dataStorePages.IsFinished then
-						break -- nothing more to pull
-					elseif index < entries then
-						-- try to pull
-						local ok, err = pcall(function()
-							dataStorePages:AdvanceToNextPageAsync()
-						end)
+					local lastPageData = pageData
+					pageData = nil
+
+					if #resultList >= entries then
+						break
+					end
+
+					if not dataStorePages.IsFinished then
+						local ok, err = PagesUtils.promiseAdvanceToNextPage(dataStorePages):Yield()
 						if not ok then
-							return reject(err)
+							return reject(string.format("Failed to advance to next page due to %s", tostring(err)))
 						end
+
+						pageData = err
+					end
+
+					-- https://devforum.roblox.com/t/ordereddatastore-pages-object-is-never-isfinished-resulting-in-finite-loops-when-n-0/3558372
+					if pageData and areEquivalentPageData(lastPageData, pageData) then
+						break
 					end
 				end
 
-				return resolve(results)
+				return resolve(resultList)
 			end)
 		end)
 end