Integrate advanced Bugsee features #49

koukibadr · 2024-11-21T15:16:22Z

GitHub Issue: #

Proposed Changes

Description

Implement top-level Bugsee exception handler for dart and flutter (layout) exceptions
Implement data obscuration in reported videos
Add data obscuration flag saved in shared prefs (updated from the diagnostic overlay)
Custom logs with filters and enable/disable flag in shared prefs.
Enable custom events logged with reported exception
Attach custom traces with reported exceptions
Attach log file with the reported exceptions
Update diagnostic layout to test all Bugsee features (data obscuration, filter, events, traces, attributes...)

Impact on version

Major
- The template structure was changed.
Minor
- New functionalities were added.
Patch
- A bug in behavior was fixed.
- Documentation was changed.

PR Checklist

Always applicable

No matter your changes, these checks always apply.

Your conventional commits are aligned with the Impact on version section.
Updated CHANGELOG.md.
- Use the latest Major.Minor.X header if you do a Patch change.
- Create a new Major.Minor.X header if you do a Minor or Major change.
- If you create a new header, it aligns with the Impact on version section and matches what is generated in the build pipeline.
Documentation files were updated according with the changes.
- Update README.md and src/cli/CLI.md if you made changes to templating.
- Update AzurePipelines.md and src/app/README.md if you made changes to pipelines.
- Update Diagnostics.md if you made changes to diagnostic tools.
- Update Architecture.md and its diagrams if you made architecture decisions or if you introduced new recipes.
- ...and so forth: Make sure you update the documentation files associated to the recipes you changed. Review the topics by looking at the content of the doc/ folder.
Images about the template are referenced from the wiki and added as images in this git.
TODO comments are hints for next steps for users of the template and not planned work.

Contextual

Based on your changes these checks may not apply.

Automated tests for the changes have been added/updated.
Tested on all relevant platforms

Other information

Internal Issue (If applicable):

src/app/.env.dev

jeanplevesque · 2024-11-25T20:34:43Z

src/app/integration_test/bugsee_test.dart

+Future<void> bugseeSetupTest() async {
+  testWidgets(
+    'Test Bugsee configuration',
+    (tester) async {},


I'm guessing this is incomplete?

Yes for this I've only prepared an integration test file for Bugsee we can later implement it
or I remove it for now ?

If it's not done, I would remove it. That way we don't have an incomplete test that could lead us to believe that Bugsee is tested even though it isn't.

src/app/.env.dev

src/app/lib/access/bugsee/bugsee_configuration_data.dart

src/app/lib/access/bugsee/bugsee_repository.dart

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

jeanplevesque · 2024-11-25T20:58:07Z

Make sure you also have a Bugsee.md file under the doc folder to explain how Bugsee is integrated.

doc/Bugsee.md

…thod

jeanplevesque · 2024-12-04T13:33:23Z

doc/Bugsee.md

+
+This document provides a comprehensive guide to integrating and using **Bugsee** in your mobile application. Bugsee is a powerful tool for monitoring and debugging your app by capturing and reporting unhandled exceptions, providing insights into app crashes, user interactions, and more.
+
+## **Overview**


Headers should not be bolded. Simply use the default header format.

jeanplevesque · 2024-12-04T13:35:18Z

src/app/.env.dev

@@ -4,5 +4,4 @@ MINIMUM_LEVEL='debug'
 DAD_JOKES_BASE_URL='https://www.reddit.com/r/dadjokes'
 APP_STORE_URL_IOS=https://apps.apple.com/us/app/uno-calculator/id1464736591
 APP_STORE_URL_Android=https://play.google.com/store/apps/details?id=uno.platform.calculator
-REMOTE_CONFIG_FETCH_INTERVAL_MINUTES=1
-DIAGNOSTIC_ENABLED=true


Should DIAGNOSTIC_ENABLED=true be removed? I also have the same comment for the prod file too.

jeanplevesque · 2024-12-04T13:37:00Z

src/app/integration_test/bugsee_test.dart

+Future<void> bugseeSetupTest() async {
+  testWidgets(
+    'Test Bugsee configuration',
+    (tester) async {},


If it's not done, I would remove it. That way we don't have an incomplete test that could lead us to believe that Bugsee is tested even though it isn't.

jeanplevesque · 2024-12-04T13:37:37Z

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

+}
+
+final class BugseeConfigState extends Equatable {
+  /// Indicate if the app require a restart to reactivate the bugsee configurations


Indicates

requires

Add a period at the end.

jeanplevesque · 2024-12-04T13:39:09Z

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

+  /// cannot be true if `isBugseeEnabled == false`.
+  final bool isVideoCaptureEnabled;
+
+  /// Indicate if bugsee configuration is valid


Make sure you separate the sentences with a period and start sentences with a capital letter.

jeanplevesque · 2024-12-04T13:47:14Z

src/app/lib/main.dart

+      await registerBugseeManager();
+      runApp(const App());
+    },
+    GetIt.I.get<BugseeManager>().inteceptExceptions,


For the global exception handling, I think we should send them into a more generic class that would then send them into Bugsee, but we could also dispatch to other locations, such as the application logs and potentially other monitoring SDK (such as Crashlytics). For the scope of this PR, let's just start with Bugsee and the existing logging system (that logs into the console and a log file depending on the configuration).

jeanplevesque · 2024-12-04T13:52:24Z

src/cli/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.22.0
+- Add bugsee global inteceptor for dart exceptions to template app


Again, sentences should end with a period. (I know some previous notes are missing, but if we look at the initial ones, they were correct.)

koukibadr added 6 commits November 18, 2024 16:02

feat: implement bugsee data obscure from reported videos

4d9287a

feat: customize logs, traces and events reported to Bugsee dashboard

621f58e

feat: implement custom attributes and attach file bugsee features

0f12bb3

feat: implement global bugsee exception handler

12f2d65

chore: add flutter framework rendering error interceptor handler

0f27491

docs: update project changelog

7f20a67

koukibadr requested review from jeanplevesque and Soap-141 and removed request for jeanplevesque November 21, 2024 15:16

koukibadr added 2 commits November 22, 2024 10:21

chore: update bugsee manager singleton registration in main file

ac885a0

chore: add mock attribute to bugsee manager initialization

f6a6938

koukibadr closed this Nov 22, 2024

koukibadr reopened this Nov 22, 2024

koukibadr marked this pull request as draft November 22, 2024 13:34

chore: add platform check when intializing Bugsee

9906020

jeanplevesque requested changes Nov 25, 2024

View reviewed changes

docs: add Bugsee implementation documentation

e7cb678

koukibadr marked this pull request as ready for review November 28, 2024 11:36

koukibadr requested a review from jeanplevesque November 29, 2024 09:23

jeanplevesque requested changes Nov 29, 2024

View reviewed changes

doc/Bugsee.md Outdated Show resolved Hide resolved

doc/Bugsee.md Outdated Show resolved Hide resolved

doc/Bugsee.md Outdated Show resolved Hide resolved

chore: update Bugsee integration documentation and event caputring me…

934f7f6

…thod

koukibadr force-pushed the config/bk/integrate-advanced-bugsee branch from 139444c to 934f7f6 Compare December 2, 2024 11:00

koukibadr requested a review from jeanplevesque December 2, 2024 11:27

jeanplevesque requested a review from a team December 2, 2024 20:42

jeanplevesque requested changes Dec 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate advanced Bugsee features #49

Integrate advanced Bugsee features #49

koukibadr commented Nov 21, 2024

jeanplevesque Nov 25, 2024

koukibadr Nov 26, 2024

jeanplevesque Dec 4, 2024

jeanplevesque commented Nov 25, 2024

jeanplevesque Dec 4, 2024

jeanplevesque Dec 4, 2024

jeanplevesque Dec 4, 2024

jeanplevesque Dec 4, 2024

jeanplevesque Dec 4, 2024

jeanplevesque Dec 4, 2024

jeanplevesque Dec 4, 2024


		This document provides a comprehensive guide to integrating and using Bugsee in your mobile application. Bugsee is a powerful tool for monitoring and debugging your app by capturing and reporting unhandled exceptions, providing insights into app crashes, user interactions, and more.

		## Overview

Integrate advanced Bugsee features #49

Are you sure you want to change the base?

Integrate advanced Bugsee features #49

Conversation

koukibadr commented Nov 21, 2024

Proposed Changes

Description

Impact on version

PR Checklist

Always applicable

Contextual

Other information

Internal Issue (If applicable):

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeanplevesque commented Nov 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment