Skip to content

ref: Hub passes the Scope #114

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marandaneto merged 17 commits into from
Oct 20, 2020
Merged

ref: Hub passes the Scope #114

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
8c6727d
init has a private method
marandaneto Oct 19, 2020
7570846
fix merge
marandaneto Oct 19, 2020
c1033b2
draft
marandaneto Oct 19, 2020
c3f453a
fix test
marandaneto Oct 19, 2020
a46e144
hub passes scope to client
marandaneto Oct 19, 2020
8a14620
fix
marandaneto Oct 19, 2020
4c3f323
fix broken tests
marandaneto Oct 19, 2020
35e3072
changelog
marandaneto Oct 19, 2020
30fa7a9
ignore omit_local_variable_types
marandaneto Oct 20, 2020
9088c88
ref
marandaneto Oct 20, 2020
e93f85e
ref imports
marandaneto Oct 20, 2020
7b05b0b
Update dart/lib/src/hub.dart
marandaneto Oct 20, 2020
1f70e4f
Update dart/lib/src/noop_hub.dart
marandaneto Oct 20, 2020
1f4bb44
Merge branch 'ref/hub-pass-scope' of github.com:getsentry/sentry-dart…
marandaneto Oct 20, 2020
d4334a9
ref
marandaneto Oct 20, 2020
d02947f
fix dartfmt
marandaneto Oct 20, 2020
ba721bd
fix merge conflict
marandaneto Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions dart/lib/src/client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,13 @@ abstract class SentryClient {
}

/// Reports the [throwable] and optionally its [stackTrace] to Sentry.io.
Future<SentryId> captureException(dynamic throwable, {dynamic stackTrace}) {
Future<SentryId> captureException(dynamic throwable,
{dynamic stackTrace, Scope scope}) {
final event = Event(
exception: throwable,
stackTrace: stackTrace,
);
return captureEvent(event);
return captureEvent(event, scope: scope);
}

/// Reports the [template]
Expand All @@ -211,12 +212,13 @@ abstract class SentryClient {
SeverityLevel level = SeverityLevel.info,
String template,
List<dynamic> params,
Scope scope,
}) {
final event = Event(
message: Message(formatted, template: template, params: params),
level: level,
);
return captureEvent(event);
return captureEvent(event, scope: scope);
}

Future<void> close() async {
Expand Down
48 changes: 22 additions & 26 deletions dart/lib/src/hub.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ class Hub {
);
}

final ListQueue<_StackItem> _stack;
final ListQueue<_StackItem> _stack = ListQueue();

/// if stack is empty, it throws IterableElementError.noElement()
_StackItem _peek() => _stack.isNotEmpty ? _stack.first : null;

final SentryOptions _options;

Expand All @@ -32,20 +35,18 @@ class Hub {
return Hub._(options);
}

Hub._(SentryOptions options)
: _options = options,
_stack = ListQueue() {
Hub._(SentryOptions options) : _options = options {
_stack.add(_StackItem(_getClient(fromOptions: options), Scope(_options)));
_isEnabled = true;
}

static void _validateOptions(SentryOptions options) {
if (options == null) {
throw ArgumentError.notNull('options');
throw ArgumentError.notNull('SentryOptions is required.');
}

if (options.dsn == null) {
throw ArgumentError.notNull('options.dsn');
if (options.dsn == null || options.dsn.isEmpty) {
throw ArgumentError.notNull('DSN is required.');
}
}

Expand All @@ -54,7 +55,7 @@ class Hub {
/// Check if the Hub is enabled/active.
bool get isEnabled => _isEnabled;

SentryId _lastEventId;
SentryId _lastEventId = SentryId.empty();

/// Last event id recorded in the current scope
SentryId get lastEventId => _lastEventId;
Expand All @@ -74,7 +75,7 @@ class Hub {
'captureEvent called with null parameter.',
);
} else {
final item = _stack.first;
final item = _peek();
if (item != null) {
try {
sentryId = await item.client.captureEvent(event, scope: item.scope);
Copy link
Contributor Author

@marandaneto marandaneto Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rxlabz I noticed that all the methods are sync now because of await

await: You can use the await keyword to get the completed result of an asynchronous expression. The await keyword only works within an async function.

should we aim for sync calls or keep it async?

@bruno-garcia

Copy link
Member

@bruno-garcia bruno-garcia Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we send the envelope to the client/transport to be sent to the network directly, this should be async.
We could make it sync if we, inside the client, pass the envelope to an Isolate. And there we could use async to send it to the network or write to disk.

I'd propose we stick to async for now, user code already expects do await on capture methods, and allows us to interface with the native layer by purely writing an envelope to disk (which is async)

if you're not using async/await on the method body, just remove the keywords and return futureObj;

Copy link
Contributor

@rxlabz rxlabz Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand. They are not sync, they return a Future

Copy link
Contributor Author

@marandaneto marandaneto Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rxlabz item.client.captureEvent returns a future, but you call this method using await
if you use the await keyboard, means you the future to be completed, so its a sync call, not async.
or I am not understanding the await keyword in Dart, which is also possible

Copy link
Contributor

@rxlabz rxlabz Oct 20, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

await is just a "syntactic sugar", it doesn't change the nature of the code. Maybe https://dart.dev/codelabs/async-await will be clearer than me.
But I noticed that this method is asynchronous when it calls item.client.captureEvent and synchronous if the hub is not enabled or if the event is null, we probably should change the signature to

FutureOr<SentryId> captureEvent(Event event) async {//...}

Copy link
Contributor Author

@marandaneto marandaneto Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not a big fan because of:

Note: the FutureOr type is interpreted as dynamic in non strong-mode.

but I got it I guess:
await item.client.captureEvent makes a sync call, but the signature of the method
hub.captureEvent is also async so it's fine.

let's keep as it is till we have a concrete implementation of the transport layer, so we'd know what looks better.

Expand Down Expand Up @@ -115,14 +116,11 @@ class Hub {
'captureException called with null parameter.',
);
} else {
final item = _stack.first;
final item = _peek();
if (item != null) {
try {
// TODO pass the scope
sentryId = await item.client.captureException(
throwable,
stackTrace: stackTrace,
);
sentryId = await item.client.captureException(throwable,
stackTrace: stackTrace, scope: item.scope);
} catch (err) {
_options.logger(
SeverityLevel.error,
Expand Down Expand Up @@ -162,16 +160,14 @@ class Hub {
'captureMessage called with null parameter.',
);
} else {
final item = _stack.first;
final item = _peek();
if (item != null) {
try {
// TODO pass the scope
sentryId = await item.client.captureMessage(
message,
level: level,
template: template,
params: params,
);
sentryId = await item.client.captureMessage(message,
level: level,
template: template,
params: params,
scope: item.scope);
} catch (err) {
_options.logger(
SeverityLevel.error,
Expand All @@ -196,7 +192,7 @@ class Hub {
_options.logger(SeverityLevel.warning,
"Instance is disabled and this 'bindClient' call is a no-op.");
} else {
final item = _stack.first;
final item = _peek();
if (item != null) {
if (client != null) {
_options.logger(SeverityLevel.debug, 'New client bound to scope.');
Expand Down Expand Up @@ -234,7 +230,7 @@ class Hub {
"Instance is disabled and this 'close' call is a no-op.",
);
} else {
final item = _stack.first;
final item = _peek();
if (item != null) {
try {
item.client.close();
Expand Down Expand Up @@ -262,7 +258,7 @@ class Hub {
"Instance is disabled and this 'configureScope' call is a no-op.",
);
} else {
final item = _stack.first;
final item = _peek();
if (item != null) {
try {
callback(item.scope);
Expand Down
12 changes: 11 additions & 1 deletion dart/lib/src/noop_client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,17 @@ import 'package:http/src/client.dart';

import 'client.dart';
import 'protocol.dart';
import 'scope.dart';

class NoOpSentryClient implements SentryClient {
NoOpSentryClient._();

static final NoOpSentryClient _instance = NoOpSentryClient._();

factory NoOpSentryClient() {
return _instance;
}

@override
User userContext;

Expand All @@ -24,7 +33,7 @@ class NoOpSentryClient implements SentryClient {
Future.value(SentryId.empty());

@override
Future<SentryId> captureException(throwable, {stackTrace}) =>
Future<SentryId> captureException(throwable, {stackTrace, scope}) =>
Future.value(SentryId.empty());

@override
Expand All @@ -33,6 +42,7 @@ class NoOpSentryClient implements SentryClient {
SeverityLevel level = SeverityLevel.info,
String template,
List<dynamic> params,
Scope scope,
}) =>
Future.value(SentryId.empty());

Expand Down
51 changes: 51 additions & 0 deletions dart/lib/src/noop_hub.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import 'dart:async';

import 'package:sentry/src/client.dart';
import 'package:sentry/src/hub.dart';
import 'package:sentry/src/protocol/sentry_id.dart';
import 'package:sentry/src/protocol/level.dart';
import 'package:sentry/src/protocol/event.dart';
Copy link
Contributor Author

@marandaneto marandaneto Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IDE does the imports like this but feels weird, whats the proper way?

Copy link
Member

@bruno-garcia bruno-garcia Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the linter should be pointing us to the right way (flutter analyze). I believe this is the way to go but I can't recall now

Copy link
Contributor Author

@marandaneto marandaneto Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it didnt complain, thats why

Copy link
Contributor

@rxlabz rxlabz Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally in Dart, relative imports should be preferred https://fuchsia.dev/fuchsia-src/development/languages/dart/style#do_import_all_files_within_a_package_using_relative_paths
( but I know that the Flutter team doesn't follow all the Dart styleguide :) )
In IntelliJ, the autocompletion often shows both the relative and package: imports. I don't know if VSCode can be configured is this way.
We could also activate this lint https://dart-lang.github.io/linter/lints/prefer_relative_imports.html which seems to not be activated with pedantic to enforce the rule.

Copy link
Contributor Author

@marandaneto marandaneto Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice I created a task for it


import 'hub.dart';

class NoOpHub implements Hub {
NoOpHub._();

static final NoOpHub _instance = NoOpHub._();

factory NoOpHub() {
return _instance;
}

@override
void bindClient(SentryClient client) {}

@override
Future<SentryId> captureEvent(Event event) => Future.value(SentryId.empty());

@override
Future<SentryId> captureException(throwable, {stackTrace}) =>
Future.value(SentryId.empty());

@override
Future<SentryId> captureMessage(String message,
{SeverityLevel level = SeverityLevel.info,
String template,
List params}) =>
Future.value(SentryId.empty());

@override
Hub clone() => this;

@override
void close() {}

@override
void configureScope(callback) {}

@override
bool get isEnabled => false;

@override
SentryId get lastEventId => SentryId.empty();
}
6 changes: 3 additions & 3 deletions dart/lib/src/protocol/sentry_id.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
/// Sentry response id
class SentryId {
static const String emptyId = '00000000-0000-0000-0000-000000000000';
static const String _emptyId = '00000000-0000-0000-0000-000000000000';

/// The ID Sentry.io assigned to the submitted event for future reference.
final String _id;

String get id => _id;
// TODO: should we generate the new UUID here with an empty ctor?
Copy link
Contributor Author

@marandaneto marandaneto Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if so, we'd need to import the uuid dependency and make the _id of its type

Copy link
Contributor

@rxlabz rxlabz Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I maybe missed it, but I didn't found a method to generate a Uuid from String in the uuid package

Copy link
Contributor Author

@marandaneto marandaneto Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe parse and unparse https://github.com/Daegalus/dart-uuid#uuidparsestring-uuid-list-buffer-null-int-offset-0

Copy link
Contributor Author

@marandaneto marandaneto Oct 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created a task for it


const SentryId(this._id);

factory SentryId.empty() => SentryId(emptyId);
factory SentryId.empty() => SentryId(_emptyId);

@override
String toString() => _id.replaceAll('-', '');
Expand Down
42 changes: 37 additions & 5 deletions dart/lib/src/sentry.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,72 @@ import 'client.dart';
import 'hub.dart';
import 'protocol.dart';
import 'sentry_options.dart';
import 'noop_hub.dart';

/// Configuration options callback
typedef OptionsConfiguration = void Function(SentryOptions);

/// Sentry SDK main entry point
///
class Sentry {
static Hub _hub;
static Hub _hub = NoOpHub();

Sentry._();

/// Returns the current hub
static Hub get currentHub => _hub;

/// Initializes the SDK
static void init(OptionsConfiguration optionsConfiguration) {
final options = SentryOptions();
optionsConfiguration(options);
_init(options);
}

/// Initializes the SDK
static void _init(SentryOptions options) {
if (isEnabled) {
options.logger(
SeverityLevel.warning,
'Sentry has been already initialized. Previous configuration will be overwritten.',
);
}

final hub = currentHub;
_hub = Hub(options);
hub.close();
}

/// Reports an [event] to Sentry.io.
static Future<SentryId> captureEvent(Event event) async {
return _hub.captureEvent(event);
return currentHub.captureEvent(event);
}

/// Reports the [exception] and optionally its [stackTrace] to Sentry.io.
static Future<SentryId> captureException(
dynamic error, {
dynamic stackTrace,
}) async {
return _hub.captureException(error, stackTrace: stackTrace);
return currentHub.captureException(error, stackTrace: stackTrace);
}

Future<SentryId> captureMessage(
String message, {
SeverityLevel level,
String template,
List<dynamic> params,
}) async {
return currentHub.captureMessage(message,
level: level, template: template, params: params);
}

/// Close the client SDK
static Future<void> close() async => _hub.close();
static Future<void> close() async => currentHub.close();

/// Check if the current Hub is enabled/active.
static bool get isEnabled => currentHub.isEnabled;

/// client injector only use for testing
@visibleForTesting
static void initClient(SentryClient client) => _hub.bindClient(client);
static void initClient(SentryClient client) => currentHub.bindClient(client);
}
6 changes: 4 additions & 2 deletions dart/test/hub_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,15 @@ void main() {
test('should capture exception', () {
hub.captureException(fakeException);

verify(client.captureException(fakeException)).called(1);
verify(client.captureException(fakeException, scope: anyNamed('scope')))
.called(1);
});

test('should capture message', () {
hub.captureMessage(fakeMessage.formatted, level: SeverityLevel.info);
verify(
client.captureMessage(fakeMessage.formatted, level: SeverityLevel.info),
client.captureMessage(fakeMessage.formatted,
level: SeverityLevel.info, scope: anyNamed('scope')),
).called(1);
});
});
Expand Down
3 changes: 2 additions & 1 deletion dart/test/sentry_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ void main() {
test('should capture the exception', () async {
await Sentry.captureException(anException);
verify(
client.captureException(anException, stackTrace: null),
client.captureException(anException,
stackTrace: null, scope: anyNamed('scope')),
).called(1);
});
});
Expand Down
Loading