Skip to content

Follow-up PR: Add solid-query and solid-start to snapshot test coverage #3370

Description

@mhamri

Acknowledgement

  • I acknowledge that issues using this template may be closed without further explanation at the maintainers' discretion.

Comment

Motivation

follow up fro #3369

tests/configs/solid-query.config.ts and tests/configs/solid-start.config.ts already exist, but neither is wired into the snapshot test pipeline. As a result:

  • Generated output for solid drifts silently between releases.
  • Issue #3365 (broken UseMutationOptions Accessor type on the user-facing mutation?: param) would have been caught at PR time if these snapshots were active.
  • Type renames in @tanstack/solid-query (e.g. SolidMutationOptionsMutationOptions in v5.100.6) currently only surface via the samples/solid-query/* typecheck, which not every contributor runs.

The previous PR (#TBD — "fix(query): emit plain SolidMutationOptions for user-facing mutation param") fixed the runtime/type bug. This PR adds the regression net.

Scope

Add solid-query and solid-start to tests/api-generation.spec.ts snapshot coverage. No production code changes.

Size estimate

Framework New files Size
solid-query 217 ~580K
solid-start 137 ~277K
Total ~354 ~860K

Comparable to existing vue-query (286 files) and svelte-query (268 files) snapshot dirs. Smaller than react-query (983 files).

Tasks

1. Wire up generation scripts

In tests/package.json under scripts, add two entries alongside the existing generate:* scripts:

"generate:solid-query": "orval --config ./configs/solid-query.config.ts",
"generate:solid-start": "orval --config ./configs/solid-start.config.ts",

run-p 'generate:*' (already the generate-api script) picks them up automatically.

2. Add snapshot dirs to the spec

In tests/api-generation.spec.ts, add the two dirs to the dirs array:

await describeApiGenerationSnapshots({
  dirs: [
    generated('angular'),
    generated('angular-query'),
    // …existing entries…
    generated('solid-query'),
    generated('solid-start'),
    generated('svelte-query'),
    // …
  ],
  // …
});

Keep the list alphabetically sorted to match the existing convention.

3. Generate and commit the initial snapshots

bun run --filter orval-tests generate-api
bun run --filter orval-tests test:snapshots:update

This will populate tests/__snapshots__/solid-query/ and tests/__snapshots__/solid-start/. Commit them as-is.

4. Verify

bun run --filter orval-tests test:snapshots
bun run --filter '@orval/query' typecheck
bun run --filter '@orval/query' test

Also verify tests/scripts/typecheck-generated.mjs picks up the new directories — it currently iterates everything under generated/, so no edits expected, but confirm by running:

bun run --filter orval-tests build

5. (Optional but useful) Document the gap

Add a one-liner to packages/query/DEVELOPMENT.md noting that solid-query / solid-start are now snapshot-covered, so future framework-adapter changes need an update run.

What this does NOT include

  • No production code in packages/query/src/** — this is purely test infrastructure.
  • No changes to samples/solid-query/* — those keep their existing tsc --noEmit test as the second line of defense.
  • No new framework features.

Pre-approval needed

Before I create PR please confirm that adding ~354 snapshot files is acceptable before doing the work. The diff will be large by file count but is mechanically generated and matches the established pattern for other framework adapters.

Metadata

Metadata

Assignees

Labels

duplicateThis issue or pull request already existssolidSolidJS or SolidStart

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions