:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { Monaco } from '@monaco-editor/react'
import clsx from 'clsx'
import { useActions, useValues } from 'kea'
import { router } from 'kea-router'
import type { editor as importedEditor } from 'monaco-editor'
import { useEffect, useRef, useState } from 'react'
import { IconMagicWand } from '@posthog/icons'
import { LemonInput, Link } from '@posthog/lemon-ui'
import { useOnMountEffect } from 'lib/hooks/useOnMountEffect'
import { LemonBanner } from 'lib/lemon-ui/LemonBanner'
import { LemonButton } from 'lib/lemon-ui/LemonButton'
import { CodeEditor } from 'lib/monaco/CodeEditor'
import { CodeEditorLogicProps, codeEditorLogic } from 'lib/monaco/codeEditorLogic'
import { dataWarehouseSettingsSceneLogic } from 'scenes/data-warehouse/settings/dataWarehouseSettingsSceneLogic'
import { urls } from 'scenes/urls'
import { HogQLQuery } from '~/queries/schema/schema-general'
import { hogQLQueryEditorLogic } from './hogQLQueryEditorLogic'
export interface HogQLQueryEditorProps {
query: HogQLQuery
setQuery?: (query: HogQLQuery) => void
onChange?: (query: string) => void
embedded?: boolean
editorFooter?: (hasErrors: boolean, errors: string | null) => JSX.Element
queryResponse?: Record<string, any>
}
let uniqueNode = 0
const EDITOR_HEIGHT = 222
export function HogQLQueryEditor(props: HogQLQueryEditorProps): JSX.Element {
const editorRef = useRef<HTMLDivElement | null>(null)
const [key, setKey] = useState(() =>
router.values.location.pathname.includes(urls.sqlEditor()) ? router.values.location.pathname : uniqueNode++
)
useEffect(() => {
if (router.values.location.pathname.includes(urls.sqlEditor())) {
setKey(router.values.location.pathname)
}
// eslint-disable-next-line react-hooks/exhaustive-deps -- intentionally re-run to reset the editor key when the SQL editor route changes
}, [router.values.location.pathname])
const [monacoAndEditor, setMonacoAndEditor] = useState(
null as [Monaco, importedEditor.IStandaloneCodeEditor] | null
)
const [monaco, editor] = monacoAndEditor ?? []
const hogQLQueryEditorLogicProps = {
query: props.query,
setQuery: props.setQuery,
onChange: props.onChange,
key,
editor,
monaco,
queryResponse: props.queryResponse,
}
const logic = hogQLQueryEditorLogic(hogQLQueryEditorLogicProps)
const { queryInput, prompt, aiAvailable, promptError, promptLoading } = useValues(logic)
const { setQueryInput, saveQuery, setPrompt, draftFromPrompt, draftFromMetadataFix, saveAsView, onUpdateView } =
useActions(logic)
const codeEditorKey = `hogQLQueryEditor/${key}`
const codeEditorLogicProps: CodeEditorLogicProps = {
key: codeEditorKey,
sourceQuery: props.query,
query: queryInput,
language: 'hogQL',
metadataFilters: props.query.filters,
}
const { hasErrors, error } = useValues(codeEditorLogic(codeEditorLogicProps))
const { editingView } = useValues(
dataWarehouseSettingsSceneLogic({
monaco,
editor,
})
)
// Clear editor state on unmount to avoid holding references to disposed editor
useOnMountEffect(() => {
return () => {
setMonacoAndEditor(null)
}
})
return (
<div className="flex items-start gap-2">
<div
data-attr="hogql-query-editor"
className={clsx(
'flex flex-col rounded deprecated-space-y-2 w-full overflow-hidden',
!props.embedded && 'p-2 border'
)}
>
<div className="flex gap-2">
<LemonInput
className="grow"
prefix={<IconMagicWand />}
value={prompt}
onPressEnter={() => draftFromPrompt()}
onChange={(value) => setPrompt(value)}
placeholder={
aiAvailable
? 'What do you want to know? How would you like to tweak the query?'
: 'To use AI features, set environment variable OPENAI_API_KEY for this instance of PostHog'
}
disabled={!aiAvailable}
maxLength={400}
/>
<LemonButton
type="primary"
onClick={() => draftFromPrompt()}
disabledReason={
!aiAvailable
? 'Environment variable OPENAI_API_KEY is unset for this instance of PostHog'
: !prompt
? 'Provide a prompt first'
: null
}
tooltipPlacement="left"
loading={promptLoading}
>
Think
</LemonButton>
</div>
{promptError ? <LemonBanner type="warning">{promptError}</LemonBanner> : null}
<div className="relative flex-1 overflow-hidden flex-col">
{/* eslint-disable-next-line react/forbid-dom-props */}
<div ref={editorRef} className="resize-y overflow-hidden" style={{ height: EDITOR_HEIGHT }}>
<CodeEditor
queryKey={codeEditorKey}
sourceQuery={props.query}
className="border rounded-b overflow-hidden h-full"
language="hogQL"
value={queryInput}
onChange={(v) => {
setQueryInput(v ?? '')
}}
height="100%"
onFixWithAI={(prompt) => draftFromMetadataFix(prompt)}
onMount={(editor, monaco) => {
setMonacoAndEditor([monaco, editor])
}}
onPressCmdEnter={(value, selectionType) => {
if (value && selectionType === 'selection') {
saveQuery(value)
} else {
saveQuery()
}
}}
options={{
minimap: {
enabled: false,
},
wordWrap: 'on',
scrollBeyondLastLine: false,
automaticLayout: true,
fixedOverflowWidgets: true,
suggest: {
showInlineDetails: true,
},
quickSuggestionsDelay: 300,
}}
/>
</div>
</div>
<div className="flex flex-row px-px">
{props.editorFooter ? (
props.editorFooter(hasErrors, error)
) : (
<>
<div className="flex-1">
<LemonButton
onClick={() => saveQuery()}
type="primary"
disabledReason={
!props.setQuery
? 'No permission to update'
: hasErrors
? (error ?? 'Query has errors')
: undefined
}
center
fullWidth
data-attr="hogql-query-editor-save"
>
{!props.setQuery ? 'No permission to update' : 'Update and run'}
</LemonButton>
</div>
{editingView ? (
<LemonButton
className="ml-2"
onClick={onUpdateView}
type="primary"
center
disabledReason={hasErrors ? (error ?? 'Query has errors') : ''}
data-attr="hogql-query-editor-update-view"
>
Update view
</LemonButton>
) : (
<LemonButton
className="ml-2"
onClick={saveAsView}
type="primary"
center
disabledReason={hasErrors ? (error ?? 'Query has errors') : ''}
data-attr="hogql-query-editor-save-as-view"
tooltip={
<div>
Save a query as a view that can be referenced in another query. This is
useful for modeling data and organizing large queries into readable chunks.{' '}
<Link to="https://posthog.com/docs/data-warehouse">More Info</Link>{' '}
</div>
}
>
Save as view
</LemonButton>
)}
</>
)}
</div>
</div>
</div>
)
}