@quenty/userserviceutils 3.11.0 → 3.11.1-canary.417.052e8ba.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.
 
+## [3.11.1-canary.417.052e8ba.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.11.0...@quenty/userserviceutils@3.11.1-canary.417.052e8ba.0) (2023-10-11)
+
+
+### Bug Fixes
+
+* User information de-duplication occurs ([bcb5c2a](https://github.com/Quenty/NevermoreEngine/commit/bcb5c2a062fa775e6c0949f2f56f7026456f849a))
+
+
+
+
+
 # [3.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.10.0...@quenty/userserviceutils@3.11.0) (2023-09-21)
 
 **Note:** Version bump only for package @quenty/userserviceutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/userserviceutils",
-  "version": "3.11.0",
+  "version": "3.11.1-canary.417.052e8ba.0",
   "description": "Utilities involving UserService in Roblox",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^6.3.0",
-    "@quenty/loader": "^6.3.0",
-    "@quenty/maid": "^2.6.0",
-    "@quenty/math": "^2.5.0",
-    "@quenty/promise": "^6.8.0",
-    "@quenty/rx": "^7.16.0",
-    "@quenty/servicebag": "^6.9.0"
+    "@quenty/baseobject": "6.3.1-canary.417.052e8ba.0",
+    "@quenty/loader": "6.3.1-canary.417.052e8ba.0",
+    "@quenty/maid": "2.6.0",
+    "@quenty/math": "2.5.0",
+    "@quenty/promise": "6.8.1-canary.417.052e8ba.0",
+    "@quenty/rx": "7.16.1-canary.417.052e8ba.0",
+    "@quenty/servicebag": "6.9.1-canary.417.052e8ba.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fd634d0ed1918fc14bae8501aff1cc099d0537e7"
+  "gitHead": "052e8ba33437f71398c4c08c8dbcbf076022d388"
 }

package/src/Client/UserInfoServiceClient.lua

@@ -46,6 +46,18 @@ function UserInfoServiceClient:PromiseDisplayName(userId)
 	return self._aggregator:PromiseDisplayName(userId)
 end
 
+--[=[
+	Observes the user info for the user
+
+	@param userId number
+	@return Observable<UserInfo>
+]=]
+function UserInfoServiceClient:ObserveUserInfo(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self._aggregator:ObserveDisplayName(userId)
+end
+
 --[=[
 	Observes the user display name for the userId
 

package/src/Server/UserInfoService.lua

@@ -34,6 +34,18 @@ function UserInfoService:PromiseUserInfo(userId)
 	return self._aggregator:PromiseUserInfo(userId)
 end
 
+--[=[
+	Observes the user info for the user
+
+	@param userId number
+	@return Observable<UserInfo>
+]=]
+function UserInfoService:ObserveUserInfo(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self._aggregator:ObserveDisplayName(userId)
+end
+
 --[=[
 	Promises the user display name for the userId
 

package/src/Shared/UserInfoAggregator.lua

@@ -1,5 +1,5 @@
 --[=[
-	Aggregates all requests into one big send request
+	Aggregates all requests into one big send request to deduplicate the request
 
 	@class UserInfoAggregator
 ]=]
@@ -11,6 +11,8 @@ local Promise = require("Promise")
 local UserServiceUtils = require("UserServiceUtils")
 local Rx = require("Rx")
 
+local MAX_USER_IDS_PER_REQUEST = 200
+
 local UserInfoAggregator = setmetatable({}, BaseObject)
 UserInfoAggregator.ClassName = "UserInfoAggregator"
 UserInfoAggregator.__index = UserInfoAggregator
@@ -20,6 +22,8 @@ function UserInfoAggregator.new()
 
 	-- TODO: LRU cache this? Limit to 1k or something?
 	self._promises = {}
+
+	self._unsentCount = 0
 	self._unsentPromises = {}
 
 	return self
@@ -42,6 +46,7 @@ function UserInfoAggregator:PromiseUserInfo(userId)
 	local promise = Promise.new()
 
 	self._unsentPromises[userId] = promise
+	self._unsentCount = self._unsentCount + 1
 	self._promises[userId] = promise
 
 	self:_queueAggregatedPromises()
@@ -64,6 +69,48 @@ function UserInfoAggregator:PromiseDisplayName(userId)
 		end)
 end
 
+--[=[
+	Promises the user display name for the userId
+
+	@param userId number
+	@return Promise<string>
+]=]
+function UserInfoAggregator:PromiseDisplayName(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self:PromiseUserInfo(userId)
+		:Then(function(userInfo)
+			return userInfo.DisplayName
+		end)
+end
+
+--[=[
+	Promises the user display name for the userId
+
+	@param userId number
+	@return Promise<boolean>
+]=]
+function UserInfoAggregator:PromiseHasVerifiedBadge(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self:PromiseUserInfo(userId)
+		:Then(function(userInfo)
+			return userInfo.HasVerifiedBadge
+		end)
+end
+
+--[=[
+	Observes the user display name for the userId
+
+	@param userId number
+	@return Observable<UserInfo>
+]=]
+function UserInfoAggregator:ObserveUserInfo(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return Rx.fromPromise(self:PromiseUserInfo(userId))
+end
+
 --[=[
 	Observes the user display name for the userId
 
@@ -73,12 +120,15 @@ end
 function UserInfoAggregator:ObserveDisplayName(userId)
 	assert(type(userId) == "number", "Bad userId")
 
-	return Rx.fromPromise(self:PromiseUserInfo(userId))
+	return self:ObserveUserInfo():Pipe({
+		Rx.map(function(userInfo)
+			return userInfo.DisplayName
+		end)
+	})
 end
 
-function UserInfoAggregator:_sendAggregatedPromises()
-	local promiseMap = self._unsentPromises
-	self._unsentPromises = {}
+function UserInfoAggregator:_sendAggregatedPromises(promiseMap)
+	assert(promiseMap, "No promiseMap")
 
 	local userIds = {}
 	local unresolvedMap = {}
@@ -91,6 +141,8 @@ function UserInfoAggregator:_sendAggregatedPromises()
 		return
 	end
 
+	assert(#userIds <= MAX_USER_IDS_PER_REQUEST, "Too many userIds sent")
+
 	self._maid:GivePromise(UserServiceUtils.promiseUserInfosByUserIds(userIds))
 		:Then(function(result)
 			assert(type(result) == "table", "Bad result")
@@ -109,24 +161,37 @@ function UserInfoAggregator:_sendAggregatedPromises()
 				promise:Reject(string.format("Failed to get result for userId %d", userId))
 			end
 		end, function(...)
-			for _, item in pairs(promiseMap) do
+			for _, item in pairs(unresolvedMap) do
 				item:Reject(...)
 			end
 		end)
 end
 
+function UserInfoAggregator:_resetQueue()
+	local promiseMap = self._unsentPromises
+
+	self._maid._queue = nil
+	self._unsentCount = 0
+	self._unsentPromises = {}
+
+	return promiseMap
+end
+
 function UserInfoAggregator:_queueAggregatedPromises()
-	if self._queued then
+	if self._unsentCount >= MAX_USER_IDS_PER_REQUEST then
+		self:_sendAggregatedPromises(self:_resetQueue())
+		return
+	end
+
+	if self._maid._queue then
 		return
 	end
 
-	self._queued = true
-	self._maid._queue = task.delay(0.05, function()
-		self._queued = false
-		self:_sendAggregatedPromises()
+	self._maid._queue = task.delay(0.1, function()
+		task.spawn(function()
+			self:_sendAggregatedPromises(self:_resetQueue())
+		end)
 	end)
 end
 
-
-
 return UserInfoAggregator

package/src/Shared/UserServiceUtils.lua

@@ -1,4 +1,6 @@
 --[=[
+	Wraps [UserService] API calls with [Promise].
+
 	@class UserServiceUtils
 ]=]
 
@@ -15,11 +17,17 @@ local UserServiceUtils = {}
 	.Id number -- The Id associated with the UserInfoResponse object
 	.Username string -- The username associated with the UserInfoResponse object
 	.DisplayName string	 -- The display name associated with the UserInfoResponse object
+	.HasVerifiedBadge boolean -- The HasVerifiedBadge value associated with the user.
 	@within UserServiceUtils
 ]=]
 
 --[=[
 	Wraps UserService:GetUserInfosByUserIdsAsync(userIds)
+
+	::: tip
+	User [UserInfoAggregator] via [UserInfoService] to get this deduplicated.
+	:::
+
 	@param userIds { number }
 	@return Promise<{ UserInfo }>
 ]=]
@@ -46,6 +54,10 @@ end
 --[=[
 	Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1]
 
+	::: tip
+	User [UserInfoAggregator] via [UserInfoService] to get this deduplicated.
+	:::
+
 	@param userId number
 	@return Promise<UserInfo>
 ]=]
@@ -67,6 +79,10 @@ end
 --[=[
 	Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].DisplayName
 
+	::: tip
+	User [UserInfoAggregator] via [UserInfoService] to get this deduplicated.
+	:::
+
 	@param userId number
 	@return Promise<string>
 ]=]
@@ -82,6 +98,10 @@ end
 --[=[
 	Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].Username
 
+	::: tip
+	User [UserInfoAggregator] via [UserInfoService] to get this deduplicated.
+	:::
+
 	@param userId number
 	@return Promise<string>
 ]=]