Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

2.2 KB
Raw Blame
import { useFlag, useParams } from 'common'
import { useCallback } from 'react'

import { resolveLogTimeRange } from '@/components/interfaces/QuerySources/LogTimeRange.utils'
import { useExecuteLogsSqlMutation } from '@/data/logs/execute-logs-sql-mutation'
import { type SafeLogSqlFragment } from '@/data/logs/safe-analytics-sql'
import {
  DEFAULT_LOG_TIME_RANGE,
  QUERY_SOURCE_REGISTRY,
} from '@/data/query-sources/query-source-registry'
import { useTrack } from '@/lib/telemetry/track'
import {
  getSqlEditorSessionSnapshot,
  useSqlEditorSessionSnapshot,
} from '@/state/sql-editor/sql-editor-session-state'

type UseLogsSqlExecutionArgs = { id: string }

/**
 * Logs counterpart to `useSqlEditorExecution`. Runs a promoted
 * `SafeLogSqlFragment` against the analytics OTEL endpoint with the snippet's
 * active time range attached as request params.
 */
export function useLogsSqlExecution({ id }: UseLogsSqlExecutionArgs) {
  const { ref: projectRef } = useParams()
  const isOtelLogsEnabled = useFlag('otelLegacyLogs')
  const track = useTrack()
  const sessionSnap = useSqlEditorSessionSnapshot()

  const { mutate, isPending: isExecuting } = useExecuteLogsSqlMutation({
    onSuccess: (data) => {
      sessionSnap.addResult(id, data.rows)
    },
    onError: (error) => {
      sessionSnap.addResultError(id, error)
    },
  })

  const executeLogsQuery = useCallback(
    (sql: SafeLogSqlFragment) => {
      if (isExecuting || projectRef === undefined) return

      if (!isOtelLogsEnabled) {
        getSqlEditorSessionSnapshot().addResultError(id, {
          message: "Querying logs from the SQL editor isn't available for this project yet.",
        })
        return
      }

      // Re-read imperatively so a range picked immediately before the run is
      // honored; relative ranges re-resolve against `now` here.
      const range = resolveLogTimeRange(
        getSqlEditorSessionSnapshot().logRange[id] ?? DEFAULT_LOG_TIME_RANGE
      )

      mutate({ projectRef, sql, range, endpoint: QUERY_SOURCE_REGISTRY.logs.endpoint })

      track('sql_editor_query_run_button_clicked', { source: 'logs' })
    },
    [id, isExecuting, isOtelLogsEnabled, mutate, projectRef, track]
  )

  return { executeLogsQuery, isExecuting }
}