0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/.coderabbit.yaml

192 lines
8.1 KiB

2026-03-31 15:54:38 +02:00
chore: Add docs styleguides (#13263) ## Description - Add docs styleguides - Add AGENTS.md files and point CLAUDE.md file to it - Add mastra-docs claude skill - Improve prompts on writing docs ## Related Issue(s) Fixes DEVED-110 ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive docs and styleguides (DOC, STYLEGUIDE, GUIDE_* , REFERENCE) and new AGENTS.md; reorganized docs content and contributor workflow. * Replaced extensive CLAUDE.md content with pointer to AGENTS.md; cleared docs changelog and removed some legacy guideline files. * Updated CLI/pr/changeset prompts and guidance to require multiple changesets for multi-package changes and warn against very long changesets. * **Community** * Updated Code of Conduct with expanded scope and clearer enforcement guidance. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-19 13:45:33 +01:00
feat(connect): add e2e smoke test suite for provider toolsets (#25815) ## Summary Adds a live end-to-end smoke test suite for `@mastra/connect` covering **all 26 checked-in providers at 100% tool coverage (1014 tool invocations)**, plus the runtime fixes that running the suite live surfaced. ### Smoke test harness (`packages/connect/scripts/smoke-test/`) - `runner.ts` / `cli.ts` — reads `MASTRA_PLATFORM_SECRET_KEY` + `MASTRA_PROJECT_ID`, resolves the project toolset through the public `tools()` resolver, and runs per-provider scenarios. `pnpm --filter @mastra/connect smoke-test [--provider <id>]`. - `scenario.ts` — scenario interface + helpers (`makeStep`, `requireTools`, `runReadBatch`, `probeTool`, `runId` tagging for collision-free resource naming). - 26 scenario files — each runs a self-contained `preflight → batch-read → create → read → update → delete` lifecycle through the tools themselves (no backdoor cleanup). Cleanup is unconditional with `log.error` on leaked resources. - `audit-coverage.ts` — static audit: every shipped tool must appear in its scenario (forward), and every scenario-referenced tool id must exist (reverse). Exits non-zero on unknown ids. - `audit-shapes.mjs` — static input-shape audit: cross-checks scenario `call()` payloads against each tool's zod input schema, flagging unknown keys (silently stripped) and missing required keys. Exits non-zero on findings. - `scripts/smoke-test/**` is now included in the package tsconfig, so `tsc --noEmit` covers it. ### Runtime changes surfaced by live runs - **`MastraConnectError.response.status` alias** — generated provider tools come from upstream Nango templates whose error handlers check the axios-shaped `error.response?.status` (35 generated files). The alias makes those handlers work unchanged (e.g. the expected-404 recovery path in `github_create_or_update_file`), instead of hand-editing generated code that the next `sync-templates` run would erase. Unit tested. - **`extractProblemDetail`** — now also extracts the first human-readable message from `{ errors: [{ message, long_message }] }` payloads (Clerk, Nango v2), preferring `long_message`. Unit tested (10 new tests in `errors.test.ts`). - **Clerk provider regenerated** from the upstream template fix (NangoHQ/integration-templates#670). Breaking tool-contract changes (documented in the changeset): - `clerk_list_sessions` requires `client_id` or `user_id` and no longer returns `total`. - `clerk_create_user` requires at least one identifier via schema refine. - `clerk_list_users` issues a count request to populate `total`. ### Policy / docs - `packages/connect/AGENTS.md` — package guidance including the new-provider checklist: every new provider must ship a scenario with 100% tool coverage. - `.coderabbit.yaml` — path instructions enforcing the scenario checklist on `packages/connect/src/providers/**` PRs. ## Test plan - `pnpm --filter @mastra/connect test` — 267/267 pass (vitest + `tsc --noEmit`, now covering the smoke scripts) - `pnpm --filter @mastra/connect lint` — clean - `tsx packages/connect/scripts/smoke-test/audit-coverage.ts` — 1014/1014 tools (100%) across 26 providers, 0 unknown ids - `node packages/connect/scripts/smoke-test/audit-shapes.mjs .` — 0 findings - Live runs against a real platform project: all 26 providers exercised; highlights: github 42/42, supabase 27/27, google-docs 36/36, hubspot 44/44, google-mail 50/52 (2 steps blocked on upstream NangoHQ/integration-templates#704), google-analytics 11/11 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR adds a command that checks whether connected-service tools work in a test project. It also updates Clerk tools to match API changes and improves how the package reports API errors. ## Summary - Add a smoke-test runner, CLI, report output, and scenarios for all 26 checked-in providers. The runner resolves tools through the public `tools()` resolver. - Add static audits for tool coverage and input shapes. Document how to run the suite and add provider scenarios. - Update Clerk tool schemas and behavior, including stricter input checks, revised session listing, and user-list filters and counts. - Add `response.status` to `MastraConnectError` and extend `extractProblemDetail` to read messages from `errors` arrays. - Add error tests and include smoke-test scripts in the TypeScript project. ## Verification The supplied context reports 267/267 tests passing, clean lint, 1,014/1,014 tools covered, and no shape-audit findings. These results are author-reported. Live runs reportedly exercised all 26 providers; two Google Mail steps were blocked by an upstream issue. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com> Co-authored-by: mastracode <mastracode@users.noreply.github.com>
2026-10-05 17:05:36 -04:00
feat(connect): add e2e smoke test suite for provider toolsets (#25815) ## Summary Adds a live end-to-end smoke test suite for `@mastra/connect` covering **all 26 checked-in providers at 100% tool coverage (1014 tool invocations)**, plus the runtime fixes that running the suite live surfaced. ### Smoke test harness (`packages/connect/scripts/smoke-test/`) - `runner.ts` / `cli.ts` — reads `MASTRA_PLATFORM_SECRET_KEY` + `MASTRA_PROJECT_ID`, resolves the project toolset through the public `tools()` resolver, and runs per-provider scenarios. `pnpm --filter @mastra/connect smoke-test [--provider <id>]`. - `scenario.ts` — scenario interface + helpers (`makeStep`, `requireTools`, `runReadBatch`, `probeTool`, `runId` tagging for collision-free resource naming). - 26 scenario files — each runs a self-contained `preflight → batch-read → create → read → update → delete` lifecycle through the tools themselves (no backdoor cleanup). Cleanup is unconditional with `log.error` on leaked resources. - `audit-coverage.ts` — static audit: every shipped tool must appear in its scenario (forward), and every scenario-referenced tool id must exist (reverse). Exits non-zero on unknown ids. - `audit-shapes.mjs` — static input-shape audit: cross-checks scenario `call()` payloads against each tool's zod input schema, flagging unknown keys (silently stripped) and missing required keys. Exits non-zero on findings. - `scripts/smoke-test/**` is now included in the package tsconfig, so `tsc --noEmit` covers it. ### Runtime changes surfaced by live runs - **`MastraConnectError.response.status` alias** — generated provider tools come from upstream Nango templates whose error handlers check the axios-shaped `error.response?.status` (35 generated files). The alias makes those handlers work unchanged (e.g. the expected-404 recovery path in `github_create_or_update_file`), instead of hand-editing generated code that the next `sync-templates` run would erase. Unit tested. - **`extractProblemDetail`** — now also extracts the first human-readable message from `{ errors: [{ message, long_message }] }` payloads (Clerk, Nango v2), preferring `long_message`. Unit tested (10 new tests in `errors.test.ts`). - **Clerk provider regenerated** from the upstream template fix (NangoHQ/integration-templates#670). Breaking tool-contract changes (documented in the changeset): - `clerk_list_sessions` requires `client_id` or `user_id` and no longer returns `total`. - `clerk_create_user` requires at least one identifier via schema refine. - `clerk_list_users` issues a count request to populate `total`. ### Policy / docs - `packages/connect/AGENTS.md` — package guidance including the new-provider checklist: every new provider must ship a scenario with 100% tool coverage. - `.coderabbit.yaml` — path instructions enforcing the scenario checklist on `packages/connect/src/providers/**` PRs. ## Test plan - `pnpm --filter @mastra/connect test` — 267/267 pass (vitest + `tsc --noEmit`, now covering the smoke scripts) - `pnpm --filter @mastra/connect lint` — clean - `tsx packages/connect/scripts/smoke-test/audit-coverage.ts` — 1014/1014 tools (100%) across 26 providers, 0 unknown ids - `node packages/connect/scripts/smoke-test/audit-shapes.mjs .` — 0 findings - Live runs against a real platform project: all 26 providers exercised; highlights: github 42/42, supabase 27/27, google-docs 36/36, hubspot 44/44, google-mail 50/52 (2 steps blocked on upstream NangoHQ/integration-templates#704), google-analytics 11/11 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR adds a command that checks whether connected-service tools work in a test project. It also updates Clerk tools to match API changes and improves how the package reports API errors. ## Summary - Add a smoke-test runner, CLI, report output, and scenarios for all 26 checked-in providers. The runner resolves tools through the public `tools()` resolver. - Add static audits for tool coverage and input shapes. Document how to run the suite and add provider scenarios. - Update Clerk tool schemas and behavior, including stricter input checks, revised session listing, and user-list filters and counts. - Add `response.status` to `MastraConnectError` and extend `extractProblemDetail` to read messages from `errors` arrays. - Add error tests and include smoke-test scripts in the TypeScript project. ## Verification The supplied context reports 267/267 tests passing, clean lint, 1,014/1,014 tools covered, and no shape-audit findings. These results are author-reported. Live runs reportedly exercised all 26 providers; two Google Mail steps were blocked by an upstream issue. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com> Co-authored-by: mastracode <mastracode@users.noreply.github.com>
2026-10-05 17:05:36 -04:00
turn on coderabbit issue planning (#10401) ## Description This PR enables CodeRabbit's issue enrichment planning feature by adding the `issue_enrichment` configuration to `.coderabbit.yaml`. With this feature enabled, CodeRabbit will automatically provide planning assistance for GitHub issues, helping to break down tasks, suggest implementation approaches, and provide structured plans for issue resolution. The planning feature will enhance our development workflow by: - Automatically analyzing new GitHub issues and providing implementation plans - Breaking down complex issues into actionable subtasks - Suggesting technical approaches and considerations - Improving issue clarity and reducing back-and-forth during planning phases ## Related Issue(s) <!-- Link to the issue(s) this PR addresses, using hashtag notation: #123 --> ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works --- **Note:** This is a configuration change that enables an external tool feature. No code changes or tests are required as this solely affects CodeRabbit's behavior on GitHub issues. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Enabled issue enrichment planning to improve automated issue processing and analysis. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-11-21 12:48:57 -06:00