mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
<!-- CURSOR_AGENT_PR_BODY_BEGIN --> ## Stack Draft stack extracted from `docs/monitoring`. Merge bottom-up. The troubleshooting *catalog* rewrite (`content/troubleshooting` and the Diagnosing UI) stays out of scope. 1. #49503 move inspect and advisors 2. #49501 split Studio logs from ClickHouse queries 3. #49500 treat reports as signal dashboards 4. #49502 add Observe the data hub 5. #49506 add agent setup components 6. #49504 add hire-an-agent templates 7. **#49505** restructure observability nav, overview, Detecting, and flatten Observe the data ← **this PR** ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs update. Top layer in the observability stack. ## What is the current behavior? The section is still titled Monitoring and Debugging, with a Debugging / Monitoring split that does not match the new pages. The debugging guide is still the master layer-isolation + symptom table. Observe the data is split into “what data” vs “where to observe it,” which duplicates the source pages. ## What is the new behavior? - Section title is Observability - Overview groups Observe the data, Detect and resolve, Hire an agent, and Export - **Observe the data is flattened by source.** Logs, Metrics API, Database, Advisors, and Reports each list where to read that source. There is no separate MCP/API/CLI/Studio nav group. - **Observe vs Detecting:** Observe is the catalog (what exists, how to access it). Detecting is how to *use* those sources to pick up a Health / Security / Performance / Usage signal. Named errors skip to Diagnosing. - Studio Logs sits under Logs. Reports sits beside the other sources. - Troubleshooting stays in the global menu and also appears as Diagnosing under Detect and resolve ## Additional context This is the last PR in the stack. Together the seven PRs reconstruct the `docs/monitoring` observability IA and guide content, without shipping the troubleshooting catalog overhaul. <!-- CURSOR_AGENT_PR_BODY_END --> <div><a href="https://cursor.com/agents/bc-a3cb5ece-925b-4046-b58a-5d69e9a9d794?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a href="https://cursor.com/background-agent?bcId=bc-a3cb5ece-925b-4046-b58a-5d69e9a9d794&cursor_ref=pr_footer&cursor_cta=open_in_cursor"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img alt="Open in Cursor" width="131" height="28" src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a> </div> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Saxon Fletcher <SaxonF@users.noreply.github.com> Co-authored-by: Nik Richers <nik@validmind.ai>
71 lines
2.7 KiB
TypeScript
71 lines
2.7 KiB
TypeScript
import { expect, test } from '@playwright/test'
|
|
|
|
const SUPABASE_URL_ERROR = /supabaseUrl is required/i
|
|
|
|
function collectPageErrors(page: import('@playwright/test').Page) {
|
|
const errors: string[] = []
|
|
page.on('pageerror', (err) => errors.push(err.message))
|
|
page.on('console', (msg) => {
|
|
if (msg.type() === 'error') errors.push(msg.text())
|
|
})
|
|
return errors
|
|
}
|
|
|
|
test.describe('docs dev runs locally without credentials', () => {
|
|
test('a normal guide page renders and the feedback widget does not crash', async ({ page }) => {
|
|
const errors = collectPageErrors(page)
|
|
|
|
const response = await page.goto('/docs/guides/database/postgres/row-level-security')
|
|
expect(response?.ok(), `expected 200, got ${response?.status()}`).toBeTruthy()
|
|
|
|
const yesButton = page.getByRole('button', { name: 'Yes', exact: true })
|
|
await expect(yesButton).toBeVisible()
|
|
await yesButton.click()
|
|
|
|
expect(errors.some((message) => SUPABASE_URL_ERROR.test(message))).toBeFalsy()
|
|
})
|
|
|
|
test('advisors page renders (full content or graceful fallback, never a crash)', async ({
|
|
page,
|
|
}) => {
|
|
const response = await page.goto('/docs/guides/observability/advisors')
|
|
expect(response?.ok(), `expected 200, got ${response?.status()}`).toBeTruthy()
|
|
|
|
await expect(page.getByRole('heading', { name: 'Advisors' })).toBeVisible()
|
|
})
|
|
|
|
test('a troubleshooting article page renders without Supabase credentials', async ({ page }) => {
|
|
const errors = collectPageErrors(page)
|
|
|
|
const response = await page.goto('/docs/guides/troubleshooting/rls-simplified-BJTcS8')
|
|
expect(response?.status(), `expected 200, got ${response?.status()}`).toBe(200)
|
|
|
|
await expect(page.getByRole('heading', { name: 'RLS Simplified' })).toBeVisible()
|
|
|
|
expect(errors.some((message) => SUPABASE_URL_ERROR.test(message))).toBeFalsy()
|
|
})
|
|
|
|
test('a federated guide missing locally returns a clean 404, not a crash', async ({ page }) => {
|
|
const response = await page.goto('/docs/guides/graphql')
|
|
expect(response?.status()).toBe(404)
|
|
})
|
|
|
|
test('the wrappers overview page renders without GitHub credentials', async ({ page }) => {
|
|
const errors = collectPageErrors(page)
|
|
|
|
const response = await page.goto('/docs/guides/database/extensions/wrappers/overview')
|
|
expect(response?.status(), `expected 200, got ${response?.status()}`).toBe(200)
|
|
|
|
await expect(page.getByRole('heading', { name: 'Foreign Data Wrappers' })).toBeVisible()
|
|
|
|
expect(errors.some((message) => SUPABASE_URL_ERROR.test(message))).toBeFalsy()
|
|
})
|
|
|
|
test('a federated wrappers page missing locally returns a clean 404, not a crash', async ({
|
|
page,
|
|
}) => {
|
|
const response = await page.goto('/docs/guides/database/extensions/wrappers/stripe')
|
|
expect(response?.status()).toBe(404)
|
|
})
|
|
})
|