Fix insights (#388)

Insight fixes

Author: munkhjin0223

src/__tests__/insightQueries.test.ts

@@ -1,4 +1,5 @@
 import * as moment from 'moment';
+import { CONVERSATION_STATUSES } from '../data/constants';
 import insightQueries from '../data/resolvers/queries/insights/insights';
 import { graphqlRequest } from '../db/connection';
 import {
@@ -46,9 +47,6 @@ describe('insightQueries', () => {
       integrationId: integration._id,
     });
 
-    await conversationFactory({
-      integrationId: integration._id,
-    });
     await conversationMessageFactory({
       conversationId: conversation._id,
       userId: null,
@@ -96,8 +94,20 @@ describe('insightQueries', () => {
       }
     `;
 
-    const jsonResponse = await graphqlRequest(qry, 'insights', doc);
-    expect(jsonResponse.integration).toBeDefined();
+    const jsonResponseBefore = await graphqlRequest(qry, 'insights', doc);
+    expect(jsonResponseBefore.integration[5].value).toEqual(1);
+
+    // conversation that is closed automatically
+    await conversationFactory({
+      status: CONVERSATION_STATUSES.CLOSED,
+      integrationId: integration._id,
+      closedAt: undefined,
+      closedUserId: undefined,
+    });
+
+    const jsonResponseAfter = await graphqlRequest(qry, 'insights', doc);
+    // don't count an automatically closed conversation
+    expect(jsonResponseAfter.integration[5].value).toEqual(1);
   });
 
   test('insightsPunchCard', async () => {
@@ -135,8 +145,20 @@ describe('insightQueries', () => {
       }
     `;
 
-    const jsonResponse = await graphqlRequest(qry, 'insightsConversation', doc);
-    expect(jsonResponse.summary).toBeDefined();
+    const responseBefore = await graphqlRequest(qry, 'insightsConversation', doc);
+
+    expect(responseBefore.trend[0].y).toBe(1);
+
+    // conversation that is closed automatically
+    await conversationFactory({
+      status: CONVERSATION_STATUSES.CLOSED,
+      closedAt: undefined,
+      closedUserId: undefined,
+    });
+
+    const responseAfter = await graphqlRequest(qry, 'insightsConversation', doc);
+    // don't count an automatically closed conversation
+    expect(responseAfter.trend[0].y).toBe(1);
   });
 
   test('insightsFirstResponse', async () => {

src/data/constants.ts

@@ -288,9 +288,9 @@ export const COMPANY_BASIC_INFOS = [
 ];
 
 export const INSIGHT_BASIC_INFOS = {
-  count: 'Conversations by customer count',
+  count: 'Customer count',
   messageCount: 'Conversation message count',
-  customerCount: 'Customer count',
+  customerCount: 'Conversations by customer count',
   customerCountPercentage: 'Customer Count Percentage',
   resolvedCount: 'Resolved conversation',
   averageResponseDuration: 'Average duration of total',

src/data/resolvers/queries/insights/dealInsights.ts

@@ -25,7 +25,7 @@ const dealInsightQueries = {
 
     // check & convert endDate's value
     const end = moment(fixDate(endDate)).format('YYYY-MM-DD');
-    const start = moment(end).add(-7, 'days');
+    const start = moment(end).add(-30, 'days');
 
     const matchMessageSelector = {
       // client or user
@@ -40,7 +40,7 @@ const dealInsightQueries = {
    */
   async dealInsightsMain(_root, args: IDealListArgs) {
     const { startDate, endDate, status } = args;
-    const { start, end } = fixDates(startDate, endDate);
+    const { start, end } = fixDates(startDate, endDate, 30);
 
     const selector = await getDealSelector(args);
 

src/data/resolvers/queries/insights/insightExport.ts

@@ -13,6 +13,7 @@ import {
   getConversationSelector,
   getFilterSelector,
   getTimezone,
+  noConversationSelector,
 } from './utils';
 
 import { addCell, addHeader, convertTime, dateToString, fixNumber, nextTime } from './exportUtils';
@@ -57,7 +58,7 @@ const insightExportQueries = {
     const { start, end } = fixDates(startDate, endDate, diffCount);
     const conversationSelector = {
       createdAt: { $gte: start, $lte: end },
-      $or: [{ userId: { $exists: true }, messageCount: { $gt: 1 } }, { userId: { $exists: false } }],
+      ...noConversationSelector,
     };
 
     const mainSelector = await getConversationSelector(args, conversationSelector);
@@ -80,9 +81,6 @@ const insightExportQueries = {
         $group: {
           _id: '$date',
           uniqueCustomerIds: { $addToSet: '$customerId' },
-          resolvedCount: {
-            $sum: { $cond: [{ $eq: ['$status', 'closed'] }, 1, 0] },
-          },
           totalCount: { $sum: 1 },
           totalResponseTime: { $sum: '$firstRespondTime' },
           totalCloseTime: { $sum: '$closeTime' },
@@ -94,7 +92,6 @@ const insightExportQueries = {
           totalCount: 1,
           totalCloseTime: 1,
           totalResponseTime: 1,
-          resolvedCount: 1,
           percentage: {
             $multiply: [
               {
@@ -107,6 +104,35 @@ const insightExportQueries = {
       },
     ]);
 
+    const resolvedSelector = {
+      closedAt: { $gte: start, $lte: end },
+      status: 'closed',
+      ...noConversationSelector,
+    };
+
+    const mainResolvedSelector = await getConversationSelector(args, resolvedSelector, 'closedAt');
+
+    const resolvedAggregatedData = await Conversations.aggregate([
+      {
+        $match: mainResolvedSelector,
+      },
+      {
+        $project: {
+          date: await getDateFieldAsStr({
+            fieldName: '$closedAt',
+            timeFormat: aggregationTimeFormat,
+            timeZone: getTimezone(user),
+          }),
+        },
+      },
+      {
+        $group: {
+          _id: '$date',
+          resolvedCount: { $sum: 1 },
+        },
+      },
+    ]);
+
     const volumeDictionary = {};
 
     let totalCustomerCount = 0;
@@ -133,7 +159,6 @@ const insightExportQueries = {
       {
         $project: {
           date: await getDateFieldAsStr({ timeFormat: aggregationTimeFormat, timeZone: getTimezone(user) }),
-          status: 1,
         },
       },
       {
@@ -150,38 +175,38 @@ const insightExportQueries = {
       totalConversationMessages += row.totalCount;
     });
 
+    const resolvedDictionary = {};
+    resolvedAggregatedData.forEach(row => {
+      resolvedDictionary[row._id] = row.resolvedCount;
+      totalResolved += row.resolvedCount;
+    });
+
     const data: IVolumeReportExportArgs[] = [];
 
     let begin = start;
     const generateData = async () => {
       const next = nextTime(begin, type);
       const dateKey = moment(begin).format(timeFormat);
-      const {
-        resolvedCount,
-        totalCount,
-        totalResponseTime,
-        totalCloseTime,
-        uniqueCustomerCount,
-        percentage,
-      } = volumeDictionary[dateKey] || {
-        resolvedCount: 0,
+      const { totalCount, totalResponseTime, totalCloseTime, uniqueCustomerCount, percentage } = volumeDictionary[
+        dateKey
+      ] || {
         totalCount: 0,
         totalResponseTime: 0,
         totalCloseTime: 0,
         uniqueCustomerCount: 0,
         percentage: 0,
       };
       const messageCount = conversationDictionary[dateKey] || 0;
+      const resolvedCount = resolvedDictionary[dateKey] || 0;
 
       totalCustomerCount += totalCount;
-      totalResolved += resolvedCount;
 
       totalUniqueCount += uniqueCustomerCount;
 
       totalClosedTime += totalCloseTime;
       totalRespondTime += totalResponseTime;
 
-      averageResponseDuration = fixNumber(totalCloseTime / resolvedCount);
+      averageResponseDuration = fixNumber(totalCloseTime / totalCount);
       firstResponseDuration = fixNumber(totalResponseTime / totalCount);
 
       data.push({
@@ -211,7 +236,7 @@ const insightExportQueries = {
       customerCountPercentage: `${((totalUniqueCount / totalCustomerCount) * 100).toFixed(0)}%`,
       messageCount: totalConversationMessages,
       resolvedCount: totalResolved,
-      averageResponseDuration: convertTime(fixNumber(totalClosedTime / totalResolved)),
+      averageResponseDuration: convertTime(fixNumber(totalClosedTime / totalCustomerCount)),
       firstResponseDuration: convertTime(fixNumber(totalRespondTime / totalCustomerCount)),
     });
 
@@ -524,7 +549,7 @@ const insightExportQueries = {
     const tagData = await Conversations.aggregate([
       {
         $match: {
-          $or: [{ userId: { $exists: true }, messageCount: { $gt: 1 } }, { userId: { $exists: false } }],
+          ...noConversationSelector,
           integrationId: { $in: rawIntegrationIds },
           createdAt: filterSelector.createdAt,
         },

src/data/resolvers/queries/insights/insights.ts

@@ -18,6 +18,7 @@ import {
   getFilterSelector,
   getSummaryData,
   getTimezone,
+  noConversationSelector,
 } from './utils';
 
 const insightQueries = {
@@ -37,7 +38,7 @@ const insightQueries = {
 
     const conversationSelector = {
       createdAt: { $gte: start, $lte: end },
-      $or: [{ userId: { $exists: true }, messageCount: { $gt: 1 } }, { userId: { $exists: false } }],
+      ...noConversationSelector,
     };
 
     // count conversations by each integration kind
@@ -152,7 +153,6 @@ const insightQueries = {
    */
   async insightsSummaryData(_root, args: IListArgs) {
     const { startDate, endDate, type } = args;
-
     const messageSelector = await generateMessageSelector({
       args,
       excludeBot: true,
@@ -175,18 +175,22 @@ const insightQueries = {
    */
   async insightsConversation(_root, args: IListArgs) {
     const filterSelector = getFilterSelector(args);
+
     const conversationSelector = {
       createdAt: filterSelector.createdAt,
-      $or: [{ userId: { $exists: true }, messageCount: { $gt: 1 } }, { userId: { $exists: false } }],
+      ...noConversationSelector,
     };
+
     const conversations = await findConversations(filterSelector, { ...conversationSelector });
+
     const insightData: any = {
       summary: [],
       trend: await generateChartDataByCollection(conversations),
     };
 
     const { startDate, endDate } = args;
     const { start, end } = fixDates(startDate, endDate);
+
     insightData.summary = await getSummaryData({
       startDate: start,
       endDate: end,

src/data/resolvers/queries/insights/utils.ts

@@ -13,7 +13,7 @@ import { IMessageDocument } from '../../../../db/models/definitions/conversation
 import { IConversationDocument } from '../../../../db/models/definitions/conversations';
 import { IStageDocument } from '../../../../db/models/definitions/deals';
 import { IUser } from '../../../../db/models/definitions/users';
-import { INSIGHT_TYPES } from '../../../constants';
+import { CONVERSATION_STATUSES, INSIGHT_TYPES } from '../../../constants';
 import { getDateFieldAsStr } from '../aggregationUtils';
 import { fixDate } from '../utils';
 import {
@@ -37,7 +37,7 @@ import {
  * Return filterSelector
  * @param args
  */
-export const getFilterSelector = (args: IListArgs): any => {
+export const getFilterSelector = (args: IListArgs, fieldName: string = 'createdAt'): any => {
   const selector: IFilterSelector = { integration: {} };
   const { startDate, endDate, integrationIds, brandIds } = args;
   const { start, end } = fixDates(startDate, endDate);
@@ -50,7 +50,7 @@ export const getFilterSelector = (args: IListArgs): any => {
     selector.integration.brandId = { $in: brandIds.split(',') };
   }
 
-  selector.createdAt = { $gte: start, $lte: end };
+  selector[fieldName] = { $gte: start, $lte: end };
 
   return selector;
 };
@@ -61,7 +61,7 @@ export const getFilterSelector = (args: IListArgs): any => {
  */
 export const getDealSelector = async (args: IDealListArgs): Promise<IDealSelector> => {
   const { startDate, endDate, boardId, pipelineIds, status } = args;
-  const { start, end } = fixDates(startDate, endDate);
+  const { start, end } = fixDates(startDate, endDate, 30);
 
   const selector: IDealSelector = {};
   const date = {
@@ -110,14 +110,19 @@ export const getDealSelector = async (args: IDealListArgs): Promise<IDealSelecto
  * @param conversationSelector
  * @param selectIds
  */
-export const getConversationSelector = async (args: IListArgs, conversationSelector: any): Promise<any> => {
-  const filterSelector = await getFilterSelector(args);
+export const getConversationSelector = async (
+  args: IListArgs,
+  conversationSelector: any,
+  fieldName: string = 'createdAt',
+): Promise<any> => {
+  const filterSelector = await getFilterSelector(args, fieldName);
 
-  if (filterSelector.integration) {
+  if (Object.keys(filterSelector.integration).length > 0) {
     const integrationIds = await Integrations.find(filterSelector.integration).select('_id');
     conversationSelector.integrationId = { $in: integrationIds.map(row => row._id) };
   }
-  conversationSelector.createdAt = filterSelector.createdAt;
+
+  conversationSelector[fieldName] = filterSelector[fieldName];
 
   return conversationSelector;
 };
@@ -230,7 +235,6 @@ export const generateMessageSelector = async ({
   // While searching by integration
   if (Object.keys(filterSelector.integration).length > 0) {
     const conversationIds = await findConversations(filterSelector, { createdAt: updatedCreatedAt }, true);
-
     const rawConversationIds = conversationIds.map(obj => obj._id);
     messageSelector.conversationId = { $in: rawConversationIds };
   }
@@ -539,3 +543,22 @@ export const generateResponseData = async (
 export const getTimezone = (user: IUser): string => {
   return (user.details ? user.details.location : '+08') || '+08';
 };
+
+export const noConversationSelector = {
+  $or: [
+    { userId: { $exists: true }, messageCount: { $gt: 1 } },
+    {
+      userId: { $exists: false },
+      $or: [
+        {
+          closedAt: { $exists: true },
+          closedUserId: { $exists: true },
+          status: CONVERSATION_STATUSES.CLOSED,
+        },
+        {
+          status: { $ne: CONVERSATION_STATUSES.CLOSED },
+        },
+      ],
+    },
+  ],
+};