mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03: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
179 lines
5.7 KiB
TypeScript
179 lines
5.7 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
|
|
import { getWorkerStateMeta, workerUrl } from './Workers.constants'
|
|
import type { Worker } from './Workers.types'
|
|
import {
|
|
filterWorkers,
|
|
formatResources,
|
|
formatRuntime,
|
|
formatSize,
|
|
getPage,
|
|
isWorkersForbidden,
|
|
isWorkersUnavailable,
|
|
} from './Workers.utils'
|
|
import { ResponseError } from '@/types'
|
|
|
|
const worker = (overrides: Partial<Worker> & Pick<Worker, 'name'>): Worker => ({
|
|
buildState: 'active',
|
|
isDeleting: false,
|
|
runtime: 'node',
|
|
size: '2gb-1vcpu',
|
|
access: 'public',
|
|
declaredInstances: 1,
|
|
...overrides,
|
|
})
|
|
|
|
const NO_FILTERS = { search: '', state: 'all', access: 'all' } as const
|
|
|
|
describe('filterWorkers', () => {
|
|
const workers = [
|
|
worker({ name: 'embed', buildState: 'active', access: 'public' }),
|
|
worker({ name: 'resize-images', buildState: 'building', access: 'private' }),
|
|
worker({ name: 'embed-batch', buildState: 'failed', access: 'public' }),
|
|
]
|
|
|
|
it('returns every worker when no filters are set', () => {
|
|
expect(filterWorkers(workers, NO_FILTERS)).toHaveLength(3)
|
|
})
|
|
|
|
it('matches names case-insensitively on a partial term', () => {
|
|
const names = filterWorkers(workers, { ...NO_FILTERS, search: 'EMBED' }).map((w) => w.name)
|
|
expect(names).toEqual(['embed', 'embed-batch'])
|
|
})
|
|
|
|
it('ignores surrounding whitespace in the search term', () => {
|
|
expect(filterWorkers(workers, { ...NO_FILTERS, search: ' resize ' })).toHaveLength(1)
|
|
})
|
|
|
|
it('filters by build state and by access', () => {
|
|
expect(filterWorkers(workers, { ...NO_FILTERS, state: 'failed' }).map((w) => w.name)).toEqual([
|
|
'embed-batch',
|
|
])
|
|
expect(filterWorkers(workers, { ...NO_FILTERS, access: 'private' }).map((w) => w.name)).toEqual(
|
|
['resize-images']
|
|
)
|
|
})
|
|
|
|
it('combines filters', () => {
|
|
expect(filterWorkers(workers, { search: 'embed', state: 'active', access: 'public' })).toEqual([
|
|
workers[0],
|
|
])
|
|
})
|
|
})
|
|
|
|
describe('getPage', () => {
|
|
const items = Array.from({ length: 25 }, (_, index) => index)
|
|
|
|
it('returns the first window and the total page count', () => {
|
|
const page = getPage(items, 1, 10)
|
|
expect(page.items).toEqual([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
|
|
expect(page).toMatchObject({ currentPage: 1, totalPages: 3, startIndex: 0 })
|
|
})
|
|
|
|
it('returns the remainder on the last page', () => {
|
|
expect(getPage(items, 3, 10).items).toEqual([20, 21, 22, 23, 24])
|
|
})
|
|
|
|
it('clamps a page beyond the end so filtering never strands an empty page', () => {
|
|
const page = getPage(items.slice(0, 5), 3, 10)
|
|
expect(page.currentPage).toBe(1)
|
|
expect(page.items).toHaveLength(5)
|
|
})
|
|
|
|
it('reports a single page when there are no items', () => {
|
|
expect(getPage([], 1, 10)).toEqual({
|
|
items: [],
|
|
currentPage: 1,
|
|
totalPages: 1,
|
|
startIndex: 0,
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('formatSize', () => {
|
|
it('splits the memory and vCPU parts the API reports', () => {
|
|
expect(formatSize('2gb-1vcpu')).toBe('2 GB · 1 vCPU')
|
|
expect(formatSize('4gb-2vcpu')).toBe('4 GB · 2 vCPU')
|
|
})
|
|
|
|
it('falls back to the raw value for a shape it does not recognize', () => {
|
|
expect(formatSize('8gb-4vcpu-gpu')).toBe('8gb-4vcpu-gpu')
|
|
expect(formatSize('')).toBe('')
|
|
})
|
|
})
|
|
|
|
describe('formatRuntime', () => {
|
|
it('labels a known runtime', () => {
|
|
expect(formatRuntime('python')).toBe('Python 3.14')
|
|
})
|
|
|
|
it('shows the raw value for a runtime it does not know', () => {
|
|
expect(formatRuntime('rust')).toBe('rust')
|
|
})
|
|
|
|
it('reports unknown when the API omits the runtime', () => {
|
|
expect(formatRuntime(undefined)).toBe('Unknown')
|
|
})
|
|
})
|
|
|
|
describe('formatResources', () => {
|
|
it('combines size and declared instance count', () => {
|
|
expect(formatResources(worker({ name: 'embed', declaredInstances: 3 }))).toBe(
|
|
'2 GB · 1 vCPU · 3 inst'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('workers error classification', () => {
|
|
const responseError = (code?: number) => new ResponseError('Denied', code)
|
|
|
|
it('reads a 404 as the project being outside the alpha allow-list', () => {
|
|
expect(isWorkersUnavailable(responseError(404))).toBe(true)
|
|
expect(isWorkersForbidden(responseError(404))).toBe(false)
|
|
})
|
|
|
|
it('reads a 403 as a missing workers permission, not a missing enrollment', () => {
|
|
expect(isWorkersForbidden(responseError(403))).toBe(true)
|
|
expect(isWorkersUnavailable(responseError(403))).toBe(false)
|
|
})
|
|
|
|
it('leaves other failures to the generic error UI', () => {
|
|
for (const error of [responseError(500), responseError(undefined), new Error('boom'), null]) {
|
|
expect(isWorkersUnavailable(error)).toBe(false)
|
|
expect(isWorkersForbidden(error)).toBe(false)
|
|
}
|
|
})
|
|
})
|
|
|
|
describe('workerUrl', () => {
|
|
it('answers on the project domain alongside /functions/v1', () => {
|
|
expect(workerUrl({ endpoint: 'abcdefgh.supabase.co', name: 'embed' })).toBe(
|
|
'https://abcdefgh.supabase.co/workers/v1/embed'
|
|
)
|
|
})
|
|
|
|
it('honors a non-https protocol', () => {
|
|
expect(workerUrl({ endpoint: 'localhost:8000', protocol: 'http', name: 'embed' })).toBe(
|
|
'http://localhost:8000/workers/v1/embed'
|
|
)
|
|
})
|
|
|
|
it('has no url until the project settings resolve', () => {
|
|
expect(workerUrl({ endpoint: undefined, name: 'embed' })).toBeUndefined()
|
|
})
|
|
})
|
|
|
|
describe('getWorkerStateMeta', () => {
|
|
it('labels every build state', () => {
|
|
expect(getWorkerStateMeta(worker({ name: 'a', buildState: 'building' })).label).toBe('Building')
|
|
expect(getWorkerStateMeta(worker({ name: 'a', buildState: 'active' })).label).toBe('Active')
|
|
expect(getWorkerStateMeta(worker({ name: 'a', buildState: 'failed' })).label).toBe('Failed')
|
|
})
|
|
|
|
it('reports deleting over the build state', () => {
|
|
expect(
|
|
getWorkerStateMeta(worker({ name: 'a', buildState: 'active', isDeleting: true })).label
|
|
).toBe('Deleting')
|
|
})
|
|
})
|