set client.options private

dart/lib/src/client.dart

@@ -18,31 +18,19 @@ abstract class SentryClient {
   /// `dart:html` is available, otherwise it will throw an unsupported error.
   factory SentryClient(SentryOptions options) => createSentryClient(options);
 
-  SentryClient.base(this.options, {String origin}) {
-    _random = options.sampleRate == null ? null : Random();
-    if (options.transport is NoOpTransport) {
-      options.transport = Transport(
-        options: options,
+  SentryClient.base(this._options, {String origin}) {
+    _random = _options.sampleRate == null ? null : Random();
+    if (_options.transport is NoOpTransport) {
+      _options.transport = Transport(
+        options: _options,
         sdkIdentifier: '${sdkName}/${sdkVersion}',
         origin: origin,
       );
     }
   }
 
-  @visibleForTesting
-  SentryOptions options;
-
-  /// Information about the current user.
-  ///
-  /// This information is sent with every logged event. If the value
-  /// of this field is updated, all subsequent events will carry the
-  /// new information.
-  ///
-  /// [Event.userContext] overrides the [User] context set here.
-  ///
-  /// See also:
-  /// * https://docs.sentry.io/learn/context/#capturing-the-user
-  User userContext;
+  //@visibleForTesting
+  SentryOptions _options;
 
   Random _random;
 
@@ -52,7 +40,7 @@ abstract class SentryClient {
     Scope scope,
     dynamic hint,
   }) async {
-    event = _processEvent(event, eventProcessors: options.eventProcessors);
+    event = _processEvent(event, eventProcessors: _options.eventProcessors);
 
     // dropped by sampling or event processors
     if (event == null) {
@@ -63,7 +51,7 @@ abstract class SentryClient {
 
     event = event.copyWith(platform: sdkPlatform);
 
-    return options.transport.send(event);
+    return _options.transport.send(event);
   }
 
   /// Reports the [throwable] and optionally its [stackTrace] to Sentry.io.
@@ -76,7 +64,7 @@ abstract class SentryClient {
     final event = SentryEvent(
       exception: throwable,
       stackTrace: stackTrace,
-      timestamp: options.clock(),
+      timestamp: _options.clock(),
     );
     return captureEvent(event, scope: scope, hint: hint);
   }
@@ -93,14 +81,14 @@ abstract class SentryClient {
     final event = SentryEvent(
       message: Message(formatted, template: template, params: params),
       level: level,
-      timestamp: options.clock(),
+      timestamp: _options.clock(),
     );
 
     return captureEvent(event, scope: scope, hint: hint);
   }
 
   void close() {
-    options.httpClient?.close();
+    _options.httpClient?.close();
   }
 
   SentryEvent _processEvent(
@@ -109,7 +97,7 @@ abstract class SentryClient {
     List<EventProcessor> eventProcessors,
   }) {
     if (_sampleRate()) {
-      options.logger(
+      _options.logger(
         SentryLevel.debug,
         'Event ${event.eventId.toString()} was dropped due to sampling decision.',
       );
@@ -120,13 +108,13 @@ abstract class SentryClient {
       try {
         event = processor(event, hint);
       } catch (err) {
-        options.logger(
+        _options.logger(
           SentryLevel.error,
           'An exception occurred while processing event by a processor : $err',
         );
       }
       if (event == null) {
-        options.logger(SentryLevel.debug, 'Event was dropped by a processor');
+        _options.logger(SentryLevel.debug, 'Event was dropped by a processor');
         break;
       }
     }
@@ -178,8 +166,8 @@ abstract class SentryClient {
   }
 
   bool _sampleRate() {
-    if (options.sampleRate != null && _random != null) {
-      return (options.sampleRate < _random.nextDouble());
+    if (_options.sampleRate != null && _random != null) {
+      return (_options.sampleRate < _random.nextDouble());
     }
     return false;
   }

dart/test/sentry_client_test.dart

@@ -17,28 +17,28 @@ void main() {
     test('captures event, sample rate is 100% enabled', () {
       options.sampleRate = 1.0;
       final client = SentryClient(options);
-      client.options.transport = transport;
+      options.transport = transport;
       client.captureEvent(fakeEvent);
 
-      verify(client.options.transport.send(any)).called(1);
+      verify(transport.send(any)).called(1);
     });
 
     test('do not capture event, sample rate is 0% disabled', () {
       options.sampleRate = 0.0;
       final client = SentryClient(options);
-      client.options.transport = transport;
+      options.transport = transport;
       client.captureEvent(fakeEvent);
 
-      verifyNever(client.options.transport.send(any));
+      verifyNever(transport.send(any));
     });
 
     test('captures event, sample rate is null, disabled', () {
       options.sampleRate = null;
       final client = SentryClient(options);
-      client.options.transport = transport;
+      options.transport = transport;
       client.captureEvent(fakeEvent);
 
-      verify(client.options.transport.send(any)).called(1);
+      verify(transport.send(any)).called(1);
     });
   });
 }

dart/test/test_utils.dart

@@ -70,30 +70,30 @@ Future testCaptureException(
     fail('Unexpected request on ${request.method} ${request.url} in HttpMock');
   });
 
-  var sentryId = SentryId.empty();
-  final client = SentryClient(
-    SentryOptions(
-      dsn: testDsn,
-      httpClient: httpMock,
-      clock: fakeClockProvider,
-      compressPayload: compressPayload,
-      environmentAttributes: SentryEvent(
-        serverName: 'test.server.com',
-        release: '1.2.3',
-        environment: 'staging',
-        timestamp: fakeClockProvider(),
-      ),
+  final options = SentryOptions(
+    dsn: testDsn,
+    httpClient: httpMock,
+    clock: fakeClockProvider,
+    compressPayload: compressPayload,
+    environmentAttributes: SentryEvent(
+      serverName: 'test.server.com',
+      release: '1.2.3',
+      environment: 'staging',
+      timestamp: fakeClockProvider(),
     ),
   );
 
+  var sentryId = SentryId.empty();
+  final client = SentryClient(options);
+
   try {
     throw ArgumentError('Test error');
   } catch (error, stackTrace) {
     sentryId = await client.captureException(error, stackTrace: stackTrace);
     expect('$sentryId', 'testeventid');
   }
 
-  expect(postUri, client.options.transport.dsn.postUri);
+  expect(postUri, options.transport.dsn.postUri);
 
   testHeaders(
     headers,
@@ -181,49 +181,53 @@ Future testCaptureException(
 
 void runTest({Codec<List<int>, List<int>> gzip, bool isWeb = false}) {
   test('can parse DSN', () async {
-    final client = SentryClient(SentryOptions(dsn: testDsn));
-    expect(client.options.transport.dsn.uri, Uri.parse(testDsn));
-    expect(client.options.transport.dsn.postUri,
+    final options = SentryOptions(dsn: testDsn);
+    final client = SentryClient(options);
+    expect(options.transport.dsn.uri, Uri.parse(testDsn));
+    expect(options.transport.dsn.postUri,
         'https://sentry.example.com/api/1/store/');
-    expect(client.options.transport.dsn.publicKey, 'public');
-    expect(client.options.transport.dsn.secretKey, 'secret');
-    expect(client.options.transport.dsn.projectId, '1');
+    expect(options.transport.dsn.publicKey, 'public');
+    expect(options.transport.dsn.secretKey, 'secret');
+    expect(options.transport.dsn.projectId, '1');
     await client.close();
   });
 
   test('can parse DSN without secret', () async {
-    final client = SentryClient(SentryOptions(dsn: _testDsnWithoutSecret));
-    expect(client.options.transport.dsn.uri, Uri.parse(_testDsnWithoutSecret));
-    expect(client.options.transport.dsn.postUri,
+    final options = SentryOptions(dsn: _testDsnWithoutSecret);
+    final client = SentryClient(options);
+    expect(options.transport.dsn.uri, Uri.parse(_testDsnWithoutSecret));
+    expect(options.transport.dsn.postUri,
         'https://sentry.example.com/api/1/store/');
-    expect(client.options.transport.dsn.publicKey, 'public');
-    expect(client.options.transport.dsn.secretKey, null);
-    expect(client.options.transport.dsn.projectId, '1');
+    expect(options.transport.dsn.publicKey, 'public');
+    expect(options.transport.dsn.secretKey, null);
+    expect(options.transport.dsn.projectId, '1');
     await client.close();
   });
 
   test('can parse DSN with path', () async {
-    final client = SentryClient(SentryOptions(dsn: _testDsnWithPath));
-    expect(client.options.transport.dsn.uri, Uri.parse(_testDsnWithPath));
+    final options = SentryOptions(dsn: _testDsnWithPath);
+    final client = SentryClient(options);
+    expect(options.transport.dsn.uri, Uri.parse(_testDsnWithPath));
     expect(
-      client.options.transport.dsn.postUri,
+      options.transport.dsn.postUri,
       'https://sentry.example.com/path/api/1/store/',
     );
-    expect(client.options.transport.dsn.publicKey, 'public');
-    expect(client.options.transport.dsn.secretKey, 'secret');
-    expect(client.options.transport.dsn.projectId, '1');
+    expect(options.transport.dsn.publicKey, 'public');
+    expect(options.transport.dsn.secretKey, 'secret');
+    expect(options.transport.dsn.projectId, '1');
     await client.close();
   });
   test('can parse DSN with port', () async {
-    final client = SentryClient(SentryOptions(dsn: _testDsnWithPort));
-    expect(client.options.transport.dsn.uri, Uri.parse(_testDsnWithPort));
+    final options = SentryOptions(dsn: _testDsnWithPort);
+    final client = SentryClient(options);
+    expect(options.transport.dsn.uri, Uri.parse(_testDsnWithPort));
     expect(
-      client.options.transport.dsn.postUri,
+      options.transport.dsn.postUri,
       'https://sentry.example.com:8888/api/1/store/',
     );
-    expect(client.options.transport.dsn.publicKey, 'public');
-    expect(client.options.transport.dsn.secretKey, 'secret');
-    expect(client.options.transport.dsn.projectId, '1');
+    expect(options.transport.dsn.publicKey, 'public');
+    expect(options.transport.dsn.secretKey, 'secret');
+    expect(options.transport.dsn.projectId, '1');
     await client.close();
   });
   test('sends client auth header without secret', () async {
@@ -367,7 +371,6 @@ void runTest({Codec<List<int>, List<int>> gzip, bool isWeb = false}) {
     );
 
     final client = SentryClient(options);
-    client.userContext = clientUserContext;
 
     try {
       throw ArgumentError('Test error');