From fafaf8d03659c49cea3f751ac5d71f57ed26ee8b Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 9 Feb 2021 23:25:28 +1100 Subject: [PATCH 1/3] Updated to embedding v2 Ref: https://github.com/flutter/flutter/wiki/Upgrading-pre-1.12-Android-projects Fixes for sentry reporting Ref: https://github.com/flutter/flutter/issues/48972 --- android/app/src/main/AndroidManifest.xml | 17 ++++- .../inventree/inventree_app/MainActivity.java | 9 +-- android/app/src/main/res/values/styles.xml | 4 + lib/main.dart | 74 +++++++++++++------ pubspec.lock | 9 ++- pubspec.yaml | 2 +- 6 files changed, 78 insertions(+), 37 deletions(-) diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml index d0832573..dc125db9 100644 --- a/android/app/src/main/AndroidManifest.xml +++ b/android/app/src/main/AndroidManifest.xml @@ -7,9 +7,11 @@ additional functionality it is fine to subclass or reimplement FlutterApplication and put your custom class here. --> + + + + + + - diff --git a/android/app/src/main/java/inventree/inventree_app/MainActivity.java b/android/app/src/main/java/inventree/inventree_app/MainActivity.java index 460b0e13..6d88807f 100644 --- a/android/app/src/main/java/inventree/inventree_app/MainActivity.java +++ b/android/app/src/main/java/inventree/inventree_app/MainActivity.java @@ -1,13 +1,6 @@ package inventree.inventree_app; -import android.os.Bundle; -import io.flutter.app.FlutterActivity; -import io.flutter.plugins.GeneratedPluginRegistrant; +import io.flutter.embedding.android.FlutterActivity; public class MainActivity extends FlutterActivity { - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - GeneratedPluginRegistrant.registerWith(this); - } } diff --git a/android/app/src/main/res/values/styles.xml b/android/app/src/main/res/values/styles.xml index 00fa4417..f09400a8 100644 --- a/android/app/src/main/res/values/styles.xml +++ b/android/app/src/main/res/values/styles.xml @@ -5,4 +5,8 @@ Flutter draws its first frame --> @drawable/launch_background + + diff --git a/lib/main.dart b/lib/main.dart index f0a14c94..5eaabe32 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -1,4 +1,5 @@ import 'dart:async'; +import 'dart:io'; import 'package:flutter_localizations/flutter_localizations.dart'; import 'package:flutter_gen/gen_l10n/app_localizations.dart'; @@ -9,13 +10,7 @@ import 'package:flutter/material.dart'; import 'dsn.dart'; -import 'package:sentry/sentry.dart'; - -// Use the secret app key -final SentryClient _sentry = SentryClient( - SentryOptions( - dsn: SENTRY_DSN_KEY, - )); +import 'package:sentry_flutter/sentry_flutter.dart'; bool isInDebugMode() { bool inDebugMode = false; @@ -26,33 +21,66 @@ bool isInDebugMode() { } Future _reportError(dynamic error, dynamic stackTrace) async { - // Print the exception to the console. + print('Caught error: $error'); + + // Errors thrown in development mode are unlikely to be interesting. You can + // check if you are running in dev mode using an assertion and omit sending + // the report. if (isInDebugMode()) { - // Print the full stacktrace in debug mode. print(stackTrace); + print('In dev mode. Not sending report to Sentry.io.'); return; - } else { - try { - await _sentry.captureException( - error, - stackTrace: stackTrace - ); - } catch (e) { - print("Sending error report to sentry.io failed: ${e}"); - print("Original error: ${error}"); - } } + + print('Reporting to Sentry.io...'); + + // Extract some platform information + if (Platform.isIOS) { + + } else if (Platform.isAndroid) { + + } + + Sentry.captureException(error, stackTrace: stackTrace).catchError((error) { + print("Error uploading information to Sentry.io:"); + print(error); + }).then((response) { + print("Uploaded information to Sentry.io : ${response.toString()}"); + }); } void main() async { + + await Sentry.init((options) { + options.dsn = SENTRY_DSN_KEY; + }, + //appRunner: () => runApp(InvenTreeApp()) + ); + + await runZonedGuarded>(() async { + WidgetsFlutterBinding.ensureInitialized(); - runZoned>(() async { - runApp(InvenTreeApp()); - }, onError: _reportError - ); + // This captures errors reported by the Flutter framework. + FlutterError.onError = (FlutterErrorDetails details) async { + if (isInDebugMode()) { + // In development mode simply print to console. + FlutterError.dumpErrorToConsole(details); + } else { + // In production mode report to the application zone to report to + // Sentry. + Zone.current.handleUncaughtError(details.exception, details.stack); + } + }; + + runApp(InvenTreeApp()); + + }, (Object error, StackTrace stackTrace) { + _reportError(error, stackTrace); + }); + } class InvenTreeApp extends StatelessWidget { diff --git a/pubspec.lock b/pubspec.lock index 8d39f12c..baeae699 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -421,12 +421,19 @@ packages: source: hosted version: "2.4.9" sentry: - dependency: "direct main" + dependency: transitive description: name: sentry url: "https://pub.dartlang.org" source: hosted version: "4.0.4" + sentry_flutter: + dependency: "direct main" + description: + name: sentry_flutter + url: "https://pub.dartlang.org" + source: hosted + version: "4.0.4" shared_preferences: dependency: "direct main" description: diff --git a/pubspec.yaml b/pubspec.yaml index 0902d4da..fea2174a 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -35,7 +35,7 @@ dependencies: device_info: ^1.0.0 # Information about the device font_awesome_flutter: ^8.8.1 # FontAwesome icon set flutter_speed_dial: ^1.2.5 # FAB menu elements - sentry: ^4.0.4 # Error reporting + sentry_flutter: ^4.0.4 # Error reporting flutter_typeahead: ^1.8.1 # Auto-complete input field image_picker: ^0.6.6 # Select or take photos url_launcher: ^5.7.10 # Open link in system browser From 0afac8348319dd31629a034e41deee9044a7dbb4 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 10 Feb 2021 00:06:25 +1100 Subject: [PATCH 2/3] Report extra context info to sentry --- lib/main.dart | 60 +++++++++++++++++++++++++++++++++++++++++ lib/settings/about.dart | 6 ++--- 2 files changed, 63 insertions(+), 3 deletions(-) diff --git a/lib/main.dart b/lib/main.dart index 5eaabe32..9d8ffb9e 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -4,10 +4,14 @@ import 'dart:io'; import 'package:flutter_localizations/flutter_localizations.dart'; import 'package:flutter_gen/gen_l10n/app_localizations.dart'; +import 'package:InvenTree/api.dart'; import 'package:InvenTree/widget/home.dart'; import 'package:flutter/cupertino.dart'; import 'package:flutter/material.dart'; +import 'package:device_info/device_info.dart'; +import 'package:package_info/package_info.dart'; + import 'dsn.dart'; import 'package:sentry_flutter/sentry_flutter.dart'; @@ -35,13 +39,69 @@ Future _reportError(dynamic error, dynamic stackTrace) async { print('Reporting to Sentry.io...'); + // Extract device information + final DeviceInfoPlugin deviceInfo = DeviceInfoPlugin(); + + Map device_info = {}; + // Extract some platform information if (Platform.isIOS) { + final iosDeviceInfo = await deviceInfo.iosInfo; + + device_info = { + 'name': iosDeviceInfo.name, + 'model': iosDeviceInfo.model, + 'systemName': iosDeviceInfo.systemName, + 'systemVersion': iosDeviceInfo.systemVersion, + 'localizedModel': iosDeviceInfo.localizedModel, + 'utsname': iosDeviceInfo.utsname.sysname, + 'identifierForVendor': iosDeviceInfo.identifierForVendor, + 'isPhysicalDevice': iosDeviceInfo.isPhysicalDevice, + }; } else if (Platform.isAndroid) { + final androidDeviceInfo = await deviceInfo.androidInfo; + device_info = { + 'type': androidDeviceInfo.type, + 'model': androidDeviceInfo.model, + 'device': androidDeviceInfo.device, + 'id': androidDeviceInfo.id, + 'androidId': androidDeviceInfo.androidId, + 'brand': androidDeviceInfo.brand, + 'display': androidDeviceInfo.display, + 'hardware': androidDeviceInfo.hardware, + 'manufacturer': androidDeviceInfo.manufacturer, + 'product': androidDeviceInfo.product, + 'version': androidDeviceInfo.version.release, + 'supported32BitAbis': androidDeviceInfo.supported32BitAbis, + 'supported64BitAbis': androidDeviceInfo.supported64BitAbis, + 'supportedAbis': androidDeviceInfo.supportedAbis, + 'isPhysicalDevice': androidDeviceInfo.isPhysicalDevice, + }; } + // Add app info + final package_info = await PackageInfo.fromPlatform(); + + Map app_version_info = { + "name": package_info.appName, + "build": package_info.buildNumber, + "version": package_info.version, + "package": package_info.packageName, + }; + + // Add server info (anonymized) + Map server_info = { + "version": InvenTreeAPI().version, + }; + + Sentry.configureScope((scope) { + scope.setExtra("server", server_info); + scope.setExtra("app", app_version_info); + scope.setExtra("device", device_info); + }); + Sentry.captureException(error, stackTrace: stackTrace).catchError((error) { print("Error uploading information to Sentry.io:"); print(error); diff --git a/lib/settings/about.dart b/lib/settings/about.dart index 8f93a118..62f0cd5f 100644 --- a/lib/settings/about.dart +++ b/lib/settings/about.dart @@ -30,21 +30,21 @@ class InvenTreeAboutWidget extends StatelessWidget { tiles.add( ListTile( title: Text(I18N.of(context).address), - subtitle: Text(InvenTreeAPI().baseUrl.isNotEmpty ? InvenTreeAPI().baseUrl : "Not connected"), + subtitle: Text(InvenTreeAPI().baseUrl.isNotEmpty ? InvenTreeAPI().baseUrl : I18N.of(context).notConnected), ) ); tiles.add( ListTile( title: Text(I18N.of(context).version), - subtitle: Text(InvenTreeAPI().version.isNotEmpty ? InvenTreeAPI().version : "Not connected"), + subtitle: Text(InvenTreeAPI().version.isNotEmpty ? InvenTreeAPI().version : I18N.of(context).notConnected), ) ); tiles.add( ListTile( title: Text(I18N.of(context).serverInstance), - subtitle: Text(InvenTreeAPI().instance.isNotEmpty ? InvenTreeAPI().instance : "Not connected"), + subtitle: Text(InvenTreeAPI().instance.isNotEmpty ? InvenTreeAPI().instance : I18N.of(context).notConnected), ) ); } else { From 9324737813deeef0883be8e125aa4a07226516a0 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 10 Feb 2021 00:14:40 +1100 Subject: [PATCH 3/3] Fix _connecting flag for API --- lib/api.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/api.dart b/lib/api.dart index 55e2b6b5..984458b9 100644 --- a/lib/api.dart +++ b/lib/api.dart @@ -143,7 +143,7 @@ class InvenTreeAPI { // Connection status flag - set once connection has been validated bool _connected = false; - bool _connecting = true; + bool _connecting = false; bool isConnected() { return profile != null && _connected && baseUrl.isNotEmpty && _token.isNotEmpty;