From 75799c01e6fc77906eff222c14d79654284584c5 Mon Sep 17 00:00:00 2001
From: Rocky <adorack@users.noreply.github.com>
Date: Fri, 23 Feb 2024 10:29:12 -0500
Subject: [PATCH] feat(dashboard-renderer): merge context into queries
 [MA-2304] (#1178)

- Data providers are in charge of merging context -- it's different for
  metric cards vs charts.
- Pick a reasonable default for timezone if not provided.
- Translate time spec to timeframe for metric cards, unfortunately.
- Externalize `analytics-utilities` dependency
---
 .../src/components/BarChartRenderer.vue       |  1 +
 .../src/components/DashboardRenderer.vue      | 12 +++++++
 .../src/components/DashboardTile.vue          |  5 +--
 .../src/components/GoldenSignalsRenderer.vue  | 35 ++++++++++++++++++-
 .../src/components/QueryDataProvider.vue      | 27 +++++++++++---
 .../src/components/SimpleChartRenderer.vue    |  1 +
 .../components/TimeseriesChartRenderer.vue    |  1 +
 .../src/types/dashboard-renderer-types.ts     |  2 ++
 .../dashboard-renderer/vite.config.ts         |  8 ++++-
 9 files changed, 84 insertions(+), 8 deletions(-)

diff --git a/packages/analytics/dashboard-renderer/src/components/BarChartRenderer.vue b/packages/analytics/dashboard-renderer/src/components/BarChartRenderer.vue
index 02cfadc6bc..4a70cf5af1 100644
--- a/packages/analytics/dashboard-renderer/src/components/BarChartRenderer.vue
+++ b/packages/analytics/dashboard-renderer/src/components/BarChartRenderer.vue
@@ -1,6 +1,7 @@
 <template>
   <QueryDataProvider
     v-slot="{ data }"
+    :context="context"
     :query="query"
     :query-ready="queryReady"
   >
diff --git a/packages/analytics/dashboard-renderer/src/components/DashboardRenderer.vue b/packages/analytics/dashboard-renderer/src/components/DashboardRenderer.vue
index 517a66596b..d5c45b7186 100644
--- a/packages/analytics/dashboard-renderer/src/components/DashboardRenderer.vue
+++ b/packages/analytics/dashboard-renderer/src/components/DashboardRenderer.vue
@@ -15,6 +15,7 @@
       <template #tile="{ tile, style }">
         <DashboardTile
           class="tile-container"
+          :context="mergedContext"
           :definition="tile.meta"
           :height="parseInt(style.height)"
         />
@@ -61,6 +62,17 @@ const gridTiles = computed(() => {
   })
 })
 
+const mergedContext = computed(() => {
+  if (props.context.tz) {
+    return props.context
+  }
+
+  return {
+    ...props.context,
+    tz: (new Intl.DateTimeFormat()).resolvedOptions().timeZone,
+  }
+})
+
 // Right now, tiles don't have unique keys.  Perhaps in the future they will,
 // and we can use that instead of `index` as the fragment key.
 
diff --git a/packages/analytics/dashboard-renderer/src/components/DashboardTile.vue b/packages/analytics/dashboard-renderer/src/components/DashboardTile.vue
index 4b0a9ad90b..7e40cac4ec 100644
--- a/packages/analytics/dashboard-renderer/src/components/DashboardTile.vue
+++ b/packages/analytics/dashboard-renderer/src/components/DashboardTile.vue
@@ -8,8 +8,7 @@
   </div>
 </template>
 <script setup lang="ts">
-import type { TileDefinition } from '../types'
-import { ChartTypes } from '../types'
+import { ChartTypes, type DashboardRendererContext, type TileDefinition } from '../types'
 import type {
   Component,
 } from 'vue'
@@ -24,6 +23,7 @@ import GoldenSignalsRenderer from './GoldenSignalsRenderer.vue'
 
 const props = withDefaults(defineProps<{
   definition: TileDefinition,
+  context: DashboardRendererContext,
   height?: number
 }>(), {
   height: DEFAULT_TILE_HEIGHT,
@@ -45,6 +45,7 @@ const componentData = computed(() => {
     component,
     rendererProps: {
       query: props.definition.query,
+      context: props.context,
       queryReady: true, // TODO: Pipelining
       chartOptions: props.definition.chart,
       height: props.height,
diff --git a/packages/analytics/dashboard-renderer/src/components/GoldenSignalsRenderer.vue b/packages/analytics/dashboard-renderer/src/components/GoldenSignalsRenderer.vue
index 885cabcce6..469ca187a4 100644
--- a/packages/analytics/dashboard-renderer/src/components/GoldenSignalsRenderer.vue
+++ b/packages/analytics/dashboard-renderer/src/components/GoldenSignalsRenderer.vue
@@ -8,7 +8,8 @@
 <script setup lang="ts">
 import type { MetricCardOptions, RendererProps } from '../types'
 import { MetricsProviderInternal, MetricsConsumer } from '@kong-ui-public/analytics-metric-provider'
-import { computed } from 'vue'
+import { computed, type Ref } from 'vue'
+import { GranularityKeys, Timeframe, TimePeriods } from '@kong-ui-public/analytics-utilities'
 
 // Unlike AnalyticsChart, the metric card package doesn't currently expose its options
 // in a convenient interface.
@@ -16,7 +17,39 @@ type ProviderProps = InstanceType<typeof MetricsProviderInternal>['$props']
 
 const props = defineProps<RendererProps<MetricCardOptions>>()
 
+const overrideTimeframe: Ref<Timeframe> = computed(() => {
+  // Convert the timeframe to a v4 timespec.
+  // Ideally, metric cards would natively support timespecs, but for right now,
+  // we're sticking with this interface.
+  const timeSpec = props.context.timeSpec
+  if (timeSpec.type === 'absolute') {
+    return new Timeframe({
+      key: 'custom',
+      timeframeText: 'custom',
+      display: 'custom',
+      startCustom: timeSpec.start,
+      endCustom: timeSpec.end,
+      timeframeLength: () => 0,
+      defaultResponseGranularity: GranularityKeys.DAILY,
+      dataGranularity: GranularityKeys.DAILY,
+      isRelative: false,
+      allowedTiers: ['free', 'plus', 'enterprise'],
+    })
+  }
+
+  const relativePeriod = TimePeriods.get(timeSpec.time_range)
+  if (!relativePeriod) {
+    // Should never happen; if it does, at least make it clear what the problem is.
+    throw new Error('Unknown time range')
+  }
+
+  return relativePeriod
+})
+
 const options = computed<ProviderProps>(() => ({
+  overrideTimeframe: overrideTimeframe.value,
+  tz: props.context.tz,
+  additionalFilters: props.context.filters,
   longCardTitles: props.chartOptions.longCardTitles,
   description: props.chartOptions.description,
   hasTrendAccess: true,
diff --git a/packages/analytics/dashboard-renderer/src/components/QueryDataProvider.vue b/packages/analytics/dashboard-renderer/src/components/QueryDataProvider.vue
index 0b28a59a9a..2a24212791 100644
--- a/packages/analytics/dashboard-renderer/src/components/QueryDataProvider.vue
+++ b/packages/analytics/dashboard-renderer/src/components/QueryDataProvider.vue
@@ -34,12 +34,14 @@ import { computed, inject, onUnmounted, ref } from 'vue'
 import useSWRV from 'swrv'
 import { useSwrvState } from '@kong-ui-public/core'
 import composables from '../composables'
-import type { AnalyticsBridge, ExploreQuery } from '@kong-ui-public/analytics-utilities'
+import type { AnalyticsBridge, ExploreFilter, ExploreQuery } from '@kong-ui-public/analytics-utilities'
 import { INJECT_QUERY_PROVIDER } from '../constants'
+import type { DashboardRendererContext } from '../types'
 
 const props = defineProps<{
+  context: DashboardRendererContext
   query: ExploreQuery
-  queryReady: boolean,
+  queryReady: boolean
 }>()
 
 const emit = defineEmits(['queryComplete'])
@@ -51,7 +53,7 @@ const queryBridge: AnalyticsBridge | undefined = inject(INJECT_QUERY_PROVIDER)
 const queryKey = () => {
   // SWRV can't accept `false` as a key, so use a more complicated conditional to match its `IKey` interface.
   if (props.queryReady && queryBridge) {
-    return JSON.stringify(props.query)
+    return JSON.stringify([props.query, props.context])
   }
 
   return null
@@ -66,8 +68,25 @@ onUnmounted(() => {
 
 const { data: v4Data, error, isValidating } = useSWRV(queryKey, async () => {
   try {
+    const mergedFilters: ExploreFilter[] = []
+
+    if (props.query.filters) {
+      mergedFilters.push(...props.query.filters)
+    }
+
+    mergedFilters.push(...props.context.filters)
+
+    const mergedQuery: ExploreQuery = {
+      ...props.query,
+      time_range: {
+        ...props.context.timeSpec,
+        tz: props.context.tz,
+      },
+      filters: mergedFilters,
+    }
+
     // Note that queryBridge is guaranteed to be set here because SWRV won't execute the query if the key is null.
-    return queryBridge?.queryFn(props.query, abortController)
+    return queryBridge?.queryFn(mergedQuery, abortController)
   } catch (e: any) {
     // Note: 'Range not allowed' is defined by the API, therefore cannot be stored as string translation
     errorMessage.value = e?.response?.data?.message === 'Range not allowed for this tier'
diff --git a/packages/analytics/dashboard-renderer/src/components/SimpleChartRenderer.vue b/packages/analytics/dashboard-renderer/src/components/SimpleChartRenderer.vue
index 8267c7ae10..af00c4346b 100644
--- a/packages/analytics/dashboard-renderer/src/components/SimpleChartRenderer.vue
+++ b/packages/analytics/dashboard-renderer/src/components/SimpleChartRenderer.vue
@@ -1,6 +1,7 @@
 <template>
   <QueryDataProvider
     v-slot="{ data }"
+    :context="context"
     :query="query"
     :query-ready="queryReady"
   >
diff --git a/packages/analytics/dashboard-renderer/src/components/TimeseriesChartRenderer.vue b/packages/analytics/dashboard-renderer/src/components/TimeseriesChartRenderer.vue
index 3f2e5d2dbc..c3ec5fe8a2 100644
--- a/packages/analytics/dashboard-renderer/src/components/TimeseriesChartRenderer.vue
+++ b/packages/analytics/dashboard-renderer/src/components/TimeseriesChartRenderer.vue
@@ -1,6 +1,7 @@
 <template>
   <QueryDataProvider
     v-slot="{ data }"
+    :context="context"
     :query="query"
     :query-ready="queryReady"
   >
diff --git a/packages/analytics/dashboard-renderer/src/types/dashboard-renderer-types.ts b/packages/analytics/dashboard-renderer/src/types/dashboard-renderer-types.ts
index a7ab2b46ac..89353b924b 100644
--- a/packages/analytics/dashboard-renderer/src/types/dashboard-renderer-types.ts
+++ b/packages/analytics/dashboard-renderer/src/types/dashboard-renderer-types.ts
@@ -6,6 +6,7 @@ import type { ExploreFilter, ExploreQuery, TimeRangeV4 } from '@kong-ui-public/a
 export interface DashboardRendererContext {
   filters: ExploreFilter[]
   timeSpec: TimeRangeV4
+  tz?: string
 }
 
 export enum ChartTypes {
@@ -408,6 +409,7 @@ export type DashboardConfig = FromSchema<typeof dashboardConfigSchema>
 
 export interface RendererProps<T> {
   query: ExploreQuery
+  context: DashboardRendererContext
   queryReady: boolean
   chartOptions: T
   height: number
diff --git a/packages/analytics/dashboard-renderer/vite.config.ts b/packages/analytics/dashboard-renderer/vite.config.ts
index 82f8bcda76..6de0407338 100644
--- a/packages/analytics/dashboard-renderer/vite.config.ts
+++ b/packages/analytics/dashboard-renderer/vite.config.ts
@@ -18,12 +18,18 @@ const config = mergeConfig(sharedViteConfig, defineConfig({
     },
     rollupOptions: {
       // Make sure to externalize deps that shouldn't be bundled into your library
-      external: ['@kong-ui-public/analytics-chart', '@kong-ui-public/analytics-metric-provider', 'swrv'],
+      external: [
+        '@kong-ui-public/analytics-chart',
+        '@kong-ui-public/analytics-metric-provider',
+        '@kong-ui-public/analytics-utilities',
+        'swrv',
+      ],
       output: {
         // Provide global variables to use in the UMD build for externalized deps
         globals: {
           '@kong-ui-public/analytics-chart': 'kong-ui-public-analytics-chart',
           '@kong-ui-public/analytics-metric-provider': 'kong-ui-public-analytics-metric-provider',
+          '@kong-ui-public/analytics-utilities': 'kong-ui-public-analytics-utilities',
           swrv: 'swrv',
         },
       },