Replace axios with @actions/http-client #1097
Conversation
Axios has issues with proxies & using the @actions client should behave better in actions enviroments. The built in retry behavior was not as robust so I've implemented retries manually.
mctofu
force-pushed
the
mctofu/replace-axios
branch
from
4647f0e
to
faa5966
Compare
src/api-client.ts
Outdated
| }: ${JSON.stringify(res.result)}` | ||
| ) | ||
| } | ||
| if (res.result == null) { |
There was a problem hiding this comment.
consider idiomatic JS
if(!res.result) {
| ) | ||
| } | ||
|
|
||
| return res.data.data.attributes | ||
| return res.result.data.attributes |
There was a problem hiding this comment.
can any of these be falsy and throw a null ref?
There was a problem hiding this comment.
It wouldn't be expected so a null ref failing the job would be OK.
| ) | ||
| } | ||
| throw error |
There was a problem hiding this comment.
consider adding semicolons at the end to avoid weird JS automatic semicolon injection bugs
There was a problem hiding this comment.
Hm, our formatter does not allow that
| ): Promise<TypedResponse<T>> { | ||
| let attempt = 1 | ||
|
|
||
| const execute = async (): Promise<TypedResponse<T>> => { |
There was a problem hiding this comment.
how does the actions team handle retries? Do they have some utility we can reuse?
There was a problem hiding this comment.
It's embedded in the library and not exported: https://github.com/actions/toolkit/blob/fe3e7ce9a7f995d29d1fcfd226a32bca407f9dc8/packages/http-client/src/index.ts#L444-L450
|
[Aside] will we need to remove |
Co-authored-by: AbdulFattaah Popoola <abdulapopoola@github.com>
mctofu
force-pushed
the
mctofu/replace-axios
branch
from
faa5966
to
6079515
Compare
Axios has issues with proxies. Rather than trying to workaround these problems this swaps our http client to
@actions/http-clientwhich is designed to work in actions environments.The swap was pretty straightforward except the built in retry behavior was not as robust. We needed it to handle additional 5xx codes so I've implemented retries manually.