feat: Ability to add label for contact page (#2350)

* feat: Ability to add label for contact page

Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
Co-authored-by: Pranav Raj S <pranav@chatwoot.com>
Co-authored-by: Nithin David Thomas <webofnithin@gmail.com>

app/javascript/dashboard/store/index.js

@@ -7,6 +7,7 @@ import auth from './modules/auth';
 import cannedResponse from './modules/cannedResponse';
 import contactConversations from './modules/contactConversations';
 import contacts from './modules/contacts';
+import contactLabels from './modules/contactLabels';
 import notifications from './modules/notifications';
 import conversationLabels from './modules/conversationLabels';
 import conversationMetadata from './modules/conversationMetadata';
@@ -38,6 +39,7 @@ export default new Vuex.Store({
     cannedResponse,
     contactConversations,
     contacts,
+    contactLabels,
     notifications,
     conversationLabels,
     conversationMetadata,

app/javascript/dashboard/store/modules/contactLabels.js

@@ -0,0 +1,89 @@
+import Vue from 'vue';
+import types from '../mutation-types';
+import ContactAPI from '../../api/contacts';
+
+const state = {
+  records: {},
+  uiFlags: {
+    isFetching: false,
+    isUpdating: false,
+    isError: false,
+  },
+};
+
+export const getters = {
+  getUIFlags($state) {
+    return $state.uiFlags;
+  },
+  getContactLabels: $state => id => {
+    return $state.records[Number(id)] || [];
+  },
+};
+
+export const actions = {
+  get: async ({ commit }, contactId) => {
+    commit(types.SET_CONTACT_LABELS_UI_FLAG, {
+      isFetching: true,
+    });
+    try {
+      const response = await ContactAPI.getContactLabels(contactId);
+      commit(types.SET_CONTACT_LABELS, {
+        id: contactId,
+        data: response.data.payload,
+      });
+      commit(types.SET_CONTACT_LABELS_UI_FLAG, {
+        isFetching: false,
+      });
+    } catch (error) {
+      commit(types.SET_CONTACT_LABELS_UI_FLAG, {
+        isFetching: false,
+      });
+    }
+  },
+  update: async ({ commit }, { contactId, labels }) => {
+    commit(types.SET_CONTACT_LABELS_UI_FLAG, {
+      isUpdating: true,
+    });
+    try {
+      const response = await ContactAPI.updateContactLabels(contactId, labels);
+      commit(types.SET_CONTACT_LABELS, {
+        id: contactId,
+        data: response.data.payload,
+      });
+      commit(types.SET_CONTACT_LABELS_UI_FLAG, {
+        isUpdating: false,
+        isError: false,
+      });
+    } catch (error) {
+      commit(types.SET_CONTACT_LABELS_UI_FLAG, {
+        isUpdating: false,
+        isError: true,
+      });
+      throw new Error(error);
+    }
+  },
+
+  setContactLabel({ commit }, { id, data }) {
+    commit(types.SET_CONTACT_LABELS, { id, data });
+  },
+};
+
+export const mutations = {
+  [types.SET_CONTACT_LABELS_UI_FLAG]($state, data) {
+    $state.uiFlags = {
+      ...$state.uiFlags,
+      ...data,
+    };
+  },
+  [types.SET_CONTACT_LABELS]: ($state, { id, data }) => {
+    Vue.set($state.records, id, data);
+  },
+};
+
+export default {
+  namespaced: true,
+  state,
+  getters,
+  actions,
+  mutations,
+};

app/javascript/dashboard/store/modules/specs/contactLabels/actions.spec.js

@@ -0,0 +1,73 @@
+import axios from 'axios';
+import { actions } from '../../contactLabels';
+import * as types from '../../../mutation-types';
+
+const commit = jest.fn();
+global.axios = axios;
+jest.mock('axios');
+
+describe('#actions', () => {
+  describe('#get', () => {
+    it('sends correct actions if API is success', async () => {
+      axios.get.mockResolvedValue({
+        data: { payload: ['customer-success', 'on-hold'] },
+      });
+      await actions.get({ commit }, 1);
+      expect(commit.mock.calls).toEqual([
+        [types.default.SET_CONTACT_LABELS_UI_FLAG, { isFetching: true }],
+
+        [
+          types.default.SET_CONTACT_LABELS,
+          { id: 1, data: ['customer-success', 'on-hold'] },
+        ],
+        [types.default.SET_CONTACT_LABELS_UI_FLAG, { isFetching: false }],
+      ]);
+    });
+    it('sends correct actions if API is error', async () => {
+      axios.get.mockRejectedValue({ message: 'Incorrect header' });
+      await actions.get({ commit });
+      expect(commit.mock.calls).toEqual([
+        [types.default.SET_CONTACT_LABELS_UI_FLAG, { isFetching: true }],
+        [types.default.SET_CONTACT_LABELS_UI_FLAG, { isFetching: false }],
+      ]);
+    });
+  });
+
+  describe('#update', () => {
+    it('updates correct actions if API is success', async () => {
+      axios.post.mockResolvedValue({
+        data: { payload: { contactId: '1', labels: ['on-hold'] } },
+      });
+      await actions.update({ commit }, { contactId: '1', labels: ['on-hold'] });
+
+      expect(commit.mock.calls).toEqual([
+        [types.default.SET_CONTACT_LABELS_UI_FLAG, { isUpdating: true }],
+        [
+          types.default.SET_CONTACT_LABELS,
+          {
+            id: '1',
+            data: { contactId: '1', labels: ['on-hold'] },
+          },
+        ],
+        [
+          types.default.SET_CONTACT_LABELS_UI_FLAG,
+          { isUpdating: false, isError: false },
+        ],
+      ]);
+    });
+
+    it('sends correct actions if API is error', async () => {
+      axios.post.mockRejectedValue({ message: 'Incorrect header' });
+      await expect(
+        actions.update({ commit }, { contactId: '1', labels: ['on-hold'] })
+      ).rejects.toThrow(Error);
+      expect(commit.mock.calls).toEqual([
+        [types.default.SET_CONTACT_LABELS_UI_FLAG, { isUpdating: true }],
+        [
+          types.default.SET_CONTACT_LABELS_UI_FLAG,
+          { isUpdating: false, isError: true },
+        ],
+      ]);
+    });
+  });
+});

app/javascript/dashboard/store/modules/specs/contactLabels/getters.spec.js

@@ -0,0 +1,24 @@
+import { getters } from '../../contactLabels';
+
+describe('#getters', () => {
+  it('getContactLabels', () => {
+    const state = {
+      records: { 1: ['customer-success', 'on-hold'] },
+    };
+    expect(getters.getContactLabels(state)(1)).toEqual([
+      'customer-success',
+      'on-hold',
+    ]);
+  });
+
+  it('getUIFlags', () => {
+    const state = {
+      uiFlags: {
+        isFetching: true,
+      },
+    };
+    expect(getters.getUIFlags(state)).toEqual({
+      isFetching: true,
+    });
+  });
+});

app/javascript/dashboard/store/modules/specs/contactLabels/mutations.spec.js

@@ -0,0 +1,29 @@
+import * as types from '../../../mutation-types';
+import { mutations } from '../../contactLabels';
+
+describe('#mutations', () => {
+  describe('#SET_CONTACT_LABELS_UI_FLAG', () => {
+    it('set ui flags', () => {
+      const state = { uiFlags: { isFetching: true } };
+      mutations[types.default.SET_CONTACT_LABELS_UI_FLAG](state, {
+        isFetching: false,
+      });
+      expect(state.uiFlags).toEqual({
+        isFetching: false,
+      });
+    });
+  });
+
+  describe('#SET_CONTACT_LABELS', () => {
+    it('set contact labels', () => {
+      const state = { records: {} };
+      mutations[types.default.SET_CONTACT_LABELS](state, {
+        id: 1,
+        data: ['customer-success', 'on-hold'],
+      });
+      expect(state.records).toEqual({
+        1: ['customer-success', 'on-hold'],
+      });
+    });
+  });
+});

app/javascript/dashboard/store/mutation-types.js

@@ -119,6 +119,10 @@ export default {
   SET_CONTACT_CONVERSATIONS: 'SET_CONTACT_CONVERSATIONS',
   ADD_CONTACT_CONVERSATION: 'ADD_CONTACT_CONVERSATION',
 
+  // Contact Label
+  SET_CONTACT_LABELS_UI_FLAG: 'SET_CONTACT_LABELS_UI_FLAG',
+  SET_CONTACT_LABELS: 'SET_CONTACT_LABELS',
+
   // Conversation Label
   SET_CONVERSATION_LABELS_UI_FLAG: 'SET_CONVERSATION_LABELS_UI_FLAG',
   SET_CONVERSATION_LABELS: 'SET_CONVERSATION_LABELS',