Skip to content

Remove overrideChannelBuilder #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2019
Merged

Remove overrideChannelBuilder #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 1 addition & 22 deletions ...tore/src/androidTest/java/com/google/firebase/firestore/testutil/IntegrationTestUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import static org.junit.Assert.assertNull;

import android.content.Context;
import android.net.SSLCertificateSocketFactory;
import android.os.StrictMode;
import androidx.test.core.app.ApplicationProvider;
import com.google.android.gms.tasks.Task;
Expand All @@ -40,12 +39,10 @@
import com.google.firebase.firestore.core.DatabaseInfo;
import com.google.firebase.firestore.local.Persistence;
import com.google.firebase.firestore.model.DatabaseId;
import com.google.firebase.firestore.remote.GrpcCallProvider;
import com.google.firebase.firestore.testutil.provider.FirestoreProvider;
import com.google.firebase.firestore.util.AsyncQueue;
import com.google.firebase.firestore.util.Logger;
import com.google.firebase.firestore.util.Logger.Level;
import io.grpc.okhttp.OkHttpChannelBuilder;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
Expand Down Expand Up @@ -117,25 +114,7 @@ public static FirebaseFirestoreSettings newTestSettingsWithSnapshotTimestampsEna

if (CONNECT_TO_EMULATOR) {
settings.setHost(String.format("%s:%d", EMULATOR_HOST, EMULATOR_PORT));

// The `sslEnabled` flag in DatabaseInfo currently does not in fact disable all SSL checks.
// Instead, we manually disable the SSL certificate check and the hostname verification for
// connections to the emulator.
// TODO(mrschmidt): Update the client to respect the `sslEnabled` flag and remove these
// channel overrides.
OkHttpChannelBuilder channelBuilder =
new OkHttpChannelBuilder(EMULATOR_HOST, EMULATOR_PORT) {
@Override
protected String checkAuthority(String authority) {
return authority;
}
};
channelBuilder.hostnameVerifier((hostname, session) -> true);
SSLCertificateSocketFactory insecureFactory =
(SSLCertificateSocketFactory) SSLCertificateSocketFactory.getInsecure(0, null);
channelBuilder.sslSocketFactory(insecureFactory);
channelBuilder.usePlaintext();
GrpcCallProvider.overrideChannelBuilder(() -> channelBuilder);
settings.setSslEnabled(false);
} else {
settings.setHost(provider.firestoreHost());
}
Expand Down
33 changes: 6 additions & 27 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/remote/GrpcCallProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
package com.google.firebase.firestore.remote;

import android.content.Context;
import androidx.annotation.VisibleForTesting;
import com.google.android.gms.common.GooglePlayServicesNotAvailableException;
import com.google.android.gms.common.GooglePlayServicesRepairableException;
import com.google.android.gms.security.ProviderInstaller;
Expand All @@ -25,7 +24,6 @@
import com.google.firebase.firestore.util.AsyncQueue;
import com.google.firebase.firestore.util.Executors;
import com.google.firebase.firestore.util.Logger;
import com.google.firebase.firestore.util.Supplier;
import com.google.firestore.v1.FirestoreGrpc;
import io.grpc.CallCredentials;
import io.grpc.CallOptions;
Expand All @@ -43,26 +41,11 @@ public class GrpcCallProvider {

private static final String LOG_TAG = "GrpcCallProvider";

private static Supplier<ManagedChannelBuilder<?>> overrideChannelBuilderSupplier;

private final Task<ManagedChannel> channelTask;
private final AsyncQueue asyncQueue;

private CallOptions callOptions;

/**
* Helper function to globally override the channel that RPCs use. Useful for testing when you
* want to bypass SSL certificate checking.
*
* @param channelBuilderSupplier The supplier for a channel builder that is used to create gRPC
* channels.
*/
@VisibleForTesting
public static void overrideChannelBuilder(
Supplier<ManagedChannelBuilder<?>> channelBuilderSupplier) {
overrideChannelBuilderSupplier = channelBuilderSupplier;
}

GrpcCallProvider(
AsyncQueue asyncQueue,
Context context,
Expand Down Expand Up @@ -105,16 +88,12 @@ private ManagedChannel initChannel(Context context, DatabaseInfo databaseInfo) {
Logger.warn(LOG_TAG, "Failed to update ssl context: %s", e);
}

ManagedChannelBuilder<?> channelBuilder;
if (overrideChannelBuilderSupplier != null) {
channelBuilder = overrideChannelBuilderSupplier.get();
} else {
channelBuilder = ManagedChannelBuilder.forTarget(databaseInfo.getHost());
if (!databaseInfo.isSslEnabled()) {
// Note that the boolean flag does *NOT* switch the wire format from Protobuf to Plaintext.
// It merely turns off SSL encryption.
channelBuilder.usePlaintext();
}
ManagedChannelBuilder<?> channelBuilder =
ManagedChannelBuilder.forTarget(databaseInfo.getHost());
if (!databaseInfo.isSslEnabled()) {
// Note that the boolean flag does *NOT* switch the wire format from Protobuf to Plaintext.
// It merely turns off SSL encryption.
channelBuilder.usePlaintext();
}

// Ensure gRPC recovers from a dead connection. (Not typically necessary, as the OS will
Expand Down