feat: Add a view for mentions (#3505)

- Added a new table mentions for saving user mentions
- Added a filter conversation_type in the API
- Added a view to see the mentions

app/javascript/dashboard/store/modules/conversations/actions.js

@@ -4,43 +4,11 @@ import ConversationApi from '../../../api/inbox/conversation';
 import MessageApi from '../../../api/inbox/message';
 import { MESSAGE_STATUS, MESSAGE_TYPE } from 'shared/constants/messages';
 import { createPendingMessage } from 'dashboard/helper/commons';
+import {
+  buildConversationList,
+  isOnMentionsView,
+} from './helpers/actionHelpers';
 
-const setPageFilter = ({ dispatch, filter, page, markEndReached }) => {
-  dispatch('conversationPage/setCurrentPage', { filter, page }, { root: true });
-  if (markEndReached) {
-    dispatch('conversationPage/setEndReached', { filter }, { root: true });
-  }
-};
-
-const setContacts = (commit, chatList) => {
-  commit(
-    `contacts/${types.SET_CONTACTS}`,
-    chatList.map(chat => chat.meta.sender)
-  );
-};
-
-const buildConversationList = (
-  context,
-  requestPayload,
-  responseData,
-  filterType
-) => {
-  const { payload: conversationList, meta: metaData } = responseData;
-  context.commit(types.SET_ALL_CONVERSATION, conversationList);
-  context.dispatch('conversationStats/set', metaData);
-  context.dispatch(
-    'conversationLabels/setBulkConversationLabels',
-    conversationList
-  );
-  context.commit(types.CLEAR_LIST_LOADING_STATUS);
-  setContacts(context.commit, conversationList);
-  setPageFilter({
-    dispatch: context.dispatch,
-    filter: filterType,
-    page: requestPayload.page,
-    markEndReached: !conversationList.length,
-  });
-};
 // actions
 const actions = {
   getConversation: async ({ commit }, conversationId) => {
@@ -233,21 +201,32 @@ const actions = {
     }
   },
 
-  addConversation({ commit, state, dispatch }, conversation) {
+  addConversation({ commit, state, dispatch, rootState }, conversation) {
     const { currentInbox, appliedFilters } = state;
     const {
       inbox_id: inboxId,
       meta: { sender },
     } = conversation;
+
     const hasAppliedFilters = !!appliedFilters.length;
     const isMatchingInboxFilter =
       !currentInbox || Number(currentInbox) === inboxId;
-    if (!hasAppliedFilters && isMatchingInboxFilter) {
+    if (
+      !hasAppliedFilters &&
+      !isOnMentionsView(rootState) &&
+      isMatchingInboxFilter
+    ) {
       commit(types.ADD_CONVERSATION, conversation);
       dispatch('contacts/setContact', sender);
     }
   },
 
+  addMentions({ dispatch, rootState }, conversation) {
+    if (isOnMentionsView(rootState)) {
+      dispatch('updateConversation', conversation);
+    }
+  },
+
   updateConversation({ commit, dispatch }, conversation) {
     const {
       meta: { sender },

app/javascript/dashboard/store/modules/conversations/helpers/actionHelpers.js

@@ -0,0 +1,46 @@
+import types from '../../../mutation-types';
+
+export const setPageFilter = ({ dispatch, filter, page, markEndReached }) => {
+  dispatch('conversationPage/setCurrentPage', { filter, page }, { root: true });
+  if (markEndReached) {
+    dispatch('conversationPage/setEndReached', { filter }, { root: true });
+  }
+};
+
+export const setContacts = (commit, chatList) => {
+  commit(
+    `contacts/${types.SET_CONTACTS}`,
+    chatList.map(chat => chat.meta.sender)
+  );
+};
+
+export const isOnMentionsView = ({ route: { name: routeName } }) => {
+  const MENTION_ROUTES = [
+    'conversation_mentions',
+    'conversation_through_mentions',
+  ];
+  return MENTION_ROUTES.includes(routeName);
+};
+
+export const buildConversationList = (
+  context,
+  requestPayload,
+  responseData,
+  filterType
+) => {
+  const { payload: conversationList, meta: metaData } = responseData;
+  context.commit(types.SET_ALL_CONVERSATION, conversationList);
+  context.dispatch('conversationStats/set', metaData);
+  context.dispatch(
+    'conversationLabels/setBulkConversationLabels',
+    conversationList
+  );
+  context.commit(types.CLEAR_LIST_LOADING_STATUS);
+  setContacts(context.commit, conversationList);
+  setPageFilter({
+    dispatch: context.dispatch,
+    filter: filterType,
+    page: requestPayload.page,
+    markEndReached: !conversationList.length,
+  });
+};

app/javascript/dashboard/store/modules/conversations/helpers/specs/actionHelpers.spec.js

@@ -0,0 +1,12 @@
+import { isOnMentionsView } from '../actionHelpers';
+
+describe('#isOnMentionsView', () => {
+  it('return valid responses when passing the state', () => {
+    expect(isOnMentionsView({ route: { name: 'conversation_mentions' } })).toBe(
+      true
+    );
+    expect(isOnMentionsView({ route: { name: 'conversation_messages' } })).toBe(
+      false
+    );
+  });
+});

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

@@ -59,7 +59,10 @@ describe('#actions', () => {
         messages: [],
         meta: { sender: { id: 1, name: 'john-doe' } },
       };
-      actions.updateConversation({ commit, dispatch }, conversation);
+      actions.updateConversation(
+        { commit, rootState: { route: { name: 'home' } }, dispatch },
+        conversation
+      );
       expect(commit.mock.calls).toEqual([
         [types.UPDATE_CONVERSATION, conversation],
       ]);
@@ -86,6 +89,7 @@ describe('#actions', () => {
       actions.addConversation(
         {
           commit,
+          rootState: { route: { name: 'home' } },
           dispatch,
           state: { currentInbox: 1, appliedFilters: [] },
         },
@@ -105,6 +109,27 @@ describe('#actions', () => {
       actions.addConversation(
         {
           commit,
+          rootState: { route: { name: 'home' } },
+          dispatch,
+          state: { currentInbox: 1, appliedFilters: [{ id: 'random-filter' }] },
+        },
+        conversation
+      );
+      expect(commit.mock.calls).toEqual([]);
+      expect(dispatch.mock.calls).toEqual([]);
+    });
+
+    it('doesnot send mutation if the view is conversation mentions', () => {
+      const conversation = {
+        id: 1,
+        messages: [],
+        meta: { sender: { id: 1, name: 'john-doe' } },
+        inbox_id: 1,
+      };
+      actions.addConversation(
+        {
+          commit,
+          rootState: { route: { name: 'conversation_mentions' } },
           dispatch,
           state: { currentInbox: 1, appliedFilters: [{ id: 'random-filter' }] },
         },
@@ -124,6 +149,7 @@ describe('#actions', () => {
       actions.addConversation(
         {
           commit,
+          rootState: { route: { name: 'home' } },
           dispatch,
           state: { currentInbox: 1, appliedFilters: [] },
         },
@@ -151,7 +177,12 @@ describe('#actions', () => {
         inbox_id: 1,
       };
       actions.addConversation(
-        { commit, dispatch, state: { appliedFilters: [] } },
+        {
+          commit,
+          rootState: { route: { name: 'home' } },
+          dispatch,
+          state: { appliedFilters: [] },
+        },
         conversation
       );
       expect(commit.mock.calls).toEqual([
@@ -379,3 +410,27 @@ describe('#deleteMessage', () => {
     });
   });
 });
+
+describe('#addMentions', () => {
+  it('does not send mutations if the view is not mentions', () => {
+    actions.addMentions(
+      { commit, dispatch, rootState: { route: { name: 'home' } } },
+      { id: 1 }
+    );
+    expect(commit.mock.calls).toEqual([]);
+    expect(dispatch.mock.calls).toEqual([]);
+  });
+
+  it('send mutations if the view is mentions', () => {
+    actions.addMentions(
+      {
+        dispatch,
+        rootState: { route: { name: 'conversation_mentions' } },
+      },
+      { id: 1, meta: { sender: { id: 1 } } }
+    );
+    expect(dispatch.mock.calls).toEqual([
+      ['updateConversation', { id: 1, meta: { sender: { id: 1 } } }],
+    ]);
+  });
+});