fix #2458 add HTTP proxy support to UrlConnectionHttpClient

[MikeDombo]

Motivation and Context

Resolves #2458. The goal of this change is to add full proxy support to the UrlConnectionHttpClient so that our project can remove the Apache HTTP Client and instead rely on Java builtins. This change must support HTTP and HTTPS proxies with username/password authorization.

Modifications

Adds HTTP proxy support to the UrlConnectionHttpClient by using largely the same ProxyConfiguration class as is in the Apache HTTP Client. If the user configures a proxy using the builder, and the request isn't going to a non-proxy host, then the request will go through the application proxy using Java's builtin Proxy class.

Testing

Manually tested using a local squid proxy via HTTP without authentication.

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Checklist

• I have read the CONTRIBUTING document
• Local run of mvn install succeeds
• My code follows the code style of this project
• My change requires a change to the Javadoc documentation
• I have updated the Javadoc documentation accordingly
• I have added tests to cover my changes
• All new and existing tests passed
• I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
• My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

• I confirm that this pull request can be released under the Apache 2 license

[sonarqubecloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

8.2% Coverage
38.4% Duplication

[debora-ito]

@MikeDombo can you please add unit tests?

[joviegas]

Since this is Duplicate function same as software.amazon.awssdk.http.apache.ProxyConfiguration can we move this to Utils like in function ApacheUtils ?

[joviegas]

Can we have more descriptive Java Doc for this class similar to one ProxyConfiguration of NettyNioAsyncHttpClient

[joviegas]

Is there a way to test this in junit or Integration tests ?
Did you get a chance to test this one , please let us know the steps.
We can discuss this offline on slack,

[joviegas]

Can we add Builder with consumer also ?

[joviegas]

To be consistent with other http client lets assign the ProxyConfiguration directly to the class Field as done in other client constructors , I didnot get the benefit of assigning it to a AttributeMap and then doing a get.

Can we do something similar to ApacheHttpClient ?

[joviegas]

can we simplify the code as below ?

    private HttpURLConnection createDefaultConnection(URI uri, SSLSocketFactory socketFactory) {

        Optional<Proxy> proxy = determineProxy(uri);

        HttpURLConnection connection = !proxy.isPresent() ?
                                       invokeSafely(() -> (HttpURLConnection) uri.toURL().openConnection())
                                                          :
                                       invokeSafely(() -> (HttpURLConnection) uri.toURL().openConnection(proxy.get()));

        if (connection instanceof HttpsURLConnection) {
            HttpsURLConnection httpsConnection = (HttpsURLConnection) connection;

            if (options.get(SdkHttpConfigurationOption.TRUST_ALL_CERTIFICATES)) {
                httpsConnection.setHostnameVerifier(NoOpHostNameVerifier.INSTANCE);
            }
            httpsConnection.setSSLSocketFactory(socketFactory);
        }

        if (proxy.isPresent() && shouldProxyAuthorize()){
            connection.addRequestProperty("proxy-authorization", String.format("Basic %s", encodedAuthToken(proxyConfiguration)));
        }
        connection.setConnectTimeout(saturatedCast(options.get(SdkHttpConfigurationOption.CONNECTION_TIMEOUT).toMillis()));
        connection.setReadTimeout(saturatedCast(options.get(SdkHttpConfigurationOption.READ_TIMEOUT).toMillis()));

        return connection;
    }

    private boolean shouldProxyAuthorize() {
        return this.proxyConfiguration != null 
               && StringUtils.isEmpty(this.proxyConfiguration.username()) 
               && StringUtils.isEmpty(this.proxyConfiguration.password());
    }


    /**
     * If a proxy is configured with username+password, then set the proxy-authorization header to authorize ourselves with the
     * proxy
     */
    private static String encodedAuthToken(ProxyConfiguration proxyConfiguration) {

        String authToken = String.format("%s:%s", proxyConfiguration.username(), proxyConfiguration.password());
        return Base64.getEncoder().encodeToString(authToken.getBytes(StandardCharsets.UTF_8));
    }

    private Optional<Proxy> determineProxy(URI uri) {
        if (isProxyEnabled(proxyConfiguration) && !isProxyHostExcluded(uri)) {
            return Optional.of(
                new Proxy(Proxy.Type.HTTP,
                          new InetSocketAddress(this.proxyConfiguration.host(), this.proxyConfiguration.port())));
        }
        return Optional.empty();
    }

[debora-ito]

Superseded by #3112. Closing.