mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-05 13:37:55 +00:00
# Pull Request Template
## Description
This PR fixes an issue where typing variables, like `{{contact.name}}`,
caused the variable list to miss showing `contact.name`. The search key
in this case became `contact.name}},` which didn't match any available
options. The logic in `VariableList.vue` only checked the part after the
last comma and didn’t fully sanitize the input.
**Solution**
Updated `searchKey` to remove all {} and commas for accurate matching.
Fixes
[CW-4574](https://linear.app/chatwoot/issue/CW-4574/i-dont-see-an-option-for-contactname-it-shows-initially-but-it-doesnt)
## Type of change
- [x] Bug fix (non-breaking change which fixes an issue)
## How Has This Been Tested?
### Loom video
https://www.loom.com/share/fc86e53853ad49e6acf6de57ebbd8fcb?sid=6702f896-d1a3-4c5a-9eb7-b96b5ed91531
## Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented on my code, particularly in hard-to-understand
areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules
145 lines
3.9 KiB
JavaScript
145 lines
3.9 KiB
JavaScript
import {
|
|
getTypingUsersText,
|
|
createPendingMessage,
|
|
convertToAttributeSlug,
|
|
convertToCategorySlug,
|
|
convertToPortalSlug,
|
|
sanitizeVariableSearchKey,
|
|
} from '../commons';
|
|
|
|
describe('#getTypingUsersText', () => {
|
|
it('returns the correct text is there is only one typing user', () => {
|
|
expect(getTypingUsersText([{ name: 'Pranav' }])).toEqual([
|
|
'TYPING.ONE',
|
|
{ user: 'Pranav' },
|
|
]);
|
|
});
|
|
|
|
it('returns the correct text is there are two typing users', () => {
|
|
expect(
|
|
getTypingUsersText([{ name: 'Pranav' }, { name: 'Nithin' }])
|
|
).toEqual(['TYPING.TWO', { user: 'Pranav', secondUser: 'Nithin' }]);
|
|
});
|
|
|
|
it('returns the correct text is there are more than two users are typing', () => {
|
|
expect(
|
|
getTypingUsersText([
|
|
{ name: 'Pranav' },
|
|
{ name: 'Nithin' },
|
|
{ name: 'Subin' },
|
|
{ name: 'Sojan' },
|
|
])
|
|
).toEqual(['TYPING.MULTIPLE', { user: 'Pranav', count: 3 }]);
|
|
});
|
|
});
|
|
|
|
describe('#createPendingMessage', () => {
|
|
const message = {
|
|
message: 'hi',
|
|
};
|
|
it('returns the pending message with expected new keys', () => {
|
|
expect(createPendingMessage(message)).toMatchObject({
|
|
content: expect.anything(),
|
|
id: expect.anything(),
|
|
status: expect.anything(),
|
|
echo_id: expect.anything(),
|
|
created_at: expect.anything(),
|
|
message_type: expect.anything(),
|
|
});
|
|
});
|
|
|
|
it('returns the pending message with status progress', () => {
|
|
expect(createPendingMessage(message)).toMatchObject({
|
|
status: 'progress',
|
|
});
|
|
});
|
|
|
|
it('returns the pending message with same id and echo_id', () => {
|
|
const pending = createPendingMessage(message);
|
|
expect(pending).toMatchObject({
|
|
echo_id: pending.id,
|
|
});
|
|
});
|
|
|
|
it('returns the pending message with attachment key if file is passed', () => {
|
|
const messageWithFile = {
|
|
message: 'hi',
|
|
file: {},
|
|
};
|
|
expect(createPendingMessage(messageWithFile)).toMatchObject({
|
|
content: expect.anything(),
|
|
id: expect.anything(),
|
|
status: expect.anything(),
|
|
echo_id: expect.anything(),
|
|
created_at: expect.anything(),
|
|
message_type: expect.anything(),
|
|
attachments: [{ id: expect.anything() }],
|
|
});
|
|
});
|
|
|
|
it('returns the pending message to have one attachment', () => {
|
|
const messageWithFile = {
|
|
message: 'hi',
|
|
file: {},
|
|
};
|
|
const pending = createPendingMessage(messageWithFile);
|
|
expect(pending.attachments.length).toBe(1);
|
|
});
|
|
});
|
|
|
|
describe('convertToAttributeSlug', () => {
|
|
it('should convert to slug', () => {
|
|
expect(convertToAttributeSlug('Test@%^&*(){}>.!@`~_ ing')).toBe(
|
|
'test__ing'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('convertToCategorySlug', () => {
|
|
it('should convert to slug', () => {
|
|
expect(convertToCategorySlug('User profile guide')).toBe(
|
|
'user-profile-guide'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('convertToPortalSlug', () => {
|
|
it('should convert to slug', () => {
|
|
expect(convertToPortalSlug('Room rental')).toBe('room-rental');
|
|
});
|
|
});
|
|
|
|
describe('sanitizeVariableSearchKey', () => {
|
|
it('removes braces', () => {
|
|
expect(sanitizeVariableSearchKey('{{contact.name}}')).toBe('contact.name');
|
|
});
|
|
|
|
it('removes right braces', () => {
|
|
expect(sanitizeVariableSearchKey('contact.name}}')).toBe('contact.name');
|
|
});
|
|
|
|
it('removes braces, comma and whitespace', () => {
|
|
expect(sanitizeVariableSearchKey(' {{contact.name }},')).toBe(
|
|
'contact.name'
|
|
);
|
|
});
|
|
|
|
it('trims whitespace', () => {
|
|
expect(sanitizeVariableSearchKey(' contact.name ')).toBe('contact.name');
|
|
});
|
|
|
|
it('handles multiple commas', () => {
|
|
expect(sanitizeVariableSearchKey('{{contact.name}},,')).toBe(
|
|
'contact.name'
|
|
);
|
|
});
|
|
|
|
it('returns empty string when only braces/commas/whitespace', () => {
|
|
expect(sanitizeVariableSearchKey(' { }, , ')).toBe('');
|
|
});
|
|
|
|
it('returns empty string for undefined input', () => {
|
|
expect(sanitizeVariableSearchKey()).toBe('');
|
|
});
|
|
});
|