Backport vacuum and some vrt utilities and pull in base template - #201
Merged
Conversation
The 0.2.x line adds the ShellRail and PageTitle shell components plus the shellRailTestIds helper, which the circuit-python device driver frontend template uses for the shared Lab Sync theming. 0.2.3 declares `@nuxt/ui >=4.10.0` and a non-optional `openapi-types >=12.1` peer dependency, so bump @nuxt/ui and add openapi-types as a dev dependency for driver projects.
…aware ones The built-in operation-description and oas3-missing-example rules inspect requestBody/response nodes directly and never follow $ref, so a pydantic model's docstring and its field-level examples are invisible to them. That forced every route to hand-type a description and example duplicating what the payload model already declares. Disable both and replace them with request/response-body-description and request/response-body-example, backed by two new custom functions that run against the schema vacuum has already dereferenced. Also raise every self-defined rule to error severity, and move the graphql 200-response exemption over to the new response-body-example rule. Backported from lab-sync/git-sherpa#241.
…linters The hook interpolated vacuum_openapi_version, which was never defined in copier.yml or the context extension, so it rendered empty and downstream repos installed an unpinned '@quobix/vacuum@'. Define it alongside the other tool pins. Also move the hook out of the tail of the has_backend block, where it sat behind pyright and pyrefly, to just after the security hooks. It is cheap and its failures are cheap to act on, so it should fail before the slow type-checkers run.
Every downstream app needs the same camelCase-over-the-wire base model and was reinventing it, so ship it in the template. HealthcheckResponse, HealthcheckQuery, ShutdownResponse and ProblemDetails all base on it now. ProblemDetails carried a hand-written alias="errorType" to camelCase one field; the alias generator covers that now. Dropping the explicit alias also lets field_title_generator apply, so its JSON-schema title becomes "Error Type" instead of the "Errortype" pydantic derives from an alias. The wire format is unchanged. The healthcheck query parameter moves from a bare Query(alias="prependV") to a HealthcheckQuery model, which drops a pyright suppression and gets the alias from the generator. Response fields gain examples so the new request/response-body-example rules pass on the model rather than on a hand-typed duplicate. Snapshot updated to match, and verified against the schema the rendered app actually serves. Backported from lab-sync/git-sherpa#241.
…sponses Documenting an HTTPException in a route decorator meant hand-writing the same application/problem+json media type and ProblemDetails schema ref every time. problem_response holds that shared part so a route passes only what differs: status code and description. It also synthesizes an example from those two, so the docs show a body matching that specific response instead of the generic field-level example a bare schema ref renders. Backported from lab-sync/git-sherpa#241, with tests added.
…mentScreenshot expectContentPaneScreenshot assumed the main area held no dynamic chrome, so it took no masks. That does not hold once a page renders non-deterministic values (generated ids and the like), so accept a mask list like the full-page helpers already do. expectElementScreenshot screenshots a single locator rather than the page or the content pane, keeping a widget's baseline insensitive to unrelated layout churn elsewhere. Use it for a self-contained section that a broader page-level VRT already covers for overall layout. It takes masks too -- LocatorAssertions.toHaveScreenshot supports the same option -- so all four helpers now expose it consistently. Backported from lab-sync/git-sherpa#241 and lab-sync/sensor-monitor#148.
…kport-vacuum-from-git-sherpa
Contributor
📝 WalkthroughWalkthroughThe PR adds schema-aware Vacuum body description and example checks, strengthens OpenAPI lint severities and tooling, introduces camelCase backend models and problem-response generation, updates OpenAPI snapshots and tests, and extends visual regression helpers for light/dark screenshot baselines and masking. ChangesOpenAPI linting
Backend API contracts
Frontend visual test helpers
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
zendern
marked this pull request as ready for review
July 26, 2026 01:17
ejfine
reviewed
Jul 26, 2026
ejfine
reviewed
Jul 26, 2026
| description: Path parameters must be snake_case. | ||
| given: $.paths[*][*].parameters[?(@.in=='path')].name | ||
| severity: warn | ||
| severity: error |
Contributor
There was a problem hiding this comment.
NIT: do we have documentation somewhere of why we're changing these all to error (e.g. a link to the github issue you created)?
Contributor
Author
There was a problem hiding this comment.
Issue here daveshanley/vacuum#947 but TLDR; output is a little weird if they are not errors. So at least the ones that we control here we are bumping them up to error even though our fail-severity is warning so that if any of those fail they render as such.
Contributor
There was a problem hiding this comment.
I know right now why we're doing it. I meant "should we add a note or link to the issue in the the code for our future selves?". Just nit though
ejfine
reviewed
Jul 26, 2026
| page: Page, | ||
| name: string, | ||
| { colorSchemes = ["light", "dark"] }: { colorSchemes?: ColorScheme[] } = {}, | ||
| { mask = [], colorSchemes = ["light", "dark"] }: { mask?: Locator[]; colorSchemes?: ColorScheme[] } = {}, |
Contributor
There was a problem hiding this comment.
NIT: should it be masks plural, since it's an array? not sure if there's a different playwright convention
ejfine
previously approved these changes
Jul 26, 2026
ejfine
approved these changes
Jul 26, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@template/.config/vacuum-functions/bodyDescription.js`:
- Around line 25-44: Update schemaHasDescription to traverse an array schema’s
items in addition to anyOf/oneOf branches, so descriptions reachable through
list item models are detected. Add cycle protection using a seen-schema tracking
array, matching the established approach in bodyExample.js, and ensure recursive
schemas terminate safely while preserving the existing direct-description and
branch checks.
In `@template/.config/vacuum-functions/bodyExample.js`:
- Around line 19-27: Update hasOwnExample to recognize Media Type Object
examples maps in addition to schema-style examples arrays: treat a non-null
object-valued node.examples as present when it is a named map, while preserving
the existing array and node.example checks.
In `@template/`{% if has_backend %}backend{% endif
%}/src/backend_api/openapi_problem_responses.py:
- Around line 27-28: Update the example construction in problem_response to
handle integer status codes not registered in HTTPStatus, such as 499 or 599.
Either restrict the function’s accepted status-code contract to registered HTTP
statuses or add explicit validation/fallback behavior before accessing
HTTPStatus(status_code), while preserving normal phrase generation for
registered codes.
In `@template/`{% if has_backend %}backend{% endif
%}/tests/unit/test_fast_api_exception_handlers.py:
- Around line 143-144: Update the CORS exception-handler test request setup to
include an allowed Origin header before checking response.headers. In the
assertions following the request, validate the expected
Access-Control-Allow-Origin value and Access-Control-Allow-Credentials value
rather than only checking header presence.
In `@template/frontend/tests/e2e/helpers/vrt.ts`:
- Around line 103-108: Update pushLogoMask in vrt-masks.ts so it adds the
intended logo Locator to the provided defaultMasks array. Preserve the existing
caller in the colorScheme screenshot loop and ensure defaultMasks contains the
logo mask before it is passed to toHaveScreenshot.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: f7a901bd-1565-4842-8cd9-28feacf5a023
📒 Files selected for processing (15)
template/.config/vacuum-functions/bodyDescription.jstemplate/.config/vacuum-functions/bodyExample.jstemplate/.config/vacuum-ignore.yaml.jinjatemplate/.config/vacuum-ruleset.yamltemplate/.gitignoretemplate/.pre-commit-config.yaml.jinjatemplate/frontend/tests/e2e/helpers/vrt.tstemplate/{% if has_backend %}backend{% endif %}/src/backend_api/app_def.py.jinjatemplate/{% if has_backend %}backend{% endif %}/src/backend_api/camel_case_model.pytemplate/{% if has_backend %}backend{% endif %}/src/backend_api/fast_api_exception_handlers.pytemplate/{% if has_backend %}backend{% endif %}/src/backend_api/openapi_problem_responses.pytemplate/{% if has_backend %}backend{% endif %}/tests/unit/__snapshots__/test_basic_server_functionality/test_openapi_schema.json.jinjatemplate/{% if has_backend %}backend{% endif %}/tests/unit/test_camel_case_model.pytemplate/{% if has_backend %}backend{% endif %}/tests/unit/test_fast_api_exception_handlers.pytemplate/{% if has_backend %}backend{% endif %}/tests/unit/test_openapi_problem_responses.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to Issue or Message thread
Why is this change necessary?
Backporting and general updating from base template
How does this change address the issue?
What side effects does this change have?
N/A
How is this change tested?
CI and downstream
Summary by CodeRabbit
API Improvements
Validation
Testing