Increase default value for `network.connection_timeout`

[MarkWendler]

Describe the request

Increase the default value of the network.connection_timeout configuration key to 5? minutes.

Reasons:

• CI/CD systems work by default configs and
• out of the box usability for beginners

Describe the current behavior

Installing a platform that requires the download of large files fails:

SiliconLabs:silabs@3.0.0 context deadline exceeded
Error during install: context deadline exceeded

The failure no longer occurs after I increase the value of the network.connection_timeout configuration key from its default of 60s:

arduino-cli config set network.connection_timeout 240s

To reproduce

Install the SiliconLabs:silabs platform on a machine with a slower Internet connection:

arduino-cli core install SiliconLabs:silabs

or:

arduino-cli core install esp32:esp32 --additional-urls https://espressif.github.io/arduino-esp32/package_esp32_index.json

Arduino CLI version

1.3.1

Operating system

Linux

Operating system version

Ubuntu WSL

Additional context

Additional reports

• Consistent Client.Timeout or context cancellation while reading body error when installing a core with 1.2.2 #2899
• Consistent Client.Timeout or context cancellation while reading body error when installing a core with 1.2.2 #2899 (comment)
• Consistent Client.Timeout or context cancellation while reading body error when installing a core with 1.2.2 #2899 (comment)
• Consistent Client.Timeout or context cancellation while reading body error when installing a core with 1.2.2 #2899 (comment)
• Consistent Client.Timeout or context cancellation while reading body error when installing a core with 1.2.2 #2899 (comment)
• Error: 4 DEADLINE_EXCEEDED when trying to install board software #2944
• https://forum.arduino.cc/t/error-during-install-context-deadline-exceeded/1384509
• https://forum.arduino.cc/t/trouble-updating-lvgl/1386928

Related

• [request] Optimize library size (arduino-cli fails install with default timeout) SiliconLabs/arduino#151

Issue checklist

• I searched for previous requests in the issue tracker
• I verified the feature was still missing when using the nightly build
• My request contains all necessary details

[per1234]

I think that we should start by considering the root cause of these failures. The purpose of the configuration key is described as:

https://arduino.github.io/arduino-cli/dev/configuration/#:~:text=the%20proxy%20server.-,connection_timeout,-%2D%20network%20connection%20timeout

network connection timeout

If the setting truly only established a timeout for the connection to the server, then the default value of 60s should be more than sufficient. If a connection hasn't been made after a minute has passed, it is never going to be made. So the operation should fail at that point rather than wasting any more time waiting.

I don't believe that the failures of the core install commands in these reports were caused by the connection to the server not being accomplished within 60 s. So it seems clear that, despite what is claimed in the documentation, this setting is imposing a timeout on more than only the connection.

We can see the relevant code here:

arduino-cli/internal/cli/configuration/network.go

Lines 101 to 109 in 0b61281

	return &http.Client{
	Transport: &httpClientRoundTripper{
	transport: &http.Transport{
	Proxy: http.ProxyURL(proxy),
	},
	userAgent: userAgent,
	},
	Timeout: settings.ConnectionTimeout(),
	}, nil

arduino-cli/internal/cli/configuration/network.go

Lines 65 to 71 in 0b61281

	// ConnectionTimeout returns the network connection timeout
	func (settings *Settings) ConnectionTimeout() time.Duration {
	if timeout, ok, _ := settings.GetDurationOk("network.connection_timeout"); ok {
	return timeout
	}
	return settings.Defaults.GetDuration("network.connection_timeout")
	}

And the documentation of the effect of setting http.Client.Timeout to 60s here:

https://pkg.go.dev/net/http#Client

Timeout specifies a time limit for requests made by this Client. The timeout includes connection time, any redirects, and reading the response body. The timer remains running after Get, Head, Post, or Do return and will interrupt reading of the Response.Body.