add shared dimensionOrderBy function

Author: RobertJoonas

assets/js/dashboard/stats/breakdowns.tsx

@@ -10,6 +10,7 @@ import {
   addFilter,
   ApiFilter,
   NonTimeDimension,
+  OrderByEntry,
   StatsQuery
 } from '../stats-query'
 import { Filter } from '../dashboard-state'
@@ -227,6 +228,14 @@ export function extractMetricValue(
   return { metricIndex, value, comparison }
 }
 
+const CANNOT_ORDER_BY_DIMENSIONS = ['event:goal']
+
+export function dimensionOrderBy(dimensions: NonTimeDimension[]) {
+  return dimensions
+    .filter((dim) => !CANNOT_ORDER_BY_DIMENSIONS.includes(dim))
+    .map((dim): OrderByEntry => [dim, 'asc'])
+}
+
 export function addDimensionSearchFilter(
   statsQuery: StatsQuery,
   dimension: string,

assets/js/dashboard/stats/modals/details-breakdown.tsx

@@ -20,7 +20,7 @@ import {
 import { SortDirection } from '../../../types/query-api'
 import { Metric, getBreakdownMetricLabel, isSortable } from '../metrics'
 import { BreakdownTable } from './breakdown-table'
-import { NonTimeDimension, OrderByEntry } from '../../stats-query'
+import { NonTimeDimension } from '../../stats-query'
 import { useSiteContext } from '../../site-context'
 import { DrilldownLink } from '../../components/drilldown-link'
 import {
@@ -31,7 +31,8 @@ import {
   useBodyPortalRef,
   extractMetricValue,
   GetFilterInfo,
-  useColumnsHiddenForAllNull
+  useColumnsHiddenForAllNull,
+  dimensionOrderBy
 } from '../breakdowns'
 import {
   QueryResultRow,
@@ -126,9 +127,7 @@ export function DetailsBreakdown({
         dimensions,
         order_by: [
           ...(orderBy.length ? orderBy : storedOrderBy),
-          ...dimensions
-            .filter((dim) => dim !== 'event:goal')
-            .map((dim): OrderByEntry => [dim, 'asc'])
+          ...dimensionOrderBy(dimensions)
         ],
         alwaysOnFilters
       },

assets/js/dashboard/stats/reports/index-breakdown.tsx

@@ -9,7 +9,7 @@ import FlipMove from 'react-flip-move'
 import LazyLoader from '../../components/lazy-loader'
 import { useDashboardStateContext } from '../../dashboard-state-context'
 import { useSiteContext } from '../../site-context'
-import { NonTimeDimension, OrderByEntry } from '../../stats-query'
+import { NonTimeDimension } from '../../stats-query'
 import { Metric, getBreakdownMetricLabel } from '../metrics'
 import {
   ColumnConfiguration,
@@ -20,7 +20,8 @@ import {
   extractMetricValue,
   MetricValueWrapper,
   GetFilterInfo,
-  useColumnsHiddenForAllNull
+  useColumnsHiddenForAllNull,
+  dimensionOrderBy
 } from '../breakdowns'
 import { DrilldownLink } from '../../components/drilldown-link'
 import { QueryResultRow, QueryResultQuery, QueryApiResponse } from '../../api'
@@ -80,12 +81,7 @@ export function IndexBreakdown({
       reportParams: {
         metrics,
         dimensions,
-        order_by: [
-          ['visitors', 'desc'],
-          ...dimensions
-            .filter((dim) => dim !== 'event:goal')
-            .map((dim): OrderByEntry => [dim, 'asc'])
-        ],
+        order_by: [['visitors', 'desc'], ...dimensionOrderBy(dimensions)],
         alwaysOnFilters,
         pagination: { limit: MAX_ITEMS, offset: 0 }
       }