mirror of
https://github.com/supabase/supabase.git
synced 2026-09-08 10:59:38 +08:00
## What
The Workers list page at `/project/[ref]/workers`, behind
`useFlag('workers')`. Reads `GET /v2/projects/{ref}/workers`.
- Sidebar and command-menu entries, both hidden when the flag is off
- Name search, state and access filters, pagination
- Read-only
Gating, in order: flag off redirects to the project home; a 404 from the
API means the project is outside the alpha allow-list ("not enabled for
this project"); a 403 means the caller lacks the permission
(`NoPermission`); anything else is an `AlertError`.
`parseWorker` in `data/workers/workers.utils.ts` is the only place the
API shape becomes the view model. It validates with zod, so a drifted
response fails the query instead of half-rendering a row.
## How to test
Only on the **Mockamaster** project in staging — it is the one project
in the alpha allow-list, and standing a worker up anywhere else is
involved right now.
1. Staging dashboard → Mockamaster → **Compute** in the sidebar
2. Expect the `dashboard-test` worker: state `Active`, runtime Deno,
private, US West, 2 GB · 1 vCPU · 1 inst
3. Open any other project's `/workers` URL → "Compute is not enabled for
this project"
4. Turn the `workers` flag off → the sidebar entry disappears and the
URL redirects to the project home
Closes FE-4188
32 lines
1.1 KiB
TypeScript
32 lines
1.1 KiB
TypeScript
import { queryOptions } from '@tanstack/react-query'
|
|
|
|
import { workersKeys } from './keys'
|
|
import { parseWorker } from './workers.utils'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import { IS_PLATFORM } from '@/lib/constants'
|
|
import type { ResponseError } from '@/types'
|
|
|
|
export type WorkersVariables = { projectRef?: string }
|
|
export type WorkersError = ResponseError
|
|
|
|
async function getWorkers({ projectRef }: WorkersVariables, signal?: AbortSignal) {
|
|
if (!projectRef) throw new Error('projectRef is required')
|
|
|
|
const { data, error } = await get('/v2/projects/{ref}/workers', {
|
|
params: { path: { ref: projectRef } },
|
|
signal,
|
|
})
|
|
|
|
if (error) return handleError(error)
|
|
return data.data.map((worker) => parseWorker(worker))
|
|
}
|
|
|
|
export type WorkersData = Awaited<ReturnType<typeof getWorkers>>
|
|
|
|
export const workersQueryOptions = ({ projectRef }: WorkersVariables) =>
|
|
queryOptions({
|
|
queryKey: workersKeys.list(projectRef),
|
|
queryFn: ({ signal }) => getWorkers({ projectRef }, signal),
|
|
enabled: IS_PLATFORM && typeof projectRef !== 'undefined',
|
|
})
|