Files
supabase/apps/docs/content/guides/functions/error-codes.mdx
T
Miranda Limonczenko 7ce4ee53ae chore(docs) Retire supa-mdx-lint (#50602)
Closes
[DOCS-1289](https://linear.app/supabase/issue/DOCS-1289/get-the-linter-to-fix-what-it-flags-or-retirereplace-the-linter)

Stacked on #50600, which points contributors at the authoring skills.
Merge that one first.

## Problem

Contributors experienced friction with the linter. They felt nickle and
dimed for tiny nits and felt detracted from the work itself. PRs would
become noisy with tiny one-word suggestions.

Additionally, our homegrown linter is not very intelligent, causing
frequent overrides.

## Solution

This removes the linter entirely in favor of directing contributors to
use SKILLS instead.

The removal entails...

- **CI.** Delete the three `docs_lint` workflows: the PR check, the
external-PR comment companion, and the nightly `--fix` bot. Drop the
stale `zizmor.yml` ignore entry for the deleted workflow.
- **Tooling.** Delete `supa-mdx-lint.config.toml` and the 14 rule files.
Drop the `lint:mdx` script and the `@supabase/supa-mdx-lint` dependency
from docs, learn, and ui-library, and regenerate the lockfile.
- **Content.** Remove the 181 directives. A separate commit carries
Prettier's reformatting of the tables and blank lines those comments had
suppressed, so the deletion commit stays readable. No prose changes.
- **Style guide.** The word list states each rule directly instead of
describing what the linter flagged. Every term survives, including the
phrase groups that mirrored `Rule004ExcludeWords`.
- **Skills.** `write-the-docs`, `edit-the-docs`, and `review-the-docs`
drop `pnpm lint:mdx` from their self-review commands and check the word
list directly. `ask-the-docs`'s CI reference drops both workflows.

## Manual testing

1. Run `git grep -i supa-mdx-lint -- . ':!pnpm-lock.yaml'`. No matches.
2. Run `pnpm install --frozen-lockfile --lockfile-only`. It passes, so
the lockfile matches the three trimmed manifests.
3. Run `git diff master...HEAD --name-only --diff-filter=ACMR | grep -E
'\.(md|mdx)$' | xargs npx prettier --config prettier.config.mjs
--check`. All changed markdown passes.
4. Open the [reformatted filter
table](https://docs-git-docs-retire-mdx-linter-supabase.vercel.app/docs/guides/observability/logs#filter-events)
on the preview and compare it with
[production](https://supabase.com/docs/guides/observability/logs#filter-events).
The table renders the same.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Documentation guidance now uses manual prose and terminology review
with the shared word list.
* Clarified storage configuration and common Realtime channel mistakes.
* Improved table formatting, text wrapping, and selected reference
links.
  * Updated documentation authoring and review guidance.

* **Chores**
* Retired automated MDX linting from workflows and local validation
commands.
* Removed lint-suppression markers throughout documentation without
changing instructions.
  * Added targeted documentation review guidance for pull requests.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-09-22 10:00:41 -07:00

327 lines
9.8 KiB
Plaintext

---
id: 'functions-error-codes'
title: 'Error codes'
description: 'Edge Functions can return the following error codes.'
subtitle: 'Understand the error codes returned by Edge Functions to properly debug issues and handle responses.'
---
When an Edge Function request fails, the response includes a `sb-error-code` header that identifies the specific error.
You can inspect this header in your HTTP client or application code to detect and handle errors programmatically.
```js
const response = await fetch('<your-function-url>')
if (!response.ok) {
const errorCode = response.headers.get('sb-error-code')
console.error('Edge Function error:', errorCode)
}
```
## Bad Implementation Errors
These errors are caused by issues in your function's code or logic which requires updating its implementation.
### EDGE_FUNCTION_ERROR
**Cause:** Your Edge Function is throwing an unhandled error or resulting a 5XX code.
```ts
// ...
function process() {
throw new Error('Some unhandled error')
}
export default {
fetch: withSupabase({ auth: 'none' }, async () => {
process()
return new Response()
}),
}
```
**Solution:**
- Ensure you are catching errors in your code logic with try-catch blocks.
```ts
function process() {
throw new Error('Some unhandled error')
}
// ...
try {
process()
return new Response()
} catch (e) {
console.error('Process fail:', e)
return new Response(null, { status: 500 })
}
```
### IDLE_TIMEOUT
**Cause:** Your Edge Function did not respond within the [request timeout limit](/docs/guides/functions/limits).
**Common causes:**
- Long-running database queries
- Slow external API calls
- Infinite loops or blocking operations
**Solution:**
- Optimize slow operations
- Add timeout handling to external requests
- Consider breaking large operations into smaller chunks
### WORKER_RESOURCE_LIMIT, WORKER_LIMIT
**Cause:** Your Edge Function execution was stopped due to exceeding resource limits. Edge Function logs should indicate which [resource limit](/docs/guides/functions/limits) was exceeded.
**Common causes:**
- Memory usage exceeded available limits
- CPU time exceeded execution quotas
- Too many concurrent operations
**Solution:** Check your Edge Function logs to see which resource limit was exceeded, then optimize your function accordingly.
### WORKER_ERROR
**Cause:** Your Edge Function threw an uncaught exception.
```ts
// ...
function initSomething() {
throw new Error('Some unhandled error')
}
initSomething() // Error threw outside request handler
export default {
fetch: withSupabase({ auth: 'none' }, async () => {
return new Response()
}),
}
```
**Common causes:**
- Unhandled JavaScript errors in your function code, outside request handler
- Missing error handling for async operations
- Invalid JSON parsing
**Solution:** Check your Edge Function logs to identify the specific error and add proper error handling to your code.
### INVALID_RESPONSE_STATUS_CODE
**Cause:** Your Edge Function is returning an invalid HTTP status code — not equal to `101` and outside the range `[200, 599]`
**Common causes:**
- Proxying an external service that returns an invalid HTTP status code
```ts
// ...
export default {
fetch: withSupabase({ auth: 'none' }, async (req) => {
// Fails in case this proxied server return a status >599
return fetch('https://some-server-to-proxy', {
method: req.method,
headers: req.headers,
body: req.body,
})
}),
}
```
**Solution:**
- Ensure you are returning a valid HTTP status code
- For proxy endpoints, do not return the `fetch()` result directly; instead return a new `Response` wrapped in a try-catch block
```ts
// ...
export default {
fetch: withSupabase({ auth: 'none' }, async (req) => {
try {
const res = await fetch('https://some-server-to-proxy', {
method: req.method,
headers: req.headers,
body: req.body,
})
// Creating a 'new Response()' ensures constructor checks
return new Response(await res.body, {
headers: res.headers,
status: res.status,
statusText: res.statusText,
})
} catch (e) {
console.error('Proxy Error', e)
return new Response(null, { status: 502 })
}
}),
}
```
## Authentication Errors
These errors occur when the request contains a missing, malformed, or unsupported JWT token. Fixing them requires ensuring your requests include a valid authorization header, or disabling JWT verification for public endpoints.
For further information, see [Authorization headers](/docs/guides/functions/auth-headers) and [Securing Edge Functions](/guides/functions/auth).
### UNAUTHORIZED_NO_AUTH_HEADER
**Cause:** The Edge Function has JWT verification enabled, but the request is missing the `Authorization` or `apikey` header.
**Solution:**
- Ensure you are passing a valid JWT token in the `Authorization` header
- Check that you are sending an API key in the `apikey` header
- For webhooks or public endpoints, consider disabling JWT verification
### UNAUTHORIZED_ASYMMETRIC_JWT
**Cause:** The Edge Function has JWT verification enabled, but the `Authorization` header contains an invalid asymmetric `ES256 | RS256` token.
**Solution:**
- Ensure you are passing a valid user JWT token in the `Authorization` header
- Check that your token has not expired
### UNAUTHORIZED_LEGACY_JWT
**Cause:** The Edge Function has JWT verification enabled, but the `Authorization` header contains an invalid legacy `HS256` token.
**Solution:**
- Ensure you are passing a valid legacy JWT token in the `Authorization` header
- Check that your token has not expired
- Verify that the legacy JWT secret has not been revoked or disabled
### UNAUTHORIZED_UNSUPPORTED_TOKEN_ALGORITHM
**Cause:** The Edge Function has JWT verification enabled, but the `Authorization` header does not contain an `ES256 | RS256 | HS256` token.
**Solution:**
- Ensure you are passing a valid Supabase-issued JWT token in the `Authorization` header
### UNAUTHORIZED_INVALID_JWT_FORMAT
**Cause:** The Edge Function has JWT verification enabled, but the `Authorization` header does not follow the `Bearer <JWT Token>` format.
**Solution:**
- Check that you are passing `Bearer <JWT Token>` in the `Authorization` header
- Ensure you are sending an API key in the `apikey` header instead of `Authorization`
- For webhooks or public endpoints, consider disabling JWT verification
## Request Errors
These errors indicate issues with the request itself, which typically require changing how the function is called.
### RATE_LIMIT_EXCEEDED
**Cause:** The platform detected [recursive or nested function call](/docs/guides/functions/recursive-functions) behavior.
**Common causes:**
- Multiple function-to-function calls
- Recursive or circular calls
**Solution:**
- Use the suggested retry window in seconds from the error message before calling your function again
- Ensure you are not performing unnecessary individual calls; use batch operations where possible
- Delegate large workloads to queues instead of recursively calling other Edge Functions
### INVALID_URL
**Cause:** The platform rejected a malformed URL.
**Solution:**
- Ensure you are calling with a valid [formatted URL](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL)
---
## Server Errors
These errors indicate issues with function loading, execution, or the underlying platform.
### NOT_FOUND
**Cause:** The Edge Function metadata or files were not found or are missing in the specific region.
**Solution:** Try redeploying your function and wait a few minutes to make sure all regions have been updated.
### NOT_FOUND_FUNCTION_BLOB
**Cause:** Your Edge Function metadata resolved, but its deployment bundle was missing from storage and could not be loaded (the metadata points at a different version than the stored bundle). This returns the same `Requested function was not found` message as `NOT_FOUND`, so the `sb-error-code` header is what distinguishes them — see [Edge Function 404 error response](/docs/guides/troubleshooting/edge-function-404-error-response).
**Common causes:**
- Two deploys of the same function running concurrently, double-incrementing the metadata version
- A batch deploy using `/deploy?bundleOnly=true` where the bulk metadata update failed
**Solution:**
- Redeploy your function with the latest version of the Supabase CLI
- Avoid running concurrent deploys of the same function, such as overlapping GitHub Actions runs
- If the problem persists, contact support so your function metadata can be re-synced
### BOOT_ERROR
**Cause:** Your Edge Function failed to start.
**Common causes:**
- Syntax errors preventing the function from loading
- Import errors or missing dependencies
- Invalid function configuration
**Solution:** Check your Edge Function logs and also verify that your function code can be executed locally with `supabase functions serve`.
### LOAD_FUNCTION_ERROR
**Cause:** The platform was unable to load your function metadata or files.
**Solution:**
- Try calling your function again after a short delay
- If the problem persists, contact support
### LOAD_FUNCTION_METADATA_ERROR
**Cause:** The platform could not fetch your function metadata, possibly due to external cache issues.
**Solution:**
- Wait a few minutes before calling your function again
- If the problem persists, contact support
### LOAD_FUNCTION_INVALID_ENTRYPOINT_PATH_ERROR
**Cause:** Your Edge Function metadata is broken or contains an invalid entrypoint.
**Solution:**
- Try redeploying your function
- If the problem persists, contact support
### LOAD_FUNCTION_UNBUNDLING_ERROR
**Cause:** Your Edge Function deployment bundle was fetched, but could not be unbundled because decompressing or parsing it failed. This usually means the bundle is corrupt or was only partially written.
**Solution:**
- Try redeploying your function
- If the problem persists, contact support