Files
supabase/apps/docs/data/monitoring-agents.utils.test.ts
Saxon Fletcher 36d2982af4 docs: add reusable monitoring agent setup components (#49506)
<!-- CURSOR_AGENT_PR_BODY_BEGIN -->
## Stack

Draft stack extracted from `docs/monitoring`. Merge bottom-up.
Troubleshooting / debugging-guide rewrite is 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 ← **this PR**
6. #49504 add hire-an-agent templates
7. #49505 restructure observability nav and overview

## 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 app feature (MDX components + markdown export). Fifth layer in the
observability stack.

## What is the current behavior?

There is no shared way to render a monitoring agent prompt, schedule,
and Claude/Codex/Cursor setup instructions in both HTML and generated
markdown.

## What is the new behavior?

- `AgentSetup` and `AgentWatchSchedule` MDX components, registered for
HTML and markdown export
- Shared `monitoring-agents` data (cadence, prompt ids, harness steps)
- Opt-in `AiPrompt` markdown export (`includeInMarkdown`) so quickstarts
stay HTML-only
- Optional content-listing `subtitle` for schedule labels on cards

No agent guide pages yet — those land in #49504 so this PR stays a
reviewable code change.

## Additional context

Markdown schema handlers share the same data module as the React
components.
<!-- 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>&nbsp;<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>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Saxon Fletcher <SaxonF@users.noreply.github.com>
2026-09-04 13:38:37 +10:00

84 lines
2.3 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import { monitoringAgents } from './monitoring-agents.data'
import {
getCronExpression,
getMonitoringAgent,
getMonitoringAgentHarnesses,
getScheduleMarks,
} from './monitoring-agents.utils'
describe('getMonitoringAgent', () => {
it('returns a registered agent', () => {
expect(getMonitoringAgent('health').name).toBe('Health monitor')
})
it('fails clearly for an unknown id', () => {
expect(() => getMonitoringAgent('missing')).toThrow('Unknown monitoring agent id: missing')
})
})
describe('getScheduleMarks', () => {
it('renders a 24-hour day for 15-minute cadence', () => {
const { window, marks } = getScheduleMarks(15)
expect(window).toBe('day')
expect(marks).toHaveLength(96)
expect(marks.filter((mark) => mark.label).map((mark) => mark.label)).toEqual([
'12am',
'6am',
'12pm',
'6pm',
])
})
it('renders a 24-hour day for hourly cadence', () => {
const { window, marks } = getScheduleMarks(60)
expect(window).toBe('day')
expect(marks).toHaveLength(24)
expect(marks[0].label).toBe('12am')
expect(marks[12].label).toBe('12pm')
})
it('renders a week for daily cadence', () => {
const { window, marks } = getScheduleMarks(1440)
expect(window).toBe('week')
expect(marks.map((mark) => mark.label)).toEqual([
'Mon',
'Tue',
'Wed',
'Thu',
'Fri',
'Sat',
'Sun',
])
})
})
describe('getCronExpression', () => {
it('maps supported intervals', () => {
expect(getCronExpression(15)).toBe('*/15 * * * *')
expect(getCronExpression(60)).toBe('0 * * * *')
expect(getCronExpression(1440)).toBe('0 9 * * *')
})
})
describe('getMonitoringAgentHarnesses', () => {
it('uses a Claude routine for hourly health checks', () => {
const claude = getMonitoringAgentHarnesses(monitoringAgents.health).find(
(harness) => harness.key === 'claude'
)
expect(claude?.intro).toContain('Create a Claude routine')
expect(claude?.note).toBeUndefined()
})
it('omits the Desktop-task note when the cadence is hourly or slower', () => {
const claude = getMonitoringAgentHarnesses(monitoringAgents.performance).find(
(harness) => harness.key === 'claude'
)
expect(claude?.intro).toContain('Create a Claude routine')
expect(claude?.note).toBeUndefined()
})
})