chore: comments

Author: janhenrikoverland

src/modules/dimensions.js

@@ -1,3 +1,7 @@
+// vis: 'dimension' in EventVisualization colums/rows/filters
+// dim: tracker analytics api dimension/filter id
+// header: tracker analytics api header name (query endpoints)
+
 const EVENT_DIMENSIONS = [
     {
         vis: 'ou',

src/modules/eventVisualization/eventVisualization.js

@@ -1,6 +1,9 @@
 import { getHeaderByVis } from '../dimensions.js'
 import { layoutGetAllDimensions } from '../layout/layoutGetAllDimensions.js'
 
+// Dimensions saved with program or program stage in an EventVisualization need
+// transformation before we can pass them to the pivot table engine
+
 export const transformEventVisualization = (vis) => {
     // Do not modify the original visualization
     const transformedVis = {
@@ -19,7 +22,7 @@ export const transformEventVisualization = (vis) => {
 
     let headerName
 
-    layoutGetAllDimensions(vis).forEach((dim) => {
+    layoutGetAllDimensions(transformedVis).forEach((dim) => {
         headerName = getHeaderByVis(dim.dimension)
 
         if (dim.program?.id) {
@@ -30,4 +33,6 @@ export const transformEventVisualization = (vis) => {
             dim.dimension = headerName
         }
     })
+
+    return transformedVis
 }

src/modules/response/event/response.js

@@ -20,6 +20,11 @@ import {
 import { applyDefaultHandler } from './default.js'
 import { applyOptionSetHandler } from './optionSet.js'
 
+// Responses coming from these endpoints need transformation
+// before we can pass it to the pivot table engine:
+// - analytics/events/aggregate
+// - analytics/enrollments/aggregate
+
 export const PREFIX_SEPARATOR = '_'
 export const NA_VALUE = ''
 export const NA_VALUE_ITEM = {
@@ -119,7 +124,6 @@ export const transformResponse = (response, { hideNaData = false } = {}) => {
     // Skip unsupported value types
     // Option set and Boolean have separate handlers
     // All other types use default handler with specific item formatter
-    console.log('metaHeaders', metaHeaders)
     metaHeaders.forEach((header) => {
         if (
             !(