SQL Expressions: Mount front-end component right first time (#103087)

* Call onChange method once on render so we have access to the value on init

---------

Co-authored-by: Tom Ratcliffe <tom.ratcliffe@grafana.com>
This commit is contained in:
Sam Jewell
2025-04-01 11:49:39 -04:00
committed by GitHub
co-authored by Tom Ratcliffe
parent 2d89b16d7e
commit cd30742616
2 changed files with 59 additions and 0 deletions
@@ -0,0 +1,50 @@
import { render } from '@testing-library/react';
import { ExpressionQuery } from '../types';
import { SqlExpr } from './SqlExpr';
jest.mock('@grafana/ui', () => ({
...jest.requireActual('@grafana/ui'),
useStyles2: jest.fn().mockImplementation(() => ({})),
}));
jest.mock('@grafana/plugin-ui', () => ({
SQLEditor: () => <div data-testid="sql-editor">SQL Editor Mock</div>,
}));
describe('SqlExpr', () => {
it('initializes new expressions with default query', () => {
const onChange = jest.fn();
const refIds = [{ value: 'A' }];
const query = { refId: 'expr1', type: 'sql', expression: '' } as ExpressionQuery;
render(<SqlExpr onChange={onChange} refIds={refIds} query={query} />);
// Verify onChange was called
expect(onChange).toHaveBeenCalled();
// Verify essential SQL structure without exact string matching
const updatedQuery = onChange.mock.calls[0][0];
expect(updatedQuery.expression.toUpperCase()).toContain('SELECT');
});
it('preserves existing expressions when mounted', () => {
const onChange = jest.fn();
const refIds = [{ value: 'A' }];
const existingExpression = 'SELECT 1 AS foo';
const query = { refId: 'expr1', type: 'sql', expression: existingExpression } as ExpressionQuery;
render(<SqlExpr onChange={onChange} refIds={refIds} query={query} />);
// Check if onChange was called
if (onChange.mock.calls.length > 0) {
// If called, ensure it didn't change the expression value
const updatedQuery = onChange.mock.calls[0][0];
expect(updatedQuery.expression).toBe(existingExpression);
}
// The SQLEditor should receive the existing expression
expect(query.expression).toBe(existingExpression);
});
});
@@ -60,6 +60,15 @@ LIMIT 10`;
return () => resizeObserver.disconnect();
}, []);
useEffect(() => {
// Call the onChange method once so we have access to the initial query in consuming components
// But only if expression is empty
if (!query.expression) {
onEditorChange(initialQuery);
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
return (
<div ref={containerRef} className={styles.editorContainer}>
<SQLEditor