List routes command fails

[targos]

Happy to provide more information if you need it. node ace list:routes (with or without --json) works fine in the terminal.

[Julien-R44]

It's weird, I can't really say why.
Is it possible for you to share the return of node ace list:routes --json?

I can't reproduce the problem, either on Mac/Linux/Windows and I tried on several projects with different routes
( Thank you for taking the time to write all these issues 👍 )

[targos]

I can't really share it (it's private customer's code)

[targos]

Would there be a way for me to debug it locally? I'd like to add a breakpoint where the JSON.parse happens.

[Julien-R44]

The only way I can see right now would be to clone the repo and debug locally 😓

That said, it's very simple, basically: clone, npm install, add a breakpoint here:

adonis-vscode-extension/src/commands/list/Routes.ts

Line 31 in 7c412cb

const jsonRoutes = JSON.parse(rawRoutes)

Then press F5, it opens a new VSCode editor, open the problematic project in it, and do the ListRoutes thing

Sorry to ask you this, I guess it's just a small error 😓
However, no hurry if you don't have much time right now, I'll investigate a bit more on my side.

[targos]

What I found is that the result of the command is truncated (the end of the output is missing).
I'm not sure it will work (and I don't have more time now to try, maybe this evening), but I suggest that instead of doing cd xxx && command, you run the command using the cwd option

adonis-vscode-extension/src/commands/BaseCommand.ts

Lines 183 to 187 in f559b92

	command = `node ace ${command}`
	let cmd =
	platform === 'win32' && !Config.misc.useUnixCd
	? `cd /d "${adonisProject.path}" && ${command}`
	: `cd "${adonisProject.path}" && ${command}`

https://nodejs.org/dist/latest-v18.x/docs/api/child_process.html#child_processexeccommand-options-callback

[targos]

I tried it (and I think it's better that way regardless), but that doesn't fix the problem.

[targos]

This is probably nodejs/node#19218

[targos]

If I understand the problem correctly, the bug is actually in ace/AdonisJS, where process.exit is called while there is still something in the queue to be printed to stdout.

[targos]

@thetutlage is that possible?

[thetutlage]

@targos Maybe. Since you are debugging it all locally. Can you please add stayAlive property to this command https://github.com/adonisjs/core/blob/develop/commands/ListRoutes/index.ts#L62

[Julien-R44]

Thank you for investigating Michaël

On my side, impossible to reproduce the problem, even with more than +500 different defined routes and thus a consequent output 🤔

[targos]

Are you on a Mac @Julien-R44 ?

[Julien-R44]

Mostly on Windows, but I have a mac and ubuntu on hand and have been unable to reproduce the bug on all three different configurations. You are experiencing this bug on Windows, right?

[targos]

No, I can only reproduce on Mac. No issues with the same project on Windows.

[Julien-R44]

Ok finally the problem occurs under my mac with my file containing more than 500 routes !

@thetutlage I was able to add stayAlive to true on ListRoutes, and indeed the problem disappears.
I also tried to increase the maxBuffer property all the way, but the problem persists.

Should we add this stayAlive on ListRoutes? I don't know if this is the right solution, I will read more about it

[thetutlage]

stayLive is okay to use, since it waits for the Node process to shutdown gracefully. Just make sure to call await this.application.shutdown() inside the command run method.

[Julien-R44]

Future readers, if you encounter the same issue :
Upgrade adonisjs/core to at least 5.7.6 and run node ace generate:manifest

[thetutlage]

Is it true that this is indeed an issue nodejs/node#19218, which is caused by exiting the process with process.exit call?

And the only available solution right now is to let the process shutdown gracefully?