Skip to content

Commit bc2ecb1

Browse files
committed
review: Address review feedback
1 parent e6ed778 commit bc2ecb1

9 files changed

Lines changed: 427 additions & 56 deletions

File tree

‎packages/app/src/components/DBEditTimeChartForm/ChartPreviewPanel.tsx‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,10 @@ type ChartPreviewPanelProps = {
178178
dbTimeChartConfig?: ChartConfigWithDateRange;
179179
/** Required dashboard filters with nothing selected that block this tile. */
180180
missingRequiredFilterNames?: string[];
181+
/** Whether turning off "Apply filters" would clear the required-filter block. */
182+
canPreviewWithoutFilters?: boolean;
183+
/** Why the current selections can't be queried, shown instead of the chart. */
184+
blockedReason?: string;
181185
setValue: (name: 'orderBy', value: string) => void;
182186
setDisplayType: (displayType: DisplayType) => void;
183187
onSubmit: () => void;
@@ -197,6 +201,8 @@ export function ChartPreviewPanel({
197201
showGeneratedPromql,
198202
dbTimeChartConfig,
199203
missingRequiredFilterNames,
204+
canPreviewWithoutFilters = false,
205+
blockedReason,
200206
setValue,
201207
setDisplayType,
202208
onSubmit,
@@ -213,8 +219,12 @@ export function ChartPreviewPanel({
213219
const blockingFilterNames = missingRequiredFilterNames ?? [];
214220
const isBlockedByRequiredFilters =
215221
blockingFilterNames.length > 0 && tabQueriesData(activeTab);
222+
const isBlocked =
223+
blockedReason != null &&
224+
!isBlockedByRequiredFilters &&
225+
tabQueriesData(activeTab);
216226
const queryReady =
217-
!isBlockedByRequiredFilters && !!isQueryReady(queriedConfig);
227+
!isBlockedByRequiredFilters && !isBlocked && !!isQueryReady(queriedConfig);
218228

219229
const onTableSortingChange = useCallback(
220230
(sortState: SortingState | null) => {
@@ -264,11 +274,22 @@ export function ChartPreviewPanel({
264274
<EmptyState
265275
description={`Missing required filters or variables: ${blockingFilterNames.join(
266276
', ',
267-
)}. Select a value for each required filter, or turn off “Apply filters” to preview this tile without them.`}
277+
)}. ${
278+
canPreviewWithoutFilters
279+
? 'Select a value for each required filter, or turn off “Apply filters” to preview this tile without them.'
280+
: 'Select a value for each one to preview this tile.'
281+
}`}
268282
variant="card"
269283
fullWidth
270284
data-testid="preview-missing-required-filters"
271285
/>
286+
) : isBlocked ? (
287+
<EmptyState
288+
description={blockedReason}
289+
variant="card"
290+
fullWidth
291+
data-testid="preview-blocked"
292+
/>
272293
) : !queryReady && tabQueriesData(activeTab) ? (
273294
<EmptyState
274295
description="Please start by defining your chart above and then click the play button to query data."

‎packages/app/src/components/DBEditTimeChartForm/EditTimeChartForm.tsx‎

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import {
1717
displayTypeSupportsRawSqlAlerts,
1818
isTimeSeriesDisplayType,
1919
} from '@hyperdx/common-utils/dist/core/utils';
20-
import { getBlockingRequiredFilters } from '@hyperdx/common-utils/dist/dashboardFilterValues';
2120
import {
2221
displayTypeRequiresSource,
2322
isRawSqlSavedChartConfig,
@@ -49,7 +48,7 @@ import {
4948
Text,
5049
Textarea,
5150
} from '@mantine/core';
52-
import { useDebouncedValue, useDisclosure, usePrevious } from '@mantine/hooks';
51+
import { useDisclosure, usePrevious } from '@mantine/hooks';
5352
import { notifications } from '@mantine/notifications';
5453
import {
5554
IconBracketsContain,
@@ -118,10 +117,12 @@ import { ChartPreviewPanel } from './ChartPreviewPanel';
118117
import { ChartSaveActions } from './ChartSaveActions';
119118
import { ErrorNotificationMessage } from './ErrorNotificationMessage';
120119
import { useBuilderToSqlConversion } from './useBuilderToSqlConversion';
120+
import { useDebouncedFormValues } from './useDebouncedFormValues';
121121
import {
122122
buildChartConfigForExplanations,
123123
computeDbTimeChartConfig,
124124
displayTypeToActiveTab,
125+
getPreviewBlockingFilters,
125126
resolveTilePreviewFilters,
126127
TABS_WITH_GENERATED_SQL,
127128
withBroadcastFilters,
@@ -411,6 +412,17 @@ export default function EditTimeChartForm({
411412
? `Select a source for $${sourceVariableName} in the filter bar to save this tile`
412413
: `The source selected for $${sourceVariableName} can't be used with this chart type`;
413414

415+
// A variable can select a source on another connection than the one a raw
416+
// SQL query runs on, which the dashboard blocks too
417+
const previewBlockedReason =
418+
isRawSqlInput &&
419+
usesReferenceVariable &&
420+
tableSource != null &&
421+
resolvedConnection != null &&
422+
tableSource.connection !== resolvedConnection
423+
? "The selected data source is on a different connection than this tile's query. Select a source on the same connection."
424+
: undefined;
425+
414426
const databaseName = tableSource?.from.databaseName;
415427
const tableName = tableSource?.from.tableName;
416428

@@ -619,37 +631,40 @@ export default function EditTimeChartForm({
619631
};
620632
}, [queriedConfig, previewDashboardFilters]);
621633

634+
const debouncedForm = useDebouncedFormValues(watch, getValues, 300);
635+
622636
// With no selection for a variable it references the tile has nothing to
623637
// query, so there may be no queried config to compute the block from.
624-
const missingRequiredFilterNames = useMemo(() => {
625-
if (previewDashboardFilters) {
626-
return previewDashboardFilters.missingRequiredFilterNames;
627-
}
628-
const unresolved = referenceVariableNames.filter(
629-
name => !referenceVariableValues.get(name),
630-
);
631-
return unresolved.length > 0
632-
? getBlockingRequiredFilters(unsatisfiedRequiredFilters ?? [], {
633-
referenceVariableNames: unresolved,
634-
consumesBroadcastFilters: false,
635-
}).map(filter => filter.name)
636-
: undefined;
638+
const previewBlockingFilters = useMemo(() => {
639+
if (previewDashboardFilters) return previewDashboardFilters;
640+
if (
641+
!referenceVariableNames.some(name => !referenceVariableValues.get(name))
642+
)
643+
return undefined;
644+
return getPreviewBlockingFilters({
645+
config: convertFormStateToSavedChartConfig(debouncedForm, tableSource),
646+
sourceId: undefined,
647+
variables,
648+
unsatisfiedRequiredFilters,
649+
applySelections: resolvedApplyFilters,
650+
referenceVariableNames,
651+
});
637652
}, [
638653
previewDashboardFilters,
639654
referenceVariableNames,
640655
referenceVariableValues,
656+
debouncedForm,
657+
tableSource,
658+
variables,
641659
unsatisfiedRequiredFilters,
660+
resolvedApplyFilters,
642661
]);
643662

644663
const dbTimeChartConfig = useMemo(
645664
() => computeDbTimeChartConfig(previewConfig, alert),
646665
[previewConfig, alert],
647666
);
648667

649-
// Casting because `useWatch` returns a deep partial type, but we know that the
650-
// form state is complete due to default values set above.
651-
const watchedForm = useWatch({ control }) as ChartEditorFormState;
652-
const [debouncedForm] = useDebouncedValue(watchedForm, 300);
653668
const additionalAlertWarnings = useMemo(() => {
654669
if (alert == null) return [];
655670
const config = convertFormStateToSavedChartConfig(
@@ -1510,7 +1525,13 @@ export default function EditTimeChartForm({
15101525
showSampleEvents={showSampleEvents}
15111526
showGeneratedPromql={isPromqlInput}
15121527
dbTimeChartConfig={dbTimeChartConfig}
1513-
missingRequiredFilterNames={missingRequiredFilterNames}
1528+
missingRequiredFilterNames={
1529+
previewBlockingFilters?.missingRequiredFilterNames
1530+
}
1531+
canPreviewWithoutFilters={
1532+
previewBlockingFilters?.canPreviewWithoutFilters
1533+
}
1534+
blockedReason={previewBlockedReason}
15141535
setValue={(name, value) => setValue(name, value)}
15151536
setDisplayType={type =>
15161537
setValue('displayType', type, { shouldDirty: true })

‎packages/app/src/components/DBEditTimeChartForm/__tests__/ChartPreviewPanel.test.tsx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,7 @@ describe('ChartPreviewPanel', () => {
514514
queriedConfig: baseBuilderConfig,
515515
dbTimeChartConfig: baseBuilderConfig,
516516
missingRequiredFilterNames: ['Service', 'Environment'],
517+
canPreviewWithoutFilters: true,
517518
};
518519

519520
it('names them instead of querying', () => {
@@ -531,6 +532,16 @@ describe('ChartPreviewPanel', () => {
531532
).not.toBeInTheDocument();
532533
});
533534

535+
it('leaves out the "Apply filters" hint when turning it off would not help', () => {
536+
renderPanel({ ...blockedProps, canPreviewWithoutFilters: false });
537+
538+
expect(
539+
screen.getByTestId('preview-missing-required-filters'),
540+
).toHaveTextContent(
541+
/^Missing required filters or variables: Service, Environment\. Select a value for each one to preview this tile\.$/,
542+
);
543+
});
544+
534545
it('does not block a markdown tile, which queries nothing', () => {
535546
renderPanel({ ...blockedProps, activeTab: 'markdown' });
536547

@@ -548,4 +559,36 @@ describe('ChartPreviewPanel', () => {
548559
).not.toBeInTheDocument();
549560
});
550561
});
562+
563+
describe('when the selections are blocked', () => {
564+
const blockedProps = {
565+
queriedConfig: baseBuilderConfig,
566+
dbTimeChartConfig: baseBuilderConfig,
567+
blockedReason: 'The selected data source is on another connection.',
568+
};
569+
570+
it('shows the reason instead of querying', () => {
571+
renderPanel(blockedProps);
572+
573+
expect(screen.getByTestId('preview-blocked')).toHaveTextContent(
574+
'The selected data source is on another connection.',
575+
);
576+
expect(screen.queryByTestId('db-time-chart')).not.toBeInTheDocument();
577+
});
578+
579+
it('shows missing required filters first', () => {
580+
renderPanel({ ...blockedProps, missingRequiredFilterNames: ['Service'] });
581+
582+
expect(
583+
screen.getByTestId('preview-missing-required-filters'),
584+
).toBeInTheDocument();
585+
expect(screen.queryByTestId('preview-blocked')).not.toBeInTheDocument();
586+
});
587+
588+
it('does not block a markdown tile, which queries nothing', () => {
589+
renderPanel({ ...blockedProps, activeTab: 'markdown' });
590+
591+
expect(screen.queryByTestId('preview-blocked')).not.toBeInTheDocument();
592+
});
593+
});
551594
});

‎packages/app/src/components/DBEditTimeChartForm/__tests__/DBEditTimeChartForm.test.tsx‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ import React from 'react';
33
import { useController as mockUseController } from 'react-hook-form';
44
import {
55
AlertThresholdType,
6+
DashboardFilter,
7+
DataSourceDashboardFilter,
68
DisplayType,
79
MetricsDataType,
810
SavedChartConfig,
@@ -13,6 +15,7 @@ import { fireEvent, screen, waitFor } from '@testing-library/react';
1315
import userEvent from '@testing-library/user-event';
1416

1517
import DBEditTimeChartForm from '@/components/DBEditTimeChartForm';
18+
import { ReferenceVariablesProvider } from '@/components/sourceSelectUtils';
1619
import { useSource } from '@/source';
1720
import { DEFAULT_TILE_ALERT } from '@/utils/alerts';
1821

@@ -40,6 +43,8 @@ jest.mock('@/hooks/useFetchMetricMetadata', () => ({
4043

4144
jest.mock('@/hooks/useMetadata', () => ({
4245
useMetadataWithSettings: jest.fn().mockReturnValue({}),
46+
// The raw SQL editor's completions
47+
useMultipleAllFields: jest.fn().mockReturnValue({ data: [] }),
4348
useGetKeyValues: jest.fn().mockReturnValue({
4449
data: [
4550
{
@@ -1585,3 +1590,114 @@ describe('DBEditTimeChartForm - Inline alerts', () => {
15851590
expect(screen.queryByTestId('remove-alert-button')).not.toBeInTheDocument();
15861591
});
15871592
});
1593+
1594+
describe('DBEditTimeChartForm - Raw SQL data source variables', () => {
1595+
const logsVariable: DataSourceDashboardFilter = {
1596+
id: 'logs',
1597+
type: 'DATA_SOURCE',
1598+
name: 'logs',
1599+
variableName: 'logs',
1600+
allowedSourceKinds: [SourceKind.Log],
1601+
minSelections: 1,
1602+
maxSelections: 1,
1603+
isBroadcastEnabled: false,
1604+
isVariableEnabled: true,
1605+
};
1606+
1607+
const rawSqlConfig: SavedChartConfig = {
1608+
configType: 'sql',
1609+
displayType: DisplayType.Table,
1610+
name: 'Raw SQL tile',
1611+
source: '$logs',
1612+
connection: 'conn-2',
1613+
sqlTemplate: 'SELECT count() FROM $__sourceTable',
1614+
};
1615+
1616+
const renderWithSelection = (sourceId: string) =>
1617+
renderWithMantine(
1618+
<QueryClientProvider client={queryClient}>
1619+
<ReferenceVariablesProvider
1620+
filters={[logsVariable]}
1621+
values={new Map([['logs', sourceId]])}
1622+
>
1623+
<DBEditTimeChartForm
1624+
chartConfig={rawSqlConfig}
1625+
dateRange={[new Date('2024-01-01'), new Date('2024-01-02')]}
1626+
dashboardId="dashboard-1"
1627+
/>
1628+
</ReferenceVariablesProvider>
1629+
</QueryClientProvider>,
1630+
);
1631+
1632+
const logSource = (connection: string) => ({
1633+
id: 'logs-source',
1634+
kind: SourceKind.Log,
1635+
name: 'Logs',
1636+
from: { databaseName: 'default', tableName: 'otel_logs' },
1637+
connection,
1638+
timestampValueExpression: 'Timestamp',
1639+
});
1640+
1641+
beforeEach(() => {
1642+
jest.clearAllMocks();
1643+
});
1644+
1645+
it("blocks the preview when the variable's source is on another connection", async () => {
1646+
mockUseSourceData(logSource('conn-1'));
1647+
renderWithSelection('logs-source');
1648+
1649+
expect(await screen.findByTestId('preview-blocked')).toHaveTextContent(
1650+
"The selected data source is on a different connection than this tile's query.",
1651+
);
1652+
});
1653+
1654+
it('blocks only on the unselected variable once filters are not applied', async () => {
1655+
const globalFilter: DashboardFilter = {
1656+
id: 'service',
1657+
type: 'QUERY_EXPRESSION',
1658+
name: 'Service',
1659+
expression: 'ServiceName',
1660+
source: 'logs-source',
1661+
minSelections: 1,
1662+
isGlobalRequirement: true,
1663+
};
1664+
mockUseSourceData(undefined);
1665+
renderWithMantine(
1666+
<QueryClientProvider client={queryClient}>
1667+
<ReferenceVariablesProvider filters={[logsVariable]} values={new Map()}>
1668+
<DBEditTimeChartForm
1669+
chartConfig={rawSqlConfig}
1670+
dateRange={[new Date('2024-01-01'), new Date('2024-01-02')]}
1671+
dashboardId="dashboard-1"
1672+
getDashboardFilters={() => []}
1673+
unsatisfiedRequiredFilters={[logsVariable, globalFilter]}
1674+
/>
1675+
</ReferenceVariablesProvider>
1676+
</QueryClientProvider>,
1677+
);
1678+
1679+
expect(
1680+
await screen.findByTestId('preview-missing-required-filters'),
1681+
).toHaveTextContent(
1682+
/^Missing required filters or variables: logs, Service\. Select a value for each required filter, or turn off “Apply filters” to preview this tile without them\.$/,
1683+
);
1684+
1685+
await userEvent.click(
1686+
screen.getByRole('switch', { name: 'Apply filters' }),
1687+
);
1688+
1689+
expect(
1690+
screen.getByTestId('preview-missing-required-filters'),
1691+
).toHaveTextContent(
1692+
/^Missing required filters or variables: logs\. Select a value for each one to preview this tile\.$/,
1693+
);
1694+
});
1695+
1696+
it("previews when the variable's source is on the tile's connection", async () => {
1697+
mockUseSourceData(logSource('conn-2'));
1698+
renderWithSelection('logs-source');
1699+
1700+
await screen.findByTestId('chart-run-query-button');
1701+
expect(screen.queryByTestId('preview-blocked')).not.toBeInTheDocument();
1702+
});
1703+
});

0 commit comments

Comments
 (0)