From f5d478757074ae172835141309c0ded53e6f8732 Mon Sep 17 00:00:00 2001
From: DevOps-zhuang <asks_zhuang@hotmail.com>
Date: Wed, 3 Jul 2024 00:13:28 +0800
Subject: [PATCH] feat: Add CopilotUsageChecker class for data analysis

The code changes include adding a new file `CopilotUsageChecker.ts` which contains the implementation of the `CopilotUsageChecker` class. This class is responsible for performing various checks on the data, such as checking for missing dates, empty breakdowns, and zero activity days. The class also provides a method `runChecks()` to run all the checks and return the results.
---
 src/api/CopilotUsageChecker.ts | 83 ++++++++++++++++++++++++++++++++++
 src/components/ApiResponse.vue | 63 ++++++++++++++++++++++++--
 2 files changed, 143 insertions(+), 3 deletions(-)
 create mode 100644 src/api/CopilotUsageChecker.ts

diff --git a/src/api/CopilotUsageChecker.ts b/src/api/CopilotUsageChecker.ts
new file mode 100644
index 00000000..49f516bf
--- /dev/null
+++ b/src/api/CopilotUsageChecker.ts
@@ -0,0 +1,83 @@
+// 首先，导入Metrics类
+import { Metrics } from '../model/Metrics';
+
+export class CopilotUsageChecker {
+    private data: Metrics[];
+    private missingDates: string[];
+    private emptyBreakdowns: string[];
+    private zeroActivityDays: string[];
+
+    constructor(jsonText: string) {
+        // Map to Metrics instances
+        this.data = JSON.parse(jsonText).map((item: any) => new Metrics(item));
+        this.missingDates = [];
+        this.emptyBreakdowns = [];
+        this.zeroActivityDays = [];
+    }
+
+    private parseISO(isoString: string): Date {
+        return new Date(isoString);
+    }
+
+    private addDays(date: Date, days: number): Date {
+        const result = new Date(date);
+        result.setDate(result.getDate() + days);
+        return result;
+    }
+
+    private differenceInCalendarDays(date1: Date, date2: Date): number {
+        const diffTime = Math.abs(date2.getTime() - date1.getTime());
+        return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+    }
+
+    private formatDate(date: Date): string {
+        return date.toISOString().split('T')[0];
+    }
+
+    private checkDatesContinuity(): void {
+        const dates = this.data.map(item => this.parseISO(item.day)).sort((a, b) => a.getTime() - b.getTime());
+        for (let i = 1; i < dates.length; i++) {
+            const diff = this.differenceInCalendarDays(dates[i], dates[i - 1]);
+            if (diff > 1) {
+                let missingDate = this.addDays(dates[i - 1], 1);
+                while (this.differenceInCalendarDays(dates[i], missingDate) > 0) {
+                    this.missingDates.push(this.formatDate(missingDate));
+                    missingDate = this.addDays(missingDate, 1);
+                }
+            }
+        }
+    }
+
+    private checkEmptyBreakdowns(): void {
+        this.data.forEach(item => { 
+            if (!item.breakdown || item.breakdown.length === 0) {
+                this.emptyBreakdowns.push(item.day);
+            }
+        });
+    }
+
+    private checkZeroActivityDays(): void {
+        this.data.forEach(item => {
+            //&& item.total_chat_turns === 0 && item.total_lines_suggested === 0, and just ignore the total_chat_turns now. will add it later.
+            if (item.total_lines_suggested === 0 ) {
+                this.zeroActivityDays.push(item.day);
+            }
+        });
+    }
+
+    public runChecks(): { missingDates: string[], emptyBreakdowns: string[], zeroActivityDays: string[], hasDataIssues: boolean } {
+        this.checkDatesContinuity();
+        this.checkEmptyBreakdowns();
+        this.checkZeroActivityDays();
+        const hasDataIssues = this.missingDates.length > 0 || this.emptyBreakdowns.length > 0 || this.zeroActivityDays.length > 0;
+        return { missingDates: this.missingDates, emptyBreakdowns: this.emptyBreakdowns, zeroActivityDays: this.zeroActivityDays, hasDataIssues };
+    }
+}
+
+// Usage example:
+// const jsonText = '...'; // JSON text from enterprise_response_sample.json
+// const checker = new CopilotUsageChecker(jsonText);
+// const { missingDates, emptyBreakdowns, zeroActivityDays,hasDataIssues } = checker.runChecks();
+// console.log("Missing dates:", missingDates);
+// console.log("Days with empty breakdowns:", emptyBreakdowns);
+// console.log("Days with zero activity:", zeroActivityDays);
\ No newline at end of file
diff --git a/src/components/ApiResponse.vue b/src/components/ApiResponse.vue
index e79658a7..98e6f97e 100644
--- a/src/components/ApiResponse.vue
+++ b/src/components/ApiResponse.vue
@@ -2,7 +2,7 @@
   <v-container>
       <!-- Displaying the JSON object -->
       <v-card max-height="575px" class="overflow-y-auto">
-          <pre ref="jsonText">{{ JSON.stringify(metrics, null, 2) }}</pre>
+          <pre ref="metricsJsonText">{{ JSON.stringify(metrics, null, 2) }}</pre>
       </v-card>
       <br>
       <div class="copy-container">
@@ -11,11 +11,18 @@
           <div v-if="showCopyMessage" :class="{'copy-message': true, 'error': isError}">{{ message }}</div>
         </transition>
       </div>
+      <br>
+      <div class="copy-container">
+        <v-btn @click="checkDataQuality">Check Data Quality</v-btn>
+        <transition name="fade">
+          <div v-if="showDataMessage" :class="{'copy-message': true, 'error': isError}">{{ message }}</div>
+        </transition>
+      </div>
       
       <br><br>
   
       <v-card max-height="575px" class="overflow-y-auto">
-          <pre ref="jsonText">{{ JSON.stringify(seats, null, 2) }}</pre>
+          <pre ref="seatsJsonText">{{ JSON.stringify(seats, null, 2) }}</pre>
       </v-card>
       <br>
       <div class="copy-container">
@@ -29,6 +36,10 @@
 
 <script lang="ts">
 import { defineComponent } from 'vue';
+import { Metrics } from '../model/Metrics';
+import { CopilotUsageChecker } from '../api/CopilotUsageChecker';
+
+
 
 export default defineComponent({
   name: 'ApiResponse',
@@ -47,6 +58,7 @@ export default defineComponent({
       vueAppScope: process.env.VUE_APP_SCOPE,
       showCopyMessage: false,
       showSeatMessage: false,
+      showDataMessage: false,
       isError: false,
       message : ''
       
@@ -54,7 +66,7 @@ export default defineComponent({
   },
   methods: {
   copyToClipboard() {
-    const jsonText = this.$refs.jsonText as HTMLElement;
+    const jsonText = this.$refs.metricsJsonText as HTMLElement;
     navigator.clipboard.writeText(jsonText.innerText)
       .then(() => {
         this.message = 'Copied to clipboard!';
@@ -71,6 +83,51 @@ export default defineComponent({
         this.showCopyMessage = false;
       }, 3000);
   },
+
+  checkDataQuality() {
+    const jsonText = this.$refs.metricsJsonText as HTMLElement;
+    const metrics = jsonText.innerText || '';
+    //check the data quality by using the CopilotUsageChecker
+    console.log('Checking data quality...');
+    console.log(jsonText.innerText);
+
+    // just return here, for test purposes
+    //return;
+    
+    try {
+      const copilotUsageChecker = new CopilotUsageChecker(metrics);
+      const { missingDates, emptyBreakdowns, zeroActivityDays,hasDataIssues } = copilotUsageChecker.runChecks();
+      if (!hasDataIssues) {
+        this.message = 'Data quality is good!';
+        this.isError = false;
+      } else {
+        this.message = 'Data quality is bad!';
+        if (missingDates.length > 0) {
+          this.message += ` Missing dates: ${missingDates.length}, Dates: ${missingDates.join(', ')};`;
+        }
+        if (emptyBreakdowns.length > 0) {
+          this.message += ` Empty breakdowns: ${emptyBreakdowns.length}, Days: ${emptyBreakdowns.join(', ')};`;
+        }
+        if (zeroActivityDays.length > 0) {
+          this.message += ` Zero activity days: ${zeroActivityDays.length}, Days: ${zeroActivityDays.join(', ')}`;
+        }
+        
+        this.isError = true;
+        console.log("Missing dates:", missingDates);
+        console.log("Days with empty breakdowns:", emptyBreakdowns);
+        console.log("Days with zero activity:", zeroActivityDays);
+      }
+    } catch (error) {
+      this.message = 'An error occurred while checking data quality!';
+      this.isError = true;
+      console.error('Error checking data quality:', error);
+    }
+
+    this.showDataMessage = true;
+      setTimeout(() => {
+        this.showDataMessage = false;
+      }, 3000);
+  },
   
   showSeatCount() {
     const seatCount = this.seats.length;