build: update bugsee manager and bugsee configuration in azure 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

@@ -54,13 +54,6 @@ steps:
   inputs:
     secureFile: ${{ parameters.androidKeyStorePropertiesFile }}
 
-# Flutter project signing process goes through 'key.properties' file which holds secure information about the keystore.
-- task: DownloadSecureFile@1
-  name: bugseeFile
-  displayName: "Download Bug See Tokens from Secure Files"
-  inputs:
-    secureFile: ${{ parameters.bugSeeFile }}
-
 # The file copied inside the source directory must be aligned with the name chosen in '/src/app/lib/android/app/build.gradle' where 'key.properties' is loaded.
 - task: PowerShell@2
   displayName: Copy Signing Configuration Files
@@ -73,9 +66,6 @@ steps:
       Copy-Item -Path '$(keyStore.secureFilePath)' -Destination '${{ parameters.pathToSrc }}\app\android\app\${{ parameters.androidKeystoreFile }}'
       Write-Host 'Key store copied to ${{ parameters.pathToSrc }}/app/android/app/${{ parameters.androidKeystoreFile }}.'
 
-      Copy-Item -Path '$(bugSeeFile.secureFilePath)' -Destination '${{ parameters.pathToSrc }}\app'
-      Write-Host 'Key store copied to ${{ parameters.pathToSrc }}/app.'
-
 - template: templates/flutter-prepare.yml
   parameters:
     projectDirectory: '${{ parameters.pathToSrc }}/app'
@@ -100,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

@@ -60,22 +60,6 @@ steps:
   inputs:
     secureFile: '${{ parameters.iosExportOptionsFile }}'
 
-# Flutter project signing process goes through 'key.properties' file which holds secure information about the keystore.
-- task: DownloadSecureFile@1
-  name: bugseeFile
-  displayName: "Download Bug See Tokens from Secure Files"
-  inputs:
-    secureFile: ${{ parameters.bugSeeFile }}
-
-# The file copied inside the source directory must be aligned with the name chosen in '/src/app/lib/android/app/build.gradle' where 'key.properties' is loaded.
-- task: PowerShell@2
-  displayName: Copy Bugsee Configuration File
-  inputs:
-    targetType: 'inline'
-    script: |
-      Copy-Item -Path '$(bugSeeFile.secureFilePath)' -Destination '${{ parameters.pathToSrc }}\app'
-      Write-Host 'Key store copied to ${{ parameters.pathToSrc }}/app.'
-
 - template: templates/flutter-prepare.yml
   parameters:
     projectDirectory: '${{ parameters.pathToSrc }}/app'
@@ -112,6 +96,7 @@ steps:
     verboseMode: true
     exportOptionsPlist: '$(exportOptions.secureFilePath)'
     dartDefine: ENV=$(applicationEnvironment)
+    dartDefine: BUGSEE_TOKEN=$(iOSDevToken)
 
 - template: templates/flutter-diagnostics.yml
   parameters:

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

@@ -2,59 +2,90 @@ import 'dart:io';
 
 import 'package:bugsee_flutter/bugsee_flutter.dart';
 import 'package:flutter/foundation.dart';
-import 'package:flutter_dotenv/flutter_dotenv.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;
 
-  Future<void> initialize({required VoidCallback runApp});
+  ///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;
-  String? bugseeAccessToken;
 
-  _BugseeManager({required this.logger});
+  late bool _isBugSeeInitialized;
+
+  _BugseeManager({
+    required this.logger,
+  });
 
   @override
   Future<void> initialize({
-    required VoidCallback runApp,
+    String? bugseeToken,
   }) async {
-    await initializeTokensAndOptions();
+    initializeLaunchOptions();
+    _isBugSeeInitialized = false;
     if (kDebugMode) {
-      runApp();
+      logger.i("BUGSEE: deactivated in debug mode");
       return;
     }
 
-    if (bugseeAccessToken == null) {
-      logger.i("bugsee token is null, bugsee won't be initialized");
+    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;
-    Bugsee.launch(
-      bugseeAccessToken ?? '',
+    await Bugsee.launch(
+      bugseeToken,
       appRunCallback: (isBugseeLaunched) {
         if (!isBugseeLaunched) {
-          logger.e("bugsee is not initialized, verify bugsee token config");
+          logger
+              .e("BUGSEE: not initialized, verify bugsee token configuration");
         }
-        runApp();
+        _isBugSeeInitialized = isBugseeLaunched;
       },
       launchOptions: launchOptions,
     );
   }
 
-  Future initializeTokensAndOptions() async {
+  Future initializeLaunchOptions() async {
     if (Platform.isAndroid) {
       launchOptions = AndroidLaunchOptions();
-      bugseeAccessToken = dotenv.env['BUGSEE_ANDROID_TOKEN'];
     } else if (Platform.isIOS) {
       launchOptions = IOSLaunchOptions();
-      bugseeAccessToken = dotenv.env['BUGSEE_IOS_TOKEN'];
+    }
+  }
+
+  @override
+  Future<void> logException({
+    required Exception exception,
+    StackTrace? stackTrace,
+  }) async {
+    if (_isBugSeeInitialized) {
+      await Bugsee.logException(exception, stackTrace);
     }
   }
 }

src/app/lib/business/environment/environment_manager.dart

@@ -33,12 +33,6 @@ final class _EnvironmentManager implements EnvironmentManager {
     Environment.production: '.env.prod',
   };
 
-  final Map<Environment, String> _bugseeFileName = {
-    Environment.development: '.bugsee.dev',
-    Environment.staging: '.bugsee.dev',
-    Environment.production: '.bugsee.dev',
-  };
-
   @override
   late List<Environment> environments;
 
@@ -63,16 +57,8 @@ final class _EnvironmentManager implements EnvironmentManager {
     );
     next = null;
 
-    await dotenv.load(
-      fileName: _bugseeFileName[current]!,
-    );
-    Map<String, String> bugSeeTokens = {
-      'BUGSEE_ANDROID_TOKEN': dotenv.env['BUGSEE_ANDROID_TOKEN']!,
-      'BUGSEE_IOS_TOKEN': dotenv.env['BUGSEE_IOS_TOKEN']!,
-    };
     await dotenv.load(
       fileName: _environmentFileNames[current]!,
-      mergeWith: bugSeeTokens,
     );
   }
 

src/app/lib/main.dart

@@ -36,12 +36,7 @@ late Logger _logger;
 
 Future<void> main() async {
   await initializeComponents();
-
-  GetIt.I.get<BugseeManager>().initialize(
-    runApp: () {
-      runApp(const App());
-    },
-  );
+  runApp(const App());
 }
 
 Future initializeComponents({bool? isMocked}) async {
@@ -129,6 +124,9 @@ Future _registerBugseeManager() async {
       logger: GetIt.I.get<Logger>(),
     ),
   );
+  GetIt.I.get<BugseeManager>().initialize(
+        bugseeToken: const String.fromEnvironment('BUGSEE_TOKEN'),
+      );
 }
 
 /// Registers the HTTP client.

src/app/pubspec.yaml

@@ -58,4 +58,3 @@ flutter:
     - .env.dev
     - .env.staging
     - .env.prod
-    - .bugsee.dev

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