More open Event model #2060

YYChen01988 · 2024-07-18T11:28:47Z

Goal

Open up more Event model APIs, that users can add new Errors, Threads, and leave breadcrumbs at an Event level.

Changeset

The Event class includes new methods to:

add a new Thread object to the Event
add a new Error object to the Event
leave additional Event level breadcrumbs

The Error and Thread classes include new methods to add Stackframes.

Testing

New unit tests added.

bugsnagbot · 2024-07-18T11:51:31Z

Android notifier sizes

Format	Size impact of Bugsnag (kB)	Size impact of Bugsnag when Minified (kB)
APK	1852.98	1674.68
arm64_v8a	631.04	450.82
armeabi_v7a	565.51	385.29
x86	708.85	528.62
x86_64	676.09	495.86

Generated by 🚫 Danger

bugsnag-android-core/src/main/java/com/bugsnag/android/Error.java

bugsnag-android-core/src/main/java/com/bugsnag/android/ErrorInternal.kt

bugsnag-android-core/src/main/java/com/bugsnag/android/Event.java

bugsnag-android-core/src/main/java/com/bugsnag/android/EventInternal.kt

examples/sdk-app-example/app/src/main/java/com/example/bugsnag/android/BaseCrashyActivity.kt

… handle unlikely nulls, and not need to be marked @nullable

…ce it is unlikely to be used, and dramatically complicates the API

…esult in an empty `Error` instead of a spurious error based on the current stacktrace

…sage)`

…d APIs

bugsnag-android-core/src/main/java/com/bugsnag/android/EventInternal.kt

bugsnag-android-core/src/main/java/com/bugsnag/android/Stacktrace.kt

tomlongridge

I think calling them events throughout is better than the word report as that matches our docs. But don't feel strongly if you have a better reason.

tomlongridge · 2024-08-06T10:45:13Z

bugsnag-android-core/src/main/java/com/bugsnag/android/Event.java

@@ -75,6 +75,35 @@ public List<Error> getErrors() {
        return impl.getErrors();
    }

+    /**
+     * Add a new error to this report and return its Error data. The new Error will appear at the


Suggested change

* Add a new error to this report and return its Error data. The new Error will appear at the

* Add a new error to this event and return its Error data. The new Error will appear at the

tomlongridge · 2024-08-06T10:45:32Z

bugsnag-android-core/src/main/java/com/bugsnag/android/Event.java

+    }
+
+    /**
+     * Add a new empty {@link ErrorType#ANDROID android} error to this report and return its Error


Suggested change

* Add a new empty {@link ErrorType#ANDROID android} error to this report and return its Error

* Add a new empty {@link ErrorType#ANDROID android} event to this report and return its Error

tomlongridge · 2024-08-06T10:45:43Z

bugsnag-android-core/src/main/java/com/bugsnag/android/Event.java

+    }
+
+    /**
+     * Add a new empty error to this report and return its Error data. The new Error will appear


Suggested change

* Add a new empty error to this report and return its Error data. The new Error will appear

* Add a new empty error to this event and return its Error data. The new Error will appear

tomlongridge · 2024-08-06T10:47:08Z

bugsnag-android-core/src/main/java/com/bugsnag/android/Event.java

+     * and name. This can be used to augment the report with thread data that would not be picked
+     * up as part of a normal report being generated (for example: native threads managed


Suggested change

* and name. This can be used to augment the report with thread data that would not be picked

* up as part of a normal report being generated (for example: native threads managed

* and name. This can be used to augment the event with thread data that would not be picked

* up as part of a normal event being generated (for example: native threads managed

tomlongridge · 2024-08-06T10:47:30Z

bugsnag-android-core/src/main/java/com/bugsnag/android/Event.java

+     * and name. This can be used to augment the report with thread data that would not be picked
+     * up as part of a normal report being generated (for example: native threads managed


Suggested change

* and name. This can be used to augment the report with thread data that would not be picked

* up as part of a normal report being generated (for example: native threads managed

* and name. This can be used to augment the event with thread data that would not be picked

* up as part of a normal event being generated (for example: native threads managed

tomlongridge · 2024-08-06T10:48:34Z

CHANGELOG.md

@@ -6,6 +6,8 @@

 * Include additional Intent information for Activity.onCreate breadcrumbs (action, categories, type, flags, id, extra keys)
  [#2057](https://github.com/bugsnag/bugsnag-android/pull/2057)
+* New APIs allowing new `Error`s, `Thread`s, and `Stackframe`s to be added to error reports (`Event`s)


Suggested change

* New APIs allowing new `Error`s, `Thread`s, and `Stackframe`s to be added to error reports (`Event`s)

* New APIs allowing new `Error`s, `Thread`s, and `Stackframe`s to be added to `Event`s

yousif-bugsnag

LGTM

…ing report stacktraces

YYChen01988 requested a review from lemnik July 18, 2024 11:28

YYChen01988 force-pushed the PLAT-12376/add-items-in-Event-model-for-customers branch from dbbee19 to 3bf0021 Compare July 18, 2024 11:52

lemnik reviewed Jul 18, 2024

View reviewed changes

YYChen01988 force-pushed the PLAT-12376/add-items-in-Event-model-for-customers branch 2 times, most recently from 391a72c to 5586b35 Compare July 18, 2024 13:38

YYChen01988 requested a review from lemnik July 18, 2024 13:39

YYChen01988 force-pushed the PLAT-12376/add-items-in-Event-model-for-customers branch 2 times, most recently from 9677b14 to 334449d Compare July 18, 2024 13:58

lemnik changed the title ~~Plat 12376/add items in event model for customers~~ More open Event model Jul 22, 2024

lemnik requested a review from kstenerud August 5, 2024 11:44

YYChen01988 and others added 10 commits August 5, 2024 12:48

feat(Event): open event add error

4ab6036

feat(Event): open event add thread and breadCrumb

5318a3a

refactor(event): reworked Event.addError/leaveBreadcrumb/addThread to…

8a07637

… handle unlikely nulls, and not need to be marked @nullable

refactor(event): removed Error.addStackframe(StackTraceElement) sin…

ec529a8

…ce it is unlikely to be used, and dramatically complicates the API

refactor(thread): added Thread.addStackframe

1785484

refactor(event): further null-safety

ba232b2

refactor(event): passing null to Event.addError(Throwable) will r…

5117db0

…esult in an empty `Error` instead of a spurious error based on the current stacktrace

docs(event): better JavaDocs for `Event.addError(errorClass, errorMes…

ba1c5fc

…sage)`

test(facades): new unit tests for the addError/addStackframe/addThrea…

9f73257

…d APIs

chore(api): update api binary-compatibility check files

3b874f9

lemnik force-pushed the PLAT-12376/add-items-in-Event-model-for-customers branch from bd7f670 to 3b874f9 Compare August 5, 2024 11:49

lemnik requested review from tomlongridge and yousif-bugsnag August 5, 2024 11:50

kstenerud reviewed Aug 5, 2024

View reviewed changes

bugsnag-android-core/src/main/java/com/bugsnag/android/EventInternal.kt Show resolved Hide resolved

bugsnag-android-core/src/main/java/com/bugsnag/android/Stacktrace.kt Outdated Show resolved Hide resolved

lemnik requested a review from kstenerud August 5, 2024 13:54

kstenerud approved these changes Aug 6, 2024

View reviewed changes

tomlongridge approved these changes Aug 6, 2024

View reviewed changes

yousif-bugsnag approved these changes Aug 6, 2024

View reviewed changes

refactor(stacktrace): reduce the number of copies required when creat…

08526ea

…ing report stacktraces

lemnik force-pushed the PLAT-12376/add-items-in-Event-model-for-customers branch from bbe0c08 to 08526ea Compare August 6, 2024 14:14

lemnik merged commit 945c734 into next Aug 6, 2024
26 checks passed

lemnik deleted the PLAT-12376/add-items-in-Event-model-for-customers branch August 6, 2024 15:33

lemnik mentioned this pull request Aug 7, 2024

Release v6.7.0 #2067

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More open Event model #2060

More open Event model #2060

YYChen01988 commented Jul 18, 2024 •

edited by lemnik

Loading

bugsnagbot commented Jul 18, 2024 •

edited

Loading

tomlongridge left a comment

tomlongridge Aug 6, 2024

tomlongridge Aug 6, 2024

tomlongridge Aug 6, 2024

tomlongridge Aug 6, 2024

tomlongridge Aug 6, 2024

tomlongridge Aug 6, 2024

yousif-bugsnag left a comment

	* Add a new error to this report and return its Error data. The new Error will appear at the
	* Add a new error to this event and return its Error data. The new Error will appear at the

	* Add a new empty {@link ErrorType#ANDROID android} error to this report and return its Error
	* Add a new empty {@link ErrorType#ANDROID android} event to this report and return its Error

	* Add a new empty error to this report and return its Error data. The new Error will appear
	* Add a new empty error to this event and return its Error data. The new Error will appear

		* and name. This can be used to augment the report with thread data that would not be picked
		* up as part of a normal report being generated (for example: native threads managed

	* New APIs allowing new `Error`s, `Thread`s, and `Stackframe`s to be added to error reports (`Event`s)
	* New APIs allowing new `Error`s, `Thread`s, and `Stackframe`s to be added to `Event`s

More open Event model #2060

More open Event model #2060

Conversation

YYChen01988 commented Jul 18, 2024 • edited by lemnik Loading

Goal

Changeset

Testing

bugsnagbot commented Jul 18, 2024 • edited Loading

Android notifier sizes

tomlongridge left a comment

Choose a reason for hiding this comment

tomlongridge Aug 6, 2024

Choose a reason for hiding this comment

tomlongridge Aug 6, 2024

Choose a reason for hiding this comment

tomlongridge Aug 6, 2024

Choose a reason for hiding this comment

tomlongridge Aug 6, 2024

Choose a reason for hiding this comment

tomlongridge Aug 6, 2024

Choose a reason for hiding this comment

tomlongridge Aug 6, 2024

Choose a reason for hiding this comment

yousif-bugsnag left a comment

Choose a reason for hiding this comment

YYChen01988 commented Jul 18, 2024 •

edited by lemnik

Loading

bugsnagbot commented Jul 18, 2024 •

edited

Loading