Skip to content
This repository was archived by the owner on Jan 25, 2025. It is now read-only.

Crash logging#49

Merged
rohan-chaturvedi merged 9 commits intov1.4.2from
crash_logging
Feb 2, 2023
Merged

Crash logging#49
rohan-chaturvedi merged 9 commits intov1.4.2from
crash_logging

Conversation

@0x4f53
Copy link
Member

@0x4f53 0x4f53 commented Jan 18, 2023

♻️ Current situation

Crashes always happen ungracefully. Users often need to report them by replicating them, copying them and pasting them into ADB. This is lame.

💡 Proposed solution

Implement easier, dialog-based, crash log emailing. This works as such:

  1. You enjoy using Keyspace.
  2. The app crashes because developers are humans.
  3. The app gracefully exists and presents you with an alert dialog asking for your consent to email the logs to us.
  4. If you tap "Send email", your default mail client is opened (you are prompted to pick one if you don't have a default set, so make sure you have at least one mail client installed).
  5. If you tap "Cancel", nothing is sent to nobody.

📚 Release Notes

  • Added ACRA for crash logging
  • Set ACRA to email user logs to info@keyspace.cloud when the user agrees via the AlertDialog.

Library version bumps

  • androidx.appcompat:appcompat 1.5.1 -> 1.6.0
  • androidx.test.ext:junit 1.1.4 -> 1.1.5
  • androidx.test.espresso:espresso-core 3.5.0 -> 3.5.1

📝 Testing

  • Try manually throwing an exception in code at a random point, by calling a class that extends the Exception() class.

@0x4f53 0x4f53 added bug Something isn't working enhancement New feature or request labels Jan 18, 2023
@nimish-ks
Copy link
Member

@4f77616973 please add [Keyspace-adroid-crash report] as an email subject prefix

@0x4f53
Copy link
Member Author

0x4f53 commented Jan 19, 2023

@nimish-ks Done.

@rohan-chaturvedi rohan-chaturvedi self-requested a review January 29, 2023 15:17
Co-authored-by: Rohan Chaturvedi <rohan.chaturvedi@protonmail.com>
@rohan-chaturvedi rohan-chaturvedi self-requested a review February 2, 2023 06:25
@rohan-chaturvedi rohan-chaturvedi merged commit b358e3e into v1.4.2 Feb 2, 2023
@rohan-chaturvedi rohan-chaturvedi deleted the crash_logging branch February 2, 2023 06:26
@rohan-chaturvedi rohan-chaturvedi mentioned this pull request Feb 2, 2023
@IzzySoft
Copy link

IzzySoft commented Feb 6, 2023

Just to confirm: ACRA is just enabled for this kind of crash reporting – i.e. the user is in full control what is sent and no data leaves their system without their approval? And that's how it will stay? I just need to know as my updater just alerted me to set the Tracking flag on Keyspace as it detected the library. If you can confirm the above (and to a non-dev like me the code in this PR looks that way), I'd instead white-list ACRA for your app.

@rohan-chaturvedi
Copy link
Member

Just to confirm: ACRA is just enabled for this kind of crash reporting – i.e. the user is in full control what is sent and no data leaves their system without their approval? And that's how it will stay? I just need to know as my updater just alerted me to set the Tracking flag on Keyspace as it detected the library. If you can confirm the above (and to a non-dev like me the code in this PR looks that way), I'd instead white-list ACRA for your app.

@IzzySoft Yes that is correct. We only use ACRA when the app crashes. You will be prompted with a dialog to optionally send crash logs, and if you chose to do so, your phone's default email app will be used to create an email with the logs as an attachment.

@IzzySoft
Copy link

IzzySoft commented Feb 7, 2023

Great, thanks! Then I'll now white-list ACRA for your app instead of (unnecessarily) raising the Tracking flag. Wonderful!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bug Something isn't working enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants