chore: bulletproofing crypto box to cc migration (WPB-14250)

[yamilmedina]

WPB-14250 [Android] implement fall guards for CC migration

---

PR Submission Checklist for internal contributors

• The PR Title

  • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
  • contains a reference JIRA issue number like SQPIT-764
  • answers the question: If merged, this PR will: ... ³

• The PR Description

  • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

---

What's new in this PR?

Issues

When enabling core crypto storage, if there are any Proteus clients, we need to migrate them from CryptoBox.
Things usually don't go as planned, so we need to have a recovery plan in place.

Causes (Optional)

There might be some errors while migrating.

Solutions

Implement a recovery plan for this case:

• Catch possible exceptions from migration, we were not handling it and assuming success
• Perform logout, using a new LogoutReason, so we can act (cleanup) accordingly
  • Cleanup local crypto files
  • Cleanup from Metadata all related client info (retained id, current id, prekeys, etc.)
  • Set the refresh token to needs update.

If everything goes smoothly, the user will be prompted to login again, preserving their local history.

Dependencies (Optional)

• chore: bulletproofing crypto box to cc migration (WPB-14250) kalium#3123

Needs releases with:

• GitHub link to other pull request

Testing

Test Coverage (Optional)

• I have added automated test to this contribution

Notes (Optional)

Note

This approach seems "more correct", since if we try to create a new device only -as the ticket suggested- we will run into the issue of the refresh token not being valid anymore, since it was associated with the broken client that we were trying to migrate. And we can't associate the previous refresh token with a different client, we get a 403.

• We will avoid other edge cases that we might not sure.
• All login cases will be covered (2FA, SCIM, etc.)
• We can expand this handling in the future (if we want) to other cases that we want to recover.

---

PR Post Submission Checklist for internal contributors (Optional)

• Wire's Github Workflow has automatically linked the PR to a JIRA issue

---

PR Post Merge Checklist for internal contributors

• If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

---

References

1. https://sparkbox.com/foundry/semantic_commit_messages
2. https://github.com/wireapp/.github#usage
3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

[github-actions]

Built wire-android-staging-compat-pr-3658.apk is available for download

[MohamadJaara]

for dev this should be fine since it is not used as a daily driver by anyone

[github-actions]

Built wire-android-staging-compat-pr-3658.apk is available for download

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.33%. Comparing base (740c99f) to head (6905f1c).
Report is 2 commits behind head on release/candidate.

Additional details and impacted files

@@                  Coverage Diff                  @@
##           release/candidate    #3658      +/-   ##
=====================================================
- Coverage              45.34%   45.33%   -0.02%     
=====================================================
  Files                    471      471              
  Lines                  15842    15848       +6     
  Branches                2655     2656       +1     
=====================================================
  Hits                    7184     7184              
- Misses                  7885     7891       +6     
  Partials                 773      773              

Files with missing lines	Coverage Δ
...n/com/wire/android/feature/AccountSwitchUseCase.kt	60.21% <ø> (ø)
...otlin/com/wire/android/ui/WireActivityViewModel.kt	71.33% <ø> (ø)

... and 2 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 740c99f...6905f1c. Read the comment docs.

[github-actions]

Built wire-android-staging-compat-pr-3658.apk is available for download