-
-
Notifications
You must be signed in to change notification settings - Fork 427
/
Scope.java
776 lines (672 loc) · 19.3 KB
/
Scope.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
package io.sentry;
import io.sentry.protocol.Contexts;
import io.sentry.protocol.Request;
import io.sentry.protocol.TransactionNameSource;
import io.sentry.protocol.User;
import io.sentry.util.CollectionUtils;
import io.sentry.util.Objects;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** Scope data to be sent with the event */
public final class Scope {
/** Scope's SentryLevel */
private @Nullable SentryLevel level;
/** Scope's {@link ITransaction}. */
private @Nullable ITransaction transaction;
/** Scope's transaction name. Used when using error reporting without the performance feature. */
private @Nullable String transactionName;
/** Scope's user */
private @Nullable User user;
/** Scope's request */
private @Nullable Request request;
/** Scope's fingerprint */
private @NotNull List<String> fingerprint = new ArrayList<>();
/** Scope's breadcrumb queue */
private @NotNull Queue<Breadcrumb> breadcrumbs;
/** Scope's tags */
private @NotNull Map<String, @NotNull String> tags = new ConcurrentHashMap<>();
/** Scope's extras */
private @NotNull Map<String, @NotNull Object> extra = new ConcurrentHashMap<>();
/** Scope's event processor list */
private @NotNull List<EventProcessor> eventProcessors = new CopyOnWriteArrayList<>();
/** Scope's SentryOptions */
private final @NotNull SentryOptions options;
// TODO Consider: Scope clone doesn't clone sessions
/** Scope's current session */
private volatile @Nullable Session session;
/** Session lock, Ops should be atomic */
private final @NotNull Object sessionLock = new Object();
/** Transaction lock, Ops should be atomic */
private final @NotNull Object transactionLock = new Object();
/** Scope's contexts */
private @NotNull Contexts contexts = new Contexts();
/** Scope's attachments */
private @NotNull List<Attachment> attachments = new CopyOnWriteArrayList<>();
/**
* Scope's ctor
*
* @param options the options
*/
public Scope(final @NotNull SentryOptions options) {
this.options = Objects.requireNonNull(options, "SentryOptions is required.");
this.breadcrumbs = createBreadcrumbsList(this.options.getMaxBreadcrumbs());
}
Scope(final @NotNull Scope scope) {
this.transaction = scope.transaction;
this.transactionName = scope.transactionName;
this.session = scope.session;
this.options = scope.options;
this.level = scope.level;
final User userRef = scope.user;
this.user = userRef != null ? new User(userRef) : null;
final Request requestRef = scope.request;
this.request = requestRef != null ? new Request(requestRef) : null;
this.fingerprint = new ArrayList<>(scope.fingerprint);
this.eventProcessors = new CopyOnWriteArrayList<>(scope.eventProcessors);
final Breadcrumb[] breadcrumbsRef = scope.breadcrumbs.toArray(new Breadcrumb[0]);
Queue<Breadcrumb> breadcrumbsClone = createBreadcrumbsList(scope.options.getMaxBreadcrumbs());
for (Breadcrumb item : breadcrumbsRef) {
final Breadcrumb breadcrumbClone = new Breadcrumb(item);
breadcrumbsClone.add(breadcrumbClone);
}
this.breadcrumbs = breadcrumbsClone;
final Map<String, String> tagsRef = scope.tags;
final Map<String, @NotNull String> tagsClone = new ConcurrentHashMap<>();
for (Map.Entry<String, String> item : tagsRef.entrySet()) {
if (item != null) {
tagsClone.put(item.getKey(), item.getValue()); // shallow copy
}
}
this.tags = tagsClone;
final Map<String, Object> extraRef = scope.extra;
Map<String, @NotNull Object> extraClone = new ConcurrentHashMap<>();
for (Map.Entry<String, Object> item : extraRef.entrySet()) {
if (item != null) {
extraClone.put(item.getKey(), item.getValue()); // shallow copy
}
}
this.extra = extraClone;
this.contexts = new Contexts(scope.contexts);
this.attachments = new CopyOnWriteArrayList<>(scope.attachments);
}
/**
* Returns the Scope's SentryLevel
*
* @return the SentryLevel
*/
public @Nullable SentryLevel getLevel() {
return level;
}
/**
* Sets the Scope's SentryLevel Level from scope exceptionally take precedence over the event
*
* @param level the SentryLevel
*/
public void setLevel(final @Nullable SentryLevel level) {
this.level = level;
}
/**
* Returns the Scope's transaction name.
*
* @return the transaction
*/
public @Nullable String getTransactionName() {
final ITransaction tx = this.transaction;
return tx != null ? tx.getName() : transactionName;
}
/**
* Sets the Scope's transaction.
*
* @param transaction the transaction
*/
public void setTransaction(final @NotNull String transaction) {
if (transaction != null) {
final ITransaction tx = this.transaction;
if (tx != null) {
tx.setName(transaction, TransactionNameSource.CUSTOM);
}
this.transactionName = transaction;
} else {
options.getLogger().log(SentryLevel.WARNING, "Transaction cannot be null");
}
}
/**
* Returns current active Span or Transaction.
*
* @return current active Span or Transaction or null if transaction has not been set.
*/
@Nullable
public ISpan getSpan() {
final ITransaction tx = transaction;
if (tx != null) {
final Span span = tx.getLatestActiveSpan();
if (span != null) {
return span;
}
}
return tx;
}
/**
* Sets the current active transaction
*
* @param transaction the transaction
*/
public void setTransaction(final @Nullable ITransaction transaction) {
synchronized (transactionLock) {
this.transaction = transaction;
}
}
/**
* Returns the Scope's user
*
* @return the user
*/
public @Nullable User getUser() {
return user;
}
/**
* Sets the Scope's user
*
* @param user the user
*/
public void setUser(final @Nullable User user) {
this.user = user;
if (options.isEnableScopeSync()) {
for (final IScopeObserver observer : options.getScopeObservers()) {
observer.setUser(user);
}
}
}
/**
* Returns the Scope's request
*
* @return the request
*/
public @Nullable Request getRequest() {
return request;
}
/**
* Sets the Scope's request
*
* @param request the request
*/
public void setRequest(final @Nullable Request request) {
this.request = request;
}
/**
* Returns the Scope's fingerprint list
*
* @return the fingerprint list
*/
@NotNull
List<String> getFingerprint() {
return fingerprint;
}
/**
* Sets the Scope's fingerprint list
*
* @param fingerprint the fingerprint list
*/
public void setFingerprint(final @NotNull List<String> fingerprint) {
if (fingerprint == null) {
return;
}
this.fingerprint = new ArrayList<>(fingerprint);
}
/**
* Returns the Scope's breadcrumbs queue
*
* @return the breadcrumbs queue
*/
@NotNull
Queue<Breadcrumb> getBreadcrumbs() {
return breadcrumbs;
}
/**
* Executes the BeforeBreadcrumb callback
*
* @param callback the BeforeBreadcrumb callback
* @param breadcrumb the breadcrumb
* @param hint the hints
* @return the mutated breadcrumb or null if dropped
*/
private @Nullable Breadcrumb executeBeforeBreadcrumb(
final @NotNull SentryOptions.BeforeBreadcrumbCallback callback,
@NotNull Breadcrumb breadcrumb,
final @NotNull Hint hint) {
try {
breadcrumb = callback.execute(breadcrumb, hint);
} catch (Throwable e) {
options
.getLogger()
.log(
SentryLevel.ERROR,
"The BeforeBreadcrumbCallback callback threw an exception. Exception details will be added to the breadcrumb.",
e);
if (e.getMessage() != null) {
breadcrumb.setData("sentry:message", e.getMessage());
}
}
return breadcrumb;
}
/**
* Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if
* set
*
* @param breadcrumb the breadcrumb
* @param hint the hint
*/
public void addBreadcrumb(@NotNull Breadcrumb breadcrumb, @Nullable Hint hint) {
if (breadcrumb == null) {
return;
}
if (hint == null) {
hint = new Hint();
}
SentryOptions.BeforeBreadcrumbCallback callback = options.getBeforeBreadcrumb();
if (callback != null) {
breadcrumb = executeBeforeBreadcrumb(callback, breadcrumb, hint);
}
if (breadcrumb != null) {
this.breadcrumbs.add(breadcrumb);
if (options.isEnableScopeSync()) {
for (final IScopeObserver observer : options.getScopeObservers()) {
observer.addBreadcrumb(breadcrumb);
}
}
} else {
options.getLogger().log(SentryLevel.INFO, "Breadcrumb was dropped by beforeBreadcrumb");
}
}
/**
* Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if
* set
*
* @param breadcrumb the breadcrumb
*/
public void addBreadcrumb(final @NotNull Breadcrumb breadcrumb) {
addBreadcrumb(breadcrumb, null);
}
/** Clear all the breadcrumbs */
public void clearBreadcrumbs() {
breadcrumbs.clear();
}
/** Clears the transaction. */
public void clearTransaction() {
synchronized (transactionLock) {
transaction = null;
}
transactionName = null;
}
/**
* Returns active transaction or null if there is no active transaction.
*
* @return the transaction
*/
@Nullable
public ITransaction getTransaction() {
return this.transaction;
}
/** Resets the Scope to its default state */
public void clear() {
level = null;
user = null;
request = null;
fingerprint.clear();
clearBreadcrumbs();
tags.clear();
extra.clear();
eventProcessors.clear();
clearTransaction();
clearAttachments();
}
/**
* Returns the Scope's tags
*
* @return the tags map
*/
@ApiStatus.Internal
@SuppressWarnings("NullAway") // tags are never null
public @NotNull Map<String, String> getTags() {
return CollectionUtils.newConcurrentHashMap(tags);
}
/**
* Sets a tag to Scope's tags
*
* @param key the key
* @param value the value
*/
public void setTag(final @NotNull String key, final @NotNull String value) {
this.tags.put(key, value);
if (options.isEnableScopeSync()) {
for (final IScopeObserver observer : options.getScopeObservers()) {
observer.setTag(key, value);
}
}
}
/**
* Removes a tag from the Scope's tags
*
* @param key the key
*/
public void removeTag(final @NotNull String key) {
this.tags.remove(key);
if (options.isEnableScopeSync()) {
for (final IScopeObserver observer : options.getScopeObservers()) {
observer.removeTag(key);
}
}
}
/**
* Returns the Scope's extra map
*
* @return the extra map
*/
@NotNull
Map<String, Object> getExtras() {
return extra;
}
/**
* Sets an extra to the Scope's extra map
*
* @param key the key
* @param value the value
*/
public void setExtra(final @NotNull String key, final @NotNull String value) {
this.extra.put(key, value);
if (options.isEnableScopeSync()) {
for (final IScopeObserver observer : options.getScopeObservers()) {
observer.setExtra(key, value);
}
}
}
/**
* Removes an extra from the Scope's extras
*
* @param key the key
*/
public void removeExtra(final @NotNull String key) {
this.extra.remove(key);
if (options.isEnableScopeSync()) {
for (final IScopeObserver observer : options.getScopeObservers()) {
observer.removeExtra(key);
}
}
}
/**
* Returns the Scope's contexts
*
* @return the contexts
*/
public @NotNull Contexts getContexts() {
return contexts;
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull Object value) {
this.contexts.put(key, value);
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull Boolean value) {
final Map<String, Boolean> map = new HashMap<>();
map.put("value", value);
setContexts(key, map);
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull String value) {
final Map<String, String> map = new HashMap<>();
map.put("value", value);
setContexts(key, map);
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull Number value) {
final Map<String, Number> map = new HashMap<>();
map.put("value", value);
setContexts(key, map);
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull Collection<?> value) {
final Map<String, Collection<?>> map = new HashMap<>();
map.put("value", value);
setContexts(key, map);
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull Object[] value) {
final Map<String, Object[]> map = new HashMap<>();
map.put("value", value);
setContexts(key, map);
}
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
public void setContexts(final @NotNull String key, final @NotNull Character value) {
final Map<String, Character> map = new HashMap<>();
map.put("value", value);
setContexts(key, map);
}
/**
* Removes a value from the Scope's contexts
*
* @param key the Key
*/
public void removeContexts(final @NotNull String key) {
contexts.remove(key);
}
/**
* Returns the Scopes's attachments
*
* @return the attachments
*/
@NotNull
List<Attachment> getAttachments() {
return new CopyOnWriteArrayList<>(attachments);
}
/**
* Adds an attachment to the Scope's list of attachments. The SDK adds the attachment to every
* event and transaction sent to Sentry.
*
* @param attachment The attachment to add to the Scope's list of attachments.
*/
public void addAttachment(final @NotNull Attachment attachment) {
attachments.add(attachment);
}
/** Clear all attachments. */
public void clearAttachments() {
attachments.clear();
}
/**
* Creates a breadcrumb list with the max number of breadcrumbs
*
* @param maxBreadcrumb the max number of breadcrumbs
* @return the breadcrumbs queue
*/
private @NotNull Queue<Breadcrumb> createBreadcrumbsList(final int maxBreadcrumb) {
return SynchronizedQueue.synchronizedQueue(new CircularFifoQueue<>(maxBreadcrumb));
}
/**
* Returns the Scope's event processors
*
* @return the event processors list
*/
@NotNull
List<EventProcessor> getEventProcessors() {
return eventProcessors;
}
/**
* Adds an event processor to the Scope's event processors list
*
* @param eventProcessor the event processor
*/
public void addEventProcessor(final @NotNull EventProcessor eventProcessor) {
eventProcessors.add(eventProcessor);
}
/**
* Callback to do atomic operations on session
*
* @param sessionCallback the IWithSession callback
* @return a clone of the Session after executing the callback and mutating the session
*/
@Nullable
Session withSession(final @NotNull IWithSession sessionCallback) {
Session cloneSession = null;
synchronized (sessionLock) {
sessionCallback.accept(session);
if (session != null) {
cloneSession = session.clone();
}
}
return cloneSession;
}
/** the IWithSession callback */
interface IWithSession {
/**
* The accept method of the callback
*
* @param session the current session or null if none exists
*/
void accept(@Nullable Session session);
}
/**
* Returns a previous session (now closed) bound to this scope together with the newly created one
*
* @return the SessionPair with the previous closed session if exists and the current session
*/
@Nullable
SessionPair startSession() {
Session previousSession;
SessionPair pair = null;
synchronized (sessionLock) {
if (session != null) {
// Assumes session will NOT flush itself (Not passing any hub to it)
session.end();
}
previousSession = session;
if (options.getRelease() != null) {
session =
new Session(
options.getDistinctId(), user, options.getEnvironment(), options.getRelease());
final Session previousClone = previousSession != null ? previousSession.clone() : null;
pair = new SessionPair(session.clone(), previousClone);
} else {
options
.getLogger()
.log(
SentryLevel.WARNING,
"Release is not set on SentryOptions. Session could not be started");
}
}
return pair;
}
/** The SessionPair class */
static final class SessionPair {
/** the previous session if exists */
private final @Nullable Session previous;
/** The current Session */
private final @NotNull Session current;
/**
* The SessionPar ctor
*
* @param current the current session
* @param previous the previous sessions if exists or null
*/
public SessionPair(final @NotNull Session current, final @Nullable Session previous) {
this.current = current;
this.previous = previous;
}
/**
* REturns the previous session
*
* @return the previous sessions if exists or null
*/
public @Nullable Session getPrevious() {
return previous;
}
/**
* Returns the current session
*
* @return the current session
*/
public @NotNull Session getCurrent() {
return current;
}
}
/**
* Ends a session, unbinds it from the scope and returns it.
*
* @return the previous session
*/
@Nullable
Session endSession() {
Session previousSession = null;
synchronized (sessionLock) {
if (session != null) {
session.end();
previousSession = session.clone();
session = null;
}
}
return previousSession;
}
/**
* Mutates the current transaction atomically
*
* @param callback the IWithTransaction callback
*/
@ApiStatus.Internal
public void withTransaction(final @NotNull IWithTransaction callback) {
synchronized (transactionLock) {
callback.accept(transaction);
}
}
/** the IWithTransaction callback */
@ApiStatus.Internal
public interface IWithTransaction {
/**
* The accept method of the callback
*
* @param transaction the current transaction or null if none exists
*/
void accept(@Nullable ITransaction transaction);
}
}