feat: add sentry sdk

PrivacyPolicy.md

@@ -18,3 +18,9 @@ Especially, your password only stored in memory and is never written to disk.
 Your data is only transferred to the server specified by you. We do not collect any data from you by default.   
 
 Note that the server provider may share your data with third parties. Please refer to the privacy policy of the server provider.
+
+## Sentry SDK
+
+We use Sentry SDK to collect crash reports and usage statistics. Sentry SDK is disabled by default. Please refer to the [Sentry Privacy Policy](https://sentry.io/privacy/) for more information.
+
+Please note that for `dev` and `alpha` builds (versions that contain these words in the version number), Sentry SDK is force enabled. These builds are primarily used by our developers and testers for debugging and feature testing. If you are using these builds, please be aware that crash reports and usage statistics will be collected automatically.

lib/consts.dart

@@ -108,6 +108,7 @@ class DotEnvValue {
   static String host = dotenv.env['HOST'] ?? '';
   static String port = dotenv.env['PORT'] ?? '';
   static String tls = dotenv.env['TLS'] ?? '';
+  static String enableSentry = dotenv.env['ENABLE_SENTRY'] ?? '';
 }
 
 const wellKnownAccountPlatforms = ['steam'];

lib/init.dart

@@ -1,16 +1,33 @@
 part of 'main.dart';
 
 Future<MyApp> init() async {
-  // dotenv
-  await dotenv.load(fileName: '.env');
-
-  // dao
+  WidgetsFlutterBinding.ensureInitialized();
+  final packageInfo = await PackageInfo.fromPlatform();
 
   // https://github.com/hivedb/hive/issues/1044
-  final path = PlatformHelper.isWeb()
+  final dataPath = PlatformHelper.isWeb()
       ? null
       : (await getApplicationSupportDirectory()).path;
-  await Hive.initFlutter(path);
+
+  // dotenv
+  var enableSentry = false;
+  if (File(path.join(dataPath ?? '', '.enable_sentry')).existsSync()) {
+    enableSentry = true;
+  }
+  if (packageInfo.version.contains('dev') ||
+      packageInfo.version.contains('alpha')) {
+    enableSentry = true;
+  }
+  if (enableSentry) {
+    await dotenv.load(mergeWith: {
+      'ENABLE_SENTRY': enableSentry.toString(),
+    });
+  } else {
+    await dotenv.load();
+  }
+
+  // dao
+  await Hive.initFlutter(dataPath);
 
   // repo
   final common = await ClientCommonRepo.init();
@@ -21,8 +38,6 @@ Future<MyApp> init() async {
   // system tray
   await _initSystemTray();
 
-  WidgetsFlutterBinding.ensureInitialized();
-
   // deep link
   if (PlatformHelper.isWindowsApp()) {
     registerProtocol('tuihub');
@@ -38,12 +53,11 @@ Future<MyApp> init() async {
   if (kDebugMode) {
     Bloc.observer = SimpleBlocObserver();
   }
-  final packageInfo = await PackageInfo.fromPlatform();
   final deviceInfo = await _genClientDeviceInfo();
   final clientSettingBloc = ClientSettingBloc(common);
   final deepLinkBloc = DeepLinkBloc(initialUri);
   final mainBloc = MainBloc(api, common, clientSettingBloc, deepLinkBloc,
-      packageInfo, deviceInfo, path);
+      packageInfo, deviceInfo, dataPath);
 
   // router
   final router = getRouter(mainBloc, api);

lib/main.dart

@@ -14,10 +14,13 @@ import 'package:flutter_localizations/flutter_localizations.dart';
 import 'package:go_router/go_router.dart';
 import 'package:hive_flutter/hive_flutter.dart';
 import 'package:package_info_plus/package_info_plus.dart';
+import 'package:path/path.dart' as path;
 import 'package:path_provider/path_provider.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
 import 'package:system_tray/system_tray.dart';
 import 'package:uni_links/uni_links.dart';
 import 'package:uni_links_desktop/uni_links_desktop.dart';
+import 'package:universal_io/io.dart';
 
 import 'bloc/chesed/chesed_bloc.dart';
 import 'bloc/client_setting/client_setting_bloc.dart';
@@ -29,6 +32,7 @@ import 'bloc/tiphereth/tiphereth_bloc.dart';
 import 'bloc/yesod/yesod_bloc.dart';
 import 'common/bloc_observer.dart';
 import 'common/platform.dart';
+import 'consts.dart';
 import 'l10n/l10n.dart';
 import 'model/common_model.dart';
 import 'repo/grpc/api_helper.dart';
@@ -45,7 +49,21 @@ void main(List<String> args) async {
 
   final app = await init();
 
-  runApp(app);
+  if (DotEnvValue.enableSentry.isNotEmpty &&
+      DotEnvValue.enableSentry == true.toString()) {
+    await SentryFlutter.init(
+      (options) {
+        options.dsn =
+            'https://[email protected]/5885';
+        // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring.
+        // We recommend adjusting this value in production.
+        options.tracesSampleRate = 1.0;
+      },
+      appRunner: () => runApp(app),
+    );
+  } else {
+    runApp(app);
+  }
 
   if (PlatformHelper.isWindowsApp()) {
     doWhenWindowReady(() {

pubspec.yaml

@@ -16,7 +16,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev
 # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
 # In Windows, build-name is used as the major, minor, and patch parts
 # of the product and file versions while build-number is used as the build suffix.
-version: 9.9.9+1 # Used in debug mode, the real version is generated by git tag
+version: 9.9.9-debug+1 # Used in debug mode, the real version is generated by git tag
 
 environment:
   sdk: '>=3.0.0 <4.0.0'
@@ -32,6 +32,7 @@ dependencies:
     sdk: flutter
   flutter_localizations:
     sdk: flutter
+  sentry_flutter: ^7.16.1
 
   # state management
   bloc: ^8.1.3