@quenty/aggregator 1.4.2 → 1.4.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.4.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/aggregator@1.4.2...@quenty/aggregator@1.4.3) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/aggregator
+
+
+
+
+
 ## [1.4.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/aggregator@1.4.0...@quenty/aggregator@1.4.2) (2025-04-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/aggregator",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "Aggregates async promise requests",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.2",
-    "@quenty/loader": "^10.8.2",
-    "@quenty/lrucache": "^1.6.2",
-    "@quenty/promise": "^10.10.3",
-    "@quenty/queue": "^2.3.2",
-    "@quenty/rx": "^13.17.2",
-    "@quenty/tuple": "^1.5.2"
+    "@quenty/baseobject": "^10.8.3",
+    "@quenty/loader": "^10.8.3",
+    "@quenty/lrucache": "^1.6.3",
+    "@quenty/promise": "^10.10.4",
+    "@quenty/queue": "^2.3.3",
+    "@quenty/rx": "^13.17.3",
+    "@quenty/tuple": "^1.5.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64def70499ec067077ee39f279936b620b217847"
+  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
 }

package/src/Shared/Aggregator.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Aggregates all requests into one big send request to deduplicate the request
 
@@ -15,6 +16,20 @@ local Aggregator = setmetatable({}, BaseObject)
 Aggregator.ClassName = "Aggregator"
 Aggregator.__index = Aggregator
 
+export type PromiseBulkQuery<T> = ({ number }) -> Promise.Promise<T>
+
+export type Aggregator<T> = typeof(setmetatable(
+	{} :: {
+		_debugName: string,
+		_promiseBatchQuery: ({ number }) -> Promise.Promise<T>,
+		_promisesLruCache: any,
+		_maxBatchSize: number,
+		_unsentCount: number,
+		_unsentPromises: { [number]: Promise.Promise<T> },
+	},
+	{} :: typeof({ __index = Aggregator })
+)) & BaseObject.BaseObject
+
 --[=[
 	Creates a new aggregator that aggregates promised results together
 
@@ -23,10 +38,10 @@ Aggregator.__index = Aggregator
 
 	@return Aggregator<T>
 ]=]
-function Aggregator.new(debugName: string, promiseBulkQuery)
+function Aggregator.new<T>(debugName: string, promiseBulkQuery: PromiseBulkQuery<T>): Aggregator<T>
 	assert(type(debugName) == "string", "Bad debugName")
 
-	local self = setmetatable(BaseObject.new(), Aggregator)
+	local self: Aggregator<T> = setmetatable(BaseObject.new() :: any, Aggregator)
 
 	self._debugName = debugName
 	self._promiseBatchQuery = assert(promiseBulkQuery, "No promiseBulkQuery")
@@ -44,7 +59,7 @@ end
 	Sets the max batch size
 	@param maxBatchSize number
 ]=]
-function Aggregator:SetMaxBatchSize(maxBatchSize: number)
+function Aggregator.SetMaxBatchSize<T>(self: Aggregator<T>, maxBatchSize: number)
 	assert(type(maxBatchSize) == "number", "Bad maxBatchSize")
 	assert(self._unsentCount == 0, "Cannot set while unsent values exist")
 
@@ -55,7 +70,7 @@ end
 	@param id number
 	@return Promise<T>
 ]=]
-function Aggregator:Promise(id: number)
+function Aggregator.Promise<T>(self: Aggregator<T>, id: number)
 	assert(type(id) == "number", "Bad id")
 
 	local found = self._promisesLruCache:get(id)
@@ -80,13 +95,13 @@ end
 	@param id number
 	@return Observable<T>
 ]=]
-function Aggregator:Observe(id: number)
+function Aggregator.Observe<T>(self: Aggregator<T>, id: number)
 	assert(type(id) == "number", "Bad id")
 
 	return Rx.fromPromise(self:Promise(id))
 end
 
-function Aggregator:_sendBatchedPromises(promiseMap)
+function Aggregator._sendBatchedPromises<T>(self: Aggregator<T>, promiseMap)
 	assert(promiseMap, "No promiseMap")
 
 	local idList = {}
@@ -102,8 +117,7 @@ function Aggregator:_sendBatchedPromises(promiseMap)
 
 	assert(#idList <= self._maxBatchSize, "Too many idList sent")
 
-	self._maid:GivePromise(self._promiseBatchQuery(idList))
-		:Then(function(result)
+	self._maid:GivePromise(self._promiseBatchQuery(idList)):Then(function(result)
 		assert(type(result) == "table", "Bad result")
 
 		for _, data in result do
@@ -119,16 +133,16 @@ function Aggregator:_sendBatchedPromises(promiseMap)
 		for id, promise in unresolvedMap do
 			promise:Reject(string.format("[Aggregator] %s failed to get result for id %d", self._debugName, id))
 		end
-		end, function(err, ...)
+	end, function(err, ...)
 		local text = string.format("[Aggregator] %s failed to get bulk result - %q", self._debugName, tostring(err))
 
-			for _, item in unresolvedMap do
-				item:Reject(text, ...)
-			end
-		end)
+		for _, item in unresolvedMap do
+			item:Reject(text, ...)
+		end
+	end)
 end
 
-function Aggregator:_resetQueue()
+function Aggregator._resetQueue<T>(self: Aggregator<T>)
 	local promiseMap = self._unsentPromises
 
 	self._maid._queue = nil
@@ -138,7 +152,7 @@ function Aggregator:_resetQueue()
 	return promiseMap
 end
 
-function Aggregator:_queueBatchRequests()
+function Aggregator._queueBatchRequests<T>(self: Aggregator<T>)
 	if self._unsentCount >= self._maxBatchSize then
 		self:_sendBatchedPromises(self:_resetQueue())
 		return

package/src/Shared/RateAggregator.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RateAggregator
 ]=]
@@ -9,19 +10,40 @@ local Queue = require("Queue")
 local Promise = require("Promise")
 local TupleLookup = require("TupleLookup")
 local LRUCache = require("LRUCache")
+local _Tuple = require("Tuple")
 
 local RateAggregator = setmetatable({}, BaseObject)
 RateAggregator.ClassName = "RateAggregator"
 RateAggregator.__index = RateAggregator
 
-function RateAggregator.new(promiseQuery)
-	local self = setmetatable(BaseObject.new(), RateAggregator)
+export type QueueEntry<TArgs..., T...> = {
+	promise: Promise.Promise<T...>,
+	tuple: _Tuple.Tuple<TArgs...>,
+}
+
+export type RateAggregator<TArgs..., T...> = typeof(setmetatable(
+	{} :: {
+		_promiseQuery: (TArgs...) -> Promise.Promise<T...>,
+		_maxRequestsPerSecond: number,
+		_minWaitTime: number,
+		_bankedWaitTime: number,
+		_lastQueryTime: number,
+		_queueRunning: boolean,
+		_queue: Queue.Queue<QueueEntry<(TArgs...), (T...)>>,
+		_tupleLookup: TupleLookup.TupleLookup,
+		_promisesLruCache: any,
+	},
+	{} :: typeof({ __index = RateAggregator })
+)) & BaseObject.BaseObject
+
+function RateAggregator.new<TArgs..., T...>(promiseQuery: (TArgs...) -> Promise.Promise<T...>): RateAggregator<TArgs..., T...>
+	local self: RateAggregator<TArgs..., T...> = setmetatable(BaseObject.new() :: any, RateAggregator)
 
 	self._promiseQuery = promiseQuery
 
 	-- Configuration
 	self._maxRequestsPerSecond = 50
-	self._minWaitTime = 1/60
+	self._minWaitTime = 1 / 60
 
 	-- State tracking
 	self._bankedWaitTime = 0
@@ -35,7 +57,7 @@ function RateAggregator.new(promiseQuery)
 	return self
 end
 
-function RateAggregator:SetMaxRequestsPerSecond(maxRequestPerSecond)
+function RateAggregator.SetMaxRequestsPerSecond<TArgs..., T...>(self: RateAggregator<TArgs..., T...>, maxRequestPerSecond: number)
 	self._maxRequestsPerSecond = maxRequestPerSecond
 end
 
@@ -45,7 +67,7 @@ end
 	@param ... any
 	@return Observable<T>
 ]=]
-function RateAggregator:Promise(...)
+function RateAggregator.Promise<TArgs..., T...>(self: RateAggregator<TArgs..., T...>, ...: T...): Promise.Promise<T...>
 	local promise = self._maid:GivePromise(Promise.new())
 
 	local tuple = self._tupleLookup:ToTuple(...)
@@ -55,8 +77,8 @@ function RateAggregator:Promise(...)
 	end
 
 	self._queue:PushRight({
-		tuple = tuple;
-		promise = promise;
+		tuple = tuple,
+		promise = promise,
 	})
 
 	self._promisesLruCache:set(tuple, promise)
@@ -66,7 +88,7 @@ function RateAggregator:Promise(...)
 	return promise
 end
 
-function RateAggregator:_startQueue()
+function RateAggregator._startQueue<TArgs..., T...>(self: RateAggregator<TArgs..., T...>)
 	if self._queueRunning then
 		return
 	end