@quenty/userserviceutils 3.7.0 → 3.8.0-canary.398.cbf5f4f.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.8.0-canary.398.cbf5f4f.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@3.7.0...@quenty/userserviceutils@3.8.0-canary.398.cbf5f4f.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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/userserviceutils",
-  "version": "3.7.0",
+  "version": "3.8.0-canary.398.cbf5f4f.0",
   "description": "Utilities involving UserService in Roblox",
   "keywords": [
     "Roblox",
@@ -25,12 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^6.2.1",
-    "@quenty/math": "^2.4.0",
-    "@quenty/promise": "^6.6.0"
+    "@quenty/baseobject": "6.2.1",
+    "@quenty/loader": "6.2.1",
+    "@quenty/maid": "2.5.0",
+    "@quenty/math": "2.4.0",
+    "@quenty/promise": "6.6.0",
+    "@quenty/servicebag": "6.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dc77d6de09e9eb9d3fd6dafd790c052d8393d38f"
+  "gitHead": "cbf5f4f4211156144e150dd960d9e2225cf9c5f5"
 }

package/src/Client/UserInfoServiceClient.lua

@@ -0,0 +1,53 @@
+--[=[
+	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
+
+function UserInfoServiceClient:Destroy()
+	self._maid:DoCleaning()
+end
+
+return UserInfoServiceClient

package/src/Server/UserInfoService.lua

@@ -0,0 +1,53 @@
+--[=[
+	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
+
+--[=[
+	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
+
+function UserInfoService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return UserInfoService

package/src/Shared/UserInfoAggregator.lua

@@ -0,0 +1,119 @@
+--[=[
+	Aggregates all requests into one big send request
+
+	@class UserInfoAggregator
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local Promise = require("Promise")
+local UserServiceUtils = require("UserServiceUtils")
+
+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._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._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
+
+function UserInfoAggregator:_sendAggregatedPromises()
+	local promiseMap = self._unsentPromises
+	self._unsentPromises = {}
+
+	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
+
+	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(promiseMap) do
+				item:Reject(...)
+			end
+		end)
+end
+
+function UserInfoAggregator:_queueAggregatedPromises()
+	if self._queued then
+		return
+	end
+
+	self._queued = true
+	self._maid._queue = task.delay(0.05, function()
+		self._queued = false
+		self:_sendAggregatedPromises()
+	end)
+end
+
+
+
+return UserInfoAggregator