web-api: expose axios interceptors as WebClient constructor option

[mtjandra]

I'd like to transform outgoing requests from the @slack/web-api package similar to other SDKs such as

• Github - @octokit/rest
  • can transform outgoing requests uses the concept of hooks
• Datadog - @datadog/datadog-api-client
  • can transform outgoing request by overriding their default httpClient

This Slack SDK allowa adding additional headers but I require more flexibility. Taking a look at the source it seems it is using axios under the hood (ref). Axios seems to support the concept of interceptors which would support my use case.

I'd like to transform all outgoing requests into POST requests with a body representing the original request, add custom headers, then re-route that to a proxy. Is this possible to configure with the current version @slack/web-api?

If what I'm asking for is not currently possible, is there anything in the works?

---

Side note: was also thinking we could override the method making the outgoing request (makeRequest), although I'm confused why all outgoing requests are post requests

[filmaj]

It may be possible in JavaScript, though you'd have to reach in to the private axios instance contained within WebClient, which may be tricky - not sure what the state of the art for ignoring class visibility modifiers is in JS 🤷

Alternatively, this could be a new feature request: expose some option on the WebClient constructor to provide the ability to specify interceptors.

although I'm confused why all outgoing requests are post requests

Because this project is aimed at interacting solely with the Slack HTTP API, and it is designed to accept POST requests for any HTTP API method you wish to interact with, this is a convenient approach for the API client. See this brief overview in our docs for details, in particular:

Pass arguments as POST parameters presented as application/x-www-form-urlencoded
When sending a HTTP POST, you may present your arguments as either standard POST parameters, or you may use JSON instead.

[mtjandra]

Hi @filmaj thank you for the reply.

you'd have to reach in to the private axios instance contained within WebClient

I would like to avoid overriding and/or modifying private methods/variables as it could lead to unexpected behaviour and breaking changes on version updates.

Alternatively, this could be a new feature request: expose some option on the WebClient constructor to provide the ability to specify interceptors.

Yes it would be amazing if this could be added as a feature. I'm sure other consumers would benefit from this feature as well. It seems fairly common for SDKs to allow consumers to hook into the request life cycle.

[filmaj]

OK, I've set it as a feature / enhancement. We cannot promise any delivery timelines for it. However, if this is something you need, we welcome pull requests!

[mtjandra]

@filmaj I have created a pr: #2076

I've sign the contributor license agreement, but CI is still failing, you may need to re-run the check on your side.

Please advise.

[filmaj]

Closing and re-opening - this sometimes helps reset the CLA robot.

[filmaj]

I meant to do on the PR, woopsie. Anyways, the CLA check is now resolved. Will review your PR shortly. Thank you for sending it!

[mtjandra]

@filmaj any idea on when a new release will be published with these changes?

I would love to start making use of it!

[filmaj]

Just released web-api 7.7.0 on npm and as a GitHub Release!