config: integrate bugsee in flutter template and update build pipeline

.vscode/launch.json

@@ -28,7 +28,9 @@
       "program": "src/app/lib/main.dart",
       "toolArgs": [
         "--dart-define",
-        "ENV=Staging"
+        "ENV=Staging",
+        "--dart-define",
+        "BUGSEE_TOKEN=<token>"
       ]
     },
     {
@@ -39,7 +41,9 @@
       "program": "src/app/lib/main.dart",
       "toolArgs": [
         "--dart-define",
-        "ENV=Production"
+        "ENV=Production",
+        "--dart-define",
+        "BUGSEE_TOKEN=<token>"
       ]
     },
     {

build/azure-pipelines.yml

@@ -86,6 +86,7 @@ stages:
       firebaseJsonFile:  $(InternalFirebaseJson)
       firebaseOptionsDartFile:  $(InternalFirebaseOptionsDart)
       googleServicesJsonFile:  $(InternalGoogleServicesJson)
+      bugseeVariableGroup: 'FlutterApplicationTemplate.BugSee.Tokens'
 
 - stage: AppCenter_TestFlight_Staging
   condition: and(succeeded(), eq(variables['IsPullRequestBuild'], 'false'))

build/stage-build.yml

@@ -56,6 +56,9 @@
   type: string
 - name: googleServicesJsonFile
   type: string
+- name: bugseeVariableGroup
+  type: string
+  default: ''
 
 jobs:
   - job: OnWindows_ReleaseNotes

build/steps-build-android.yml

@@ -90,6 +90,7 @@ steps:
     projectDirectory: '${{ parameters.pathToSrc }}/app'
     verboseMode: true
     dartDefine: ENV=$(applicationEnvironment)
+    dartDefine: BUGSEE_TOKEN=$(AndroidDevToken)
 
 - template: templates/flutter-diagnostics.yml
   parameters:

build/steps-build-ios.yml

@@ -96,6 +96,7 @@ steps:
     verboseMode: true
     exportOptionsPlist: '$(exportOptions.secureFilePath)'
     dartDefine: ENV=$(applicationEnvironment)
+    dartDefine: BUGSEE_TOKEN=$(iOSDevToken)
 
 - template: templates/flutter-diagnostics.yml
   parameters:

src/app/.gitignore

@@ -34,3 +34,5 @@ app.*.map.json
 
 # Localization related
 lib/l10n/gen_l10n/*
+
+.bugsee.dev

src/app/android/settings.gradle

@@ -19,7 +19,7 @@ pluginManagement {
 
 plugins {
     id "dev.flutter.flutter-plugin-loader" version "1.0.0"
-    id "com.android.application" version "7.3.0" apply false
+    id "com.android.application" version '7.4.2' apply false
     // START: FlutterFire Configuration
     id "com.google.gms.google-services" version "4.3.15" apply false
     // END: FlutterFire Configuration

src/app/lib/business/bugsee/bugsee_manager.dart

@@ -0,0 +1,91 @@
+import 'dart:io';
+
+import 'package:bugsee_flutter/bugsee_flutter.dart';
+import 'package:flutter/foundation.dart';
+import 'package:logger/logger.dart';
+import 'package:logger/web.dart';
+
+const String bugseeTokenFormat =
+    r'^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$';
+
+///Service related to initializing Bugsee service
+abstract interface class BugseeManager {
+  factory BugseeManager({
+    required Logger logger,
+  }) = _BugseeManager;
+
+  ///initialize bugsee with given token
+  ///bugsee is not available in debug mode
+  ///* [bugseeToken]: nullable bugsee token, if null bugsee won't be initialized make sure you provide
+  ///[BUGSEE_TOKEN] in the env using `--dart-define` or `launch.json` on vscode
+  Future<void> initialize({
+    String? bugseeToken,
+  });
+
+  ///Manually log a provided exception with a stack trace
+  Future<void> logException({
+    required Exception exception,
+    StackTrace? stackTrace,
+  });
+}
+
+final class _BugseeManager implements BugseeManager {
+  final Logger logger;
+
+  late BugseeLaunchOptions launchOptions;
+
+  late bool _isBugSeeInitialized;
+
+  _BugseeManager({
+    required this.logger,
+  });
+
+  @override
+  Future<void> initialize({
+    String? bugseeToken,
+  }) async {
+    initializeLaunchOptions();
+    _isBugSeeInitialized = false;
+    if (kDebugMode) {
+      logger.i("BUGSEE: deactivated in debug mode");
+      return;
+    }
+
+    if (bugseeToken == null ||
+        !RegExp(bugseeTokenFormat).hasMatch(bugseeToken)) {
+      logger.i("BUGSEE: token is null or invalid, bugsee won't be initialized");
+      return;
+    }
+
+    HttpOverrides.global = Bugsee.defaultHttpOverrides;
+    await Bugsee.launch(
+      bugseeToken,
+      appRunCallback: (isBugseeLaunched) {
+        if (!isBugseeLaunched) {
+          logger
+              .e("BUGSEE: not initialized, verify bugsee token configuration");
+        }
+        _isBugSeeInitialized = isBugseeLaunched;
+      },
+      launchOptions: launchOptions,
+    );
+  }
+
+  Future initializeLaunchOptions() async {
+    if (Platform.isAndroid) {
+      launchOptions = AndroidLaunchOptions();
+    } else if (Platform.isIOS) {
+      launchOptions = IOSLaunchOptions();
+    }
+  }
+
+  @override
+  Future<void> logException({
+    required Exception exception,
+    StackTrace? stackTrace,
+  }) async {
+    if (_isBugSeeInitialized) {
+      await Bugsee.logException(exception, stackTrace);
+    }
+  }
+}

src/app/lib/main.dart

@@ -17,6 +17,7 @@ import 'package:app/access/logger/logger_repository.dart';
 import 'package:app/access/mocking/mocking_repository.dart';
 import 'package:app/app.dart';
 import 'package:app/app_router.dart';
+import 'package:app/business/bugsee/bugsee_manager.dart';
 import 'package:app/business/dad_jokes/dad_jokes_service.dart';
 import 'package:app/business/diagnostics/diagnostics_service.dart';
 import 'package:app/business/environment/environment.dart';
@@ -35,14 +36,14 @@ late Logger _logger;
 
 Future<void> main() async {
   await initializeComponents();
-
   runApp(const App());
 }
 
 Future initializeComponents({bool? isMocked}) async {
   WidgetsFlutterBinding.ensureInitialized();
   await _registerAndLoadEnvironment();
   await _registerAndLoadLoggers();
+  await _registerBugseeManager();
 
   _logger.d("Initialized environment and logger.");
 
@@ -117,6 +118,17 @@ Future _registerAndLoadLoggers() async {
   GetIt.I.registerSingleton(_logger);
 }
 
+Future _registerBugseeManager() async {
+  GetIt.I.registerSingleton<BugseeManager>(
+    BugseeManager(
+      logger: GetIt.I.get<Logger>(),
+    ),
+  );
+  GetIt.I.get<BugseeManager>().initialize(
+        bugseeToken: const String.fromEnvironment('BUGSEE_TOKEN'),
+      );
+}
+
 /// Registers the HTTP client.
 void _registerHttpClient() {
   final dio = Dio();

src/app/pubspec.lock

@@ -57,6 +57,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.1"
+  bugsee_flutter:
+    dependency: "direct main"
+    description:
+      name: bugsee_flutter
+      sha256: "570e37a678178d772a7fa2fc52cfe9e5bd3beadc225e89091d688a1d3c97e691"
+      url: "https://pub.dev"
+    source: hosted
+    version: "8.4.0"
   build:
     dependency: transitive
     description:

src/app/pubspec.yaml

@@ -31,6 +31,7 @@ dependencies:
   flutter_localizations:
     sdk: flutter
   intl: any
+  bugsee_flutter: ^8.4.0
 
 # This is required with alice installed unless this PR is merged https://github.com/jhomlala/alice/pull/171
 dependency_overrides:

src/cli/CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
 Prefix your items with `(Template)` if the change is about the template and not the resulting application.
 
+## 0.21.0
+- Add bugsee sdk in Fluttter template
+- Update build stage in `steps-build-android.yml` and `steps-build-ios` providing bugsee token
+
 ## 0.20.4
 - Updates to documentation