Files
supabase/apps/studio/tests/components/ui/QueryBlock/QueryBlock.utils.test.ts
Joshen Lim 6fd48944a8 Support multi series bar charts in explorer and chart-bar (#49241)
## Context

- Updates the BarChart in our design system to support multi series in a
similar fashion to how the LineChart already supports multi series
- Update chart renderer in explorer notebooks to support multiple Y axes
using the `MultiSelector` component
- Up to 3 y columns can be selected for now (Arbitrary limit from a
color's selection POV but also just felt like anything more and the
chart doesn't feel useful)
- Only linear scale will be supported if multiple y columns are selected
(Will switch back to linear if originally on log scale)

<img width="943" height="493" alt="image"
src="https://github.com/user-attachments/assets/2eba46f0-7e41-4544-a3ff-2bf08773d11b"
/>
<img width="946" height="497" alt="image"
src="https://github.com/user-attachments/assets/4ffe7a73-6f97-4f0d-a33a-31e4035800ab"
/>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Charts now support selecting and displaying up to three Y-axis data
series.
  * Bar and line charts render multiple series with distinct colors.
* Cumulative calculations work independently across multiple selected
series.
* Chart controls provide clearer responsive layouts and limit selections
appropriately.

* **Bug Fixes**
* Logarithmic scaling automatically switches to linear when multiple
series or unsupported values are selected.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-19 16:58:35 +08:00

210 lines
5.9 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import {
checkHasNonPositiveValues,
formatLogTick,
getCumulativeResults,
} from '@/components/ui/QueryBlock/QueryBlock.utils'
describe('checkHasNonPositiveValues', () => {
it('returns false for an empty array', () => {
expect(checkHasNonPositiveValues([], 'value')).toBe(false)
})
it('returns false when all values are positive', () => {
const data = [{ value: 1 }, { value: 2 }, { value: 100 }]
expect(checkHasNonPositiveValues(data, 'value')).toBe(false)
})
it('returns true when a value is zero', () => {
const data = [{ value: 1 }, { value: 0 }, { value: 3 }]
expect(checkHasNonPositiveValues(data, 'value')).toBe(true)
})
it('returns true when a value is negative', () => {
const data = [{ value: 5 }, { value: -1 }, { value: 3 }]
expect(checkHasNonPositiveValues(data, 'value')).toBe(true)
})
it('returns true when all values are non-positive', () => {
const data = [{ value: -5 }, { value: 0 }, { value: -1 }]
expect(checkHasNonPositiveValues(data, 'value')).toBe(true)
})
it('checks only the specified key', () => {
const data = [
{ x: -1, y: 5 },
{ x: 2, y: 10 },
]
expect(checkHasNonPositiveValues(data, 'y')).toBe(false)
expect(checkHasNonPositiveValues(data, 'x')).toBe(true)
})
it('returns false when key is absent (undefined cast to NaN is not <= 0)', () => {
const data = [{ value: 1 }, { value: 2 }]
expect(checkHasNonPositiveValues(data, 'missing')).toBe(false)
})
})
describe('formatLogTick', () => {
it('formats values below 1,000 as plain locale strings', () => {
expect(formatLogTick(0)).toBe('0')
expect(formatLogTick(1)).toBe('1')
expect(formatLogTick(999)).toBe('999')
expect(formatLogTick(500)).toBe('500')
})
it('formats values >= 1,000 with a "k" suffix', () => {
expect(formatLogTick(1_000)).toBe('1k')
expect(formatLogTick(1_500)).toBe('1.5k')
expect(formatLogTick(10_000)).toBe('10k')
expect(formatLogTick(999_999)).toBe('1,000k')
})
it('formats values >= 1,000,000 with an "M" suffix', () => {
expect(formatLogTick(1_000_000)).toBe('1M')
expect(formatLogTick(1_500_000)).toBe('1.5M')
expect(formatLogTick(10_000_000)).toBe('10M')
expect(formatLogTick(1_234_567)).toBe('1.2M')
})
it('respects maximumFractionDigits of 1', () => {
// 1,050 → 1.05k, but max 1 decimal → "1.1k" (rounded)
expect(formatLogTick(1_050)).toBe('1.1k')
// 1,049 → 1.049k → "1k" (rounded down)
expect(formatLogTick(1_049)).toBe('1k')
})
})
describe('getCumulativeResults', () => {
it('returns empty array when results are empty', () => {
expect(getCumulativeResults({ rows: [] }, { yKey: 'y' })).toEqual([])
})
it('returns empty array when results are undefined', () => {
expect(getCumulativeResults(undefined as any, { yKey: 'y' })).toEqual([])
})
it('accumulates yKey values across rows', () => {
const results = {
rows: [
{ x: 'a', y: 10 },
{ x: 'b', y: 20 },
{ x: 'c', y: 5 },
],
}
const config = {
type: 'bar' as const,
xKey: 'x',
yKey: 'y',
cumulative: true,
showLabels: false,
showGrid: false,
}
const output = getCumulativeResults(results, config)
expect(output).toEqual([
{ x: 'a', y: 10 },
{ x: 'b', y: 30 },
{ x: 'c', y: 35 },
])
})
it('accumulates each key independently when yKey is an array', () => {
const results = {
rows: [
{ x: 'a', y1: 10, y2: 1 },
{ x: 'b', y1: 20, y2: 2 },
{ x: 'c', y1: 5, y2: 3 },
],
}
const output = getCumulativeResults(results, { yKey: ['y1', 'y2'] })
expect(output).toEqual([
{ x: 'a', y1: 10, y2: 1 },
{ x: 'b', y1: 30, y2: 3 },
{ x: 'c', y1: 35, y2: 6 },
])
})
it('preserves other keys on each row', () => {
const results = {
rows: [
{ x: 'a', y: 1, label: 'foo' },
{ x: 'b', y: 2, label: 'bar' },
],
}
const config = {
type: 'bar' as const,
xKey: 'x',
yKey: 'y',
cumulative: true,
showLabels: false,
showGrid: false,
}
const output = getCumulativeResults(results, config)
expect(output[0]).toMatchObject({ x: 'a', y: 1, label: 'foo' })
expect(output[1]).toMatchObject({ x: 'b', y: 3, label: 'bar' })
})
it('handles a single row', () => {
const results = { rows: [{ x: 'a', y: 42 }] }
const config = {
type: 'bar' as const,
xKey: 'x',
yKey: 'y',
cumulative: true,
showLabels: false,
showGrid: false,
}
const output = getCumulativeResults(results, config)
expect(output).toEqual([{ x: 'a', y: 42 }])
})
// Postgres returns `bigint`, `numeric`, `money` and `count(*)` columns as
// strings, so the running total must sum numerically rather than concatenate.
it('sums numeric string yKey values instead of concatenating them', () => {
const results = {
rows: [
{ x: 'a', y: '10' },
{ x: 'b', y: '20' },
{ x: 'c', y: '30' },
],
}
const config = {
type: 'bar' as const,
xKey: 'x',
yKey: 'y',
cumulative: true,
showLabels: false,
showGrid: false,
}
const output = getCumulativeResults(results, config)
expect(output).toEqual([
{ x: 'a', y: 10 },
{ x: 'b', y: 30 },
{ x: 'c', y: 60 },
])
})
it('treats null/undefined and non-numeric yKey values as 0', () => {
const results = {
rows: [
{ x: 'a', y: null },
{ x: 'b', y: '5' },
{ x: 'c', y: undefined },
{ x: 'd', y: 'not-a-number' },
{ x: 'e', y: 4 },
],
}
const config = {
type: 'bar' as const,
xKey: 'x',
yKey: 'y',
cumulative: true,
showLabels: false,
showGrid: false,
}
const output = getCumulativeResults(results, config)
expect(output.map((row: { y: number }) => row.y)).toEqual([0, 5, 5, 5, 9])
})
})