From 8cc8b2501e154e8761448271ad114d3d247a721b Mon Sep 17 00:00:00 2001
From: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
Date: Tue, 30 May 2023 14:45:12 +0000
Subject: [PATCH] Bug 34587: Add reports by metric types

Adds the ability to generate a report with the individual metric types as columns

Signed-off-by: Jessica Zairo <jzairo@bywatersolutions.com>
Signed-off-by: Michaela Sieber <michaela.sieber@kit.edu>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
---
 api/v1/swagger/paths/erm_usage_titles.yaml    |  2 +-
 .../ERM/UsageStatisticsReportBuilder.vue      | 51 ++++++++++++------
 .../ERM/UsageStatisticsReportsViewer.vue      | 53 +++++++++++++------
 3 files changed, 71 insertions(+), 35 deletions(-)

diff --git a/api/v1/swagger/paths/erm_usage_titles.yaml b/api/v1/swagger/paths/erm_usage_titles.yaml
index 9e553de098..112af70d52 100644
--- a/api/v1/swagger/paths/erm_usage_titles.yaml
+++ b/api/v1/swagger/paths/erm_usage_titles.yaml
@@ -110,4 +110,4 @@
           $ref: "../swagger.yaml#/definitions/error"
     x-koha-authorization:
       permissions:
-        erm: 1
\ No newline at end of file
+        erm: 1
diff --git a/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportBuilder.vue b/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportBuilder.vue
index ba92c58e53..2920a21d21 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportBuilder.vue
+++ b/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportBuilder.vue
@@ -8,24 +8,28 @@
                     <ol>
                         <li>
                             <label for="interval"
-                                >{{ $__("Monthly or yearly totals?") }}:</label
+                                >{{ $__("Data display") }}:</label
                             >
                             <v-select
                                 id="interval"
-                                v-model="query.interval"
+                                v-model="query.data_display"
                                 label="description"
                                 :reduce="interval => interval.value"
                                 :options="[
                                     {
                                         value: 'monthly',
-                                        description: 'Monthly',
+                                        description: 'By month',
                                     },
                                     {
                                         value: 'monthly_with_totals',
                                         description:
-                                            'Monthly with period total',
+                                            'By month with period total',
+                                    },
+                                    { value: 'yearly', description: 'By year' },
+                                    {
+                                        value: 'metric_type',
+                                        description: 'By metric type',
                                     },
-                                    { value: 'yearly', description: 'Yearly' },
                                 ]"
                             />
                         </li>
@@ -102,7 +106,9 @@
                                 label="description"
                                 :reduce="month => month.value"
                                 :options="months_data"
-                                :disabled="query.interval.includes('yearly')"
+                                :disabled="
+                                    query.data_display.includes('yearly')
+                                "
                             />
                         </li>
                         <li>
@@ -128,7 +134,9 @@
                                 label="description"
                                 :reduce="month => month.value"
                                 :options="months_data"
-                                :disabled="query.interval.includes('yearly')"
+                                :disabled="
+                                    query.data_display.includes('yearly')
+                                "
                             />
                         </li>
                         <li>
@@ -171,7 +179,7 @@
                         </li>
                     </ol>
                 </div>
-                <div v-if="query.interval.includes('monthly')">
+                <div v-if="query.data_display.includes('monthly')">
                     <h3>{{ $__("Select date display method") }}</h3>
                     <div class="date_display">
                         <label
@@ -368,7 +376,7 @@ export default {
                 },
             },
             query: {
-                interval: "monthly",
+                data_display: "monthly",
                 report_type: null,
                 metric_types: null,
                 usage_data_providers: null,
@@ -481,7 +489,7 @@ export default {
             e.preventDefault()
 
             this.query = {
-                interval: "monthly",
+                data_display: "monthly",
                 report_type: null,
                 metric_types: null,
                 usage_data_providers: null,
@@ -500,7 +508,7 @@ export default {
             const {
                 start_year,
                 end_year,
-                interval,
+                data_display,
                 report_type,
                 metric_types,
             } = queryObject
@@ -533,13 +541,16 @@ export default {
                 queryObject.metric_types = final_metric_types
             }
 
-            const url = interval.includes("monthly")
+            const metric_report_type =
+                data_display === "metric_type" ? true : false
+            const url = !data_display.includes("yearly")
                 ? this.build_monthly_url_query(
                       queryObject,
-                      this.time_period_columns_builder
+                      this.time_period_columns_builder,
+                      metric_report_type
                   )
                 : this.build_yearly_url_query(queryObject)
-            const type = interval
+            const type = data_display
             const columns = this.defineColumns(
                 this.title_property_column_options
             )
@@ -547,7 +558,7 @@ export default {
             this.setReportURL(url)
             this.setQuery(queryObject)
             this.setTimePeriodColumns(this.time_period_columns_builder)
-            if (interval.includes("monthly")) {
+            if (data_display.includes("monthly")) {
                 this.setYearlyFilter(this.yearly_filter_required)
             } else {
                 this.setYearlyFilter(false)
@@ -652,8 +663,14 @@ export default {
 
             this.time_period_columns_builder = time_period_columns
         },
-        build_monthly_url_query(query, time_period_columns) {
-            let url = "/api/v1/erm/usage_titles/monthly_report"
+        build_monthly_url_query(
+            query,
+            time_period_columns,
+            metric_type_report
+        ) {
+            let url = metric_type_report
+                ? "/api/v1/erm/usage_titles/metric_types_report"
+                : "/api/v1/erm/usage_titles/monthly_report"
             // Work out which years are included in the query
             const years = []
             const {
diff --git a/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportsViewer.vue b/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportsViewer.vue
index dbc23b3f15..2336574a6e 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportsViewer.vue
+++ b/koha-tmpl/intranet-tmpl/prog/js/vue/components/ERM/UsageStatisticsReportsViewer.vue
@@ -45,9 +45,7 @@ export default {
 
         const report_type = getReportType()
         const embed =
-            report_type === "monthly" || report_type === "monthly_with_totals"
-                ? ["erm_usage_muses"]
-                : ["erm_usage_yuses"]
+            report_type === "yearly" ? ["erm_usage_yuses"] : ["erm_usage_muses"]
 
         const years = Object.keys(getTimePeriodColumns())
         const year = ref(years[years.length - 1])
@@ -73,10 +71,7 @@ export default {
             building_table: false,
             initialized: false,
             tableOptions: {
-                columns: this.buildColumnArray(
-                    this.report_type,
-                    this.sum_totals
-                ),
+                columns: this.buildColumnArray(this.report_type),
                 options: { embed: this.embed },
                 url: () => this.tableURL(this.year),
                 table_settings: this.report_type.includes("monthly")
@@ -85,8 +80,6 @@ export default {
                 add_filters: true,
             },
             yearly_filter: null,
-            report_ready: false,
-            sum_totals: false,
         }
     },
     methods: {
@@ -95,17 +88,20 @@ export default {
             const months_data = this.getMonthsData()
             const time_period_columns = this.getTimePeriodColumns()
             const yearly_filter = this.getYearlyFilter()
+            const query = this.getQuery()
 
             const column_set = [...columns]
             // Add metric type to each row
-            column_set.push({
-                title: __("Metric"),
-                render: function (data, type, row, meta) {
-                    return row.metric_type
-                },
-                searchable: true,
-                orderable: true,
-            })
+            if (report_type !== "metric_type") {
+                column_set.push({
+                    title: __("Metric"),
+                    render: function (data, type, row, meta) {
+                        return row.metric_type
+                    },
+                    searchable: true,
+                    orderable: true,
+                })
+            }
 
             // Add monthly columns
             if (yearly_filter) {
@@ -187,6 +183,29 @@ export default {
                         })
                     })
                 }
+                if (report_type === "metric_type") {
+                    const metric_types = query.metric_types
+                    metric_types.forEach(metric => {
+                        column_set.push({
+                            title: __(metric),
+                            render: function (data, type, row, meta) {
+                                const filterByMetric =
+                                    row.erm_usage_muses.filter(
+                                        item => item.metric_type === metric
+                                    )
+                                const period_total = filterByMetric.reduce(
+                                    (acc, item) => {
+                                        return acc + item.usage_count
+                                    },
+                                    0
+                                )
+                                return period_total
+                            },
+                            searchable: true,
+                            orderable: true,
+                        })
+                    })
+                }
             }
             // Add totals column if required
             if (report_type === "monthly_with_totals") {
-- 
2.20.1