Cannot upgrade from 5.x.x to 6.x.x using Express, Prisma and Multer uploads

[RomainGueffier]

Hi,

Tsoa 6 CLI spec-and-routes is still crashing after multiple attempts to upgrade on each minor version since version 6.
Some issues about this seems similar but have been closed as completed, however I still encounter those issues.
All is working correctly in Tsoa 5

Prisma errors:

There was a problem resolving type of 'Agency'.
Generate routes error.
TypeError: Cannot read properties of undefined (reading 'kind')
at Object.isEnumMember (/home/romain-g/customers-sites/node_modules/typescript/lib/typescript.js:30442:15)
at TypeResolver.calcRefTypeName (/home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:549:20)
at TypeResolver.calcTypeReferenceTypeName (/home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:712:34)
at TypeResolver.calcTypeName (/home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:629:25)
at /home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:663:64
at Array.map (<anonymous>)
at TypeResolver.calcTypeName (/home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:663:47)
at /home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:635:43
at Array.map (<anonymous>)
at TypeResolver.calcTypeName (/home/romain-g/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:632:41)

Multer errors:

.tsoa/routes.ts:2638:56 - error TS2353: Object literal may only specify known properties, and '"multiple"' does not exist in type 'Field'.
  upload.fields([{"name":"file","maxCount":1,"multiple":false}]),

Other errors:

.tsoa/routes.ts:2479:21 - error TS2741: Property 'name' is missing in type '{ in: string; required: true; ref: string; }' but required in type 'ParameterSchema'.
  undefined: {"in":"body","required":true,"ref":"AgentFeesBody"},

Sorting

• I'm submitting a ...

  • bug report
  • feature request
  • support request

• I confirm that I

  • used the search to make sure that a similar issue hasn't already been submit

Expected Behavior

tsoa spec-and-routes to complete without typescript errors.

Ideally:

import type { Agency } from '@prima/client'

export type AgencyJoinActivityResponse = Promise<{ data: Agency }>

@Route('agencies')
@Tags('Agency')
@Security('jwt_token')
@SuccessResponse('201', 'Success')
@Response<AuthErrorResponse>(401, 'Unauthorized')
@Response<AuthErrorResponse>(403, 'Forbidden Access')
@Response<ValidateError>(422, 'ValidationError')
@Response<ServerErrorResponse>(500, 'Internal Error')
export class AgencyController extends Controller {
  @Post()
  @SuccessResponse(201, 'Created')
  async createOneAgency(
    @Request() req: Express.Request,
    @FormField() name: string,
    @FormField() website: string,
    @FormField() description: string,
    @FormField() address: string,
    @UploadedFile() file?: Express.Multer.File
  ): AgencyJoinActivityResponse {
    // ....code
  }
}

Current Behavior

To bypass typescript errors, I had to write:

import type { Agency } from '@prima/client'

export type AgencyJoinActivityResponse = Promise<{ data: {
  name: string
  description: string
  // rewrite prisma types and lost schema sync ! 🔴
}}>

@Route('agencies')
@Tags('Agency')
@Security('jwt_token')
@SuccessResponse('201', 'Success')
@Response<AuthErrorResponse>(401, 'Unauthorized')
@Response<AuthErrorResponse>(403, 'Forbidden Access')
@Response<ValidateError>(422, 'ValidationError')
@Response<ServerErrorResponse>(500, 'Internal Error')
export class AgencyController extends Controller {
  @Post()
  @SuccessResponse(201, 'Created')
  async createOneAgency(
    @Request() req: Express.Request,
    @FormField() name: string,
    @FormField() website: string,
    @FormField() description: string,
    @FormField() address: string,
    @UploadedFile() file?: Express.Multer.File
  ): AgencyJoinActivityResponse {
    // ....code
  }
}

Possible Solution

--

Steps to Reproduce

Run tsoa spec and routes

Context (Environment)

Version of the library: 6.x.x, in example 6.4.0
Version of NodeJS: 18-22
Version of Typescript: 5.5.3

• Confirm you were using yarn not npm: pnpm

Detailed Description

--

Breaking change?

--

[github-actions]

Hello there RomainGueffier 👋

Thank you for opening your very first issue in this project.

We will try to get back to you as soon as we can.👀

[mattdean-digicatapult]

The error

.tsoa/routes.ts:2638:56 - error TS2353: Object literal may only specify known properties, and '"multiple"' does not exist in type 'Field'.
  upload.fields([{"name":"file","maxCount":1,"multiple":false}]),

is something I came across and filed a bug for #1642. Unfortunately it has been closed without a fix. I have recently done some more digging and think the issue is slightly more complicated than I originally thought. This stems from a change in #1620 which introduced the property multiple onto a datatype being passed to multer. Unfortunately the type of the fields method doesn't expect this property. Originally I thought this was just something that can be removed but the property is being used in the hapi template

tsoa/packages/cli/src/routeGeneration/templates/hapi.hbs

Line 74 in d573d6f

{{#if multiple}}

.

I think there are two choices:

• remove the multiple property and implement the logic for multiple based on the presence of the maxCount property
• Prevent the multiple property from being rendered in the express and koa templates. These are currently just using a hleper json

If one of the maintainers can comment I'm more than happy to contribute a fix to this part of the issue

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[RomainGueffier]

Issue is still up to date

[jackey8616]

@RomainGueffier, @mattdean-digicatapult
The file error should be fix after we introduce v6.4.1 or v6.5.0, I'm not sure. cc @WoH

[falk-stefan]

@jackey8616 whyn are we going to have 6.4.1? I am facing the same issue..

[jackey8616]

@jackey8616 whyn are we going to have 6.4.1? I am facing the same issue..

I'm not sure, It depends on our another collaborator @WoH,
whom controls each releases.

[WoH]

We have v6.5 now, thanks for the ping.
I had issues with the npm login a few times last week, but now it seems to be ok again, sorry for the backlog

[RomainGueffier]

Thanks for the work!
Sadly I still encounter issues on my app with tsoa 6.5.1:

There was a problem resolving type of 'EstateAlert'.
There was a problem resolving type of 'APIResponse<EstateAlert[], {"count": number}>'.
There was a problem resolving type of 'EstateAlertArrayResponse'.
Generate routes error.
 TypeError: Cannot read properties of undefined (reading 'kind')
    at Object.isEnumMember (/customers-sites/node_modules/typescript/lib/typescript.js:30511:15)
    at TypeResolver.calcRefTypeName (/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:549:20)
    at TypeResolver.calcTypeReferenceTypeName (/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:712:34)
    at TypeResolver.calcTypeName (/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:629:25)
    at /customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:635:43
    at Array.map (<anonymous>)
    at TypeResolver.calcTypeName (/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:632:41)
    at /customers-sites/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:715:73
    at Array.map (<anonymous>)
    at TypeResolver.calcTypeReferenceTypeName (/customers-sites/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:715:56)

Where EstateAlert type is coming from Prisma (v5.20.0) and contains an enum that seems to cause the issue.

[jackey8616]

@RomainGueffier
Can you provide a minimum repo to reproduce this error?
Also the last work tsoa & primsa version.
Let's see what can I do on this.

[RomainGueffier]

@jackey8616 Working on it but I can't reproduce error for now outside of my company repo 😭. Will let you know thanks!

[RomainGueffier]

OK, after deep investigations, seem like what I tried previously with prisma types to avoid error is the cause of error on this new version of tsoa, so I revert back to use Prisma type directly and it worked!

I face this issue #1582 since it was long time without updating tsoa but there is a workaround. Multer error is also gone.

So everything works !! 🚀 thanks so much for this fix, happy to enter version 6 😄