Skip to content

docs: Add KSCrash migration strategy document - #8094

Merged
NinjaLikesCheez merged 8 commits into
mainfrom
kscrash-migration-strategy
Jun 30, 2026
Merged

docs: Add KSCrash migration strategy document#8094
NinjaLikesCheez merged 8 commits into
mainfrom
kscrash-migration-strategy

Conversation

@NinjaLikesCheez

@NinjaLikesCheez NinjaLikesCheez commented Jun 16, 2026

Copy link
Copy Markdown
Member

📜 Description

Adds a develop-doc with the two potential migration strategies for KSCrash along with a recommendation of which approach to take.

💡 Motivation and Context

Early alignment on the strategy will allow us to start landing code changes incrementally sooner rather than later

📝 Checklist

You have to check all boxes before merging:

  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.
  • If I added a new public API, I also added it to the SentryObjC wrapper.

#skip-changelog

Closes #8095

@NinjaLikesCheez NinjaLikesCheez added the ready-to-merge (deprecated) Use run-full-ci instead. label Jun 16, 2026
@NinjaLikesCheez
NinjaLikesCheez marked this pull request as ready for review June 16, 2026 13:57
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated

@philipphofmann philipphofmann left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for putting this together @NinjaLikesCheez.

Very important points that we need to address somewhere. Maybe they should be part of this document. If they're out of scope, please let me know:

  1. Version update strategy — do we always point to the latest kscrash, or pin to a version and bump deliberately?
  2. Should we have our own kscrash fork, or do we directly integrate kscrash? The benefit of our own fork would be that we won't be blocked by incidents and hotfixes. The key would be, obviously, that this fork, by default, should always be the same as KSCrash.

Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
@supervacuus

Copy link
Copy Markdown
Collaborator

The migration work will certainly teach us humility, but

  • Should we have our own kscrash fork, or do we directly integrate kscrash? The benefit of our own fork would be that we won't be blocked by incidents and hotfixes. The key would be, obviously, that this fork, by default, should always be the same as KSCrash.

We will start from a fork and try to upstream changes as much as possible, or create adapters on the sentry-cocoa side (even those might require upstream changes). Ideally, we can switch to the vanilla upstream at some point. But that is not a goal for the v10 release. It could also be the case that the fork will exist ad infinitum.

  • Version update strategy — do we always point to the latest kscrash, or pin to a version and bump deliberately?

This depends on the above. I expect the fork to exist for a while, meaning we bump regularly, but whenever it makes sense. Even when a fork is no longer necessary, I think it is reasonable to pin, given how core behavioral changes are to the SDK (and also regarding the rather liberal versioning upstream).

@philipphofmann

Copy link
Copy Markdown
Member

We will start from a fork and try to upstream changes as much as possible, or create adapters on the sentry-cocoa side (even those might require upstream changes). Ideally, we can switch to the vanilla upstream at some point. But that is not a goal for the v10 release. It could also be the case that the fork will exist ad infinitum.

I would really try to do vanilla as much as possible. If not, I see the risk that the fork deviates, and we put logic into the fork that should actually be in the Cocoa SDK. During the migration phase, which will be experimental, we don't need to worry about KSCrash's stability issues.

Comment thread develop-docs/KSCRASH-MIGRATION-STRATEGY.md Outdated
@NinjaLikesCheez

Copy link
Copy Markdown
Member Author

I have opened a first go at the implementation mentioned in this document here: #8154

I would like to (of course) reach an agreement here, summerize this document to a decision (mentioned here: #8094 (comment)), remove the document in favour of the decision, and only then merge in this & #8154

@NinjaLikesCheez
NinjaLikesCheez enabled auto-merge (squash) June 30, 2026 07:36
@NinjaLikesCheez
NinjaLikesCheez merged commit b32b02f into main Jun 30, 2026
179 checks passed
@NinjaLikesCheez
NinjaLikesCheez deleted the kscrash-migration-strategy branch June 30, 2026 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add KSCrash migration strategy document

5 participants