Skip to content

Create native proxy object to check provider on each call and mediate… #2532

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.

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 13 commits into from
Apr 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.firebase.crashlytics.internal;

import static org.mockito.ArgumentMatchers.eq;

import androidx.test.runner.AndroidJUnit4;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;

@RunWith(AndroidJUnit4.class)
public class ProviderProxyNativeComponentTest {
private static final String TEST_STRING = "abc";
private static final long TEST_LONG = 123;
private static final boolean TEST_BOOLEAN = true;
private static final int TEST_INT = 1234;

@Mock private CrashlyticsNativeComponent component;

@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
}
Comment on lines +33 to +38
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: for this simple case you can just use the more concise:

Suggested change
@Mock private CrashlyticsNativeComponent component;
@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
}
private final CrashlyticsNativeComponent component = mock(CrashlyticsNativeComponent.class);


@Test
public void testProviderProxyCallsThroughProvidedValue() {
ProviderProxyNativeComponent proxy = new ProviderProxyNativeComponent(() -> component);

proxy.hasCrashDataForSession(TEST_STRING);
Mockito.verify(component, Mockito.times(1)).hasCrashDataForSession(eq(TEST_STRING));

proxy.openSession(TEST_STRING);
Mockito.verify(component, Mockito.times(1)).openSession(eq(TEST_STRING));

proxy.finalizeSession(TEST_STRING);
Mockito.verify(component, Mockito.times(1)).finalizeSession(eq(TEST_STRING));

proxy.getSessionFileProvider(TEST_STRING);
Mockito.verify(component, Mockito.times(1)).getSessionFileProvider(eq(TEST_STRING));

proxy.writeBeginSession(TEST_STRING, TEST_STRING, TEST_LONG);
Mockito.verify(component, Mockito.times(1))
.writeBeginSession(eq(TEST_STRING), eq(TEST_STRING), eq(TEST_LONG));

proxy.writeSessionApp(
TEST_STRING, TEST_STRING, TEST_STRING, TEST_STRING, TEST_STRING, TEST_INT, TEST_STRING);
Mockito.verify(component, Mockito.times(1))
.writeSessionApp(
eq(TEST_STRING),
eq(TEST_STRING),
eq(TEST_STRING),
eq(TEST_STRING),
eq(TEST_STRING),
eq(TEST_INT),
eq(TEST_STRING));

proxy.writeSessionOs(TEST_STRING, TEST_STRING, TEST_STRING, TEST_BOOLEAN);
Mockito.verify(component, Mockito.times(1))
.writeSessionOs(eq(TEST_STRING), eq(TEST_STRING), eq(TEST_STRING), eq(TEST_BOOLEAN));

proxy.writeSessionDevice(
TEST_STRING,
TEST_INT,
TEST_STRING,
TEST_INT,
TEST_LONG,
TEST_LONG,
TEST_BOOLEAN,
TEST_INT,
TEST_STRING,
TEST_STRING);
Mockito.verify(component, Mockito.times(1))
.writeSessionDevice(
eq(TEST_STRING),
eq(TEST_INT),
eq(TEST_STRING),
eq(TEST_INT),
eq(TEST_LONG),
eq(TEST_LONG),
eq(TEST_BOOLEAN),
eq(TEST_INT),
eq(TEST_STRING),
eq(TEST_STRING));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
import com.google.firebase.FirebaseApp;
import com.google.firebase.crashlytics.internal.CrashlyticsNativeComponent;
import com.google.firebase.crashlytics.internal.CrashlyticsTestCase;
import com.google.firebase.crashlytics.internal.MissingNativeComponent;
import com.google.firebase.crashlytics.internal.NativeSessionFileProvider;
import com.google.firebase.crashlytics.internal.ProviderProxyNativeComponent;
import com.google.firebase.crashlytics.internal.analytics.AnalyticsEventLogger;
import com.google.firebase.crashlytics.internal.log.LogFileManager;
import com.google.firebase.crashlytics.internal.persistence.FileStore;
Expand Down Expand Up @@ -112,7 +112,7 @@ private class ControllerBuilder {

ControllerBuilder() {
dataCollectionArbiter = mockDataCollectionArbiter;
nativeComponent = new MissingNativeComponent();
nativeComponent = new ProviderProxyNativeComponent(() -> null);

unityVersionProvider = mock(UnityVersionProvider.class);
when(unityVersionProvider.getUnityVersion()).thenReturn(null);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import com.google.firebase.FirebaseOptions;
import com.google.firebase.crashlytics.internal.CrashlyticsNativeComponent;
import com.google.firebase.crashlytics.internal.CrashlyticsTestCase;
import com.google.firebase.crashlytics.internal.MissingNativeComponent;
import com.google.firebase.crashlytics.internal.ProviderProxyNativeComponent;
import com.google.firebase.crashlytics.internal.analytics.UnavailableAnalyticsEventLogger;
import com.google.firebase.crashlytics.internal.breadcrumbs.DisabledBreadcrumbSource;
import com.google.firebase.crashlytics.internal.persistence.FileStore;
Expand Down Expand Up @@ -99,7 +99,7 @@ public CoreBuilder(Context context, FirebaseOptions firebaseOptions) {
when(installationsApiMock.getId()).thenReturn(Tasks.forResult("instanceId"));
idManager = new IdManager(context, context.getPackageName(), installationsApiMock);

nativeComponent = new MissingNativeComponent();
nativeComponent = new ProviderProxyNativeComponent(() -> null);

arbiter = mock(DataCollectionArbiter.class);
when(arbiter.isAutomaticDataCollectionEnabled()).thenReturn(true);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import com.google.firebase.crashlytics.BuildConfig;
import com.google.firebase.crashlytics.internal.CrashlyticsNativeComponent;
import com.google.firebase.crashlytics.internal.CrashlyticsTestCase;
import com.google.firebase.crashlytics.internal.MissingNativeComponent;
import com.google.firebase.crashlytics.internal.ProviderProxyNativeComponent;
import com.google.firebase.crashlytics.internal.analytics.UnavailableAnalyticsEventLogger;
import com.google.firebase.crashlytics.internal.breadcrumbs.BreadcrumbHandler;
import com.google.firebase.crashlytics.internal.breadcrumbs.BreadcrumbSource;
Expand All @@ -48,7 +48,7 @@ public class CrashlyticsCoreTest extends CrashlyticsTestCase {
private static final String GOOGLE_APP_ID = "google:app:id";

private static final CrashlyticsNativeComponent MISSING_NATIVE_COMPONENT =
new MissingNativeComponent();
new ProviderProxyNativeComponent(() -> null);

private CrashlyticsCore crashlyticsCore;
private BreadcrumbSource mockBreadcrumbSource;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.google.firebase.components.Dependency;
import com.google.firebase.crashlytics.internal.CrashlyticsNativeComponent;
import com.google.firebase.inject.Deferred;
import com.google.firebase.inject.Provider;
import com.google.firebase.installations.FirebaseInstallationsApi;
import com.google.firebase.platforminfo.LibraryVersionComponent;
import java.util.Arrays;
Expand All @@ -35,8 +36,8 @@ public List<Component<?>> getComponents() {
Component.builder(FirebaseCrashlytics.class)
.add(Dependency.required(FirebaseApp.class))
.add(Dependency.required(FirebaseInstallationsApi.class))
.add(Dependency.optionalProvider(CrashlyticsNativeComponent.class))
.add(Dependency.deferred(AnalyticsConnector.class))
.add(Dependency.optional(CrashlyticsNativeComponent.class))
.factory(this::buildCrashlytics)
.eagerInDefaultApp()
.build(),
Expand All @@ -46,7 +47,8 @@ public List<Component<?>> getComponents() {
private FirebaseCrashlytics buildCrashlytics(ComponentContainer container) {
FirebaseApp app = container.get(FirebaseApp.class);

CrashlyticsNativeComponent nativeComponent = container.get(CrashlyticsNativeComponent.class);
Provider<CrashlyticsNativeComponent> nativeComponent =
container.getProvider(CrashlyticsNativeComponent.class);

Deferred<AnalyticsConnector> analyticsConnector =
container.getDeferred(AnalyticsConnector.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import com.google.firebase.analytics.connector.AnalyticsConnector;
import com.google.firebase.crashlytics.internal.CrashlyticsNativeComponent;
import com.google.firebase.crashlytics.internal.Logger;
import com.google.firebase.crashlytics.internal.MissingNativeComponent;
import com.google.firebase.crashlytics.internal.ProviderProxyNativeComponent;
import com.google.firebase.crashlytics.internal.common.AppData;
import com.google.firebase.crashlytics.internal.common.CommonUtils;
import com.google.firebase.crashlytics.internal.common.CrashlyticsCore;
Expand All @@ -37,6 +37,7 @@
import com.google.firebase.crashlytics.internal.unity.ResourceUnityVersionProvider;
import com.google.firebase.crashlytics.internal.unity.UnityVersionProvider;
import com.google.firebase.inject.Deferred;
import com.google.firebase.inject.Provider;
import com.google.firebase.installations.FirebaseInstallationsApi;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
Expand All @@ -61,8 +62,8 @@ public class FirebaseCrashlytics {
static @Nullable FirebaseCrashlytics init(
@NonNull FirebaseApp app,
@NonNull FirebaseInstallationsApi firebaseInstallationsApi,
@Nullable CrashlyticsNativeComponent nativeComponent,
Deferred<AnalyticsConnector> analyticsConnector) {
@NonNull Provider<CrashlyticsNativeComponent> nativeComponent,
@NonNull Deferred<AnalyticsConnector> analyticsConnector) {
Logger.getLogger().i("Initializing Firebase Crashlytics " + CrashlyticsCore.getVersion());
Context context = app.getApplicationContext();
// Set up the IdManager.
Expand All @@ -71,9 +72,8 @@ public class FirebaseCrashlytics {

final DataCollectionArbiter arbiter = new DataCollectionArbiter(app);

if (nativeComponent == null) {
nativeComponent = new MissingNativeComponent();
}
ProviderProxyNativeComponent proxyNativeComponent =
new ProviderProxyNativeComponent(nativeComponent);

// Integration with Firebase Analytics
final AnalyticsDeferredProxy analyticsDeferredProxy =
Expand All @@ -85,7 +85,7 @@ public class FirebaseCrashlytics {
new CrashlyticsCore(
app,
idManager,
nativeComponent,
proxyNativeComponent,
arbiter,
analyticsDeferredProxy.getDeferredBreadcrumbSource(),
analyticsDeferredProxy.getAnalyticsEventLogger(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,65 @@
package com.google.firebase.crashlytics.internal;

import androidx.annotation.NonNull;
import com.google.firebase.inject.Provider;
import java.io.File;

public final class MissingNativeComponent implements CrashlyticsNativeComponent {
public final class ProviderProxyNativeComponent implements CrashlyticsNativeComponent {

private static final NativeSessionFileProvider MISSING_NATIVE_SESSION_FILE_PROVIDER =
new MissingNativeSessionFileProvider();

private final Provider<CrashlyticsNativeComponent> provider;

public ProviderProxyNativeComponent(Provider<CrashlyticsNativeComponent> provider) {
this.provider = provider;
}

@Override
public boolean hasCrashDataForSession(@NonNull String sessionId) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
return nativeComponent.hasCrashDataForSession(sessionId);
}
return false;
}

@Override
public boolean openSession(@NonNull String sessionId) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
return nativeComponent.openSession(sessionId);
}
return true;
}

@Override
public boolean finalizeSession(@NonNull String sessionId) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
return nativeComponent.finalizeSession(sessionId);
}
return true;
}

@NonNull
@Override
public NativeSessionFileProvider getSessionFileProvider(@NonNull String sessionId) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
return nativeComponent.getSessionFileProvider(sessionId);
}
return MISSING_NATIVE_SESSION_FILE_PROVIDER;
}

@Override
public void writeBeginSession(
@NonNull String sessionId, @NonNull String generator, long startedAtSeconds) {}
@NonNull String sessionId, @NonNull String generator, long startedAtSeconds) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
nativeComponent.writeBeginSession(sessionId, generator, startedAtSeconds);
}
}

@Override
public void writeSessionApp(
Expand All @@ -55,14 +83,31 @@ public void writeSessionApp(
@NonNull String versionName,
@NonNull String installUuid,
int deliveryMechanism,
@NonNull String unityVersion) {}
@NonNull String unityVersion) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
nativeComponent.writeSessionApp(
sessionId,
appIdentifier,
versionCode,
versionName,
installUuid,
deliveryMechanism,
unityVersion);
}
}

@Override
public void writeSessionOs(
@NonNull String sessionId,
@NonNull String osRelease,
@NonNull String osCodeName,
boolean isRooted) {}
boolean isRooted) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
nativeComponent.writeSessionOs(sessionId, osRelease, osCodeName, isRooted);
}
}

@Override
public void writeSessionDevice(
Expand All @@ -75,7 +120,22 @@ public void writeSessionDevice(
boolean isEmulator,
int state,
@NonNull String manufacturer,
@NonNull String modelClass) {}
@NonNull String modelClass) {
CrashlyticsNativeComponent nativeComponent = provider.get();
if (nativeComponent != null) {
nativeComponent.writeSessionDevice(
sessionId,
arch,
model,
availableProcessors,
totalRam,
diskSpace,
isEmulator,
state,
manufacturer,
modelClass);
}
}

private static final class MissingNativeSessionFileProvider implements NativeSessionFileProvider {

Expand Down