Zero length files using `.get()` with `2.5.0`

I’m running node v8.15.1.

Noticed my files were coming down as zero byte files since March 30th 2019 when we did a release.

checked the logs and saw this error:

(node:10933) UnhandledPromiseRejectionWarning: TypeError: stream.pipe is not a function

Code at this point looks like this:

await this.sftp.get(remote_filename).then((stream) => {
  stream.pipe(fs.createWriteStream(local_path));
});

So there is no .pipe() on the stream object at this point for some reason. I did a console log on the stream object and it is a Buffer.

Checked the ssh2-sftp-client version and we were running 2.5.0.

Downgraded to 2.4.3 and the problem resolved itself.

I’m not sure what changed between 2.4.3 and 2.5.0, but clearly it broke my code.

[theophilusx]

The next release which alters API ini any way will have a new major version number. This will also be the practice for all future releases.

[theophilusx]

Agree that the version should have been increased to 3.x.y because the changes broke the existing API. This was in the PR, but did not occur - don’t know why.