Skip to content

docs(driver-tests): drop vitest name filter#4892

Closed
NathanFlurry wants to merge 1 commit into05-02-chore_driver-test-runner_add_native_wasm_runtime_matrix_to_skillfrom
driver-test-complaints/drop-vitest-filter
Closed

docs(driver-tests): drop vitest name filter#4892
NathanFlurry wants to merge 1 commit into05-02-chore_driver-test-runner_add_native_wasm_runtime_matrix_to_skillfrom
driver-test-complaints/drop-vitest-filter

Conversation

@NathanFlurry
Copy link
Copy Markdown
Member

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link
Copy Markdown
Member Author

NathanFlurry commented May 3, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 3, 2026

Code Review

Overview

This PR updates the driver-test-runner skill documentation to remove Vitest -t name filtering from the driver test commands. The change recognizes that environment variables already constrain the test matrix to a single runtime/backend/encoding cell, making the regex-based -t filter redundant — and potentially harmful to describe.sequential ordering.


Analysis

Correctness

The change is sound. Since RIVETKIT_DRIVER_TEST_RUNTIME, RIVETKIT_DRIVER_TEST_SQLITE, and RIVETKIT_DRIVER_TEST_ENCODING already gate which describe block runs, adding a -t regex is pure noise. More importantly, the project's testing conventions confirm that describe.sequential ordering can be disrupted by Vitest name filtering, so removing -t is the correct fix for any flakes caused by out-of-order execution.

Documentation quality

  • The new note ("Do not use Vitest -t for driver matrix cells") is placed immediately before the base command — exactly where a reader executing the steps would see it. Good placement.
  • The substitution guide now correctly drops the <SUITE_DESCRIPTION> placeholder from commands while retaining it in the progress-file description, which avoids confusion between the two contexts.
  • The debugging section adds a concrete alternative (describe.only) and an explicit prohibition against using -t as a flake workaround. This aligns with the project's rule against papering over flakes (see CLAUDE.md: "Never paper over flakes with retry loops or bumped waits").

Style

All prose follows project comment conventions: lowercase, complete sentences, no em dashes, no unnecessary parentheticals.


Minor Suggestions

  • The file-to-suite-description mapping table is still present even though <SUITE_DESCRIPTION> is no longer used in commands. Consider adding a short note in the table header clarifying it is retained for human-readable progress tracking only (e.g., "Suite descriptions below are for the progress file only; they are not passed to pnpm test"). This prevents a future reader from wondering whether the table is still actionable.
  • The describe.only workaround guidance already mentions removing .only before committing — this is handled well.

Summary

Small, targeted documentation fix with clear motivation and no code risk. The change improves clarity, prevents a class of flakes, and is consistent with the project's testing conventions. No blocking issues.

This was referenced May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant