fix: correct ajvFilePlugin type to be compatible with Fastify ajv.plugins by nahyeongjin1 · Pull Request #606 · fastify/fastify-multipart

nahyeongjin1 · 2026-02-03T05:55:13Z

Summary

Fix ajvFilePlugin type definition to be compatible with Fastify's ajv.plugins option
Add ajv to devDependencies for type definitions
Change return type from void to Ajv

Problem

The ajvFilePlugin was typed as (ajv: any): void, but Fastify's ajv.plugins expects Plugin<unknown> which requires returning Ajv.

Solution

// Before
export function ajvFilePlugin (ajv: any): void

// After
import type Ajv from 'ajv'
export function ajvFilePlugin (ajv: Ajv): Ajv

Test plan

npm run test:typescript passes
Verified fix resolves the type error when using with Fastify

Fixes #605

mcollina

Can you ads a test for this type? We use tsd.

nahyeongjin1 · 2026-02-03T06:54:34Z

Added type test in types/avj-plugin.test-d.ts with expectType<Ajv> assertion.

Note: The tsd tests are located in types/ directory (not test/), as the test/ folder contains only JS unit tests.

Also noticed the filename has a typo: avj-plugin.test-d.ts should be ajv-plugin.test-d.ts. Would you like me to rename it in this PR as well?

mrazauskas · 2026-02-04T08:13:49Z

The tsd tests are located in types/ directory (not test/), as the test/ folder contains only JS unit tests.

This also means tsd checks only the index.test-d.ts file.

I think the best fix would be to follow the pattern from other fastify packages:

move all type test files to the test/types directory (fix the typo in the file name as well)
set the package.json#tsd.directory field to "test/types"

nahyeongjin1 · 2026-02-04T08:40:49Z

Thanks @mrazauskas for the suggestion!

Done. Moved all type test files to test/types/ directory and fixed the typo (avj → ajv).

The tsd.directory is already set to test, which includes subdirectories, so no config change needed.

mrazauskas · 2026-02-04T08:58:23Z

Thanks! I checked out this branch. All works as expected.

Copilot

Pull request overview

This PR fixes a TypeScript type incompatibility between ajvFilePlugin and Fastify's ajv.plugins option. The plugin was incorrectly typed as returning void when it should return Ajv to satisfy Fastify's Plugin<unknown> interface requirement.

Changes:

Updated ajvFilePlugin type signature to accept Ajv instead of any and return Ajv instead of void
Added ajv v8.17.1 to devDependencies for type definitions
Fixed test file organization by moving from types/ to test/types/ and correcting a filename typo ("avj" → "ajv")

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
types/index.d.ts	Updated ajvFilePlugin type signature and added Ajv type import
package.json	Added ajv to devDependencies for type definitions
test/types/ajv-plugin.test-d.ts	New comprehensive test file for ajvFilePlugin compatibility with proper path
types/avj-plugin.test-d.ts	Removed old test file with typo in filename
test/types/named-import.test-d.ts	Updated import path from '..' to '../..' to reflect new test location
test/types/index.test-d.ts	Updated import path from '..' to '../..' to reflect new test location

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mcollina

lgtm

mcollina · 2026-02-09T22:13:48Z

Ci looks red

nahyeongjin1 · 2026-02-10T02:52:06Z

Fixed the CI failures:

Node.js 22+ test runner was auto-discovering .test-d.ts files in test/ and trying to execute them as regular tests.
Fixed by specifying an explicit glob pattern: node --test 'test/*.test.js'
tsd.directory: Narrowed from test to test/types for more precise targeting, as @mrazauskas suggested.
Swagger schema assertion: @fastify/swagger v9.7.0 introduced requestBody.required when schema.body exists fix(openapi): always set requestBody.required to true when schema.body exists fastify-swagger#903, making the full paths assertion version-dependent.
Changed the test to only verify ajvFilePlugin's core behavior (isFile: true → { type: 'string', format: 'binary' }), which is what this test should be asserting regardless of swagger version.

Could you re-run the CI? Thanks!

ilteoood · 2026-02-18T19:11:26Z

test/multipart-ajv-file.test.js

+   * requestBody.required (fastify/fastify-swagger#903), making the exact
+   * shape version-dependent.
+   */
+  // t.assert.deepStrictEqual(fastify.swagger().paths, {


instead of commenting it out, could you check other parts of the requestBody like the content?
Additionally, you should be able also to check the operation id.

@nahyeongjin1
nit: shouldn't you remove this huge comment and keep just the one below?

Done, removed the commented-out block 👍

nahyeongjin1 · 2026-02-19T04:35:30Z

@ilteoood
Done. Now asserting operationId, requestBody.content, and responses individually.

requestBody.required is intentionally skipped,
because @fastify/swagger v9.7.0 introduced it (fastify/fastify-swagger#903), making it version-dependent.

nahyeongjin1 · 2026-02-20T05:55:04Z

Fixed the Node.js 20 CI failure: glob quotes in node --test 'test/*.test.js' were treated as a literal path.
Removed quotes so the shell handles glob expansion.

Verified all tests pass on Node.js 20, 22, and 24.

CI still red

nahyeongjin1 · 2026-02-20T08:14:00Z

@ilteoood
The CI failure on Node.js 22 + macOS (should finish with error on partial upload - saveRequestFiles) is unrelated to this PR.
It's a flaky test caused by a race condition.
The test checks temp file deletion immediately after receiving the response, but cleanup may not have completed yet on macOS.

I've added a fix using exponential backoff retry for the file deletion check.
Since this is outside the scope of this PR, I can either include it here or open a separate PR for it. Let me know which you'd prefer.

…gins The ajvFilePlugin return type was incorrectly declared as void instead of Ajv.This caused TypeScript errors when using the plugin with Fastify ajv.plugins option Changes: - Add ajv to devDependencies for type definitions - Import Ajv type in types/index.d.ts - Change ajvFilePlugin signature from (ajv: any): void to (ajv: Ajv): Ajv Fixes fastify#605

Added expectType<Ajv> assertion to verify ajvFilePlugin correctly returns Ajv instance.

- Move type test files from types/ to test/types/ - Fix filename typo: avj-plugin.test-d.ts -> ajv-plugin.test-d.ts - Update import paths from '..' to '../..'

Node.js 22+ test runner auto-discovers .ts files in the test/ directory, causing tsd type test files (.test-d.ts) to be executed as regular tests. Changes: - Specify explicit glob pattern to only run .test.js files - Narrow tsd directory from test/ to test/types/ for precise targeting - Update swagger schema assertion to include requestBody.required field added by newer @fastify/swagger versions

Only verify ajvFilePlugin's core behavior (isFile -> string/binary) instead of the full paths object. The requestBody.required field was introduced in @fastify/swagger v9.7.0 (fastify/fastify-swagger#903), making the exact shape version-dependent.

…heck

nahyeongjin1 · 2026-02-23T05:03:20Z

Rebased on main.
Note that #607 added required: true to the full deepStrictEqual assertion.
But this PR takes a different approach — asserting operationId, requestBody.content, and responses individually, intentionally skipping requestBody.required since it's version-dependent (@fastify/swagger v9.7.0+).

If you'd prefer the #607 approach (full assertion with required: true), let me know and I'll revert to that.

mcollina requested changes Feb 3, 2026

View reviewed changes

nahyeongjin1 requested a review from mcollina February 3, 2026 06:57

Fdawgs requested a review from Copilot February 4, 2026 09:34

Copilot started reviewing on behalf of Fdawgs February 4, 2026 09:34 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

mcollina approved these changes Feb 9, 2026

View reviewed changes

nahyeongjin1 force-pushed the fix/ajv-file-plugin-type branch 3 times, most recently from 751fbec to 431f3ee Compare February 10, 2026 02:37

ilteoood reviewed Feb 18, 2026

View reviewed changes

nahyeongjin1 requested a review from ilteoood February 19, 2026 04:35

ilteoood approved these changes Feb 19, 2026

View reviewed changes

nahyeongjin1 requested a review from ilteoood February 19, 2026 07:38

ilteoood approved these changes Feb 19, 2026

View reviewed changes

nahyeongjin1 requested a review from ilteoood February 20, 2026 05:55

ilteoood previously approved these changes Feb 20, 2026

View reviewed changes

nahyeongjin1 requested a review from ilteoood February 20, 2026 08:46

nahyeongjin1 added 3 commits February 23, 2026 13:52

test: add explicit type test for ajvFilePlugin return type

fc48053

Added expectType<Ajv> assertion to verify ajvFilePlugin correctly returns Ajv instance.

refactor: move tsd type tests to test/types directory

df35834

- Move type test files from types/ to test/types/ - Fix filename typo: avj-plugin.test-d.ts -> ajv-plugin.test-d.ts - Update import paths from '..' to '../..'

nahyeongjin1 added 6 commits February 23, 2026 13:52

test: assert operationId, content, and responses individually

0e813ac

test: remove commented-out assertion block

2bce1dd

fix(ci): remove quotes from test glob for Node.js v20 compatibility

9bccc1e

fix: add retry with exponential backoff for flaky temp file cleanup c…

6fee76d

…heck

nahyeongjin1 force-pushed the fix/ajv-file-plugin-type branch from 74f4f71 to 6fee76d Compare February 23, 2026 05:00

style: fix formatting

485e024

Uh oh!

Comments

Conversation

nahyeongjin1 commented Feb 3, 2026

Summary

Problem

Solution

Test plan

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

nahyeongjin1 commented Feb 3, 2026

Uh oh!

mrazauskas commented Feb 4, 2026

Uh oh!

nahyeongjin1 commented Feb 4, 2026

Uh oh!

mrazauskas commented Feb 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

mcollina commented Feb 9, 2026

Uh oh!

nahyeongjin1 commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ilteoood Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

ilteoood Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

nahyeongjin1 Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

nahyeongjin1 commented Feb 19, 2026

Uh oh!

nahyeongjin1 commented Feb 20, 2026

Uh oh!

nahyeongjin1 commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nahyeongjin1 commented Feb 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

nahyeongjin1 commented Feb 10, 2026 •

edited

Loading

nahyeongjin1 commented Feb 20, 2026 •

edited

Loading