APM for hive

.github/workflows/dart.yml

@@ -11,6 +11,7 @@ on:
       - "dio/**"
       - "file/**"
       - "sqflite/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

.github/workflows/diagrams.yml

@@ -43,6 +43,10 @@ jobs:
         working-directory: ./logging
         run: lakos . -i "{test/**,example/**}" | dot -Tsvg -o class-diagram.svg
 
+      - name: hive
+        working-directory: ./hive
+        run: lakos . -i "{test/**,example/**}" | dot -Tsvg -o class-diagram.svg
+
         # Source: https://stackoverflow.com/a/58035262
       - name: Extract branch name
         shell: bash

.github/workflows/dio.yml

@@ -11,6 +11,7 @@ on:
       - "flutter/**"
       - "file/**"
       - "sqflite/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

.github/workflows/e2e_dart.yml

@@ -12,6 +12,7 @@ on:
       - "flutter/**"
       - "file/**"
       - "sqflite/**"
+      - "hive/**"
 
 env:
   SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}

.github/workflows/file.yml

@@ -11,6 +11,7 @@ on:
       - "flutter/**"
       - "dio/**"
       - "sqflite/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

.github/workflows/flutter.yml

@@ -11,6 +11,7 @@ on:
       - "dio/**"
       - "file/**"
       - "sqflite/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

.github/workflows/hive.yml

@@ -0,0 +1,71 @@
+name: sentry-hive
+on:
+  push:
+    branches:
+      - main
+      - release/**
+  pull_request:
+    paths-ignore:
+      - "**/*.md"
+      - "logging/**"
+      - "flutter/**"
+      - "dio/**"
+      - "file/**"
+      - "sqflite/**"
+
+jobs:
+  cancel-previous-workflow:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 # pin@0.11.0
+        with:
+          access_token: ${{ github.token }}
+
+  build:
+    name: Build ${{matrix.sdk}} on ${{matrix.os}}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    defaults:
+      run:
+        shell: bash
+        working-directory: ./hive
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        sdk: [stable, beta]
+        exclude:
+          - os: windows-latest
+            sdk: beta
+          - os: macos-latest
+            sdk: beta
+    steps:
+      - uses: dart-lang/setup-dart@6a218f2413a3e78e9087f638a238f6b40893203d # pin@v1
+        with:
+          sdk: ${{ matrix.sdk }}
+      - uses: actions/checkout@v3
+
+      - name: Test VM
+        run: |
+          dart pub get
+          dart test -p vm --coverage=coverage --test-randomize-ordering-seed=random --chain-stack-traces
+          dart pub run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=lib
+
+      - uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # pin@v3
+        if: runner.os == 'Linux' && matrix.sdk == 'stable'
+        with:
+          name: sentry_hive
+          files: ./hive/coverage/lcov.info
+
+      - uses: VeryGoodOpenSource/very_good_coverage@e5c91bc7ce9843e87c800b3bcafdfb86fbe28491 # pin@v2.1.0
+        if: runner.os == 'Linux' && matrix.sdk == 'stable'
+        with:
+          path: "./hive/coverage/lcov.info"
+          min_coverage: 55
+
+  analyze:
+    uses: ./.github/workflows/analyze.yml
+    with:
+      package: hive
+      panaThreshold: 90

.github/workflows/logging.yml

@@ -11,6 +11,7 @@ on:
       - "flutter/**"
       - "file/**"
       - "sqflite/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

.github/workflows/min_version_test.yml

@@ -9,6 +9,7 @@ on:
       - "**/*.md"
       - "file/**"
       - "sqflite/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

.github/workflows/sqflite.yml

@@ -11,6 +11,7 @@ on:
       - "flutter/**"
       - "dio/**"
       - "file/**"
+      - "hive/**"
 
 jobs:
   cancel-previous-workflow:

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 - StackTraces in `PlatformException.message` will get nicely formatted too when present ([#1716](https://github.com/getsentry/sentry-dart/pull/1716))
 - Breadcrumbs for database operations ([#1656](https://github.com/getsentry/sentry-dart/pull/1656))
+- APM for hive ([#1672](https://github.com/getsentry/sentry-dart/pull/1672))
 - Add `attachScreenshotOnlyWhenResumed` to options ([#1700](https://github.com/getsentry/sentry-dart/pull/1700))
 
 ### Dependencies

dart/lib/src/sentry_trace_origins.dart

@@ -18,4 +18,9 @@ class SentryTraceOrigins {
       'auto.db.sqflite.database_executor';
   static const autoDbSqfliteDatabaseFactory =
       'auto.db.sqflite.database_factory';
+
+  static const autoDbHive = 'auto.db.hive';
+  static const autoDbHiveBoxBase = 'auto.db.hive.box_base';
+  static const autoDbHiveLazyBox = 'auto.db.hive.lazy_box';
+  static const autoDbHiveBoxCollection = 'auto.db.hive.box_collection';
 }

flutter/example/lib/main.dart

@@ -7,6 +7,7 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:logging/logging.dart';
+import 'package:path_provider/path_provider.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
 import 'package:sentry_sqflite/sentry_sqflite.dart';
 import 'package:sqflite/sqflite.dart';
@@ -19,6 +20,7 @@ import 'user_feedback_dialog.dart';
 import 'package:dio/dio.dart';
 import 'package:sentry_dio/sentry_dio.dart';
 import 'package:sentry_logging/sentry_logging.dart';
+import 'package:sentry_hive/sentry_hive.dart';
 
 // ATTENTION: Change the DSN below with your own to see the events in Sentry. Get one at sentry.io
 const String exampleDsn =
@@ -149,6 +151,10 @@ class MainScaffold extends StatelessWidget {
           children: [
             if (_isIntegrationTest) const IntegrationTestWidget(),
             const Center(child: Text('Trigger an action:\n')),
+            ElevatedButton(
+              onPressed: () => hiveTest(),
+              child: const Text('hive'),
+            ),
             ElevatedButton(
               onPressed: () => sqfliteTest(),
               child: const Text('sqflite'),
@@ -422,6 +428,31 @@ class MainScaffold extends StatelessWidget {
     );
   }
 
+  Future<void> hiveTest() async {
+    if (kIsWeb) {
+      return;
+    }
+
+    final tr = Sentry.startTransaction(
+      'hiveTest',
+      'db',
+      bindToScope: true,
+    );
+
+    final appDir = await getApplicationDocumentsDirectory();
+    SentryHive.init(appDir.path);
+
+    final catsBox = await SentryHive.openBox<Map>('cats');
+    await catsBox.put('fluffy', {'name': 'Fluffy', 'age': 4});
+    await catsBox.put('loki', {'name': 'Loki', 'age': 2});
+    await catsBox.clear();
+    await catsBox.close();
+
+    SentryHive.close();
+
+    await tr.finish(status: const SpanStatus.ok());
+  }
+
   Future<void> sqfliteTest() async {
     final tr = Sentry.startTransaction(
       'sqfliteTest',

flutter/example/pubspec.yaml

@@ -17,6 +17,7 @@ dependencies:
   sentry_logging:
   sentry_sqflite:
   sentry_file:
+  sentry_hive:
   universal_platform: ^1.0.0
   feedback: ^2.0.0
   provider: ^6.0.0
@@ -28,6 +29,7 @@ dependencies:
   #sqflite_common_ffi: ^2.0.0
   #sqflite_common_ffi_web: ^0.3.0
   http: ^1.0.0
+  hive: any  # This gets constrained by `sentry_hive`
 
 dev_dependencies:
   flutter_lints: ^2.0.0

flutter/example/pubspec_overrides.yaml

@@ -11,3 +11,5 @@ dependency_overrides:
     path: ../../sqflite
   sentry_file:
     path: ../../file
+  sentry_hive:
+    path: ../../hive

hive/.gitignore

@@ -0,0 +1,14 @@
+# Omit committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/

hive/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hive/README.md

@@ -0,0 +1,85 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+Sentry integration for `hive` package
+===========
+
+| package     | build                                                                                                                                                                           | pub                                                                                                  | likes                                                                                                | popularity                                                                                                     | pub points |
+|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| ------- |
+| sentry_hive | [![build](https://github.com/getsentry/sentry-dart/workflows/sentry-hive/badge.svg?branch=main)](https://github.com/getsentry/sentry-dart/actions?query=workflow%3Asentry-hive) | [![pub package](https://img.shields.io/pub/v/sentry_hive.svg)](https://pub.dev/packages/sentry_hive) | [![likes](https://img.shields.io/pub/likes/sentry_hive)](https://pub.dev/packages/sentry_hive/score) | [![popularity](https://img.shields.io/pub/popularity/sentry_hive)](https://pub.dev/packages/sentry_hive/score) | [![pub points](https://img.shields.io/pub/points/sentry_hive)](https://pub.dev/packages/sentry_hive/score)
+
+Integration for the [`hive`](https://pub.dev/packages/hive) package.
+
+#### Usage
+
+- Sign up for a Sentry.io account and get a DSN at https://sentry.io.
+
+- Follow the installing instructions on [pub.dev](https://pub.dev/packages/sentry/install).
+
+- Initialize the Sentry SDK using the DSN issued by Sentry.io.
+
+- Call...
+
+```dart
+import 'package:sentry/sentry.dart';
+import 'package:hive/hive.dart';
+import 'package:sentry_hive/sentry_hive.dart';
+import 'package:path_provider/path_provider.dart';
+
+Future<void> main() async {
+  await SentryFlutter.init(
+    (options) {
+      options.dsn = 'https://example@sentry.io/add-your-dsn-here';
+      options.tracesSampleRate = 1.0;
+    },
+    appRunner: () => runApp(YourApp()),
+  );
+}
+
+Future<void> insertUser() async {
+  // Use [SentryHive] where you would use [Hive]
+  final appDir = await getApplicationDocumentsDirectory();
+  SentryHive
+    ..init(appDir.path)
+    ..registerAdapter(PersonAdapter());
+
+  var box = await SentryHive.openBox('testBox');
+
+  var person = Person(
+    name: 'Dave',
+    age: 22,
+  );
+
+  await box.put('dave', person);
+
+  print(box.get('dave')); // Dave: 22
+}
+
+@HiveType(typeId: 1)
+class Person {
+  Person({required this.name, required this.age});
+
+  @HiveField(0)
+  String name;
+
+  @HiveField(1)
+  int age;
+
+  @override
+  String toString() {
+    return '$name: $age';
+  }
+}
+```
+
+#### Resources
+
+* [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dart/)
+* [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)
+* [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)
+* [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](https://stackoverflow.com/questions/tagged/sentry)
+* [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)