# Pull Request Template ## Description Adds a Contact condition to the conversation advanced filter so agents can search for an existing contact and filter conversations by `conversations.contact_id`. Fixes [CW-7239](https://linear.app/chatwoot/issue/CW-7239/contact-filter-for-conversations) ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? - `eval "$(rbenv init -)" && bundle exec rspec spec/services/conversations/filter_service_spec.rb` - `pnpm exec vitest --no-watch --no-cache --no-coverage --logHeapUsage app/javascript/dashboard/components-next/filter/helper/filterHelper.spec.js app/javascript/dashboard/store/modules/conversations/helpers/specs/filterHelpers.spec.js app/javascript/dashboard/helper/specs/customViewsHelper.spec.js app/javascript/dashboard/helper/specs/filterQueryGenerator.spec.js` - `pnpm eslint` - `eval "$(rbenv init -)" && bundle exec rubocop spec/services/conversations/filter_service_spec.rb` ## 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 - [x] 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 --------- Co-authored-by: iamsivin <iamsivin@gmail.com> Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com>
157 lines
4.6 KiB
JavaScript
157 lines
4.6 KiB
JavaScript
import * as MutationHelpers from 'shared/helpers/vuex/mutationHelpers';
|
|
import types from '../mutation-types';
|
|
import CustomViewsAPI from '../../api/customViews';
|
|
|
|
const VIEW_TYPES = {
|
|
CONVERSATION: 'conversation',
|
|
CONTACT: 'contact',
|
|
};
|
|
|
|
// use to normalize the filter type
|
|
const FILTER_KEYS = {
|
|
0: VIEW_TYPES.CONVERSATION,
|
|
1: VIEW_TYPES.CONTACT,
|
|
[VIEW_TYPES.CONVERSATION]: VIEW_TYPES.CONVERSATION,
|
|
[VIEW_TYPES.CONTACT]: VIEW_TYPES.CONTACT,
|
|
};
|
|
|
|
// a folder's contact_id filter stores only the id, extract it so the
|
|
// contact can be fetched and its name shown in the edit folder modal
|
|
const getFolderContactId = folder =>
|
|
folder?.query?.payload?.find(filter => filter.attribute_key === 'contact_id')
|
|
?.values?.[0];
|
|
|
|
export const state = {
|
|
[VIEW_TYPES.CONVERSATION]: {
|
|
records: [],
|
|
},
|
|
[VIEW_TYPES.CONTACT]: {
|
|
records: [],
|
|
},
|
|
uiFlags: {
|
|
isFetching: false,
|
|
isCreating: false,
|
|
isDeleting: false,
|
|
},
|
|
activeConversationFolder: null,
|
|
};
|
|
|
|
export const getters = {
|
|
getUIFlags(_state) {
|
|
return _state.uiFlags;
|
|
},
|
|
getCustomViewsByFilterType: _state => key => {
|
|
const filterType = FILTER_KEYS[key];
|
|
return _state[filterType].records;
|
|
},
|
|
getConversationCustomViews(_state) {
|
|
return _state[VIEW_TYPES.CONVERSATION].records;
|
|
},
|
|
getContactCustomViews(_state) {
|
|
return _state[VIEW_TYPES.CONTACT].records;
|
|
},
|
|
getActiveConversationFolder(_state) {
|
|
return _state.activeConversationFolder;
|
|
},
|
|
getActiveFolderContactId(_state) {
|
|
return getFolderContactId(_state.activeConversationFolder);
|
|
},
|
|
};
|
|
|
|
export const actions = {
|
|
get: async function getCustomViews({ commit }, filterType) {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isFetching: true });
|
|
try {
|
|
const response =
|
|
await CustomViewsAPI.getCustomViewsByFilterType(filterType);
|
|
commit(types.SET_CUSTOM_VIEW, { data: response.data, filterType });
|
|
} catch (error) {
|
|
// Ignore error
|
|
} finally {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isFetching: false });
|
|
}
|
|
},
|
|
create: async function createCustomViews({ commit }, obj) {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isCreating: true });
|
|
try {
|
|
const response = await CustomViewsAPI.create(obj);
|
|
commit(types.ADD_CUSTOM_VIEW, {
|
|
data: response.data,
|
|
filterType: FILTER_KEYS[obj.filter_type],
|
|
});
|
|
return response;
|
|
} catch (error) {
|
|
const errorMessage = error?.response?.data?.message;
|
|
throw new Error(errorMessage);
|
|
} finally {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isCreating: false });
|
|
}
|
|
},
|
|
update: async function updateCustomViews({ commit }, obj) {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isCreating: true });
|
|
try {
|
|
const response = await CustomViewsAPI.update(obj.id, obj);
|
|
commit(types.UPDATE_CUSTOM_VIEW, {
|
|
data: response.data,
|
|
filterType: FILTER_KEYS[obj.filter_type],
|
|
});
|
|
} catch (error) {
|
|
const errorMessage = error?.response?.data?.message;
|
|
throw new Error(errorMessage);
|
|
} finally {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isCreating: false });
|
|
}
|
|
},
|
|
delete: async ({ commit }, { id, filterType }) => {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isDeleting: true });
|
|
try {
|
|
await CustomViewsAPI.deleteCustomViews(id, filterType);
|
|
commit(types.DELETE_CUSTOM_VIEW, { data: id, filterType });
|
|
} catch (error) {
|
|
throw new Error(error);
|
|
} finally {
|
|
commit(types.SET_CUSTOM_VIEW_UI_FLAG, { isDeleting: false });
|
|
}
|
|
},
|
|
setActiveConversationFolder({ commit, dispatch }, data) {
|
|
commit(types.SET_ACTIVE_CONVERSATION_FOLDER, data);
|
|
// prefetch the contact of a contact filter so the UI can show its name
|
|
const contactId = getFolderContactId(data);
|
|
if (contactId) dispatch('contacts/show', { id: contactId }, { root: true });
|
|
},
|
|
};
|
|
|
|
export const mutations = {
|
|
[types.SET_CUSTOM_VIEW_UI_FLAG](_state, data) {
|
|
_state.uiFlags = {
|
|
..._state.uiFlags,
|
|
...data,
|
|
};
|
|
},
|
|
|
|
[types.ADD_CUSTOM_VIEW]: (_state, { data, filterType }) => {
|
|
MutationHelpers.create(_state[filterType], data);
|
|
},
|
|
[types.SET_CUSTOM_VIEW]: (_state, { data, filterType }) => {
|
|
MutationHelpers.set(_state[filterType], data);
|
|
},
|
|
[types.UPDATE_CUSTOM_VIEW]: (_state, { data, filterType }) => {
|
|
MutationHelpers.update(_state[filterType], data);
|
|
},
|
|
[types.DELETE_CUSTOM_VIEW]: (_state, { data, filterType }) => {
|
|
MutationHelpers.destroy(_state[filterType], data);
|
|
},
|
|
|
|
[types.SET_ACTIVE_CONVERSATION_FOLDER](_state, folder) {
|
|
_state.activeConversationFolder = folder;
|
|
},
|
|
};
|
|
|
|
export default {
|
|
namespaced: true,
|
|
actions,
|
|
state,
|
|
getters,
|
|
mutations,
|
|
};
|