Skip to content

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

feat(workers): add log filters FE-4322 (#49893)

Jordi Enrica46170aa7618
diff --git a/apps/studio/components/interfaces/Workers/WorkerDetail/WorkerLogsTab.tsx b/apps/studio/components/interfaces/Workers/WorkerDetail/WorkerLogsTab.tsx
index 1056bd7295b..183af913a42 100644
--- a/apps/studio/components/interfaces/Workers/WorkerDetail/WorkerLogsTab.tsx
+++ b/apps/studio/components/interfaces/Workers/WorkerDetail/WorkerLogsTab.tsx
@@ -1,12 +1,17 @@
import { useQuery } from '@tanstack/react-query'
import { useParams } from 'common'
-import { RefreshCw } from 'lucide-react'
+import { RefreshCw, Search } from 'lucide-react'
import { useState } from 'react'
-import { Button } from 'ui'
+import { Button, InputGroup, InputGroupAddon, InputGroupInput } from 'ui'
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
import { WorkerCommandLine } from '../WorkerCommandLine'
import { WorkersLogsColumnRender } from '@/components/interfaces/Settings/Logs/LogColumnRenderers/WorkersLogsColumnRender'
+import { EXPLORER_DATEPICKER_HELPERS } from '@/components/interfaces/Settings/Logs/Logs.constants'
+import {
+ LogsDatePicker,
+ type DatePickerValue,
+} from '@/components/interfaces/Settings/Logs/Logs.DatePickers'
import type { LogData } from '@/components/interfaces/Settings/Logs/Logs.types'
import { LogTable } from '@/components/interfaces/Settings/Logs/LogTable'
import { AlertError } from '@/components/ui/AlertError'
@@ -15,6 +20,7 @@ import {
workerLogsQueryOptions,
type WorkerLogStream,
} from '@/data/workers/worker-logs-query'
+import { useDebouncedValue } from '@/hooks/misc/useDebouncedValue'
import { CLI_NAME } from '@/lib/constants/workers'
interface WorkerLogsTabProps {
@@ -22,9 +28,23 @@ interface WorkerLogsTabProps {
stream: WorkerLogStream
}
+const defaultDateRange = (): DatePickerValue => {
+ const helper = EXPLORER_DATEPICKER_HELPERS.find((helper) => helper.text === 'Last 24 hours')!
+
+ return {
+ from: helper.calcFrom(),
+ to: helper.calcTo(),
+ isHelper: true,
+ text: helper.text,
+ }
+}
+
export const WorkerLogsTab = ({ workerName, stream }: WorkerLogsTabProps) => {
const { ref: projectRef } = useParams()
const [selectedLog, setSelectedLog] = useState<LogData | null>(null)
+ const [dateRange, setDateRange] = useState<DatePickerValue>(defaultDateRange)
+ const [message, setMessage] = useState('')
+ const debouncedMessage = useDebouncedValue(message, 300)
const {
data: logs,
@@ -33,13 +53,42 @@ export const WorkerLogsTab = ({ workerName, stream }: WorkerLogsTabProps) => {
isError,
isFetching,
refetch,
- } = useQuery(workerLogsQueryOptions({ projectRef, name: workerName, stream }))
+ } = useQuery(
+ workerLogsQueryOptions({
+ projectRef,
+ name: workerName,
+ stream,
+ iso_timestamp_start: dateRange.from,
+ iso_timestamp_end: dateRange.to,
+ message: debouncedMessage,
+ })
+ )
const label = WORKER_LOG_STREAM_LABEL[stream].toLowerCase()
return (
<div className="flex flex-1 flex-col min-h-0">
- <div className="flex items-center justify-end border-b border-default px-4 py-2">
+ <div className="flex flex-wrap items-center justify-between gap-2 border-b border-default px-4 py-2">
+ <div className="flex flex-wrap items-center gap-2">
+ <LogsDatePicker
+ hideWarnings
+ value={dateRange}
+ onSubmit={setDateRange}
+ helpers={EXPLORER_DATEPICKER_HELPERS}
+ align="start"
+ />
+ <InputGroup className="w-60">
+ <InputGroupInput
+ size="tiny"
+ placeholder="Filter by event message"
+ value={message}
+ onChange={(event) => setMessage(event.target.value)}
+ />
+ <InputGroupAddon>
+ <Search />
+ </InputGroupAddon>
+ </InputGroup>
+ </div>
<Button
variant="default"
icon={<RefreshCw />}
@@ -75,7 +124,7 @@ export const WorkerLogsTab = ({ workerName, stream }: WorkerLogsTabProps) => {
onSelectedLogChange={(log) => setSelectedLog(log)}
EmptyState={
<div className="mx-auto max-w-md space-y-3 py-16 text-center">
- <p className="text-sm text-foreground">No {label} in the last 24 hours</p>
+ <p className="text-sm text-foreground">No {label} in the selected time range</p>
<p className="text-sm text-foreground-lighter">
Follow them from the Supabase CLI while you wait for traffic.
</p>
diff --git a/apps/studio/data/workers/keys.ts b/apps/studio/data/workers/keys.ts
index 9eedc104d21..cdbce564452 100644
--- a/apps/studio/data/workers/keys.ts
+++ b/apps/studio/data/workers/keys.ts
@@ -2,6 +2,14 @@ export const workersKeys = {
list: (projectRef: string | undefined) => ['projects', projectRef, 'workers'] as const,
detail: (projectRef: string | undefined, name: string | undefined) =>
['projects', projectRef, 'worker', name, 'detail'] as const,
- logs: (projectRef: string | undefined, name: string | undefined, stream: string) =>
- ['projects', projectRef, 'worker', name, 'logs', stream] as const,
+ logs: (
+ projectRef: string | undefined,
+ name: string | undefined,
+ stream: string,
+ filters: {
+ iso_timestamp_start?: string
+ iso_timestamp_end?: string
+ message?: string
+ }
+ ) => ['projects', projectRef, 'worker', name, 'logs', stream, filters] as const,
}
diff --git a/apps/studio/data/workers/worker-logs-query.test.ts b/apps/studio/data/workers/worker-logs-query.test.ts
index 2c909f8459d..baf6d79a80d 100644
--- a/apps/studio/data/workers/worker-logs-query.test.ts
+++ b/apps/studio/data/workers/worker-logs-query.test.ts
@@ -1,5 +1,6 @@
import { describe, expect, it } from 'vitest'
+import { workersKeys } from './keys'
import { parseWorkerLogRows, workerLogsSql } from './worker-logs-query'
describe('workerLogsSql', () => {
@@ -9,6 +10,12 @@ describe('workerLogsSql', () => {
)
})
+ it('filters by event message before applying the limit', () => {
+ expect(workerLogsSql('embed', 'requests', { message: 'timeout' })).toBe(
+ "select id, timestamp, severity_text as severity, event_message as message from logs where log_attributes['worker'] = 'embed' and log_attributes['source'] = 'worker_ingress_logs' and event_message ilike '%timeout%' order by timestamp desc limit 100"
+ )
+ })
+
it('names the right stream for each tab', () => {
expect(workerLogsSql('embed', 'requests')).toContain("'worker_ingress_logs'")
expect(workerLogsSql('embed', 'builds')).toContain("'worker_api_logs'")
@@ -19,6 +26,36 @@ describe('workerLogsSql', () => {
"log_attributes['worker'] = 'embed'' or ''1''=''1'"
)
})
+
+ it('escapes filter values rather than interpolating them raw', () => {
+ expect(workerLogsSql('embed', 'requests', { message: "can't connect" })).toContain(
+ "event_message ilike '%can''t connect%'"
+ )
+ })
+})
+
+describe('workersKeys.logs', () => {
+ it('includes the selected time range and filters', () => {
+ expect(
+ workersKeys.logs('project-ref', 'embed', 'requests', {
+ iso_timestamp_start: '2026-09-01T12:00:00.000Z',
+ iso_timestamp_end: '2026-09-02T12:00:00.000Z',
+ message: 'timeout',
+ })
+ ).toEqual([
+ 'projects',
+ 'project-ref',
+ 'worker',
+ 'embed',
+ 'logs',
+ 'requests',
+ {
+ iso_timestamp_start: '2026-09-01T12:00:00.000Z',
+ iso_timestamp_end: '2026-09-02T12:00:00.000Z',
+ message: 'timeout',
+ },
+ ])
+ })
})
describe('parseWorkerLogRows', () => {
diff --git a/apps/studio/data/workers/worker-logs-query.ts b/apps/studio/data/workers/worker-logs-query.ts
index eb68cd8968c..7fb4cc10ca8 100644
--- a/apps/studio/data/workers/worker-logs-query.ts
+++ b/apps/studio/data/workers/worker-logs-query.ts
@@ -1,5 +1,4 @@
import { queryOptions } from '@tanstack/react-query'
-import dayjs from 'dayjs'
import { z } from 'zod'
import { workersKeys } from './keys'
@@ -29,7 +28,6 @@ export const WORKER_LOG_STREAM_LABEL: Record<WorkerLogStream, string> = {
const WORKER_NAME_KEY = 'worker'
const STREAM_KEY = 'source'
-const LOOKBACK_HOURS = 24
const LOG_LIMIT = 100
const workerLogRowSchema = z.object({
@@ -43,10 +41,22 @@ export type WorkerLogsVariables = {
projectRef?: string
name?: string
stream: WorkerLogStream
+ iso_timestamp_start: string
+ iso_timestamp_end: string
+ message?: string
}
-export const workerLogsSql = (name: string, stream: WorkerLogStream) =>
- safeSql`select id, timestamp, severity_text as severity, event_message as message from logs where log_attributes[${analyticsLiteral(WORKER_NAME_KEY)}] = ${analyticsLiteral(name)} and log_attributes[${analyticsLiteral(STREAM_KEY)}] = ${analyticsLiteral(WORKER_LOG_SOURCES[stream])} order by timestamp desc limit ${analyticsLiteral(LOG_LIMIT)}`
+export const workerLogsSql = (
+ name: string,
+ stream: WorkerLogStream,
+ { message }: Pick<WorkerLogsVariables, 'message'> = {}
+) => {
+ const messageFilter = message
+ ? safeSql` and event_message ilike ${analyticsLiteral(`%${message}%`)}`
+ : safeSql``
+
+ return safeSql`select id, timestamp, severity_text as severity, event_message as message from logs where log_attributes[${analyticsLiteral(WORKER_NAME_KEY)}] = ${analyticsLiteral(name)} and log_attributes[${analyticsLiteral(STREAM_KEY)}] = ${analyticsLiteral(WORKER_LOG_SOURCES[stream])}${messageFilter} order by timestamp desc limit ${analyticsLiteral(LOG_LIMIT)}`
+}
export const parseWorkerLogRows = (result: unknown): LogData[] =>
z
@@ -60,30 +70,46 @@ export const parseWorkerLogRows = (result: unknown): LogData[] =>
}))
async function getWorkerLogs(
- { projectRef, name, stream }: WorkerLogsVariables,
+ {
+ projectRef,
+ name,
+ stream,
+ iso_timestamp_start,
+ iso_timestamp_end,
+ message,
+ }: WorkerLogsVariables,
signal?: AbortSignal
): Promise<LogData[]> {
if (!projectRef) throw new Error('projectRef is required')
if (!name) throw new Error('name is required')
- const end = dayjs()
- const start = end.subtract(LOOKBACK_HOURS, 'hour')
-
const data = await executeAnalyticsSql({
projectRef,
endpoint: logsAllEndpointUrl(true),
- sql: workerLogsSql(name, stream),
- iso_timestamp_start: start.toISOString(),
- iso_timestamp_end: end.toISOString(),
+ sql: workerLogsSql(name, stream, { message }),
+ iso_timestamp_start,
+ iso_timestamp_end,
signal,
})
return parseWorkerLogRows(data?.result)
}
-export const workerLogsQueryOptions = ({ projectRef, name, stream }: WorkerLogsVariables) =>
- queryOptions({
- queryKey: workersKeys.logs(projectRef, name, stream),
- queryFn: ({ signal }) => getWorkerLogs({ projectRef, name, stream }, signal),
+export const workerLogsQueryOptions = (variables: WorkerLogsVariables) => {
+ const { projectRef, name, stream, iso_timestamp_start, iso_timestamp_end } = variables
+ const message = variables.message?.trim() || undefined
+
+ return queryOptions({
+ queryKey: workersKeys.logs(projectRef, name, stream, {
+ iso_timestamp_start,
+ iso_timestamp_end,
+ message,
+ }),
+ queryFn: ({ signal }) =>
+ getWorkerLogs(
+ { projectRef, name, stream, iso_timestamp_start, iso_timestamp_end, message },
+ signal
+ ),
enabled: IS_PLATFORM && typeof projectRef !== 'undefined' && typeof name !== 'undefined',
})
+}