unified api fixes and add web example (#137)

.gitignore

@@ -15,4 +15,6 @@ ios/
 build/
 .cxx/
 
+
 .test_coverage.dart
+dart/coverage/*

CHANGELOG.md

@@ -35,6 +35,7 @@
 - Ref: execute before send callback
 - Feat: add lastEventId to the Sentry static API
 - Feat: addBreadcrumb on Static API
+- Add a Dart web example
 - Fix: Integrations are executed on Hub creation
 - Fix: NoOp encode for Web
 - Fix: Breadcrumb data should accept serializable types and not only String values

dart/example/event_example.dart

@@ -6,43 +6,45 @@ final event = SentryEvent(
   release: '1.4.0-preview.1',
   environment: 'Test',
   message: Message('This is an example Dart event.'),
-  transaction: '/example/app',
-  level: SentryLevel.warning,
   tags: const <String, String>{'project-id': '7371'},
-  extra: const <String, String>{'company-name': 'Dart Inc'},
+  extra: const <String, String>{'section': '1'},
   fingerprint: const <String>['example-dart'],
   userContext: const User(
-      id: '800',
-      username: 'first-user',
-      email: '[email protected]',
-      ipAddress: '127.0.0.1',
-      extras: <String, String>{'first-sign-in': '2020-01-01'}),
+    id: '800',
+    username: 'first-user',
+    email: '[email protected]',
+    ipAddress: '127.0.0.1',
+    extras: <String, String>{'first-sign-in': '2020-01-01'},
+  ),
   breadcrumbs: [
     Breadcrumb(
-        message: 'UI Lifecycle',
-        timestamp: DateTime.now().toUtc(),
-        category: 'ui.lifecycle',
-        type: 'navigation',
-        data: {'screen': 'MainActivity', 'state': 'created'},
-        level: SentryLevel.info)
+      message: 'UI Lifecycle',
+      timestamp: DateTime.now().toUtc(),
+      category: 'ui.lifecycle',
+      type: 'navigation',
+      data: {'screen': 'MainActivity', 'state': 'created'},
+      level: SentryLevel.info,
+    )
   ],
   contexts: Contexts(
     operatingSystem: const OperatingSystem(
-        name: 'Android',
-        version: '5.0.2',
-        build: 'LRX22G.P900XXS0BPL2',
-        kernelVersion:
-            'Linux version 3.4.39-5726670 (dpi@SWHC3807) (gcc version 4.8 (GCC) ) #1 SMP PREEMPT Thu Dec 1 19:42:39 KST 2016',
-        rooted: false),
+      name: 'Android',
+      version: '5.0.2',
+      build: 'LRX22G.P900XXS0BPL2',
+      kernelVersion:
+          'Linux version 3.4.39-5726670 (dpi@SWHC3807) (gcc version 4.8 (GCC) ) #1 SMP PREEMPT Thu Dec 1 19:42:39 KST 2016',
+      rooted: false,
+    ),
     runtimes: [const Runtime(name: 'ART', version: '5')],
     app: App(
-        name: 'Example Dart App',
-        version: '1.42.0',
-        identifier: 'HGT-App-13',
-        build: '93785',
-        buildType: 'release',
-        deviceAppHash: '5afd3a6',
-        startTime: DateTime.now().toUtc()),
+      name: 'Example Dart App',
+      version: '1.42.0',
+      identifier: 'HGT-App-13',
+      build: '93785',
+      buildType: 'release',
+      deviceAppHash: '5afd3a6',
+      startTime: DateTime.now().toUtc(),
+    ),
     browser: const Browser(name: 'Firefox', version: '42.0.1'),
     device: Device(
       name: 'SM-P900',

dart/example/main.dart

@@ -3,32 +3,72 @@
 // found in the LICENSE file.
 
 import 'dart:async';
-import 'dart:io';
 
 import 'package:sentry/sentry.dart';
 
 import 'event_example.dart';
 
 /// Sends a test exception report to Sentry.io using this Dart client.
-Future<void> main(List<String> rawArgs) async {
-  if (rawArgs.length != 1) {
-    stderr.writeln(
-        'Expected exactly one argument, which is the DSN issued by Sentry.io to your project.');
-    exit(1);
-  }
+Future<void> main() async {
+  const dsn =
+      'https://[email protected]/5428562';
+
+  SentryEvent processTagEvent(SentryEvent event, Object hint) =>
+      event..tags.addAll({'page-locale': 'en-us'});
+
+  Sentry.init((options) => options
+    ..dsn = dsn
+    ..addEventProcessor(processTagEvent));
+
+  Sentry.addBreadcrumb(
+    Breadcrumb(
+      message: 'Authenticated user',
+      category: 'auth',
+      type: 'debug',
+      data: {
+        'admin': true,
+        'permissions': [1, 2, 3]
+      },
+    ),
+  );
 
-  final dsn = rawArgs.single;
-  Sentry.init((options) => options.dsn = dsn);
+  Sentry.configureScope((scope) {
+    scope
+      ..user = User(
+        id: '800',
+        username: 'first-user',
+        email: '[email protected]',
+        ipAddress: '127.0.0.1',
+        extras: <String, String>{'first-sign-in': '2020-01-01'},
+      )
+      ..fingerprint = ['example-dart']
+      ..transaction = '/example/app'
+      ..level = SentryLevel.warning
+      ..setTag('build', '579')
+      ..setExtra('company-name', 'Dart Inc');
+  });
 
   print('\nReporting a complete event example: ');
 
   // Sends a full Sentry event payload to show the different parts of the UI.
   final sentryId = await Sentry.captureEvent(event);
 
-  print('SentryId : ${sentryId}');
+  print('Capture event result : SentryId : ${sentryId}');
+
+  print('\nCapture message: ');
+
+  // Sends a full Sentry event payload to show the different parts of the UI.
+  final messageSentryId = await Sentry.captureMessage(
+    'Message 1',
+    level: SentryLevel.warning,
+    template: 'Message %s',
+    params: ['1'],
+  );
+
+  print('Capture message result : SentryId : ${messageSentryId}');
 
   try {
-    await foo();
+    await loadConfig();
   } catch (error, stackTrace) {
     print('\nReporting the following stack trace: ');
     print(stackTrace);
@@ -37,22 +77,22 @@ Future<void> main(List<String> rawArgs) async {
       stackTrace: stackTrace,
     );
 
-    print('SentryId : ${sentryId}');
+    print('Capture exception result : SentryId : ${sentryId}');
   } finally {
     await Sentry.close();
   }
 
   /* TODO(rxlabz) Sentry CaptureMessage(message, level) */
 }
 
-Future<void> foo() async {
-  await bar();
+Future<void> loadConfig() async {
+  await parseConfig();
 }
 
-Future<void> bar() async {
-  await baz();
+Future<void> parseConfig() async {
+  await decode();
 }
 
-Future<void> baz() async {
+Future<void> decode() async {
   throw StateError('This is a test error');
 }

dart/example_web/.gitignore

@@ -0,0 +1,9 @@
+# Files and directories created by pub
+.dart_tool/
+.packages
+
+# Conventional directory for build outputs
+build/
+
+# Directory created by dartdoc
+doc/api/

dart/example_web/README.md

@@ -0,0 +1,9 @@
+# Sentry Dart : web example
+
+```dart
+pub get
+
+# run the project ( see https://dart.dev/tools/webdev#serve ) 
+webdev serve --release
+
+```

dart/example_web/pubspec.yaml

@@ -0,0 +1,16 @@
+name: sentry_dart_web_example
+description: An absolute bare-bones web app.
+# version: 1.0.0
+#homepage: https://www.example.com
+
+environment:
+  sdk: ^2.0.0
+
+dependencies:
+  sentry:
+    path: ../..
+
+dev_dependencies:
+  build_runner: ^1.10.0
+  build_web_compilers: ^2.13.0
+  pedantic: ^1.9.0

dart/example_web/web/event.dart

@@ -0,0 +1,77 @@
+import 'package:sentry/src/protocol.dart';
+
+final event = SentryEvent(
+  logger: 'main',
+  serverName: 'server.dart',
+  release: '1.4.0-preview.1',
+  environment: 'Test',
+  message: Message('This is an example Dart event.'),
+  tags: const <String, String>{'project-id': '7371'},
+  extra: const <String, String>{'section': '1'},
+  fingerprint: const <String>['example-dart'],
+  userContext: const User(
+    id: '800',
+    username: 'first-user',
+    email: '[email protected]',
+    ipAddress: '127.0.0.1',
+    extras: <String, String>{'first-sign-in': '2020-01-01'},
+  ),
+  breadcrumbs: [
+    Breadcrumb(
+      message: 'UI Lifecycle',
+      timestamp: DateTime.now().toUtc(),
+      category: 'ui.lifecycle',
+      type: 'navigation',
+      data: {'screen': 'MainActivity', 'state': 'created'},
+      level: SentryLevel.info,
+    )
+  ],
+  contexts: Contexts(
+    operatingSystem: const OperatingSystem(
+      name: 'Android',
+      version: '5.0.2',
+      build: 'LRX22G.P900XXS0BPL2',
+      kernelVersion:
+          'Linux version 3.4.39-5726670 (dpi@SWHC3807) (gcc version 4.8 (GCC) ) #1 SMP PREEMPT Thu Dec 1 19:42:39 KST 2016',
+      rooted: false,
+    ),
+    runtimes: [const Runtime(name: 'ART', version: '5')],
+    app: App(
+      name: 'Example Dart App',
+      version: '1.42.0',
+      identifier: 'HGT-App-13',
+      build: '93785',
+      buildType: 'release',
+      deviceAppHash: '5afd3a6',
+      startTime: DateTime.now().toUtc(),
+    ),
+    browser: const Browser(name: 'Firefox', version: '42.0.1'),
+    device: Device(
+      name: 'SM-P900',
+      family: 'SM-P900',
+      model: 'SM-P900 (LRX22G)',
+      modelId: 'LRX22G',
+      arch: 'armeabi-v7a',
+      batteryLevel: 99,
+      orientation: Orientation.landscape,
+      manufacturer: 'samsung',
+      brand: 'samsung',
+      screenResolution: '2560x1600',
+      screenDensity: 2.1,
+      screenDpi: 320,
+      online: true,
+      charging: true,
+      lowMemory: true,
+      simulator: false,
+      memorySize: 1500,
+      freeMemory: 200,
+      usableMemory: 4294967296,
+      storageSize: 4294967296,
+      freeStorage: 2147483648,
+      externalStorageSize: 8589934592,
+      externalFreeStorage: 2863311530,
+      bootTime: DateTime.now().toUtc(),
+      timezone: 'America/Toronto',
+    ),
+  ),
+);

dart/example_web/web/index.html

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="scaffolded-by" content="https://github.com/dart-lang/stagehand">
+    <title>dart_web</title>
+    <link rel="stylesheet" href="styles.css">
+    <link rel="icon" href="favicon.ico">
+
+    <style>
+      .bloc {
+        display: flex;
+        margin: 1rem;
+      }
+
+      .result {
+        padding-left: 1rem;
+        color: green;
+        display: none;
+      }
+    </style>
+
+    <script defer src="main.dart.js"></script>
+</head>
+
+<body>
+
+<div id="output"></div>
+
+<div class="bloc">
+    <button id="btEvent">Capture Event</button>
+    <div id="eventResult" class="result">Captured</div>
+</div>
+
+<div class="bloc">
+    <button id="btMessage">Capture Message</button>
+    <div id="messageResult" class="result">Captured</div>
+</div>
+
+<div class="bloc">
+    <button id="btException">Capture Exception</button>
+    <div id="exceptionResult" class="result">Captured</div>
+</div>
+
+</body>
+</html>