@quenty/chatproviderservice 9.67.3 → 9.67.4

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.67.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/chatproviderservice@9.67.3...@quenty/chatproviderservice@9.67.4) (2026-07-29)
+
+### Bug Fixes
+
+- **chatproviderservice:** let a PlayerMock be chat tagged ([#776](https://github.com/Quenty/NevermoreEngine/issues/776)) ([7d1843b](https://github.com/Quenty/NevermoreEngine/commit/7d1843b24225a3d3e2f70c2743688b28a0e2acb4))
+
 ## [9.67.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/chatproviderservice@9.67.2...@quenty/chatproviderservice@9.67.3) (2026-07-29)
 
 **Note:** Version bump only for package @quenty/chatproviderservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/chatproviderservice",
-  "version": "9.67.3",
+  "version": "9.67.4",
   "description": "Provide wrapper around chat system to allow tags to be set",
   "keywords": [
     "Roblox",
@@ -43,6 +43,7 @@
     "@quenty/nevermore-test-runner": "1.5.0",
     "@quenty/permissionprovider": "14.49.0",
     "@quenty/playerbinder": "14.46.0",
+    "@quenty/playermock": "1.6.0",
     "@quenty/playerutils": "8.41.0",
     "@quenty/preferredparentutils": "4.4.2",
     "@quenty/promise": "10.23.0",
@@ -60,5 +61,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0215f657269834e0ec1272ac1bf97bbdf58c78cd"
+  "gitHead": "98488545769a2a9586da14845730dfb36d718744"
 }

package/src/Client/ChatProviderServiceClient.lua

@@ -7,6 +7,7 @@ local require = require(script.Parent.loader).load(script)
 
 local HttpService = game:GetService("HttpService")
 local Players = game:GetService("Players")
+local RunService = game:GetService("RunService")
 local TextChatService = game:GetService("TextChatService")
 
 local Binder = require("Binder")
@@ -49,6 +50,12 @@ function ChatProviderServiceClient.Init(self: ChatProviderServiceClient, service
 end
 
 function ChatProviderServiceClient.Start(self: ChatProviderServiceClient): ()
+	-- The engine rejects this assignment outside a client, and a headless test that boots a client bag
+	-- on the server would take the whole bag down with it. Nothing to render there anyway.
+	if not RunService:IsClient() then
+		return
+	end
+
 	TextChatService.OnIncomingMessage = function(textChatMessage): TextChatMessageProperties?
 		self.MessageIncoming:Fire(textChatMessage)
 

package/src/Server/ChatProviderService.lua

@@ -17,6 +17,7 @@ local LocalizedTextUtils = require("LocalizedTextUtils")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local PermissionLevel = require("PermissionLevel")
+local PlayerMock = require("PlayerMock")
 local PreferredParentUtils = require("PreferredParentUtils")
 local Promise = require("Promise")
 local Rx = require("Rx")
@@ -173,7 +174,7 @@ function ChatProviderService.PromiseAddChatTag(
 	player: Player,
 	chatTagData: ChatTagDataUtils.ChatTagData
 ): Promise.Promise<Instance>
-	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or PlayerMock.isMock(player), "Bad player")
 	assert(ChatTagDataUtils.isChatTagData(chatTagData), "Bad chatTagData")
 
 	local hasChatTagBinder = self._serviceBag:GetService(HasChatTags)
@@ -189,7 +190,7 @@ end
 	@param player Player
 ]=]
 function ChatProviderService.ClearChatTags(self: ChatProviderService, player: Player)
-	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or PlayerMock.isMock(player), "Bad player")
 
 	local hasChatTagBinder = self._serviceBag:GetService(HasChatTags)
 	local hasChatTags = hasChatTagBinder:Get(player)
@@ -300,4 +301,15 @@ function ChatProviderService._promiseSpeaker(self: ChatProviderService, speakerN
 	end)
 end
 
+--[=[
+	Cleans up the service. Should be done via [ServiceBag].
+
+	Load-bearing rather than tidy: the developer and admin tags hold a subscription to every player in
+	the place, which outlived this service without it. A destroyed bag then went on resolving
+	permissions and tagging players through services it no longer owns.
+]=]
+function ChatProviderService.Destroy(self: ChatProviderService)
+	self._maid:DoCleaning()
+end
+
 return ChatProviderService

package/src/Server/ChatProviderService.spec.lua

@@ -0,0 +1,196 @@
+--!strict
+--[[
+	Coverage for the server chat-tag API against a PlayerMock. No real player joins a headless Open
+	Cloud place, so a mock has to be able to reach a chat tag the same way a joined player does --
+	through the PlayerBinder-backed HasChatTags, with the test creating nothing by hand but the mock.
+
+	The built-in (dev) and (mod) tags are switched off per test: they resolve through PermissionService,
+	which is a different question than whether a mock can be tagged at all.
+
+	@class ChatProviderService.spec.lua
+]]
+
+local require = require(script.Parent.loader).load(script)
+
+local ChatProviderService = require("ChatProviderService")
+local ChatTagConstants = require("ChatTagConstants")
+local ChatTagDataUtils = require("ChatTagDataUtils")
+local HasChatTagsConstants = require("HasChatTagsConstants")
+local Jest = require("Jest")
+local PermissionProviderUtils = require("PermissionProviderUtils")
+local PermissionService = require("PermissionService")
+local PlayerMockService = require("PlayerMockService")
+local ServiceBag = require("ServiceBag")
+
+local afterEach = Jest.Globals.afterEach
+local describe = Jest.Globals.describe
+local expect = Jest.Globals.expect
+local it = Jest.Globals.it
+
+local DEMO_TAG = ChatTagDataUtils.createChatTagData({
+	TagText = "[DEMO]",
+	TagPriority = 5,
+	TagColor = Color3.fromRGB(245, 163, 27),
+})
+
+local activeController: any = nil
+
+afterEach(function()
+	if activeController then
+		local controller = activeController
+		activeController = nil
+		controller.destroy()
+	end
+end)
+
+local remoteNameCounter = 0
+
+-- Polls rather than observes: the tag arrives through a binder, a permission promise and an Rx chain,
+-- and the point of these tests is the end state rather than which hop delivered it.
+local function waitForTagCount(player: Player, expected: number, timeout: number): number
+	local deadline = os.clock() + timeout
+
+	repeat
+		local container = player:FindFirstChild(HasChatTagsConstants.TAG_CONTAINER_NAME)
+		local count = if container then #container:GetChildren() else 0
+		if count == expected then
+			return count
+		end
+		task.wait(0.1)
+	until os.clock() > deadline
+
+	local container = player:FindFirstChild(HasChatTagsConstants.TAG_CONTAINER_NAME)
+	return if container then #container:GetChildren() else 0
+end
+
+-- creatorUserId, when given, makes that user the creator so the built-in developer tag actually
+-- applies to them. Left nil, both built-in tags are switched off: they resolve through
+-- PermissionService, which is a different question than whether a mock can be tagged at all.
+local function setup(creatorUserId: number?)
+	local serviceBag = ServiceBag.new()
+	local container = Instance.new("Folder")
+	container.Name = "ChatProviderServiceSpecContainer"
+	container.Parent = workspace
+
+	local chatProviderService: any = serviceBag:GetService(ChatProviderService)
+	local permissionService: any = serviceBag:GetService(PermissionService)
+	local playerMockService: any = serviceBag:GetService(PlayerMockService)
+
+	serviceBag:Init()
+
+	if creatorUserId then
+		remoteNameCounter += 1
+		permissionService:SetProviderFromConfig(PermissionProviderUtils.createSingleUserConfig({
+			userId = creatorUserId,
+			remoteFunctionName = string.format("ChatProviderServiceSpecRemote%d", remoteNameCounter),
+		}))
+	end
+
+	serviceBag:Start()
+
+	if not creatorUserId then
+		chatProviderService:SetDeveloperTag(nil)
+		chatProviderService:SetAdminTag(nil)
+	end
+
+	local mocks: { Player } = {}
+	local bagDestroyed = false
+
+	local function destroyBag()
+		if not bagDestroyed then
+			bagDestroyed = true
+			serviceBag:Destroy()
+		end
+	end
+
+	local controller
+	controller = {
+		chatProviderService = chatProviderService,
+		newMock = function(userId: number?): Player
+			local mock = playerMockService:CreatePlayer(if userId then { UserId = userId } else nil)
+			mock.Parent = container
+			table.insert(mocks, mock)
+			return mock
+		end,
+		destroyBag = destroyBag,
+		destroy = function()
+			destroyBag()
+
+			for _, mock in mocks do
+				mock:Destroy()
+			end
+			table.clear(mocks)
+
+			container:Destroy()
+		end,
+	}
+
+	activeController = controller
+	return controller
+end
+
+describe("ChatProviderService.PromiseAddChatTag", function()
+	it("tags a player mock", function()
+		local controller = setup()
+		local player = controller.newMock()
+
+		local tag = controller.chatProviderService:PromiseAddChatTag(player, DEMO_TAG):Wait()
+
+		expect(tag:GetAttribute(ChatTagConstants.TAG_TEXT_ATTRIBUTE)).toBe(DEMO_TAG.TagText)
+		expect(tag:IsDescendantOf(player)).toBe(true)
+	end)
+
+	it("drops the tag when the instance is destroyed", function()
+		local controller = setup()
+		local player = controller.newMock()
+
+		local tag = controller.chatProviderService:PromiseAddChatTag(player, DEMO_TAG):Wait()
+		tag:Destroy()
+
+		expect(tag:IsDescendantOf(player)).toBe(false)
+	end)
+end)
+
+describe("ChatProviderService.SetDeveloperTag", function()
+	local CREATOR_USER_ID = 4242
+
+	it("tags the creator", function()
+		local controller = setup(CREATOR_USER_ID)
+		local player = controller.newMock(CREATOR_USER_ID)
+
+		expect(waitForTagCount(player, 1, 10)).toBe(1)
+	end)
+
+	it("leaves everybody else alone", function()
+		local controller = setup(CREATOR_USER_ID)
+		local player = controller.newMock(CREATOR_USER_ID + 1)
+
+		expect(waitForTagCount(player, 0, 3)).toBe(0)
+	end)
+
+	--[[
+		The tag holds a subscription to every player in the place, so without a Destroy it outlived its
+		own bag: a destroyed service went on resolving permissions and reaching for binders through
+		services it no longer owned.
+	]]
+	it("stops tagging once its bag is destroyed", function()
+		local controller = setup(CREATOR_USER_ID)
+		controller.destroyBag()
+
+		local player = controller.newMock(CREATOR_USER_ID)
+
+		expect(waitForTagCount(player, 0, 3)).toBe(0)
+	end)
+end)
+
+describe("ChatProviderService.ClearChatTags", function()
+	it("clears a player mock's tags", function()
+		local controller = setup()
+		local player = controller.newMock()
+
+		local tag = controller.chatProviderService:PromiseAddChatTag(player, DEMO_TAG):Wait()
+		controller.chatProviderService:ClearChatTags(player)
+
+		expect(tag.Parent).toBe(nil)
+	end)
+end)