[BUG] Multiple openapi-generator-cli processeses may download jar to corrupt file

🐛 Bug Report:

Describe the bug

When multiple node processes execute openapi-generator-cli, and multiple node processes download the openapi-generator jar file, it may become corrupt.

Steps to Reproduce

Steps to reproduce the behavior:

1. Execute 2 or more node processes that execute openapi-generator-cli
2. If they both detect that the openapi-generator jar should be downloaded, both will do so simultaneously, to the same location.
3. Both processes write to the same file, and it may become corrupt.

Expected behavior

There should not be any file corruption, and also not any errors.

You may use a file lock, or download it to a temporary location and move it atomically to the correct location after downloading.

Screenshots

Excerpt of openapi-generator-cli downloading the jar file.

Download 5.0.0-beta2 ...                                                                                                                                                     
(node:18698) UnhandledPromiseRejectionWarning: Error: Error: Invalid or corrupt jarfile /home/hidde.wieringa/Projects/api/node_modules/@openapitools/openapi-generator-cli/ve
rsions/5.0.0-beta2.jar                                                                                                                                                       
                                                                                                                                                                             
    at /home/hidde.wieringa/Projects/api/node_modules/@openapitools/openapi-generator-cli/main.js:613:32                                                                     
    at ChildProcess.exithandler (child_process.js:315:5)                                                                                                                     
    at ChildProcess.emit (events.js:315:20)                                                                                                                                  
    at maybeClose (internal/child_process.js:1048:16)                                                                                                                        
    at Socket.<anonymous> (internal/child_process.js:439:11)                                                                                                                 
    at Socket.emit (events.js:315:20)                                                                                                                                        
    at Pipe.<anonymous> (net.js:673:12)                                                                                                                                      
(Use `node --trace-warnings ...` to show where the warning was created)                                                                                                      
(node:18698) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by
 rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see
 https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)                                                                                           
(node:18698) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js pro
cess with a non-zero exit code.                                                                                                                                              
Downloaded 5.0.0-beta2                                                                                                                                                       
[main] INFO  o.o.codegen.DefaultGenerator - Generating with dryRun=false                                                                                                     

Operation System (please complete the following information):

• Debian 10

Package System (please complete the following information):

• 1.0.18-5.0.0-beta2
• Yarn workspaces is in use

Additional context

[hiddewie]

@kay-schecker

I would like to request this issue re-opened. As mentioned in the issue description, Yarn workspaces are in use. That means that a single node_modules folder is used for (many) workspaces. The workspaces contain the Node code and configuration (including openapitools.json for many workspaces).

This means that the solution for multiple generators in openapitools.json will not work, because the workspaces each have their own openapitools.json file.

We use gulp to call tasks in workspaces in parallel, because Yarn workspaces are fully indepentent, including the generation of their code clients with openapi-generator-cli.

Approximate directory layout:

.
  node_modules
    @openapitools
      openapi-generator-cli
        (binary, invoked concurrently)
  packages
    app-a
      openapitools.json
      package.json
    app-b
      openapitools.json
      package.json

The workaround of calling openapi-generator-cli version-manager set 5.0.0-beta2 will work as a workaround, but requires that the root project knows the version of openapi-generator of each of the workspaces. This is not a good thing, because the workspaces should be independent.

My request remains: the downloading of the binary concurrently should be done correctly, by either locking the file in the filesystem, or by downloading it to a temporary directory and then moving it atomically to the correct location.

[kay-schecker]

🎉 This PR is included in version 2.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀