SteamKit icon indicating copy to clipboard operation
SteamKit copied to clipboard
verified publisher icon SteamRE

WebAPI DefaultTimeout is not set to a reasonable default

Open azuisleet opened this issue 4 years ago • 4 comments

The default timeout for WebAPI requests is set to a fixed 100 seconds currently, and there's no simple way to reconfigure it for classes like SteamDirectory that use the SteamConfigurationWebAPIExtensions to generate WebAPI interfaces from the SteamConfiguration.

https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Steam/WebAPI/WebAPI.cs https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Steam/WebAPI/SteamConfigurationWebAPIExtensions.cs

There should probably be:

  1. A reasonable default closer to ConnectionTimeout (understanding that for HTTP requests, this is a full round trip timeout)
  2. The option to configure the timeout

azuisleet avatar Jun 02 '21 16:06 azuisleet

  • Why do we need to reconfigure it?
  • What is a "reasonable" timeout?
  • Are you trying to lower or raise the timeout? ConnectionTimeout seems to be much lower.
  • Would something like making WebAPI.DefaultTimeout settable resolve the problem (if perhaps not ideal) or do you want different timeouts for different interfaces?

yaakov-h avatar Jun 03 '21 07:06 yaakov-h

  1. If the user can configure all the other timeouts, including ConnectionTimeout and CDNClient timeouts, they should also be able to configure the timeouts that affect all WebAPI based requests.
  2. A reasonable timeout is probably closer to 30 seconds for a full request and response.
  3. I want to lower the timeout used to fetch the server list in SteamDirectory, as ConnectionTimeout is set to 5 seconds while the lookup is set to 100 seconds, as this affects how long CMClient.Connect takes (105 seconds in this case)
  4. Being able to set WebAPI.DefaultTimeout would be sufficient.

Also to be clear, if you own a WebAPI instance, there is a configurable Timeout property. https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Steam/WebAPI/WebAPI.cs#L47

In this case, SteamDirectory owns the WebAPI instance https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Steam/WebAPI/SteamDirectory.cs#L50

azuisleet avatar Jun 03 '21 17:06 azuisleet

SteamDirectory owns it, and has a SteamConfiguration instance, so I'm tempted to add SteamConfiguration.WebApiTimeout so that it's not just some big static that people have to mutate.

Any thoughts on that?

yaakov-h avatar Oct 02 '21 13:10 yaakov-h

SteamConfiguration.WebApiTimeout sounds good because you can get instances of WebAPI from Configuration.

xPaw avatar Mar 21 '23 08:03 xPaw