Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

read release conf. on manifest #266

Merged
merged 2 commits into from Feb 11, 2020
Merged

read release conf. on manifest #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d30021c
read release on manifest
marandaneto Feb 11, 2020
55776f8
fix merge conflict
marandaneto Feb 11, 2020
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
71 changes: 49 additions & 22 deletions sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java
View file
Open in desktop
Expand Up @@ -9,42 +9,52 @@
import java.util.Locale;
import org.jetbrains.annotations.NotNull;

/** Class responsible for reading values from manifest and setting them to the options */
final class ManifestMetadataReader {

static final String DSN_KEY = "io.sentry.dsn";
static final String DEBUG_KEY = "io.sentry.debug";
static final String DSN = "io.sentry.dsn";
static final String DEBUG = "io.sentry.debug";
static final String DEBUG_LEVEL = "io.sentry.debug.level";
static final String SAMPLE_RATE = "io.sentry.sample-rate";
static final String ANR_ENABLE = "io.sentry.anr.enable";
static final String ANR_REPORT_DEBUG = "io.sentry.anr.report-debug";
static final String ANR_TIMEOUT_INTERVAL_MILLS = "io.sentry.anr.timeout-interval-mills";
static final String AUTO_INIT = "io.sentry.auto-init";
static final String ENABLE_NDK = "io.sentry.ndk.enable";
static final String NDK_ENABLE = "io.sentry.ndk.enable";
static final String RELEASE = "io.sentry.release";

/** ManifestMetadataReader ctor */
private ManifestMetadataReader() {}

static void applyMetadata(@NotNull Context context, @NotNull SentryAndroidOptions options) {
/**
* Reads configurations from Manifest and sets it to the options
*
* @param context the application context
* @param options the SentryAndroidOptions
*/
static void applyMetadata(
final @NotNull Context context, final @NotNull SentryAndroidOptions options) {
if (context == null) throw new IllegalArgumentException("The application context is required.");
if (options == null) throw new IllegalArgumentException("The options object is required.");

try {
Bundle metadata = getMetadata(context);
final Bundle metadata = getMetadata(context);

if (metadata != null) {
boolean debug = metadata.getBoolean(DEBUG_KEY, options.isDebug());
final boolean debug = metadata.getBoolean(DEBUG, options.isDebug());
options.setDebug(debug);
options.getLogger().log(SentryLevel.DEBUG, "debug read: %s", debug);

if (options.isDebug()) {
String level =
final String level =
metadata.getString(
DEBUG_LEVEL, options.getDiagnosticLevel().name().toLowerCase(Locale.ROOT));
options.setDiagnosticLevel(SentryLevel.valueOf(level.toUpperCase(Locale.ROOT)));
}

boolean isAnrEnabled = metadata.getBoolean(ANR_ENABLE, options.isAnrEnabled());
options.getLogger().log(SentryLevel.DEBUG, "isAnrEnabled read: %s", isAnrEnabled);
options.setAnrEnabled(isAnrEnabled);
final boolean anrEnabled = metadata.getBoolean(ANR_ENABLE, options.isAnrEnabled());
options.getLogger().log(SentryLevel.DEBUG, "anrEnabled read: %s", anrEnabled);
options.setAnrEnabled(anrEnabled);

if (options.getSampleRate() == null) {
Double sampleRate = metadata.getDouble(SAMPLE_RATE, -1);
Expand All @@ -54,21 +64,19 @@ static void applyMetadata(@NotNull Context context, @NotNull SentryAndroidOption
}
}

boolean isAnrReportInDebug =
boolean anrReportInDebug =
metadata.getBoolean(ANR_REPORT_DEBUG, options.isAnrReportInDebug());
options
.getLogger()
.log(SentryLevel.DEBUG, "isAnrReportInDebug read: %s", isAnrReportInDebug);
options.setAnrReportInDebug(isAnrReportInDebug);
options.getLogger().log(SentryLevel.DEBUG, "anrReportInDebug read: %s", anrReportInDebug);
options.setAnrReportInDebug(anrReportInDebug);

long anrTimeoutIntervalMills =
final long anrTimeoutIntervalMills =
metadata.getInt(ANR_TIMEOUT_INTERVAL_MILLS, (int) options.getAnrTimeoutIntervalMills());
options
.getLogger()
.log(SentryLevel.DEBUG, "anrTimeoutIntervalMills read: %d", anrTimeoutIntervalMills);
options.setAnrTimeoutIntervalMills(anrTimeoutIntervalMills);

String dsn = metadata.getString(DSN_KEY, null);
final String dsn = metadata.getString(DSN, null);
if (dsn == null) {
options
.getLogger()
Expand All @@ -80,9 +88,13 @@ static void applyMetadata(@NotNull Context context, @NotNull SentryAndroidOption
}
options.setDsn(dsn);

boolean ndk = metadata.getBoolean(ENABLE_NDK, options.isEnableNdk());
final boolean ndk = metadata.getBoolean(NDK_ENABLE, options.isEnableNdk());
options.getLogger().log(SentryLevel.DEBUG, "NDK read: %s", ndk);
options.setEnableNdk(ndk);

final String release = metadata.getString(RELEASE, options.getRelease());
options.getLogger().log(SentryLevel.DEBUG, "release read: %s", release);
options.setRelease(release);
}
options
.getLogger()
Expand All @@ -95,12 +107,19 @@ static void applyMetadata(@NotNull Context context, @NotNull SentryAndroidOption
}
}

static boolean isAutoInit(Context context, final @NotNull ILogger logger) {
/**
* Checks if auto init is enabled or disabled
*
* @param context the application context
* @param logger the Logger interface
* @return true if auto init is enabled or false otherwise
*/
static boolean isAutoInit(final Context context, final @NotNull ILogger logger) {
if (context == null) throw new IllegalArgumentException("The application context is required.");

boolean autoInit = true;
try {
Bundle metadata = getMetadata(context);
final Bundle metadata = getMetadata(context);
if (metadata != null) {
autoInit = metadata.getBoolean(AUTO_INIT, true);
logger.log(SentryLevel.DEBUG, "Auto-init: %s", autoInit);
Expand All @@ -112,8 +131,16 @@ static boolean isAutoInit(Context context, final @NotNull ILogger logger) {
return autoInit;
}

private static Bundle getMetadata(Context context) throws PackageManager.NameNotFoundException {
ApplicationInfo app =
/**
* Returns the Bundle attached from the given Context
*
* @param context the application context
* @return the Bundle attached to the PackageManager
* @throws PackageManager.NameNotFoundException if the package name is non-existent
*/
private static Bundle getMetadata(final Context context)
throws PackageManager.NameNotFoundException {
final ApplicationInfo app =
context
.getPackageManager()
.getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
Expand Down
8 changes: 4 additions & 4 deletions sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidTest.kt
View file
Open in desktop
Expand Up @@ -44,7 +44,7 @@ class SentryAndroidTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, "https://key@sentry.io/123")
metaData.putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")
metaData.putBoolean(ManifestMetadataReader.AUTO_INIT, false)

SentryAndroid.init(mockContext)
Expand All @@ -60,7 +60,7 @@ class SentryAndroidTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, "https://key@sentry.io/123")
metaData.putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")
metaData.putBoolean(ManifestMetadataReader.AUTO_INIT, false)

val logger = mock<ILogger>()
Expand All @@ -78,7 +78,7 @@ class SentryAndroidTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, "https://key@sentry.io/123")
metaData.putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")
metaData.putBoolean(ManifestMetadataReader.AUTO_INIT, false)

var refOptions: SentryAndroidOptions? = null
Expand All @@ -97,7 +97,7 @@ class SentryAndroidTest {
val mockContext = createMockContext()
val metaData = Bundle()
mockMetaData(mockContext, metaData)
metaData.putString(ManifestMetadataReader.DSN_KEY, "https://key@sentry.io/123")
metaData.putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")

val logger = mock<ILogger>()
SentryAndroid.init(mockContext, logger)
Expand Down
10 changes: 5 additions & 5 deletions sentry-android-core/src/test/java/io/sentry/android/core/SentryInitProviderTest.kt
View file
Open in desktop
Expand Up @@ -54,7 +54,7 @@ class SentryInitProviderTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, "https://key@sentry.io/123")
metaData.putString(ManifestMetadataReader.DSN, "https://key@sentry.io/123")

sentryInitProvider.attachInfo(mockContext, providerInfo)

Expand All @@ -72,7 +72,7 @@ class SentryInitProviderTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, "")
metaData.putString(ManifestMetadataReader.DSN, "")

sentryInitProvider.attachInfo(mockContext, providerInfo)

Expand All @@ -90,7 +90,7 @@ class SentryInitProviderTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, null)
metaData.putString(ManifestMetadataReader.DSN, null)

assertFailsWith<IllegalArgumentException> { sentryInitProvider.attachInfo(mockContext, providerInfo) }
}
Expand All @@ -106,7 +106,7 @@ class SentryInitProviderTest {
val metaData = Bundle()
mockMetaData(mockContext, metaData)

metaData.putString(ManifestMetadataReader.DSN_KEY, "invalid dsn")
metaData.putString(ManifestMetadataReader.DSN, "invalid dsn")

assertFailsWith<InvalidDsnException> { sentryInitProvider.attachInfo(mockContext, providerInfo) }
}
Expand Down Expand Up @@ -138,7 +138,7 @@ class SentryInitProviderTest {

val metaData = Bundle()
mockMetaData(mockContext, metaData)
metaData.putBoolean(ManifestMetadataReader.ENABLE_NDK, false)
metaData.putBoolean(ManifestMetadataReader.NDK_ENABLE, false)

AndroidOptionsInitializer.init(sentryOptions, mockContext, mockLogger)

Expand Down