Download and share attachments

[laevandus]

🔗 Issue Links

Resolves: PBE-4725

🎯 Goal

Show an action for downloading individual attachments and sharing them with the share sheet

📝 Summary

• Added public APIs (known attachment types can be downloaded)
  • Chat.downloadAttachment(_:) (async throws)
  • Chat.deleteLocalAttachmentDownload(for:) (async throws)
  • ConnectedUser.deleteAllLocalAttachmentDownloads()(async throws)
  • MessageController.downloadAttachment(_:completion:)
  • MessageController.deleteLocalAttachmentDownload(for:completion:)
  • CurrentUserController.deleteAllLocalAttachmentDownloads()
• Added download and share buttons to the file attachment view
  • Feature toggle: Components.default.isDownloadFileAttachmentsEnabled
• Documentation on the getstream.io
• Demo app
  • Configuration option for isDownloadFileAttachmentsEnabled
  • Debug command: "Delete Downloaded Attachments"

🛠 Implementation

Added a download icon to file attachments which triggers the local attachment download. Attachments are downloaded to "AttachmentDownloads" folder in user's documents directory. Relative path to the downloaded file is kept in the local DB. If the attachment has been downloaded, a share button appears which allows users to share the downloaded attachment.

🎨 Showcase

🧪 Manual Testing Notes

Note: Turn on configuration option: isDownloadFileAttachmentsEnabled

Case 1

1. Upload a file attachment (e.g. txt file)
   Result: download icon appears after uploading

Case 2

1. Open a channel with attachments
2. Tap on the download icon
3. Tap on the share icon
4. Save the file and also add it to notes.
   Result: Attachment file appears in the Notes app and Files app.

Case 3

1. Download some attachments
2. Debug command > "Delete Downloaded Attachments"
   Result: Attachment views update to show download icon instead of share icon and the file can be downloaded again.

Case 4

1. Download some attachments
2. Log out and log in with the same account
3. Open a channel where attachments were downloaded in step 1
   Result: Attachments show download icon because logout deletes local downloads

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• This change should be manually QAed
• Changelog is updated with client-facing changes
• Changelog is updated with new localization keys
• New code is covered by unit tests
• Comparison screenshots added for visual changes
• Affected documentation updated (docusaurus, tutorial, CMS)

🎁 Meme

Provide a funny gif or image that relates to your work on this pull request. (Optional)

[github-actions]

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	6.76 MB	6.82 MB	+55 KB	🟢
StreamChatUI	4.41 MB	4.42 MB	+2 KB	🟢

[martinmitrevski]

Looks good 👍 Added few comments.

[martinmitrevski]

The new methods look good 👍 Additionally, we need to update the changelog, show some examples in the docs and write some tests.

[nuno-vieira]

Its looking good overall but I believe there are still 2 points that we need to address:
1- Custom Attachments being downloadable
2- Making sure we don't break customers current UI

[nuno-vieira]

Almost there 👌 Just added a few more comments 👍

[nuno-vieira]

LGTM! ✅

[sonarqubecloud]

Quality Gate passed

Issues
157 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.8% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarCloud