fix: Variable search item not showing after braces/commas (#11864)
# 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
This commit is contained in:
@@ -1,6 +1,7 @@
|
|||||||
<script>
|
<script>
|
||||||
import { mapGetters } from 'vuex';
|
import { mapGetters } from 'vuex';
|
||||||
import { MESSAGE_VARIABLES } from 'shared/constants/messages';
|
import { MESSAGE_VARIABLES } from 'shared/constants/messages';
|
||||||
|
import { sanitizeVariableSearchKey } from 'dashboard/helper/commons';
|
||||||
import MentionBox from '../mentions/MentionBox.vue';
|
import MentionBox from '../mentions/MentionBox.vue';
|
||||||
|
|
||||||
export default {
|
export default {
|
||||||
@@ -16,6 +17,9 @@ export default {
|
|||||||
...mapGetters({
|
...mapGetters({
|
||||||
customAttributes: 'attributes/getAttributes',
|
customAttributes: 'attributes/getAttributes',
|
||||||
}),
|
}),
|
||||||
|
sanitizedSearchKey() {
|
||||||
|
return sanitizeVariableSearchKey(this.searchKey);
|
||||||
|
},
|
||||||
items() {
|
items() {
|
||||||
return [
|
return [
|
||||||
...this.standardAttributeVariables,
|
...this.standardAttributeVariables,
|
||||||
@@ -25,8 +29,8 @@ export default {
|
|||||||
standardAttributeVariables() {
|
standardAttributeVariables() {
|
||||||
return MESSAGE_VARIABLES.filter(variable => {
|
return MESSAGE_VARIABLES.filter(variable => {
|
||||||
return (
|
return (
|
||||||
variable.label.includes(this.searchKey) ||
|
variable.label.includes(this.sanitizedSearchKey) ||
|
||||||
variable.key.includes(this.searchKey)
|
variable.key.includes(this.sanitizedSearchKey)
|
||||||
);
|
);
|
||||||
}).map(variable => ({
|
}).map(variable => ({
|
||||||
label: variable.key,
|
label: variable.key,
|
||||||
|
|||||||
@@ -83,3 +83,16 @@ export const convertToPortalSlug = text => {
|
|||||||
.replace(/[^\w ]+/g, '')
|
.replace(/[^\w ]+/g, '')
|
||||||
.replace(/ +/g, '-');
|
.replace(/ +/g, '-');
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Strip curly braces, commas and leading/trailing whitespace from a search key.
|
||||||
|
* Eg. "{{contact.name}}," => "contact.name"
|
||||||
|
* @param {string} searchKey
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
export const sanitizeVariableSearchKey = (searchKey = '') => {
|
||||||
|
return searchKey
|
||||||
|
.replace(/[{}]/g, '') // remove all curly braces
|
||||||
|
.replace(/,/g, '') // remove commas
|
||||||
|
.trim();
|
||||||
|
};
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import {
|
|||||||
convertToAttributeSlug,
|
convertToAttributeSlug,
|
||||||
convertToCategorySlug,
|
convertToCategorySlug,
|
||||||
convertToPortalSlug,
|
convertToPortalSlug,
|
||||||
|
sanitizeVariableSearchKey,
|
||||||
} from '../commons';
|
} from '../commons';
|
||||||
|
|
||||||
describe('#getTypingUsersText', () => {
|
describe('#getTypingUsersText', () => {
|
||||||
@@ -107,3 +108,37 @@ describe('convertToPortalSlug', () => {
|
|||||||
expect(convertToPortalSlug('Room rental')).toBe('room-rental');
|
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('');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user