compatibility with esbuild

[alexandervandekleutab]

When importing stuff like Route, Body, etc from tsoa, bundling code with esbuild fails and tries to use tsoa as the cli.

Sorting

• 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

Steps to Reproduce

• install esbuild and tsoa
• copy the tsoa example from the docs
• bundle it with esbuild src/server.ts target=node --outfile=index.js
• try running it with node index.js
• instead of starting the server as expected, the bundled code is treated as if it were the command line tsoa function.

This can be solved by importing from @tsoa/runtime directly.

Version of the library: "tsoa": "^3.9.0"
Version of NodeJS: v14.17.0

• Confirm you were using yarn not npm: [x]

[WoH]

If this is not a misconfiguration, I'd suspect this would more likely be an esbuild issue.

[WoH]

Guess I was wrong, seems like ts-node has similar issues: #1090
Marking this as a bug.

[jpmtrabbold]

Hi - a bit of more information on this bug. On the built code, there is this:

    exports2.runCLI = runCLI;
    if (!module2.parent)
      runCLI();

somehow, when built with esbuild, runCLI() is executed when the server starts, which makes the whole server process fail. Do you guys have any ideas on how to solve this? @lukeautry

[jpmtrabbold]

Also, info from here:

nodejs v15 deprecated usage of module.parent to detect if module is loaded or running as standalone:
[DEP0144] DeprecationWarning: module.parent is deprecated due to accuracy issues. Please use require.main to find program entry point instead.

From node's documentation:

"When a file is run directly from Node.js, require.main is set to its module. That means that it is possible to determine whether a file has been run directly by testing require.main === module.

For a file foo.js, this will be true if run via node foo.js, but false if run by require('./foo')."

So - would you guys be okay to try to use require.main === module instead of !module.parent?

[WoH]

Also, info from here:

nodejs v15 deprecated usage of module.parent to detect if module is loaded or running as standalone:
[DEP0144] DeprecationWarning: module.parent is deprecated due to accuracy issues. Please use require.main to find program entry point instead.

From node's documentation:

"When a file is run directly from Node.js, require.main is set to its module. That means that it is possible to determine whether a file has been run directly by testing require.main === module.

For a file foo.js, this will be true if run via node foo.js, but false if run by require('./foo')."

So - would you guys be okay to try to use require.main === module instead of !module.parent?

TL;Dr: Yes, feel free to send a PR.

It's a better/recommended way of checking anyway and has no compatibility impact. Not sure why esbuild seems to set a parent here in the transpiled code.

[jpmtrabbold]

@WoH great! PR done, tests passed. The PR is minimal, but let me know if you have any problems with it. Thanks

[jpmtrabbold]

@WoH just so I plan accordingly - are there any releases planned soon for this fix to be available?

[WoH]

I don't tend to give ETAs for OS stuff. But here's a release you may be interested in: v3.13.0

[jpmtrabbold]

Thanks!