[CW-53] feat: allow downloading heatmap report (#6683)

* feat: add control header slot * feat: add download API call * feat: add conversation traffic template * feat: allow downloading heatmap content * feat: wire up download * fix: grid layout for mobile * chore: revert formatting * revert: en.yml file * feat: add conversation traffic text * feat: disable rule for map block * test: conversation traffic * fix: timezone offset * feat: download report in UTC * feat: add UTC warning * chore: revert formatting * feat: add traffic text * chore: fix whitespace change
chatwoot · Mar 20, 2023 · e5134c9 · e5134c9
1 parent 4f936aa
commit e5134c9
Show file tree

Hide file tree

Showing 10 changed files with 187 additions and 25 deletions.
diff --git a/app/controllers/api/v2/accounts/reports_controller.rb b/app/controllers/api/v2/accounts/reports_controller.rb
@@ -32,6 +32,11 @@ def teams
     generate_csv('teams_report', 'api/v2/accounts/reports/teams')
   end
 
+  def conversation_traffic
+    @report_data = generate_conversations_heatmap_report
+    generate_csv('conversation_traffic_reports', 'api/v2/accounts/reports/conversation_traffic')
+  end
+
   def conversations
     return head :unprocessable_entity if params[:type].blank?
 

diff --git a/app/helpers/api/v2/accounts/reports_helper.rb b/app/helpers/api/v2/accounts/reports_helper.rb
@@ -27,6 +27,27 @@ def generate_labels_report
     end
   end
 
+  def generate_conversations_heatmap_report
+    report_params = {
+      type: :account,
+      group_by: 'hour',
+      since: params[:since],
+      until: params[:until],
+      metric: 'conversations_count',
+      business_hours: false
+    }
+    data = V2::ReportBuilder.new(Current.account, report_params).build
+
+    # data format is { timestamp: 1231242342, value: 3}
+    # we need to convert it to { date: "2020-01-01", hour: 12, value: 3}
+    #
+    # the generated report is **always** in UTC timezone
+    data.map do |d|
+      date = Time.zone.at(d[:timestamp]).to_s
+      [date, d[:value]]
+    end
+  end
+
   def generate_report(report_params)
     V2::ReportBuilder.new(
       Current.account,

diff --git a/app/javascript/dashboard/api/reports.js b/app/javascript/dashboard/api/reports.js
@@ -59,6 +59,12 @@ class ReportsAPI extends ApiClient {
     });
   }
 
+  getConversationTrafficCSV({ from: since, to: until }) {
+    return axios.get(`${this.url}/conversation_traffic`, {
+      params: { since, until },
+    });
+  }
+
   getLabelReports({ from: since, to: until, businessHours }) {
     return axios.get(`${this.url}/labels`, {
       params: { since, until, business_hours: businessHours },

diff --git a/app/javascript/dashboard/routes/dashboard/settings/reports/LiveReports.vue b/app/javascript/dashboard/routes/dashboard/settings/reports/LiveReports.vue
@@ -40,6 +40,17 @@
       <metric-card
         :header="this.$t('OVERVIEW_REPORTS.CONVERSATION_HEATMAP.HEADER')"
       >
+        <template #control>
+          <woot-button
+            icon="arrow-download"
+            size="small"
+            variant="smooth"
+            color-scheme="secondary"
+            @click="downloadHeatmapData"
+          >
+            Download Report
+          </woot-button>
+        </template>
         <report-heatmap
           :heat-data="accountConversationHeatmap"
           :is-loading="uiFlags.isFetchingAccountConversationsHeatmap"
@@ -129,6 +140,15 @@ export default {
       this.fetchAgentConversationMetric();
       this.fetchHeatmapData();
     },
+    downloadHeatmapData() {
+      let to = endOfDay(new Date());
+      let from = startOfDay(subDays(to, 6));
+
+      this.$store.dispatch('downloadAccountConversationHeatmap', {
+        from: getUnixTime(from),
+        to: getUnixTime(to),
+      });
+    },
     fetchHeatmapData() {
       if (this.uiFlags.isFetchingAccountConversationsHeatmap) {
         return;

diff --git a/...javascript/dashboard/routes/dashboard/settings/reports/components/overview/MetricCard.vue b/...javascript/dashboard/routes/dashboard/settings/reports/components/overview/MetricCard.vue
@@ -1,10 +1,19 @@
 <template>
   <div class="card">
     <div class="card-header">
-      <h5>{{ header }}</h5>
-      <span class="live">
-        <span class="ellipse" /><span>{{ $t('OVERVIEW_REPORTS.LIVE') }}</span>
-      </span>
+      <slot name="header">
+        <div class="card-header--title-area">
+          <h5>{{ header }}</h5>
+          <span class="live">
+            <span class="ellipse" /><span>{{
+              $t('OVERVIEW_REPORTS.LIVE')
+            }}</span>
+          </span>
+        </div>
+        <div class="card-header--control-area">
+          <slot name="control" />
+        </div>
+      </slot>
     </div>
     <div v-if="!isLoading" class="card-body row">
       <slot />
@@ -42,37 +51,66 @@ export default {
 <style lang="scss" scoped>
 .card {
   margin: var(--space-small) !important;
+
+  .card-header--control-area {
+    opacity: 0.2;
+    transition: opacity 0.2s ease-in-out;
+  }
+
+  &:hover {
+    .card-header--control-area {
+      opacity: 1;
+    }
+  }
 }
+
 .card-header {
-  display: flex;
-  flex-direction: row;
-  align-items: center;
+  display: grid;
+  grid-template-columns: repeat(auto-fit, minmax(max-content, 50%));
+  gap: var(--space-small) 0px;
+  flex-grow: 1;
+  width: 100%;
   margin-bottom: var(--space-medium);
 
-  h5 {
-    margin-bottom: var(--zero);
-  }
-
-  .live {
+  .card-header--title-area {
     display: flex;
     flex-direction: row;
     align-items: center;
-    padding-right: var(--space-small);
-    padding-left: var(--space-small);
-    margin: var(--space-smaller);
-    background: rgba(37, 211, 102, 0.1);
-    color: var(--g-400);
-    font-size: var(--font-size-mini);
 
-    .ellipse {
-      background-color: var(--g-400);
-      height: var(--space-smaller);
-      width: var(--space-smaller);
-      border-radius: var(--border-radius-rounded);
-      margin-right: var(--space-smaller);
+    h5 {
+      margin-bottom: var(--zero);
     }
+
+    .live {
+      display: flex;
+      flex-direction: row;
+      align-items: center;
+      padding-right: var(--space-small);
+      padding-left: var(--space-small);
+      margin: var(--space-smaller);
+      background: rgba(37, 211, 102, 0.1);
+      color: var(--g-400);
+      font-size: var(--font-size-mini);
+
+      .ellipse {
+        background-color: var(--g-400);
+        height: var(--space-smaller);
+        width: var(--space-smaller);
+        border-radius: var(--border-radius-rounded);
+        margin-right: var(--space-smaller);
+      }
+    }
+  }
+
+  .card-header--control-area {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: end;
+    gap: var(--space-small);
   }
 }
+
 .card-body {
   .metric-content {
     padding-bottom: var(--space-small);

diff --git a/app/javascript/dashboard/store/modules/reports.js b/app/javascript/dashboard/store/modules/reports.js
@@ -1,7 +1,7 @@
 /* eslint no-console: 0 */
 import * as types from '../mutation-types';
 import Report from '../../api/reports';
-import { downloadCsvFile } from '../../helper/downloadHelper';
+import { downloadCsvFile, generateFileName } from '../../helper/downloadHelper';
 import AnalyticsHelper from '../../helper/AnalyticsHelper';
 import { REPORTS_EVENTS } from '../../helper/AnalyticsHelper/events';
 import {
@@ -179,6 +179,26 @@ export const actions = {
         console.error(error);
       });
   },
+  downloadAccountConversationHeatmap(_, reportObj) {
+    Report.getConversationTrafficCSV(reportObj)
+      .then(response => {
+        downloadCsvFile(
+          generateFileName({
+            type: 'Conversation traffic',
+            to: reportObj.to,
+          }),
+          response.data
+        );
+
+        AnalyticsHelper.track(REPORTS_EVENTS.DOWNLOAD_REPORT, {
+          reportType: 'conversation_heatmap',
+          businessHours: false,
+        });
+      })
+      .catch(error => {
+        console.error(error);
+      });
+  },
 };
 
 const mutations = {

diff --git a/app/views/api/v2/accounts/reports/conversation_traffic.erb b/app/views/api/v2/accounts/reports/conversation_traffic.erb
@@ -0,0 +1,12 @@
+<% headers = [
+    I18n.t('reports.conversation_traffic_csv.date'),
+    I18n.t('reports.conversation_traffic_csv.conversations_count'),
+  ]
+%>
+<%= CSVSafe.generate_line headers -%>
+<% @report_data.each do |row| %>
+<%= CSVSafe.generate_line row -%>
+<% end %>
+
+<%= CSVSafe.generate_line [I18n.t('reports.period', since: Date.strptime(params[:since], '%s'), until: Date.strptime(params[:until], '%s'))] %>
+<%= CSVSafe.generate_line [I18n.t('reports.utc_warning')] %>
diff --git a/config/locales/en.yml b/config/locales/en.yml
@@ -73,6 +73,7 @@ en:
 
   reports:
     period: Reporting period %{since} to %{until}
+    utc_warning: The report generated is in UTC timezone
     agent_csv:
       agent_name: Agent name
       conversations_count: Conversations count
@@ -94,6 +95,9 @@ en:
       conversations_count: Conversations count
       avg_first_response_time: Avg first response time (Minutes)
       avg_resolution_time: Avg resolution time (Minutes)
+    conversation_traffic_csv:
+      date: Date and time
+      conversations_count: No. of conversations
     default_group_by: day
     csat:
       headers:

diff --git a/config/routes.rb b/config/routes.rb
@@ -259,6 +259,7 @@
             get :labels
             get :teams
             get :conversations
+            get :conversation_traffic
           end
         end
       end

diff --git a/spec/controllers/api/v2/accounts/report_controller_spec.rb b/spec/controllers/api/v2/accounts/report_controller_spec.rb
@@ -363,4 +363,39 @@
       end
     end
   end
+
+  describe 'GET /api/v2/accounts/:account_id/reports/conversation_traffic' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get "/api/v2/accounts/#{account.id}/reports/conversation_traffic.csv"
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      let(:params) do
+        super().merge(
+          since: 7.days.ago.to_i.to_s,
+          until: date_timestamp.to_s
+        )
+      end
+
+      it 'returns unauthorized' do
+        get "/api/v2/accounts/#{account.id}/reports/conversation_traffic.csv",
+            params: params,
+            headers: agent.create_new_auth_token
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+
+      it 'returns values' do
+        get "/api/v2/accounts/#{account.id}/reports/conversation_traffic.csv",
+            params: params,
+            headers: admin.create_new_auth_token
+
+        expect(response).to have_http_status(:success)
+      end
+    end
+  end
 end