oci-go-sdk icon indicating copy to clipboard operation
oci-go-sdk copied to clipboard

add http client timeout option to raw config provider

Open MKrupauskas opened this issue 2 years ago • 2 comments

Currently, the base http client is always initialized with a defaultTimeout of 1 minute. This value cannot be overriden.

A timeout of 60 seconds is not sufficient when using the objectstorage package to upload blobs larger than a few gigabytes. The user should be able to set the timeout value depending on their use case. For example, we're uploading image builds with sizes of a few gigabytes. A timeout of 60 seconds is not enough to complete the upload request.

This PR adds an HTTP timeout config option to the raw config provider. It was implemented with the option function pattern as to not break the public API while adding new options.

A small internal httpConfigurationProvider interface was introduced to prevent a larger change of extending the config provider interface. There are many config provider implementations that would have need to changed if we extended the main interface. Doing it this way we introduce only the minimal amount of changes needed to implement the behavior we want.

Added unit tests to verify the correct behavior of the extended raw config provider implementation.

--- PASS: TestHTTPTimeoutRawConfigurationProvider (0.00s)
    --- PASS: TestHTTPTimeoutRawConfigurationProvider/default (0.00s)
    --- PASS: TestHTTPTimeoutRawConfigurationProvider/timeout_option (0.00s)

We're already using this patch internally in our codebase. Please merge it so we can follow upstream directly again.

The commit is signed of as per CONTRIBUTING.md.

MKrupauskas avatar Mar 22 '23 21:03 MKrupauskas

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA). The following contributors of this PR have not signed the OCA:

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

I've signed the OCA.

MKrupauskas avatar Mar 22 '23 21:03 MKrupauskas