-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dataframe): Column variable support (#50)
- Loading branch information
1 parent
1dd516d
commit db00fa6
Showing
8 changed files
with
210 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
src/datasources/data-frame/components/DataFrameQueryEditorCommon.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| import { QueryEditorProps, CoreApp, SelectableValue } from "@grafana/data"; | ||
| import { LoadOptionsCallback } from "@grafana/ui"; | ||
| import { getWorkspaceName, getVariableOptions } from "core/utils"; | ||
| import _ from "lodash"; | ||
| import { DataFrameDataSource } from "../DataFrameDataSource"; | ||
| import { DataFrameQuery, DataFrameQueryType, ValidDataFrameQuery } from "../types"; | ||
|
|
||
| export type Props = QueryEditorProps<DataFrameDataSource, DataFrameQuery>; | ||
|
|
||
| export class DataFrameQueryEditorCommon { | ||
| readonly datasource: DataFrameDataSource; | ||
| readonly onChange: (value: DataFrameQuery) => void; | ||
| readonly query: ValidDataFrameQuery; | ||
| readonly onRunQuery: () => false | void; | ||
| readonly handleError: (error: Error) => void; | ||
|
|
||
| constructor(readonly props: Props, readonly errorHandler: (error: Error) => void) { | ||
| this.datasource = props.datasource; | ||
| this.onChange = props.onChange; | ||
| this.query = this.datasource.processQuery(props.query); | ||
| this.onRunQuery = () => props.app !== CoreApp.Explore && props.onRunQuery(); | ||
| this.handleError = errorHandler; | ||
| } | ||
|
|
||
| readonly handleQueryChange = (value: DataFrameQuery, runQuery: boolean) => { | ||
| this.onChange(value); | ||
| if (runQuery) { | ||
| this.onRunQuery(); | ||
| } | ||
| }; | ||
|
|
||
| readonly handleIdChange = (item: SelectableValue<string>) => { | ||
| if (this.query.tableId !== item.value) { | ||
| this.handleQueryChange({ ...this.query, tableId: item.value, columns: [] }, this.query.type === DataFrameQueryType.Metadata); | ||
| } | ||
| }; | ||
|
|
||
| readonly loadTableOptions = _.debounce((query: string, cb?: LoadOptionsCallback<string>) => { | ||
| Promise.all([this.datasource.queryTables(query), this.datasource.getWorkspaces()]) | ||
| .then(([tables, workspaces]) => | ||
| cb?.( | ||
| tables.map(t => ({ | ||
| label: t.name, | ||
| value: t.id, | ||
| title: t.id, | ||
| description: getWorkspaceName(workspaces, t.workspace), | ||
| })) | ||
| ) | ||
| ) | ||
| .catch(this.handleError); | ||
| }, 300); | ||
|
|
||
| readonly handleLoadOptions = (query: string, cb?: LoadOptionsCallback<string>) => { | ||
| if (!query || query.startsWith('$')) { | ||
| return cb?.(getVariableOptions(this.datasource).filter((v) => v.value?.includes(query))); | ||
| } | ||
|
|
||
| this.loadTableOptions(query, cb); | ||
| }; | ||
| } |
31 changes: 31 additions & 0 deletions
31
src/datasources/data-frame/components/DataFrameVariableQueryEditor.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import { render, screen } from '@testing-library/react'; | ||
| import React from 'react'; | ||
| import { select } from 'react-select-event'; | ||
| import { setupDataSource } from 'test/fixtures'; | ||
| import { DataFrameDataSource } from '../DataFrameDataSource'; | ||
| import { DataFrameVariableQueryEditor } from './DataFrameVariableQueryEditor'; | ||
| import { DataFrameQuery } from '../types'; | ||
|
|
||
| const onChange = jest.fn(); | ||
| const onRunQuery = jest.fn(); | ||
| const [datasource] = setupDataSource(DataFrameDataSource); | ||
|
|
||
| test('renders with no data table selected', async () => { | ||
| render(<DataFrameVariableQueryEditor {...{ onChange, onRunQuery, datasource, query: '' as unknown as DataFrameQuery }} />); | ||
|
|
||
| expect(screen.getByRole('combobox')).toHaveAccessibleDescription('Search by name or enter id'); | ||
| }); | ||
|
|
||
| test('populates data table drop-down with variables', async () => { | ||
| render(<DataFrameVariableQueryEditor {...{ onChange, onRunQuery, datasource, query: { tableId: '$test_var' } as DataFrameQuery }} />); | ||
|
|
||
| expect(screen.getByText('$test_var')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| test('user selects new data table', async () => { | ||
| render(<DataFrameVariableQueryEditor {...{ onChange, onRunQuery, datasource, query: '' as unknown as DataFrameQuery }} />); | ||
|
|
||
| await select(screen.getByRole('combobox'), '$test_var', { container: document.body }); | ||
| expect(onChange).toHaveBeenCalledWith(expect.objectContaining({ tableId: '$test_var' })); | ||
| }); | ||
|
|
Oops, something went wrong.