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

[saleniuk]

---

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

599 tests   598 ✔️  7m 13s ⏱️
  85 suites      1 💤
  85 files        0 ❌

Results for commit 8b0e94c.

♻️ This comment has been updated with latest results.

[github-actions]

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

[AndroidBob]

Build 1675 succeeded.

The build produced the following APK's:

• com.wire.android-v4.4.2(8038714)(8038714)-staging-compat.apk

[github-actions]

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

[AndroidBob]

Build 1692 succeeded.

The build produced the following APK's:

• com.wire.android-v4.4.2(8047533)(8047533)-staging-compat.apk