mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
Miranda Limonczenko
abbf667084
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem The Docs E2E link checker found broken links throughout docs, starting with `phone-login.mdx` pointing to `/docs/guides/cli/config` (404). Old links like `/docs/guides/cli/config` still work on the live site because `supabase.com` has redirects set up for them, but these links break on the docs preview site, which is what the E2E check tests against. These issues look clean on the live site, and I didn't catch them in my first pass because I was testing production instead of the preview. The E2E check only tests the ~20 pages a given PR happens to touch, so fixing the pages it flagged kept exposing more of the same problem one page at a time as each fix pulled in a new file. To stop chasing this incrementally, I cross-referenced every `/docs/guides/*` and `/docs/reference/*` redirect source in `apps/www/lib/redirects.js` against actual usage across all of `apps/docs`, and verified each candidate against the live preview. ## Solution Rather than updating the Docs E2E link checker, this PR resolves the links. **Why:** we own these docs, so keeping the links clean without redirects is keeping the house maintained. See [Broken Window Theory](https://blog.codinghorror.com/the-broken-window-theory/). Updated every link still using an old path to point straight at the current page instead of relying on a redirect. This covers old links like: - `/docs/guides/cli/config` → `/docs/guides/local-development/cli/config` - `/docs/guides/cli/getting-started` → `/docs/guides/local-development/cli/getting-started` - `/docs/guides/cli/local-development` → `/docs/guides/local-development/database-migrations` - `/docs/guides/cli/managing-environments` → `/docs/guides/deployment/managing-environments` - `/docs/guides/cli/seeding-your-database` → `/docs/guides/local-development/seeding-your-database` - bare `/docs/guides/cli` → `/docs/guides/local-development` - `/docs/guides/platform/compute-add-ons` → `/docs/guides/platform/compute-and-disk` - `/docs/guides/platform/shared-responsibility-model` → `/docs/guides/deployment/shared-responsibility-model` - `/docs/guides/database` → `/docs/guides/database/overview` - `/docs/reference/javascript`, `/docs/reference/dart`, `/docs/reference/kotlin`, `/docs/reference/python`, `/docs/reference/csharp` → their `/introduction` pages (the redirect's own destination, `/start`, turned out to be dead even on production — a separate bug in `redirects.js` I didn't touch here) - and about 35 more of the same pattern, listed in the commit messages Also fixed a handful of dead heading anchors found along the way (links that resolve to the right page but point at a `#section` that got renamed or moved), including the original `#bigquery` anchor and a few in `connecting-to-postgres.mdx` where content moved to its own dedicated page. Left alone on purpose: - `content/guides/cli.mdx` — this page has no route in the docs app at all (no `app/guides/cli/` directory), so it 404s even in production before the `www` redirect ever fires. Fixing its internal link wouldn't change that; it needs an actual routing/content decision, not a link fix. - A few candidates that already resolve fine as-is (`pg_partman`, bare `/docs/reference/api`, bare `/docs/reference/cli`) — confirmed via curl, left untouched. ## Manual testing 1. Confirmed every new link target actually exists by checking the destination file/page and matching heading anchors. 2. Cross-referenced every `/docs/guides/*` and `/docs/reference/*` redirect source in `apps/www/lib/redirects.js` against real usage in `apps/docs`, and curl-verified each old path (404) and new path (200) against the live PR preview before fixing it. 3. Ran the Docs E2E link checker locally against changed pages. 4. Spot-checked the original broken link from CI (`/docs/guides/cli/config`) to confirm it now points to a working page.
77 lines
3.3 KiB
Plaintext
77 lines
3.3 KiB
Plaintext
---
|
|
id: 'testing-emails-locally'
|
|
title: 'Testing and linting'
|
|
description: 'Using the CLI to test your Supabase project.'
|
|
subtitle: 'Using the CLI to test your Supabase project.'
|
|
---
|
|
|
|
The Supabase CLI provides a set of tools to help you test and lint your Postgres database and Edge Functions.
|
|
|
|
## Testing your database
|
|
|
|
The Supabase CLI provides Postgres linting using the `supabase test db` command.
|
|
|
|
{/* prettier-ignore */}
|
|
```markdown
|
|
supabase test db --help
|
|
Tests local database with pgTAP
|
|
|
|
Usage:
|
|
supabase test db [flags]
|
|
```
|
|
|
|
This is powered by the [pgTAP](/docs/guides/database/extensions/pgtap) extension. You can find a full guide to writing and running tests in the [Testing your database](/docs/guides/database/testing) section.
|
|
|
|
### Test helpers
|
|
|
|
Our friends at [Basejump](https://usebasejump.com/) have created a useful set of Database [Test Helpers](https://github.com/usebasejump/supabase-test-helpers), with an accompanying [blog post](https://usebasejump.com/blog/testing-on-supabase-with-pgtap).
|
|
|
|
### Running database tests in CI
|
|
|
|
Use our GitHub Action to [automate your database tests](/docs/guides/deployment/ci/testing).
|
|
|
|
## Testing your Edge Functions
|
|
|
|
Edge Functions are powered by Deno, which provides a [native set of testing tools](https://deno.land/manual@v1.35.3/basics/testing). We extend this functionality in the Supabase CLI. You can find a detailed guide in the [Edge Functions section](/docs/guides/functions/unit-test).
|
|
|
|
## Testing Auth emails
|
|
|
|
The Supabase CLI uses [Mailpit](https://github.com/axllent/mailpit) to capture emails sent from your local machine. This is useful for testing emails sent from Supabase Auth.
|
|
|
|
### Accessing Mailpit
|
|
|
|
By default, Mailpit is available at [localhost:54324](http://localhost:54324) when you run `supabase start`. Open this URL in your browser to view the emails.
|
|
|
|
### Going into production
|
|
|
|
The "default" email provided by Supabase is only for development purposes. It is [heavily restricted](/docs/guides/deployment/going-into-prod#auth-rate-limits) to ensure that it is not used for spam. Before going into production, configure your own email provider by enabling SMTP credentials in your [project settings](/dashboard/project/_/auth/smtp).
|
|
|
|
## Linting your database
|
|
|
|
The Supabase CLI provides Postgres linting using the `supabase db lint` command:
|
|
|
|
{/* prettier-ignore */}
|
|
```markdown
|
|
supabase db lint --help
|
|
Checks local database for typing error
|
|
|
|
Usage:
|
|
supabase db lint [flags]
|
|
|
|
Flags:
|
|
--level [ warning | error ] Error level to emit. (default warning)
|
|
--linked Lints the linked project for schema errors.
|
|
-s, --schema strings List of schema to include. (default all)
|
|
```
|
|
|
|
This is powered by [plpgsql_check](https://github.com/okbob/plpgsql_check), which leverages the internal Postgres parser/evaluator so you see any errors that would occur at runtime. It provides the following features:
|
|
|
|
- validates you are using the correct types for function parameters
|
|
- identifies unused variables and function arguments
|
|
- detection of dead code (any code after an `RETURN` command)
|
|
- detection of missing `RETURN` commands with your Postgres function
|
|
- identifies unwanted hidden casts, which can be a performance issue
|
|
- checks `EXECUTE` statements against SQL injection vulnerability
|
|
|
|
Check the Reference Docs for [more information](/docs/reference/cli/supabase-db-lint).
|