Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move demangle filter to an optional module #540

Merged
merged 18 commits into from
Aug 26, 2024
Merged

Move demangle filter to an optional module #540

merged 18 commits into from
Aug 26, 2024

Conversation

bamx23
Copy link
Collaborator

@bamx23 bamx23 commented Aug 16, 2024

Demangling is not a requirement for crash reports that are later passed through the symbolicator (with dSYMs).
To reduce minimal library size and exclude parts of swift/llvm code base, this module becomes optional.

@bamx23 bamx23 changed the title Move demangle to an optional filter Move demangle filter to an optional module Aug 16, 2024
@bamx23 bamx23 requested a review from GLinnik21 August 16, 2024 22:53
@bamx23 bamx23 marked this pull request as ready for review August 16, 2024 22:53
Copy link
Collaborator

@GLinnik21 GLinnik21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Now we will be more in line with the principle of single responsibility!

Package.swift Show resolved Hide resolved
@GLinnik21
Copy link
Collaborator

GLinnik21 commented Aug 18, 2024

I'm also curious about how users will install KSCrash by default, as they might have expected that demangling worked by default. It seems like most of the users would still need it, so I'm wondering how we can make that as easy as possible for them.
Also, I think we should update README as well.

@bamx23
Copy link
Collaborator Author

bamx23 commented Aug 25, 2024

I'm also curious about how users will install KSCrash by default, as they might have expected that demangling worked by default. It seems like most of the users would still need it, so I'm wondering how we can make that as easy as possible for them. Also, I think we should update README as well.

It's a valid concern. I've added demangling to Installations API and made it enabled by-default. So those who were using installations can keep this functionality without extra efforts. And I've updated the README to highlight that this is now not a default behavior.

Also, we'll need a "migration guide" for 2.0 anyway as there are other breaking changes and we need to highlight the expected app code updates.

@bamx23 bamx23 requested a review from GLinnik21 August 25, 2024 20:08
@bamx23 bamx23 merged commit 9b9f2c2 into master Aug 26, 2024
26 checks passed
@bamx23 bamx23 deleted the demangling-module branch August 26, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants