Users want to have control over the request timeout

[rhamzeh]

Checklist

• I have looked into the README and have not found a suitable solution or answer.
• I have looked into the documentation and have not found a suitable solution or answer.
• I have searched the issues and have not found a suitable solution or answer.
• I have upgraded to the latest version of OpenFGA and the issue still persists.
• I have searched the Slack community and have not found a suitable solution or answer.
• I agree to the terms within the OpenFGA Code of Conduct.

Description

OpenFgaApi methods support passing in a _request_timeout:

python-sdk/openfga_sdk/sync/open_fga_api.py

Lines 64 to 67 in e82545e

	:param _request_timeout: timeout setting for this request. If one
	number provided, it will be total request
	timeout. It can also be a pair (tuple) of
	(connection, read) timeouts.

However the options_to_kwargs

python-sdk/openfga_sdk/sync/client/client.py

Lines 92 to 106 in e82545e

	def options_to_kwargs(options: dict[str, int | str] = None):
	"""
	Return kwargs with continuation_token and page_size
	"""
	kwargs = {}
	if options is not None:
	if options.get("page_size"):
	kwargs["page_size"] = options["page_size"]
	if options.get("continuation_token"):
	kwargs["continuation_token"] = options["continuation_token"]
	if options.get("headers"):
	kwargs["_headers"] = options["headers"]
	if options.get("retry_params"):
	kwargs["_retry_params"] = options["retry_params"]
	return kwargs

does not pass in that option down from the OpenFgaClient methods to the OpenFgaApi methods

Expectation

A user should be able to set the request timeout on a method.

Note that instead of just allowing passing in _request_timeout per method, this should be done like in the Java SDK.

Users should be able to configure a default timeout in the Configuration/ClientConfiguration, and override it per method.

Example in Java: https://github.com/openfga/java-sdk/blob/b1e03e523c530824f5921313c2191dc5f6d93af8/src/main/java/dev/openfga/sdk/api/configuration/BaseConfiguration.java#L22-L24

Reproduction

.

OpenFGA SDK version

v0.6.1

OpenFGA version

N/A

SDK Configuration

N/A

Logs

No response

References

https://cloud-native.slack.com/archives/C06G1NNH47N/p1723022081318009

[GMorris-professional]

I'd like to pick this up 😀 Nevermind I see there is a PR for this already 👍

[rhamzeh]

@Oscmage you have a draft PR for this - are you still working on it?

If not, would you mind if @ryanpq steps in to help take it to completion?

[Oscmage]

Please be my guest!

[ryanpq]

I've revised the updates in the PR to use milliseconds as advised for consistency across sdks while still passing second values to requests and urllib3 as they require.

[Oscmage]

@ryanpq Thanks a lot for taking this all the way.