fix: crash when saving file - duplicate names [WPB-5026]

[AndroidBob]

WPB-5026 [Android] Crash when downloading a file

Cherry pick from the original PR:

• fix: crash when saving file - duplicate names [WPB-5026] #2396

---

⚠️ Conflicts during cherry-pick:
kalium

---

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

On some devices, the app is randomly crashing when downloading a file.
java.lang.IllegalStateException: Failed to build unique file: /storage/emulated/0/Download/image owner_package_name=com.waz.zclient.dev _display_name=image mime_type=application/octet-stream _data=/storage/emulated/0/Download/image _size=246181 is_download=1 relative_path=Download/

Causes (Optional)

In theory, ContentResolver handles duplicate names itself and we use it on Android 10 and up, but it uses buildUniqueFileWithExtension from FileUtils which looks like this:

while (file.exists()) {
            if (n++ >= 32) {
                throw new FileNotFoundException("Failed to create unique file");
            }
            file = buildFile(parent, name + " (" + n + ")", ext);
        }

so it works but up to 32 times, after that it returns this exact crash.

Solutions

Use our function findFirstUniqueName also for Android versions that use ContentResolver, to also determine unique filename ourselves.

This ContentResolver also changes the file names to remove disallowed characters (like colon or quotation mark) so it's then not possible to compare these names, so it's required to do the same (also to not allow for creating files with invalid names), that's why sanitizeFilename is also added.

Testing

Test Coverage (Optional)

• I have added automated test to this contribution

How to Test

Try to save the same file more than 32 times.

---

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]

Test Results

680 tests  +1   680 ✔️ +1   8m 32s ⏱️ +3s
  98 suites ±0       0 💤 ±0 
  98 files   ±0       0 ❌ ±0 

Results for commit ae53cb0. ± Comparison against base commit 23af8cd.

♻️ This comment has been updated with latest results.

[github-actions]

APKs built during tests are available here. Scroll down to Artifacts!

[github-actions]

APKs built during tests are available here. Scroll down to Artifacts!

[AndroidBob]

Build 1699 succeeded.

The build produced the following APK's:

• com.wire.android-v4.5.0(8048149)(8048149)-staging-compat.apk

[codecov]

Codecov Report

Merging #2402 (b0d84a5) into develop (23af8cd) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head b0d84a5 differs from pull request most recent head ae53cb0. Consider uploading reports for the commit ae53cb0 to get more accurate results

@@            Coverage Diff             @@
##             develop    #2402   +/-   ##
==========================================
  Coverage      41.46%   41.47%           
+ Complexity      1083     1081    -2     
==========================================
  Files            344      344           
  Lines          12408    12389   -19     
  Branches        1630     1629    -1     
==========================================
- Hits            5145     5138    -7     
+ Misses          6779     6767   -12     
  Partials         484      484           

Files	Coverage Δ
.../src/main/kotlin/com/wire/android/util/FileUtil.kt	0.00% <ø> (ø)

... and 4 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 23af8cd...ae53cb0. Read the comment docs.

[github-actions]

APKs built during tests are available here. Scroll down to Artifacts!

[AndroidBob]

Build 1722 succeeded.

The build produced the following APK's:

• com.wire.android-v4.5.0(8057068)(8057068)-staging-compat.apk