Update protocol by ueman · Pull Request #1038 · getsentry/sentry-dart

ueman · 2022-10-02T09:38:43Z

📜 Description

Update protocol. I've also cleaned up some more toJson methods.

💡 Motivation and Context

Fixes #1028

💚 How did you test it?

📝 Checklist

🔮 Next steps

codecov-commenter · 2022-10-02T09:40:16Z

Codecov Report

Base: 90.45% // Head: 91.37% // Increases project coverage by +0.91% 🎉

Coverage data is based on head (37dbdeb) compared to base (559d28f).
Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1038      +/-   ##
==========================================
+ Coverage   90.45%   91.37%   +0.91%     
==========================================
  Files         114        9     -105     
  Lines        3584      197    -3387     
==========================================
- Hits         3242      180    -3062     
+ Misses        342       17     -325

Impacted Files	Coverage Δ
...art/lib/src/http_client/failed_request_client.dart
dart/lib/src/protocol/breadcrumb.dart
dart/lib/src/protocol/debug_image.dart
dart/lib/src/protocol/debug_meta.dart
dart/lib/src/protocol/mechanism.dart
dart/lib/src/protocol/sdk_info.dart
dart/lib/src/protocol/sdk_version.dart
dart/lib/src/protocol/sentry_app.dart
dart/lib/src/protocol/sentry_browser.dart
dart/lib/src/protocol/sentry_exception.dart
... and 95 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

marandaneto · 2022-10-03T12:36:20Z

@@ -0,0 +1,29 @@
+/// Geographical location of the end user or device.
+class SentryGeo {


Documented here but not here.
I will check if this is inferred by the ip_address on the server side or if SDKs can actually set it as well.

This is inferred from ip_address in the server, but if its set, it keeps as it is, I'm checking if SDKs should be allowed to set their own geo data.

Relay schema

Let's keep it, I will update the develop docs.
We have to fix the Native bridges, to also sync the geo data.
Such as Android:

sentry-dart/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt

Lines 265 to 291 in e390ced

private fun setUser(user: Map<String, Any?>?, result: Result) {

if (user == null) {

Sentry.setUser(null)

result.success("")

return

}

val userInstance = User()

(user["email"] as? String)?.let { userInstance.email = it }

(user["id"] as? String)?.let { userInstance.id = it }

(user["username"] as? String)?.let { userInstance.username = it }

(user["ip_address"] as? String)?.let { userInstance.ipAddress = it }

(user["extras"] as? Map<String, Any?>)?.let { extras ->

val others = mutableMapOf<String, String>()

for ((key, value) in extras.entries) {

if (value != null) {

others[key] = value.toString()

}

}

userInstance.others = others

}

Sentry.setUser(userInstance)

result.success("")

}

iOS

sentry-dart/flutter/ios/Classes/SentryFlutterPluginApple.swift

Lines 503 to 528 in e390ced

private func setUser(user: [String: Any?]?, result: @escaping FlutterResult) {

if let user = user {

let userInstance = User()

if let email = user["email"] as? String {

userInstance.email = email

}

if let id = user["id"] as? String {

userInstance.userId = id

}

if let username = user["username"] as? String {

userInstance.username = username

}

if let ipAddress = user["ip_address"] as? String {

userInstance.ipAddress = ipAddress

}

if let extras = user["extras"] as? [String: Any] {

userInstance.data = extras

}

SentrySDK.setUser(userInstance)

} else {

SentrySDK.setUser(nil)

}

result("")

}

Will do, but why is it this cumbersome to set the user on the native layer?

Both, Cocoa and Java, don't have the Geo object yet. I've added the data sync though

getsentry/team-mobile#59 (comment)
Added a comment on the geo field on Dart that this is not going to be synced for now (scope sync).
I will see if I can get this done on both.

Or maybe we add it under data for now?

I went for the solution of documenting the missing sync

getsentry/develop#705

Co-authored-by: Manoel Aranda Neto <[email protected]>

marandaneto

left a comment.

ueman · 2022-10-12T07:28:38Z

There seems to be an issue with the NDK installation, do you know why that's happening, @marandaneto?

Checking the license for package NDK (Side by side) 21.4.7075529 in /usr/local/lib/android/sdk/licenses
License for package NDK (Side by side) 21.4.7075529 accepted.
Preparing "Install NDK (Side by side) 21.4.7075529 (revision: 21.4.7075529)".
Warning: An error occurred while preparing SDK package NDK (Side by side) 21.4.7075529: archive is not a ZIP archive.:
...
"Install NDK (Side by side) 21.4.[707](https://github.com/getsentry/sentry-dart/actions/runs/3228373240/jobs/5284386206#step:11:708)5529 (revision: 21.4.70[755](https://github.com/getsentry/sentry-dart/actions/runs/3228373240/jobs/5284386206#step:11:756)29)" failed.

marandaneto · 2022-10-12T08:11:09Z

There seems to be an issue with the NDK installation, do you know why that's happening, @marandaneto?

Checking the license for package NDK (Side by side) 21.4.7075529 in /usr/local/lib/android/sdk/licenses
License for package NDK (Side by side) 21.4.7075529 accepted.
Preparing "Install NDK (Side by side) 21.4.7075529 (revision: 21.4.7075529)".
Warning: An error occurred while preparing SDK package NDK (Side by side) 21.4.7075529: archive is not a ZIP archive.:
...
"Install NDK (Side by side) 21.4.[707](https://github.com/getsentry/sentry-dart/actions/runs/3228373240/jobs/5284386206#step:11:708)5529 (revision: 21.4.70[755](https://github.com/getsentry/sentry-dart/actions/runs/3228373240/jobs/5284386206#step:11:756)29)" failed.

I suspect

sentry-dart/flutter/example/android/app/build.gradle

Lines 67 to 69 in 56810ff

    
           // TODO: we need to fix CI as the version 21.1 (default) is not installed by default on 
        
           // GH Actions. 
        
           ndkVersion "21.4.7075529" // windows requires 21.4.7075529

Maybe GH action images changed, since this is the sample, feel free to either remove it or use a version that works, as long as CI is happy.

ueman · 2022-10-12T08:44:01Z

Ci is now happy 🎉

marandaneto · 2022-10-12T11:19:28Z


 ### Fixes

+- Bring protocol up to date with latest Sentry protocol ([#1038](https://github.com/getsentry/sentry-dart/pull/1038))


We have to move to unreleased section

Fixed it. You're doing way too many releases lately, I can barely keep up with it :D

marandaneto

Thanks a lot @ueman

ueman added 3 commits October 2, 2022 11:16

update protocol

4025afc

formatting

1cd84a8

add changelog

c4a77e5

ueman added 3 commits October 2, 2022 12:50

fix tests

5354e13

clean up toJson methods

05280c1

fix mistake

cd2119b

ueman commented Oct 2, 2022

View reviewed changes

Comment thread dart/lib/src/protocol/sentry_stack_trace.dart

Comment thread dart/lib/src/protocol/sentry_request.dart Outdated

ueman marked this pull request as ready for review October 2, 2022 15:46

ueman requested review from brustolin, krystofwoldrich and marandaneto as code owners October 2, 2022 15:46

Merge branch 'main' into fix-protocol

19305eb