@quenty/datastore 13.19.0 → 13.19.1-canary.543.25d35f7.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.
 
+## [13.19.1-canary.543.25d35f7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.19.0...@quenty/datastore@13.19.1-canary.543.25d35f7.0) (2025-03-20)
+
+
+### Bug Fixes
+
+* Work around Roblox bug with OrderedDataStore never finishing ([25d35f7](https://github.com/Quenty/NevermoreEngine/commit/25d35f72be565caa6f020208bb00551cd4094af2))
+
+
+
+
+
 # [13.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.18.0...@quenty/datastore@13.19.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/datastore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "13.19.0",
+  "version": "13.19.1-canary.543.25d35f7.0",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,21 +26,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@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/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"
+    "@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": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "25d35f72be565caa6f020208bb00551cd4094af2"
 }

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