[Feature] Change month dimension to yearMonth and format

18F · Oct 31, 2024 · a91f411 · a91f411
1 parent 40afa50
commit a91f411
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 21 deletions.
diff --git a/reports/usa.json b/reports/usa.json
@@ -26,7 +26,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "screenResolution"
@@ -135,7 +135,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "screenResolution"
@@ -245,7 +245,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "language"
@@ -401,7 +401,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "deviceCategory"
@@ -510,7 +510,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "deviceCategory"
@@ -619,7 +619,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "mobileDeviceModel"
@@ -728,7 +728,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "operatingSystem"
@@ -837,7 +837,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "operatingSystem"
@@ -946,7 +946,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "operatingSystemVersion"
@@ -1063,7 +1063,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "operatingSystemVersion"
@@ -1180,7 +1180,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "browser"
@@ -1289,7 +1289,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "browser"
@@ -1395,7 +1395,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "browser"
@@ -1548,7 +1548,7 @@
       "query": {
         "dimensions": [
           {
-            "name": "month"
+            "name": "yearMonth"
           },
           {
             "name": "browser"

diff --git a/src/process_results/analytics_data_processor.js b/src/process_results/analytics_data_processor.js
@@ -162,13 +162,6 @@ class AnalyticsDataProcessor {
     return data;
   }
 
-  #formatDate(date) {
-    if (date == "(other)") {
-      return date;
-    }
-    return [date.substr(0, 4), date.substr(4, 2), date.substr(6, 2)].join("-");
-  }
-
   #processRow({ hostname, row, data }) {
     const point = {};
 
@@ -189,6 +182,8 @@ class AnalyticsDataProcessor {
 
             if (field === "date") {
               modValue = this.#formatDate(value);
+            } else if (field === "yearMonth") {
+              modValue = this.#formatYearMonth(value);
             } else {
               modValue = value;
             }
@@ -212,6 +207,20 @@ class AnalyticsDataProcessor {
     const name = data[targetKey][index].name;
     return this.#mapping[name] || name;
   }
+
+  #formatDate(date) {
+    if (date == "(other)") {
+      return date;
+    }
+    return [date.substr(0, 4), date.substr(4, 2), date.substr(6, 2)].join("-");
+  }
+
+  #formatYearMonth(value) {
+    const year = parseInt(value.substring(0, 4));
+    const monthIndex = parseInt(value.slice(3)) - 1;
+    const date = new Date(year, monthIndex);
+    return date.toLocaleString("en-us", { month: "long", year: "numeric" });
+  }
 }
 
 module.exports = AnalyticsDataProcessor;
diff --git a/test/process_results/analytics_data_processor.test.js b/test/process_results/analytics_data_processor.test.js
@@ -84,6 +84,14 @@ describe("AnalyticsDataProcessor", () => {
         expect(result.data[0].date).to.equal("2017-01-30");
       });
 
+      it("should format yearMonth values", () => {
+        data.dimensionHeaders = [{ name: "yearMonth" }];
+        data.rows = [{ dimensionValues: [{ value: "202010" }] }];
+
+        const result = subject.processData({ report, data });
+        expect(result.data[0].yearMonth).to.equal("October 2020");
+      });
+
       it("should not format dates with value (other)", () => {
         data.dimensionHeaders = [{ name: "date" }];
         data.rows = [{ dimensionValues: [{ value: "(other)" }] }];