Skip to content

Improve implicit FormData detection. Add tests. #1539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aphofstede wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve implicit FormData detection. Add tests. #1539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a39905
Improve implicit form data detection. Add tests.
aphofstede Dec 2, 2025
54adc23
Merge branch 'main' into fix/1538-content-type-detection
aphofstede Feb 26, 2026
791773f
Merge branch 'main' into fix/1538-content-type-detection
aphofstede Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/schema-routes/schema-routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,9 +766,15 @@ export class SchemaRoutes {
// It needed for cases when swagger schema is not declared request body type as form data
// but request body data type contains form data types like File
if (
this.FORM_DATA_TYPES.some((dataType) =>
content.includes(`: ${dataType}`),
)
this.FORM_DATA_TYPES.some((dataType) => {
// Match e.g. ": File" followed by word boundary, array brackets, or union/nullable syntax
// This prevents false positives like ": FileType" or ": SomeFile"
// Escape special regex characters (getSchemaType can theoretically return complex types like "File | null" or "UtilRequiredKeys<File, ...>")
const escapedType = dataType.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");

@js2me js2me Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is regexp is needed here? Why we can not use data from swagger schema ?

@aphofstede aphofstede Jun 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a more specific version of the string includes() that's there now

return new RegExp(`:\\s*${escapedType}(?:\\[\\]|\\s*\\||\\b|$)`).test(
content,
);
Comment on lines +770 to +776

Copilot AI Feb 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex only matches : File followed by []/|/word-boundary, but it won’t match array types produced as : (File)[] (or : (File | null)[]) because of the leading (. If request bodies can contain arrays of file/binary, the workaround will miss them and keep contentKind as JSON. Consider allowing optional parentheses around the matched type (e.g., match :\s*\(?${type}\)? before handling []/unions), or add a dedicated branch to handle the (...)[] form.

Suggested change
// Match e.g. ": File" followed by word boundary, array brackets, or union/nullable syntax
// This prevents false positives like ": FileType" or ": SomeFile"
// Escape special regex characters (getSchemaType can theoretically return complex types like "File | null" or "UtilRequiredKeys<File, ...>")
const escapedType = dataType.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
return new RegExp(`:\\s*${escapedType}(?:\\[\\]|\\s*\\||\\b|$)`).test(
content,
);
// Match e.g. ": File" or ": (File)" (optionally with unions like "(File | null)")
// followed by word boundary, array brackets, or union/nullable syntax.
// This prevents false positives like ": FileType" or ": SomeFile".
// Escape special regex characters (getSchemaType can theoretically return complex types like "File | null" or "UtilRequiredKeys<File, ...>")
const escapedType = dataType.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
// Allow either a bare type or a parenthesized form that may contain unions, e.g. "(File | null)".
const pattern = `:\\s*(?:\\(\\s*${escapedType}(?:\\s*\\|[^)]*)?\\)|${escapedType})(?:\\[\\]|\\s*\\||\\b|$)`;
return new RegExp(pattern).test(content);

Copilot uses AI. Check for mistakes.

@aphofstede aphofstede Jun 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I'm not so sure we want/need that.. Any opinions?

})
) {
contentKind = CONTENT_KIND.FORM_DATA;
}
Expand Down
Loading