Skip to content

fix: Agents unable to assign outbound message replies to themselves #36989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tassoevan merged 7 commits into from
Sep 19, 2025
Merged

fix: Agents unable to assign outbound message replies to themselves #36989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cca2fc8
fix(outbound): Agent anable to assign themselves
aleksandernsilva Sep 18, 2025
2467c6f
refactor: created hook and added unit tests
aleksandernsilva Sep 18, 2025
d32d58d
test: adjusted mock import
aleksandernsilva Sep 18, 2025
54f97fa
test: added role livechat-agent to mock user
aleksandernsilva Sep 18, 2025
78d3470
test: removed it.only
aleksandernsilva Sep 18, 2025
75d517a
test: adjusted permissions
aleksandernsilva Sep 18, 2025
c248f2c
Replace file extension
tassoevan Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...l/OutboundMessage/components/OutboundMessageWizard/forms/RepliesForm/RepliesForm.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const mockUser = createFakeUser({
_id: 'agent-1',
username: 'agent.one',
name: 'Agent One',
roles: ['livechat-agent'],
});

const mockAgentOne: Serialized<ILivechatAgent> = {
Expand Down Expand Up @@ -218,7 +219,7 @@ describe('RepliesForm', () => {
getDepartmentMock.mockResolvedValue({ department: mockDepartment, agents: [] });
const handleSubmit = jest.fn();
render(<RepliesForm defaultValues={{ departmentId: 'department-1', agentId: 'agent-1' }} onSubmit={handleSubmit} />, {
wrapper: appRoot().build(),
wrapper: appRoot([]).build(),
});

await userEvent.click(screen.getByRole('button', { name: 'Submit' }));
Expand Down
17 changes: 13 additions & 4 deletions ...hannel/OutboundMessage/components/OutboundMessageWizard/forms/RepliesForm/RepliesForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { Serialized, ILivechatDepartment, ILivechatDepartmentAgents } from
import { Box, Button, FieldGroup } from '@rocket.chat/fuselage';
import { useEffectEvent } from '@rocket.chat/fuselage-hooks';
import { useToastBarDispatch } from '@rocket.chat/fuselage-toastbar';
import { useEndpoint, usePermission } from '@rocket.chat/ui-contexts';
import { useEndpoint, usePermission, useUser } from '@rocket.chat/ui-contexts';
import { useQuery } from '@tanstack/react-query';
import type { ReactNode } from 'react';
import { useEffect, useId, useMemo } from 'react';
Expand All @@ -11,6 +11,7 @@ import { useTranslation } from 'react-i18next';

import AgentField from './components/AgentField';
import DepartmentField from './components/DepartmentField';
import { useAllowedAgents } from './hooks/useAllowedAgents';
import { omnichannelQueryKeys } from '../../../../../../../lib/queryKeys';
import { FormFetchError } from '../../utils/errors';

Expand Down Expand Up @@ -41,6 +42,7 @@ const RepliesForm = (props: RepliesFormProps) => {
const dispatchToastMessage = useToastBarDispatch();
const { t } = useTranslation();
const repliesFormId = useId();
const user = useUser();

const canAssignAllDepartments = usePermission('outbound.can-assign-queues');
const canAssignSelfOnlyAgent = usePermission('outbound.can-assign-self-only');
Expand All @@ -62,7 +64,7 @@ const RepliesForm = (props: RepliesFormProps) => {
const getDepartment = useEndpoint('GET', '/v1/livechat/department/:_id', { _id: departmentId ?? '' });

const {
data: { department, agents = [] } = {},
data: { department, agents: queryAgents = [] } = {},
isError: isErrorDepartment,
isFetching: isFetchingDepartment,
refetch: refetchDepartment,
Expand All @@ -72,6 +74,14 @@ const RepliesForm = (props: RepliesFormProps) => {
enabled: !!departmentId,
});

const agents = useAllowedAgents({
user,
queryAgents,
departmentId: department?._id,
canAssignSelfOnlyAgent,
canAssignAnyAgent,
});

useEffect(() => {
isErrorDepartment && trigger('departmentId');
return () => clearErrors('departmentId');
Expand Down Expand Up @@ -119,8 +129,7 @@ const RepliesForm = (props: RepliesFormProps) => {
<AgentField
control={control}
agents={agents}
canAssignAny={canAssignAnyAgent}
canAssignSelfOnly={canAssignSelfOnlyAgent}
canAssignAgent={canAssignAnyAgent || canAssignSelfOnlyAgent}
disabled={!departmentId}
isLoading={isFetchingDepartment}
/>
Expand Down
13 changes: 3 additions & 10 deletions ...boundMessage/components/OutboundMessageWizard/forms/RepliesForm/components/AgentField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type { ILivechatDepartmentAgents, Serialized } from '@rocket.chat/core-typings';
import { Field, FieldError, FieldHint, FieldLabel, FieldRow } from '@rocket.chat/fuselage';
import { useUserId } from '@rocket.chat/ui-contexts';
import { useId } from 'react';
import type { Control } from 'react-hook-form';
import { useController } from 'react-hook-form';
Expand All @@ -13,21 +12,15 @@ import type { RepliesFormData } from '../RepliesForm';
type AgentFieldProps = {
control: Control<RepliesFormData>;
agents: Serialized<ILivechatDepartmentAgents>[];
canAssignAny?: boolean;
canAssignSelfOnly?: boolean;
canAssignAgent?: boolean;
disabled?: boolean;
isLoading?: boolean;
};

const AgentField = ({ control, agents, canAssignAny, canAssignSelfOnly, disabled = false, isLoading = false }: AgentFieldProps) => {
const AgentField = ({ control, agents, canAssignAgent, disabled = false, isLoading = false }: AgentFieldProps) => {
const { t } = useTranslation();
const agentFieldId = useId();

const userId = useUserId();
const canAssignAgent = canAssignSelfOnly || canAssignAny;

const allowedAgents = canAssignAny ? agents : agents.filter((agent) => agent.agentId === userId);

const {
field: agentField,
fieldState: { error: agentFieldError },
Expand All @@ -50,7 +43,7 @@ const AgentField = ({ control, agents, canAssignAny, canAssignSelfOnly, disabled
})}
error={!!agentFieldError}
id={agentFieldId}
agents={allowedAgents}
agents={agents}
placeholder={isLoading ? t('Loading...') : t('Select_agent')}
disabled={disabled || isLoading || !canAssignAgent}
value={agentField.value}
Expand Down
169 changes: 169 additions & 0 deletions ...Message/components/OutboundMessageWizard/forms/RepliesForm/hooks/useAllowedAgents.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
import type { ILivechatDepartmentAgents, IUser, Serialized } from '@rocket.chat/core-typings';
import { renderHook } from '@testing-library/react';

import { useAllowedAgents } from './useAllowedAgents';
import { createFakeUser } from '../../../../../../../../../tests/mocks/data';
import { getAgentDerivedFromUser } from '../utils/getAgentDerivedFromUser';

jest.mock('../utils/getAgentDerivedFromUser', () => ({
getAgentDerivedFromUser: jest.fn(),
}));

const getAgentDerivedFromUserMocked = jest.mocked(getAgentDerivedFromUser);

const mockUser: IUser = createFakeUser({
_id: 'test-user-id',
username: 'testuser',
roles: ['livechat-agent'],
});

const mockQueryAgents: Serialized<ILivechatDepartmentAgents>[] = [
{
agentId: 'agent1',
username: 'agent.one',
count: 1,
order: 1,
_id: 'agent1',
_updatedAt: new Date().toISOString(),
departmentEnabled: true,
departmentId: 'dept1',
},
{
agentId: 'agent2',
username: 'agent.two',
count: 2,
order: 2,
_id: 'agent2',
_updatedAt: new Date().toISOString(),
departmentEnabled: true,
departmentId: 'dept1',
},
];

const mockDerivedAgent: Serialized<ILivechatDepartmentAgents> = {
agentId: 'test-user-id',
username: 'testuser',
_id: 'test-user-id',
_updatedAt: new Date().toISOString(),
departmentId: 'department-1',
departmentEnabled: true,
count: 0,
order: 0,
};

describe('useAllowedAgents', () => {
beforeEach(() => {
jest.clearAllMocks();
});

it('should return an empty array if no departmentId is provided', () => {
const { result } = renderHook(() =>
useAllowedAgents({
user: mockUser,
departmentId: undefined,
canAssignSelfOnlyAgent: true,
canAssignAnyAgent: true,
queryAgents: mockQueryAgents,
}),
);

expect(result.current).toEqual([]);
});

it('should return an empty array if user has no assignment permissions', () => {
const { result } = renderHook(() =>
useAllowedAgents({
user: mockUser,
departmentId: 'department-1',
canAssignSelfOnlyAgent: false,
canAssignAnyAgent: false,
queryAgents: mockQueryAgents,
}),
);

expect(result.current).toEqual([]);
});

it('should return queryAgents if canAssignAnyAgent is true and queryAgents has items', () => {
const { result } = renderHook(() =>
useAllowedAgents({
user: mockUser,
departmentId: 'department-1',
canAssignSelfOnlyAgent: false,
canAssignAnyAgent: true,
queryAgents: mockQueryAgents,
}),
);

expect(result.current).toEqual(mockQueryAgents);
});

it('should return derived agent if canAssignSelfOnlyAgent is true', () => {
getAgentDerivedFromUserMocked.mockReturnValue(mockDerivedAgent);

const { result } = renderHook(() =>
useAllowedAgents({
user: mockUser,
departmentId: 'department-1',
canAssignSelfOnlyAgent: true,
canAssignAnyAgent: false,
queryAgents: mockQueryAgents,
}),
);

expect(getAgentDerivedFromUserMocked).toHaveBeenCalledWith(mockUser, 'department-1');
expect(result.current).toEqual([mockDerivedAgent]);
});

it('should return derived agent if canAssignAnyAgent is true but queryAgents is empty', () => {
getAgentDerivedFromUserMocked.mockReturnValue(mockDerivedAgent);

const { result } = renderHook(() =>
useAllowedAgents({
user: mockUser,
departmentId: 'department-1',
canAssignSelfOnlyAgent: false,
canAssignAnyAgent: true,
queryAgents: [],
}),
);

expect(getAgentDerivedFromUserMocked).toHaveBeenCalledWith(mockUser, 'department-1');
expect(result.current).toEqual([mockDerivedAgent]);
});

it('should return derived agent if canAssignAnyAgent is true but queryAgents is undefined', () => {
getAgentDerivedFromUserMocked.mockReturnValue(mockDerivedAgent);

const { result } = renderHook(() =>
useAllowedAgents({
user: mockUser,
departmentId: 'department-1',
canAssignSelfOnlyAgent: false,
canAssignAnyAgent: true,
queryAgents: undefined,
}),
);

expect(getAgentDerivedFromUserMocked).toHaveBeenCalledWith(mockUser, 'department-1');
expect(result.current).toEqual([mockDerivedAgent]);
});

it('should return an empty array if getAgentDerivedFromUser throws an error', () => {
getAgentDerivedFromUserMocked.mockImplementation(() => {
throw new Error('User not found');
});

const { result } = renderHook(() =>
useAllowedAgents({
user: null,
departmentId: 'department-1',
canAssignSelfOnlyAgent: true,
canAssignAnyAgent: false,
queryAgents: [],
}),
);

expect(result.current).toEqual([]);
});
});
37 changes: 37 additions & 0 deletions ...boundMessage/components/OutboundMessageWizard/forms/RepliesForm/hooks/useAllowedAgents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import type { Serialized, ILivechatDepartmentAgents, IUser } from '@rocket.chat/core-typings';
import { useMemo } from 'react';

import { getAgentDerivedFromUser } from '../utils/getAgentDerivedFromUser';

type UseAllowedAgentsProps = {
user: IUser | null;
departmentId: string | undefined;
canAssignSelfOnlyAgent: boolean;
canAssignAnyAgent: boolean;
queryAgents: Serialized<ILivechatDepartmentAgents>[] | undefined;
};

export const useAllowedAgents = ({ user, departmentId, queryAgents, canAssignSelfOnlyAgent, canAssignAnyAgent }: UseAllowedAgentsProps) =>
useMemo(() => {
// no department selected, no agents
if (!departmentId) {
return [];
}

// no permission to assign any agents, no agents
if (!canAssignSelfOnlyAgent && !canAssignAnyAgent) {
return [];
}

// can assign any agent, return all agents from query (if any)
if (canAssignAnyAgent && queryAgents?.length) {
return queryAgents;
}

try {
// all other cases, attempt to derive agent from user
return [getAgentDerivedFromUser(user, departmentId)];
} catch {
return [];
}
}, [canAssignAnyAgent, canAssignSelfOnlyAgent, user, departmentId, queryAgents]);
39 changes: 39 additions & 0 deletions .../components/OutboundMessageWizard/forms/RepliesForm/utils/getAgentDerivedFromUser.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import type { IUser } from '@rocket.chat/core-typings';

import { getAgentDerivedFromUser } from './getAgentDerivedFromUser';
import { createFakeUser } from '../../../../../../../../../tests/mocks/data';

describe('getAgentDerivedFromUser', () => {
it('should throw an error if the user is null', () => {
expect(() => getAgentDerivedFromUser(null, 'any-department-id')).toThrow('User is not a livechat agent');
});

it('should throw an error if the user is not a livechat agent', () => {
const user: IUser = createFakeUser({ roles: ['user'] });

expect(() => getAgentDerivedFromUser(user, 'any-department-id')).toThrow('User is not a livechat agent');
});

it('should return a valid agent object if the user is a livechat agent', () => {
const user: IUser = createFakeUser({
_id: 'agentId123',
username: 'agentusername',
roles: ['livechat-agent'],
});

const departmentId = 'department123';

const agent = getAgentDerivedFromUser(user, departmentId);

expect(agent).toEqual({
agentId: user._id,
username: user.username,
_id: user._id,
_updatedAt: expect.any(String),
departmentId,
departmentEnabled: true,
count: 0,
order: 0,
});
});
});
20 changes: 20 additions & 0 deletions ...ssage/components/OutboundMessageWizard/forms/RepliesForm/utils/getAgentDerivedFromUser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import type { ILivechatDepartmentAgents, Serialized, IUser } from '@rocket.chat/core-typings';

const isOmnichannelAgent = (user: IUser | null): user is IUser => (user ? user.roles.includes('livechat-agent') : false);

export const getAgentDerivedFromUser = (user: IUser | null, departmentId: string): Serialized<ILivechatDepartmentAgents> => {
if (!isOmnichannelAgent(user)) {
throw new Error('User is not a livechat agent');
}

return {
agentId: user._id,
username: user.username || '',
_id: user._id,
_updatedAt: new Date().toISOString(),
departmentId,
departmentEnabled: true,
count: 0,
order: 0,
};
};
Loading