Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Split Apks info as extras #3193

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,7 @@ private void setOptionsTags(final @NotNull SentryBaseEvent event) {
private void setStaticValues(final @NotNull SentryEvent event) {
mergeUser(event);
setSideLoadedInfo(event);
setSplitApksInfo(event);
}

private void setPlatform(final @NotNull SentryBaseEvent event) {
Expand Down Expand Up @@ -535,6 +536,20 @@ private void setSideLoadedInfo(final @NotNull SentryBaseEvent event) {
}
}

private void setSplitApksInfo(final @NotNull SentryBaseEvent event) {
try {
final ContextUtils.SplitApksInfo splitApksInfo =
ContextUtils.retrieveSplitApksInfo(context, options.getLogger(), buildInfoProvider);

if (splitApksInfo != null) {
final @NotNull Map<String, Object> extras = splitApksInfo.asExtras();
event.setExtras(extras);
}
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, "Error getting split apks info.", e);
}
}

private void setDevice(final @NotNull SentryBaseEvent event) {
if (event.getContexts().getDevice() == null) {
event.getContexts().setDevice(getDevice());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,36 @@ public boolean isSideLoaded() {
}
}

static class SplitApksInfo {
// https://github.com/google/bundletool/blob/master/src/main/java/com/android/tools/build/bundletool/model/AndroidManifest.java#L257-L263
static final String SPLITS_REQUIRED = "com.android.vending.splits.required";

private final boolean isSplitApks;
private final String[] splitNames;

public SplitApksInfo(final boolean isSplitApks, final String[] splitNames) {
this.isSplitApks = isSplitApks;
this.splitNames = splitNames;
}

public boolean isSplitApks() {
return isSplitApks;
}

public @Nullable String[] getSplitNames() {
return splitNames;
}

public @NotNull Map<String, Object> asExtras() {
final Map<String, Object> data = new HashMap<>();
data.put("isSplitApks", String.valueOf(isSplitApks));
if (splitNames != null) {
data.put("splitNames", String.join(", ", splitNames));
}
return data;
}
}

private ContextUtils() {}

/**
Expand Down Expand Up @@ -234,6 +264,36 @@ public static boolean isForegroundImportance() {
return null;
}

@SuppressWarnings({"deprecation"})
static @Nullable SplitApksInfo retrieveSplitApksInfo(
final @NotNull Context context,
final @NotNull ILogger logger,
final @NotNull BuildInfoProvider buildInfoProvider) {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
// packageInfo.splitNames is available since LOLLIPOP
return null;
}
String[] splitNames = null;
try {
final ApplicationInfo applicationInfo = getApplicationInfo(context, PackageManager.GET_META_DATA, buildInfoProvider);
final PackageInfo packageInfo = getPackageInfo(context, logger, buildInfoProvider);

if (packageInfo != null) {
splitNames = packageInfo.splitNames;
boolean isSplitApks = false;
if (applicationInfo.metaData != null) {
isSplitApks = applicationInfo.metaData.getBoolean(SplitApksInfo.SPLITS_REQUIRED);
}

return new SplitApksInfo(isSplitApks, splitNames);
}
} catch (PackageManager.NameNotFoundException e) {
logger.log(SentryLevel.DEBUG, "cannot retrive application info");
}

return null;
}

/**
* Get the human-facing Application name.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ private void setCommons(
mergeUser(event);
setDevice(event, errorEvent, applyScopeData);
setSideLoadedInfo(event);
setSplitApksInfo(event);
}

private boolean shouldApplyScopeData(
Expand Down Expand Up @@ -243,6 +244,18 @@ private void setSideLoadedInfo(final @NotNull SentryBaseEvent event) {
}
}

private void setSplitApksInfo(final @NotNull SentryBaseEvent event) {
try {
final ContextUtils.SplitApksInfo splitApksInfo = deviceInfoUtil.get().getSplitApksInfo();
if (splitApksInfo != null) {
final @NotNull Map<String, Object> extras = splitApksInfo.asExtras();
event.setExtras(extras);
}
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, "Error getting split apks info.", e);
}
}

@Override
public @NotNull SentryTransaction process(
final @NotNull SentryTransaction transaction, final @NotNull Hint hint) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public final class DeviceInfoUtil {
private final @NotNull BuildInfoProvider buildInfoProvider;
private final @Nullable Boolean isEmulator;
private final @Nullable ContextUtils.SideLoadedInfo sideLoadedInfo;
private final @Nullable ContextUtils.SplitApksInfo splitApksInfo;
private final @NotNull OperatingSystem os;

private final @Nullable Long totalMem;
Expand All @@ -60,6 +61,8 @@ public DeviceInfoUtil(
isEmulator = buildInfoProvider.isEmulator();
sideLoadedInfo =
ContextUtils.retrieveSideLoadedInfo(context, options.getLogger(), buildInfoProvider);
splitApksInfo =
ContextUtils.retrieveSplitApksInfo(context, options.getLogger(), buildInfoProvider);
final @Nullable ActivityManager.MemoryInfo memInfo =
ContextUtils.getMemInfo(context, options.getLogger());
if (memInfo != null) {
Expand Down Expand Up @@ -181,6 +184,12 @@ public ContextUtils.SideLoadedInfo getSideLoadedInfo() {
return sideLoadedInfo;
}

@Nullable
public ContextUtils.SplitApksInfo getSplitApksInfo() {
return splitApksInfo;
}


private void setDeviceIO(final @NotNull Device device, final boolean includeDynamicData) {
final Intent batteryIntent = getBatteryIntent();
if (batteryIntent != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import android.app.ActivityManager.RunningAppProcessInfo
import android.content.BroadcastReceiver
import android.content.Context
import android.content.IntentFilter
import android.content.pm.ApplicationInfo
import android.content.pm.PackageInfo
import android.content.pm.PackageManager
import android.os.Build
import android.os.Process
import androidx.test.core.app.ApplicationProvider
Expand All @@ -19,12 +22,14 @@ import org.mockito.kotlin.mock
import org.mockito.kotlin.spy
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever
import org.robolectric.Shadows
import org.robolectric.annotation.Config
import org.robolectric.shadow.api.Shadow
import org.robolectric.shadows.ShadowActivityManager
import org.robolectric.shadows.ShadowBuild
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertContentEquals
import kotlin.test.assertEquals
import kotlin.test.assertFalse
import kotlin.test.assertNotNull
Expand Down Expand Up @@ -113,6 +118,34 @@ class ContextUtilsTest {
assertEquals("play.google.com", sideLoadedInfo.installerStore)
}

@Test
fun `given a valid PackageInfo, returns valid splitNames`() {
val splitNames = arrayOf<String?>("config.arm64_v8a")
val mockedContext = mock<Context>()
val mockedPackageManager = mock<PackageManager>()
val mockedApplicationInfo = mock<ApplicationInfo>()
val mockedPackageInfo = mock<PackageInfo>()
mockedPackageInfo.splitNames = splitNames

whenever(mockedContext.packageName).thenReturn("dummy")

whenever(mockedPackageManager.getApplicationInfo(
any<String>(),
any<PackageManager.ApplicationInfoFlags>()
)).thenReturn(mockedApplicationInfo)

whenever(mockedPackageManager.getPackageInfo(
any<String>(),
any<PackageManager.PackageInfoFlags>()
)).thenReturn(mockedPackageInfo)

whenever(mockedContext.packageManager).thenReturn(mockedPackageManager)

val splitApksInfo =
ContextUtils.retrieveSplitApksInfo(mockedContext, logger, BuildInfoProvider(logger))
assertContentEquals(splitNames, splitApksInfo!!.splitNames)
}

@Test
@Config(qualifiers = "w360dp-h640dp-xxhdpi")
fun `when display metrics specified, getDisplayMetrics returns correct values`() {
Expand Down