import { LanguageMap, languages as prismLanguages } from 'prismjs'; import React, { ReactNode } from 'react'; import { Plugin, Node } from 'slate'; import { QueryEditorProps } from '@grafana/data'; import { reportInteraction } from '@grafana/runtime'; import { SlatePrism, TypeaheadOutput, SuggestionsState, QueryField, TypeaheadInput, BracesPlugin, DOMUtil, Icon, } from '@grafana/ui'; import { LocalStorageValueProvider } from 'app/core/components/LocalStorageValueProvider'; import { LokiDatasource } from '../datasource'; import LokiLanguageProvider from '../language_provider'; import { escapeLabelValueInSelector, shouldRefreshLabels } from '../language_utils'; import { LokiQuery, LokiOptions } from '../types'; import { LokiLabelBrowser } from './LokiLabelBrowser'; const LAST_USED_LABELS_KEY = 'grafana.datasources.loki.browser.labels'; function getChooserText(hasSyntax: boolean, hasLogLabels: boolean) { if (!hasSyntax) { return 'Loading labels...'; } if (!hasLogLabels) { return '(No logs found)'; } return 'Log browser'; } function willApplySuggestion(suggestion: string, { typeaheadContext, typeaheadText }: SuggestionsState): string { // Modify suggestion based on context switch (typeaheadContext) { case 'context-labels': { const nextChar = DOMUtil.getNextCharacter(); if (!nextChar || nextChar === '}' || nextChar === ',') { suggestion += '='; } break; } case 'context-label-values': { // Always add quotes and remove existing ones instead let suggestionModified = ''; if (!typeaheadText.match(/^(!?=~?"|")/)) { suggestionModified = '"'; } suggestionModified += escapeLabelValueInSelector(suggestion, typeaheadText); if (DOMUtil.getNextCharacter() !== '"') { suggestionModified += '"'; } suggestion = suggestionModified; break; } default: } return suggestion; } export interface LokiQueryFieldProps extends QueryEditorProps { ExtraFieldElement?: ReactNode; placeholder?: string; 'data-testid'?: string; } interface LokiQueryFieldState { labelsLoaded: boolean; labelBrowserVisible: boolean; } export class LokiQueryField extends React.PureComponent { plugins: Plugin[]; _isMounted = false; constructor(props: LokiQueryFieldProps) { super(props); this.state = { labelsLoaded: false, labelBrowserVisible: false }; this.plugins = [ BracesPlugin(), SlatePrism( { onlyIn: (node: Node) => node.object === 'block' && node.type === 'code_block', getSyntax: (node: Node) => 'logql', }, { ...(prismLanguages as LanguageMap), logql: this.props.datasource.languageProvider.getSyntax() } ), ]; } async componentDidMount() { this._isMounted = true; await this.props.datasource.languageProvider.start(); if (this._isMounted) { this.setState({ labelsLoaded: true }); } } componentWillUnmount() { this._isMounted = false; } componentDidUpdate(prevProps: LokiQueryFieldProps) { const { range, datasource: { languageProvider }, } = this.props; const refreshLabels = shouldRefreshLabels(range, prevProps.range); // We want to refresh labels when range changes (we round up intervals to a minute) if (refreshLabels) { languageProvider.fetchLabels(); } } onChangeLabelBrowser = (selector: string) => { this.onChangeQuery(selector, true); this.setState({ labelBrowserVisible: false }); }; onChangeQuery = (value: string, override?: boolean) => { // Send text change to parent const { query, onChange, onRunQuery } = this.props; if (onChange) { const nextQuery = { ...query, expr: value }; onChange(nextQuery); if (override && onRunQuery) { onRunQuery(); } } }; onClickChooserButton = () => { if (!this.state.labelBrowserVisible) { reportInteraction('grafana_loki_log_browser_opened', { app: this.props.app, }); } else { reportInteraction('grafana_loki_log_browser_closed', { app: this.props.app, closeType: 'logBrowserButton', }); } this.setState((state) => ({ labelBrowserVisible: !state.labelBrowserVisible })); }; onTypeahead = async (typeahead: TypeaheadInput): Promise => { const { datasource } = this.props; if (!datasource.languageProvider) { return { suggestions: [] }; } const lokiLanguageProvider = datasource.languageProvider as LokiLanguageProvider; const { history } = this.props; const { prefix, text, value, wrapperClasses, labelKey } = typeahead; const result = await lokiLanguageProvider.provideCompletionItems( { text, value, prefix, wrapperClasses, labelKey }, { history } ); return result; }; render() { const { ExtraFieldElement, query, app, datasource, placeholder = 'Enter a Loki query (run with Shift+Enter)', } = this.props; const { labelsLoaded, labelBrowserVisible } = this.state; const lokiLanguageProvider = datasource.languageProvider as LokiLanguageProvider; const cleanText = datasource.languageProvider ? lokiLanguageProvider.cleanText : undefined; const hasLogLabels = lokiLanguageProvider.getLabelKeys().length > 0; const chooserText = getChooserText(labelsLoaded, hasLogLabels); const buttonDisabled = !(labelsLoaded && hasLogLabels); return ( storageKey={LAST_USED_LABELS_KEY} defaultValue={[]}> {(lastUsedLabels, onLastUsedLabelsSave, onLastUsedLabelsDelete) => { return ( <>
{labelBrowserVisible && (
)} {ExtraFieldElement} ); }} ); } }