@quenty/userserviceutils 4.0.0-canary.367.e9fdcbc.0 → 4.0.0

package/CHANGELOG.md

@@ -3,7 +3,64 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [4.0.0-canary.367.e9fdcbc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.5.0...@quenty/userserviceutils@4.0.0-canary.367.e9fdcbc.0) (2023-06-05)
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.11.0...@quenty/userserviceutils@4.0.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
+
+
+
+
+
+# [3.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.9.0...@quenty/userserviceutils@3.10.0) (2023-08-23)
+
+
+### Features
+
+* Add UserInfoService:ObserveDisplayName(userId) ([950c121](https://github.com/Quenty/NevermoreEngine/commit/950c121c35d734d7a66415ada647b146e06c4bf7))
+
+
+
+
+
+# [3.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.8.0...@quenty/userserviceutils@3.9.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/userserviceutils
+
+
+
+
+
+# [3.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.7.0...@quenty/userserviceutils@3.8.0) (2023-07-25)
+
+
+### Features
+
+* Add UserInfoService to aggregate user info in a de-duplicated request format ([deb1a79](https://github.com/Quenty/NevermoreEngine/commit/deb1a7914f753f8835ce407a2f94b3f8eac7d812))
+
+
+
+
+
+# [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.6.0...@quenty/userserviceutils@3.7.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/userserviceutils
+
+
+
+
+
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.5.0...@quenty/userserviceutils@3.6.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/userserviceutils
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/userserviceutils",
-  "version": "4.0.0-canary.367.e9fdcbc.0",
+  "version": "4.0.0",
   "description": "Utilities involving UserService in Roblox",
   "keywords": [
     "Roblox",
@@ -25,12 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "6.2.1",
-    "@quenty/math": "3.0.0-canary.367.e9fdcbc.0",
-    "@quenty/promise": "6.5.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/math": "^2.5.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/servicebag": "^7.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9fdcbc6ea1d46e068bf42a08b833099e9005259"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Client/UserInfoServiceClient.lua

@@ -0,0 +1,77 @@
+--[=[
+	Centralized provider for user info so we can coordinate web requests.
+
+	@class UserInfoServiceClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UserInfoAggregator = require("UserInfoAggregator")
+local Maid = require("Maid")
+
+local UserInfoServiceClient = {}
+UserInfoServiceClient.ServiceName = "UserInfoServiceClient"
+
+function UserInfoServiceClient:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self._aggregator = UserInfoAggregator.new()
+	self._maid:GiveTask(self._aggregator)
+end
+
+--[=[
+	Promises the user info for the given user, aggregating all requests to reduce
+	calls into Roblox.
+
+	@param userId number
+	@return Promise<UserInfo>
+]=]
+function UserInfoServiceClient:PromiseUserInfo(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self._aggregator:PromiseUserInfo(userId)
+end
+
+--[=[
+	Promises the user display name for the userId
+
+	@param userId number
+	@return Promise<string>
+]=]
+function UserInfoServiceClient:PromiseDisplayName(userId)
+	assert(type(userId) == "number", "Bad 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
+
+	@param userId number
+	@return Observable<string>
+]=]
+function UserInfoServiceClient:ObserveDisplayName(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self._aggregator:ObserveDisplayName(userId)
+end
+
+function UserInfoServiceClient:Destroy()
+	self._maid:DoCleaning()
+end
+
+return UserInfoServiceClient

package/src/Server/UserInfoService.lua

@@ -0,0 +1,78 @@
+--[=[
+	Centralized provider for user info so we can coordinate web requests.
+
+	@class UserInfoService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UserInfoAggregator = require("UserInfoAggregator")
+local Maid = require("Maid")
+
+local UserInfoService = {}
+UserInfoService.ServiceName = "UserInfoService"
+
+function UserInfoService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self._aggregator = UserInfoAggregator.new()
+	self._maid:GiveTask(self._aggregator)
+end
+
+--[=[
+	Promises the user info for the given user, aggregating all requests to reduce
+	calls into Roblox.
+
+	@param userId number
+	@return Promise<UserInfo>
+]=]
+function UserInfoService:PromiseUserInfo(userId)
+	assert(type(userId) == "number", "Bad 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
+
+	@param userId number
+	@return Promise<string>
+]=]
+function UserInfoService:PromiseDisplayName(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self._aggregator:PromiseDisplayName(userId)
+end
+
+--[=[
+	Observes the user display name for the userId
+
+	@param userId number
+	@return Observable<string>
+]=]
+function UserInfoService:ObserveDisplayName(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self._aggregator:ObserveDisplayName(userId)
+end
+
+
+function UserInfoService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return UserInfoService

package/src/Shared/UserInfoAggregator.lua

@@ -0,0 +1,197 @@
+--[=[
+	Aggregates all requests into one big send request to deduplicate the request
+
+	@class UserInfoAggregator
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+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
+
+function UserInfoAggregator.new()
+	local self = setmetatable(BaseObject.new(), UserInfoAggregator)
+
+	-- TODO: LRU cache this? Limit to 1k or something?
+	self._promises = {}
+
+	self._unsentCount = 0
+	self._unsentPromises = {}
+
+	return self
+end
+
+--[=[
+	Promises the user info for the given user, aggregating all requests to reduce
+	calls into Roblox.
+
+	@param userId number
+	@return Promise<UserInfo>
+]=]
+function UserInfoAggregator:PromiseUserInfo(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	if self._promises[userId] then
+		return self._promises[userId]
+	end
+
+	local promise = Promise.new()
+
+	self._unsentPromises[userId] = promise
+	self._unsentCount = self._unsentCount + 1
+	self._promises[userId] = promise
+
+	self:_queueAggregatedPromises()
+
+	return promise
+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<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
+
+	@param userId number
+	@return Observable<string>
+]=]
+function UserInfoAggregator:ObserveDisplayName(userId)
+	assert(type(userId) == "number", "Bad userId")
+
+	return self:ObserveUserInfo():Pipe({
+		Rx.map(function(userInfo)
+			return userInfo.DisplayName
+		end)
+	})
+end
+
+function UserInfoAggregator:_sendAggregatedPromises(promiseMap)
+	assert(promiseMap, "No promiseMap")
+
+	local userIds = {}
+	local unresolvedMap = {}
+	for userId, promise in pairs(promiseMap) do
+		table.insert(userIds, userId)
+		unresolvedMap[userId] = promise
+	end
+
+	if #userIds == 0 then
+		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")
+
+			for _, data in pairs(result) do
+				assert(type(data.Id) == "number", "Bad result[?].Id")
+
+				if unresolvedMap[data.Id] then
+					unresolvedMap[data.Id]:Resolve(data)
+					unresolvedMap[data.Id] = nil
+				end
+			end
+
+			-- Reject other ones
+			for userId, promise in pairs(unresolvedMap) do
+				promise:Reject(string.format("Failed to get result for userId %d", userId))
+			end
+		end, function(...)
+			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._unsentCount >= MAX_USER_IDS_PER_REQUEST then
+		self:_sendAggregatedPromises(self:_resetQueue())
+		return
+	end
+
+	if self._maid._queue then
+		return
+	end
+
+	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>
 ]=]