addChunked stream version method for Node.js, #1513

[koltyakov]

Category

• Bug fix?
• New feature?
• New sample?
• Documentation update?

Related Issues

mentioned in #1513

What's in this Pull Request?

The PR adds addChunked method extension to support ReadStream in Node.js.

Guidance

For a test, run npm run test -- -g 'nodejs - sp-extensions'

Usage: when Node.js sp-extensions are loaded addChunked method is extended and "polyfilled" to support stream content received with Node's fs.createReadStream.

const stream = fs.createReadStream('/path/to/file.dat');
await files.addChunked(name, stream);

Existing user implementations should not fail. When no-stream content is passed, it is processed as previously.

[patrick-rodgers]

Awesome, thanks! We'll have a look and get it merged ahead of the release Friday so will land in 2.1.0.

[patrick-rodgers]

TIL about the -g option for mocha. That is awesome. Thanks for doing this, will be a big help for folks in node. I added the methods to the docs page too.

[koltyakov]

Oh, docs, that's what I forgot completely.

Tested the published version's method by uploading 3GB file and checking if I can playback it after. Went well. But found a nuance which we could add to docs as well. Readable stream should be created with fixed hight water mark equal to chunk size:

// Important: highWaterMark must be equal to chunkSize
const rs = fs.createReadStream(filePath, { highWaterMark: chunkSize });

Linking a comment with usage sample for those who found a the PR directly #1513 (comment)