Skip to content

Commit 7fac010

Browse files
stefanosianostefanosiano
committed
renamed autoTransactionDeadlineTimeoutMillis to deadlineTimeout
small tests cleanup
1 parent 176d0af commit 7fac010

File tree

11 files changed

+39
-39
lines changed

11 files changed

+39
-39
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Features
66

7-
- Add autoTransactionDeadlineTimeoutMillis option ([#4555](https://github.com/getsentry/sentry-java/pull/4555))
7+
- Add deadlineTimeout option ([#4555](https://github.com/getsentry/sentry-java/pull/4555))
88

99
### Fixes
1010

‎sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ private void startTracing(final @NotNull Activity activity) {
191191
final TransactionOptions transactionOptions = new TransactionOptions();
192192

193193
// Set deadline timeout based on configured option
194-
final long deadlineTimeoutMillis = options.getAutoTransactionDeadlineTimeoutMillis();
194+
final long deadlineTimeoutMillis = options.getDeadlineTimeout();
195195
// No deadline when zero or negative value is set
196196
transactionOptions.setDeadlineTimeout(
197197
deadlineTimeoutMillis <= 0 ? null : deadlineTimeoutMillis);

‎sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@ final class ManifestMetadataReader {
127127
static final String ENABLE_AUTO_TRACE_ID_GENERATION =
128128
"io.sentry.traces.enable-auto-id-generation";
129129

130-
static final String AUTO_TRANSACTION_DEADLINE_TIMEOUT_MILLIS =
131-
"io.sentry.traces.auto-transaction-deadline-timeout-millis";
130+
static final String DEADLINE_TIMEOUT = "io.sentry.traces.deadline-timeout";
132131

133132
static final String FEEDBACK_NAME_REQUIRED = "io.sentry.feedback.is-name-required";
134133

@@ -449,12 +448,8 @@ static void applyMetadata(
449448
ENABLE_AUTO_TRACE_ID_GENERATION,
450449
options.isEnableAutoTraceIdGeneration()));
451450

452-
options.setAutoTransactionDeadlineTimeoutMillis(
453-
readLong(
454-
metadata,
455-
logger,
456-
AUTO_TRANSACTION_DEADLINE_TIMEOUT_MILLIS,
457-
options.getAutoTransactionDeadlineTimeoutMillis()));
451+
options.setDeadlineTimeout(
452+
readLong(metadata, logger, DEADLINE_TIMEOUT, options.getDeadlineTimeout()));
458453

459454
if (options.getSessionReplay().getSessionSampleRate() == null) {
460455
final double sessionSampleRate =

‎sentry-android-core/src/main/java/io/sentry/android/core/internal/gestures/SentryGestureListener.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ private void startTracing(final @NotNull UiElement target, final @NotNull Gestur
251251
transactionOptions.setWaitForChildren(true);
252252

253253
// Set deadline timeout based on configured option
254-
final long deadlineTimeoutMillis = options.getAutoTransactionDeadlineTimeoutMillis();
254+
final long deadlineTimeoutMillis = options.getDeadlineTimeout();
255255
// No deadline when zero or negative value is set
256256
transactionOptions.setDeadlineTimeout(
257257
deadlineTimeoutMillis <= 0 ? null : deadlineTimeoutMillis);

‎sentry-android-core/src/test/java/io/sentry/android/core/ActivityLifecycleIntegrationTest.kt‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ class ActivityLifecycleIntegrationTest {
229229
fun `Activity transaction uses custom deadline timeout when autoTransactionDeadlineTimeoutMillis is set to positive value`() {
230230
val sut = fixture.getSut()
231231
fixture.options.tracesSampleRate = 1.0
232-
fixture.options.autoTransactionDeadlineTimeoutMillis = 60000L // 60 seconds
232+
fixture.options.deadlineTimeout = 60000L // 60 seconds
233233

234234
sut.register(fixture.scopes, fixture.options)
235235
sut.onActivityCreated(mock(), fixture.bundle)
@@ -247,7 +247,7 @@ class ActivityLifecycleIntegrationTest {
247247
fun `Activity transaction uses no deadline timeout when autoTransactionDeadlineTimeoutMillis is set to zero`() {
248248
val sut = fixture.getSut()
249249
fixture.options.tracesSampleRate = 1.0
250-
fixture.options.autoTransactionDeadlineTimeoutMillis = 0L // No deadline
250+
fixture.options.deadlineTimeout = 0L // No deadline
251251

252252
sut.register(fixture.scopes, fixture.options)
253253
sut.onActivityCreated(mock(), fixture.bundle)
@@ -265,7 +265,7 @@ class ActivityLifecycleIntegrationTest {
265265
fun `Activity transaction uses no deadline timeout when autoTransactionDeadlineTimeoutMillis is set to negative value`() {
266266
val sut = fixture.getSut()
267267
fixture.options.tracesSampleRate = 1.0
268-
fixture.options.autoTransactionDeadlineTimeoutMillis = -1L // No deadline
268+
fixture.options.deadlineTimeout = -1L // No deadline
269269

270270
sut.register(fixture.scopes, fixture.options)
271271
sut.onActivityCreated(mock(), fixture.bundle)
@@ -283,7 +283,6 @@ class ActivityLifecycleIntegrationTest {
283283
fun `Activity transaction uses default deadline timeout when autoTransactionDeadlineTimeoutMillis is default`() {
284284
val sut = fixture.getSut()
285285
fixture.options.tracesSampleRate = 1.0
286-
// Don't set autoTransactionDeadlineTimeoutMillis, use default (30000)
287286

288287
sut.register(fixture.scopes, fixture.options)
289288
sut.onActivityCreated(mock(), fixture.bundle)
@@ -292,7 +291,10 @@ class ActivityLifecycleIntegrationTest {
292291
.startTransaction(
293292
any<TransactionContext>(),
294293
check<TransactionOptions> { transactionOptions ->
295-
assertEquals(30000L, transactionOptions.deadlineTimeout)
294+
assertEquals(
295+
TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION,
296+
transactionOptions.deadlineTimeout,
297+
)
296298
},
297299
)
298300
}

‎sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import io.sentry.ILogger
99
import io.sentry.ProfileLifecycle
1010
import io.sentry.SentryLevel
1111
import io.sentry.SentryReplayOptions
12+
import io.sentry.TransactionOptions
1213
import kotlin.test.BeforeTest
1314
import kotlin.test.Test
1415
import kotlin.test.assertEquals
@@ -1095,15 +1096,14 @@ class ManifestMetadataReaderTest {
10951096
fun `applyMetadata reads autoTransactionDeadlineTimeoutMillis from metadata`() {
10961097
// Arrange
10971098
val expectedTimeout = 60000
1098-
val bundle =
1099-
bundleOf(ManifestMetadataReader.AUTO_TRANSACTION_DEADLINE_TIMEOUT_MILLIS to expectedTimeout)
1099+
val bundle = bundleOf(ManifestMetadataReader.DEADLINE_TIMEOUT to expectedTimeout)
11001100
val context = fixture.getContext(metaData = bundle)
11011101

11021102
// Act
11031103
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
11041104

11051105
// Assert
1106-
assertEquals(expectedTimeout.toLong(), fixture.options.autoTransactionDeadlineTimeoutMillis)
1106+
assertEquals(expectedTimeout.toLong(), fixture.options.deadlineTimeout)
11071107
}
11081108

11091109
@Test
@@ -1115,7 +1115,10 @@ class ManifestMetadataReaderTest {
11151115
ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
11161116

11171117
// Assert
1118-
assertEquals(30000L, fixture.options.autoTransactionDeadlineTimeoutMillis)
1118+
assertEquals(
1119+
TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION,
1120+
fixture.options.deadlineTimeout,
1121+
)
11191122
}
11201123

11211124
@Test

‎sentry-android-navigation/src/main/java/io/sentry/android/navigation/SentryNavigationListener.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ constructor(
133133
it.idleTimeout = scopes.options.idleTimeout
134134

135135
// Set deadline timeout based on configured option
136-
val deadlineTimeoutMillis = scopes.options.autoTransactionDeadlineTimeoutMillis
136+
val deadlineTimeoutMillis = scopes.options.deadlineTimeout
137137
// No deadline when zero or negative value is set
138138
it.deadlineTimeout = if (deadlineTimeoutMillis <= 0) null else deadlineTimeoutMillis
139139

‎sentry-android-navigation/src/test/java/io/sentry/android/navigation/SentryNavigationListenerTest.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ class SentryNavigationListenerTest {
402402
@Test
403403
fun `Navigation listener uses custom deadline timeout when set to positive value`() {
404404
val sut = fixture.getSut()
405-
fixture.options.autoTransactionDeadlineTimeoutMillis = 60000L
405+
fixture.options.deadlineTimeout = 60000L
406406

407407
sut.onDestinationChanged(fixture.navController, fixture.destination, null)
408408

@@ -416,7 +416,7 @@ class SentryNavigationListenerTest {
416416
@Test
417417
fun `Navigation listener uses no deadline timeout when set to zero`() {
418418
val sut = fixture.getSut()
419-
fixture.options.autoTransactionDeadlineTimeoutMillis = 0L
419+
fixture.options.deadlineTimeout = 0L
420420

421421
sut.onDestinationChanged(fixture.navController, fixture.destination, null)
422422

@@ -430,7 +430,7 @@ class SentryNavigationListenerTest {
430430
@Test
431431
fun `Navigation listener uses no deadline timeout when set to negative value`() {
432432
val sut = fixture.getSut()
433-
fixture.options.autoTransactionDeadlineTimeoutMillis = -1L
433+
fixture.options.deadlineTimeout = -1L
434434

435435
sut.onDestinationChanged(fixture.navController, fixture.destination, null)
436436

‎sentry/api/sentry.api‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3265,7 +3265,6 @@ public class io/sentry/SentryOptions {
32653265
public fun addScopeObserver (Lio/sentry/IScopeObserver;)V
32663266
public static fun empty ()Lio/sentry/SentryOptions;
32673267
public fun findPersistingScopeObserver ()Lio/sentry/cache/PersistingScopeObserver;
3268-
public fun getAutoTransactionDeadlineTimeoutMillis ()J
32693268
public fun getBackpressureMonitor ()Lio/sentry/backpressure/IBackpressureMonitor;
32703269
public fun getBeforeBreadcrumb ()Lio/sentry/SentryOptions$BeforeBreadcrumbCallback;
32713270
public fun getBeforeEnvelopeCallback ()Lio/sentry/SentryOptions$BeforeEnvelopeCallback;
@@ -3283,6 +3282,7 @@ public class io/sentry/SentryOptions {
32833282
public fun getContinuousProfiler ()Lio/sentry/IContinuousProfiler;
32843283
public fun getCron ()Lio/sentry/SentryOptions$Cron;
32853284
public fun getDateProvider ()Lio/sentry/SentryDateProvider;
3285+
public fun getDeadlineTimeout ()J
32863286
public fun getDebugMetaLoader ()Lio/sentry/internal/debugmeta/IDebugMetaLoader;
32873287
public fun getDefaultScopeType ()Lio/sentry/ScopeType;
32883288
public fun getDiagnosticLevel ()Lio/sentry/SentryLevel;
@@ -3398,7 +3398,6 @@ public class io/sentry/SentryOptions {
33983398
public fun setAttachServerName (Z)V
33993399
public fun setAttachStacktrace (Z)V
34003400
public fun setAttachThreads (Z)V
3401-
public fun setAutoTransactionDeadlineTimeoutMillis (J)V
34023401
public fun setBackpressureMonitor (Lio/sentry/backpressure/IBackpressureMonitor;)V
34033402
public fun setBeforeBreadcrumb (Lio/sentry/SentryOptions$BeforeBreadcrumbCallback;)V
34043403
public fun setBeforeEnvelopeCallback (Lio/sentry/SentryOptions$BeforeEnvelopeCallback;)V
@@ -3414,6 +3413,7 @@ public class io/sentry/SentryOptions {
34143413
public fun setContinuousProfiler (Lio/sentry/IContinuousProfiler;)V
34153414
public fun setCron (Lio/sentry/SentryOptions$Cron;)V
34163415
public fun setDateProvider (Lio/sentry/SentryDateProvider;)V
3416+
public fun setDeadlineTimeout (J)V
34173417
public fun setDebug (Z)V
34183418
public fun setDebugMetaLoader (Lio/sentry/internal/debugmeta/IDebugMetaLoader;)V
34193419
public fun setDefaultScopeType (Lio/sentry/ScopeType;)V

‎sentry/src/main/java/io/sentry/SentryOptions.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ public class SentryOptions {
582582
*
583583
* <p>Default is 30000 (30 seconds).
584584
*/
585-
private long autoTransactionDeadlineTimeoutMillis = 30000;
585+
private long deadlineTimeout = TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION;
586586

587587
private @NotNull SentryOptions.Logs logs = new SentryOptions.Logs();
588588

@@ -2030,8 +2030,8 @@ public void setStartProfilerOnAppStart(final boolean startProfilerOnAppStart) {
20302030
this.startProfilerOnAppStart = startProfilerOnAppStart;
20312031
}
20322032

2033-
public long getAutoTransactionDeadlineTimeoutMillis() {
2034-
return autoTransactionDeadlineTimeoutMillis;
2033+
public long getDeadlineTimeout() {
2034+
return deadlineTimeout;
20352035
}
20362036

20372037
/**
@@ -2042,10 +2042,10 @@ public long getAutoTransactionDeadlineTimeoutMillis() {
20422042
*
20432043
* <p>Default is 30000 (30 seconds).
20442044
*
2045-
* @param autoTransactionDeadlineTimeoutMillis the timeout in milliseconds
2045+
* @param deadlineTimeout the timeout in milliseconds
20462046
*/
2047-
public void setAutoTransactionDeadlineTimeoutMillis(long autoTransactionDeadlineTimeoutMillis) {
2048-
this.autoTransactionDeadlineTimeoutMillis = autoTransactionDeadlineTimeoutMillis;
2047+
public void setDeadlineTimeout(long deadlineTimeout) {
2048+
this.deadlineTimeout = deadlineTimeout;
20492049
}
20502050

20512051
/**

0 commit comments

Comments
 (0)