Add back ability to customise OkHttp client

[cdlewis]

Motivation

Prior to 0a71f48, users could customise the OkHttp client used by React Native on Android by calling replaceOkHttpClient in OkHttpClientProvider.

This functionality has a variety of legitimate applications from changing connection timeouts or pool size to Stetho integration. The challenge is to add back support for replacing the client without causing a breaking change or reintroducing the problems @olegbl sought to address in his original commit.

Introducing a client factory archives these aims, it adds a new, backwards compatible interface and is called each time a client is requested rather than re-using the same instance (unless you explicitly want this behaviour, in which case you could replicate it using a static class property inside your custom factory).

A number of PRs have been opened to add this functionality: #14675, #14068.

I don't have a lot of Java experience so I'm open to better/more idiomatic ways to achieve this :)

Test Plan

Create React Native application and set a custom factory in the constructor, e.g. OkHttpClientProvider.setOkHttpClientFactory(new CustomNetworkModule());

Where a custom factory would look like:

class CustomNetworkModule implements OkHttpClientFactory {
    public OkHttpClient createNewNetworkModuleClient() {
        return new OkHttpClient.Builder().build();
    }
}

Related PRs

Remove the existing replace client method to prevent accident use and alert existing users that its functionality has changed: #16972

Release Notes

[Android] [Minor] [Networking] - | Provide interface for customising the OkHttp client used by React Native |

[facebook-github-bot]

@cdlewis I tried to find reviewers for this pull request and wanted to ping them to take another look. However, based on the blame information for the files in this pull request I couldn't find any reviewers. This sometimes happens when the files in the pull request are new or don't exist on master anymore. Is this pull request still relevant? If yes could you please rebase? In case you know who has context on this code feel free to mention them in a comment (one person is fine). Thanks for reading and hope you will continue contributing to the project.

[cdlewis]

@hramos and @mkonicek have been reviewers on similar PRs.

[facebook-github-bot]

@hramos is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

[facebook-github-bot]

@hramos is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

[facebook-github-bot]

I tried to merge this pull request into the Facebook internal repo but some checks failed. To unblock yourself please check the following: Does this pull request pass all open source tests on GitHub? If not please fix those. Does the code still apply cleanly on top of GitHub master? If not can please rebase. In all other cases this means some internal test failed, for example a part of a fb app won't work with this pull request. I've added the Import Failed label to this pull request so it is easy for someone at fb to find the pull request and check what failed. If you don't see anyone comment in a few days feel free to comment mentioning one of the core contributors to the project so they get a notification.

[hramos]

Can you rebase? We just need to move this past a problematic one week old commit before we can import it.

[facebook-github-bot]

@hramos is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

[denisk20]

@cdlewis I'm trying to use this but I'm getting an error if I add the

OkHttpClientProvider.setOkHttpClientFactory(new PinningOkHttpClientFactory());

into my Application.onCreate(). Removing the line fixes the error.

The error:

java.lang.ClassCastException: okhttp3.CookieJar$1 cannot be cast to com.facebook.react.modules.network.CookieJarContainer
    at com.facebook.react.modules.network.NetworkingModule.<init>(NetworkingModule.java:141)
    at com.facebook.react.modules.network.NetworkingModule.<init>(NetworkingModule.java:164)
    at com.facebook.react.shell.MainReactPackage$18.get(MainReactPackage.java:245)
    at com.facebook.react.shell.MainReactPackage$18.get(MainReactPackage.java:242)
    at com.facebook.react.LazyReactPackage.createNativeModules(LazyReactPackage.java:79)
    at com.facebook.react.NativeModuleRegistryBuilder.processPackage(NativeModuleRegistryBuilder.java:106)
    at com.facebook.react.ReactInstanceManager.processPackage(ReactInstanceManager.java:1172)
    at com.facebook.react.ReactInstanceManager.processPackages(ReactInstanceManager.java:1142)
    at com.facebook.react.ReactInstanceManager.createReactContext(ReactInstanceManager.java:1080)
    at com.facebook.react.ReactInstanceManager.access$900(ReactInstanceManager.java:113)
    at com.facebook.react.ReactInstanceManager$5.run(ReactInstanceManager.java:911)
    at java.lang.Thread.run(Thread.java:764)