UploadV2 fails to recognize csv-stringify stream as a ReadableStream and errors

[elrob]

(Filling out the following with as much detail as you can provide will help us solve your issue sooner.)

Packages:

Select all that apply:

• @slack/web-api
• @slack/rtm-api
• @slack/webhooks
• @slack/oauth
• @slack/socket-mode
• @slack/types
• I don't know

Reproducible in:

The Slack SDK version

"slack/web-api": "^6.8.0",

Node.js runtime version

v18.12.1

OS info

Linux

Steps to reproduce:

1. Generate a basic CSV with https://csv.js.org/stringify/
2. This returns a node.js stream.Transform which extends Duplex which extends Readable which implements NodeJS.ReadableStream
3. However, file upload v2 fails and it enters this if statement:

   node-slack-sdk/packages/web-api/src/file-upload.ts

   Line 262 in acef8cf

   if (file && !(typeof file === 'string' || Buffer.isBuffer(file) || (file as any) instanceof ReadStream)) {

4. For some reason, (file as any) instanceof ReadStream must be returning false, I believe.

Expected result:

API successfully uploads the file from the stream.
It worked fine before switching to uploadV2.

Actual result:

error:

"errorMessage": "file must be a valid string path, buffer or ReadStream",
    "code": "slack_webapi_file_upload_invalid_args_error",
    "stack": [
        "Error: file must be a valid string path, buffer or ReadStream",
        "    at errorIfInvalidOrMissingFileData (/var/task/node_modules/@slack/web-api/dist/file-upload.js:234:43)",
        "    at getFileData (/var/task/node_modules/@slack/web-api/dist/file-upload.js:91:5)",
        "    at getFileUploadJob (/var/task/node_modules/@slack/web-api/dist/file-upload.js:20:28)",
        "    at WebClient.getAllFileUploads (/var/task/node_modules/@slack/web-api/dist/WebClient.js:377:71)",
        "    at WebClient.filesUploadV2 (/var/task/node_modules/@slack/web-api/dist/WebClient.js:286:40)",
        "    at file:///var/task/dist/slack-api.js:47:44",

[elrob]

Update, I think it may be because the check is checking if it is an fs ReadStream rather than a generic ReadableStream...

[zimeg]

Hi @elrob! 👋 Thank you for sharing the steps to reproduce this error – I am seeing this same thing. Good call with the ReadStream vs generic ReadableStream check too. It appears that this is exactly the issue!

Testing this against the changes from #1577 seems to remove the error and successfully upload Readable file types. Once this PR is merged and released, this error should be gone!

[seratch]

Hey @elrob, it's been a while! (Hope you remember me😸) Thanks a lot for taking the time to report this!

[elrob]

Hey @seratch ! I wondered whether to ping you as I saw that you were a top contributor on this repo but I thought I'd be patient and polite first. 😆 Of course I remember you!

You're still the emoji for :forever_supporter: in our slack!

[elrob]

Related but not the same issue...
I noticed that this method also requires additional permission scopes:
It looks like files:read is required where it wasn't before.
Is there anything else that is newly required?

 "errorType": "Error",
    "errorMessage": "An API error occurred: missing_scope",
    "code": "slack_webapi_platform_error",
    "data": {
        "ok": false,
        "error": "missing_scope",
        "needed": "files:read",
        "provided": "chat:write,chat:write.public,files:write",
        "response_metadata": {
            "scopes": [
                "chat:write",
                "chat:write.public",
                "files:write"
            ],
            "acceptedScopes": [
                "files:read"
            ]
        }
    },

[seratch]

@elrob As you observed, files:read scope is necessary for the v2 method by default. The additional scope is used to make returned data compatible with files.upload's. If you don't need any file metadata properties apart from file IDs, you can pass request_file_info: false to turn the additional API calls off.

[elrob]

Thank you!

[filmaj]

This was resolved in #1577 and will be shipped (shortly!) in @slack/web-api@6.8.1 - working on the release now.

[elrob]

Thank you!

I can confirm that uploadV2 is now working for us with a stream and using request_file_info: false to avoid needing to add another permission scope.

Thanks for the quick response and turnaround!