RestClient methods to have a configurable timeout

[sosadchuk]

Hi,

The RestClient class static methods lack timeout support for client-side connection errors like host resolution. The default NodeJS timeout would be around 2-3 minutes, which might be too much.

The http module already supports timeouts (see the ClientRequestArgs interface), and the AbstractRestClient.request() could be ehanced to set timeout option either in the .buildOptions() method, or by calling the clientRequest.setTimeout(N); after creating one of http/https clients.

In addition to that an event listener is needed, similar to the one you have for the error event:

clientRequest.on("timeout", () => {
                reject(this.populateError({
                    msg: "Failed to send an HTTP request.",
                    causeErrors: "Connection timeout.",
                    source: "client"
                }));
            });

And the last item would be the RestClient which methods need to accept and bypass the timeout option. I believe a static property common for all requests should be fine.

Thanks,
Sergei.

[github-actions]

Thank you for raising this enhancement request.
The community has 90 days to vote on it.
If the enhancement receives at least 5 upvotes, it is added to our development backlog.
If it receives fewer votes, the issue is closed.