[CIS-2262] Allow changing attachment info with custom CDN

[nuno-vieira]

🔗 Issue Links

CIS-2262

🎯 Goal

Currently, our CDNClient protocol expects always to return a single URL. This is very limited since a customer might want to update the attachment info using their file uploader API, like changing the preview URL or adding extra data.

The goal of this PR is to improve this and allow the customer to change the final attachment when uploading to their CDN.

🛠 Implementation

• Introduces a new AttachmentUploader and renames the old one to AttachmentQueueUploader.
• channelController.uploadFile() and channelController.uploadImage() are now deprecated in favour of channelController.uploadAttachment()

The CDNClient can be customized if you are only interested in changing the CDN Url and do not want to update the attachment payload.

The AtttachmentUploader can be customized for more fine-grain control, in case you want to update the final attachment with additional information.

🧪 Manual Testing Notes

Probably worth doing smoke testing related to loading images.

☑️ Contributor Checklist

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

[Stream-iOS-Bot]

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

[emerge-tools]

📏 Size Analysis

Total install size 10.6 MB | This change: ⬆️ +18.3 kB (+0.172%)

🗂 See size breakdown

Item	Install size
➕ StreamChat.framework/StreamChat.AnyAttachmentUpdater.update(forPayload)	⬆️ 5.0 kB
➕ StreamChat.framework/StreamChat.UploadedAttachment.value witness	⬆️ 3.7 kB
➖ StreamChat.framework/StreamChat.ChatChannelController.uploadFile(localFileURL,progress,completion)	⬇️ 3.6 kB
➖ StreamChat.framework/StreamChat.AttachmentDTO.update(uploadedFileURL)	⬇️ 3.6 kB
➖ StreamChat.framework/StreamChat.ChatChannelController.uploadImage(localFileURL,progress,completion)	⬇️ 3.2 kB
➕ StreamChat.framework/StreamChat.AttachmentQueueUploader.updateAttachmentIfNeeded(attachmentId,uploadedAttachment,newState,completion)	⬆️ 3.2 kB
➕ StreamChat.framework/StreamChat.ChatChannelController.uploadAttachment(localFileURL,type,progress,completion)	⬆️ 2.9 kB
➕ StreamChat.framework/StreamChat.AttachmentQueueUploader.uploadNextAttachment	⬆️ 2.8 kB
➖ StreamChat.framework/StreamChat.AttachmentUploader.uploadNextAttachment	⬇️ 2.6 kB
➖ StreamChat.framework/StreamChat.AttachmentUploader.updateAttachmentIfNeeded(newState,attachmentUpdates,completion)	⬇️ 2.1 kB
➕ StreamChat.framework/StreamChat.UploadedFile.value witness	⬆️ 1.6 kB
➕ StreamChat.framework/StreamChat.AttachmentQueueUploader.startObserving	⬆️ 1.6 kB
➖ StreamChat.framework/StreamChat.AttachmentUploader.startObserving	⬇️ 1.6 kB
StreamChat.framework/DYLD.Exports	⬆️ 1.3 kB
➕ StreamChat.framework/StreamChat.APIClient.init(sessionConfiguration,requestEncoder,requestDecoder,attachmentUploader,tokenRefresher,queueOfflineRequest)	⬆️ 1.1 kB
➖ StreamChat.framework/StreamChat.APIClient.init(sessionConfiguration,requestEncoder,requestDecoder,CDNClient,tokenRefresher,queueOfflineRequest)	⬇️ 1.1 kB
StreamChat.framework/StreamChat.FileUploadPayload.value witness	⬆️ 1.1 kB
StreamChat.framework/StreamChat.ImageAttachmentPayload.value witness	740 B
➕ StreamChat.framework/StreamChat.StreamAttachmentUploader.upload(progress,completion)	660 B
StreamChat.framework/Code Signature	520 B

🔎 See the full size analysis (fb4e383) merging into develop (d6c94f3)

Provide a baseSha and pullRequestNumber with your upload to ensure diffs are correct. Read more in the docs

[martinmitrevski]

Looks good in general. I'm only worried about this line:
let previewUrl = try container.decodeIfPresent(URL.self, forKey: .thumbURL) ?? imageURL.
It seems we were previously decoding the thumbURL and setting the previewURL after all. Now this logic is gone, which might be a breaking change.

[nuno-vieira]

Looks good in general. I'm only worried about this line:

let previewUrl = try container.decodeIfPresent(URL.self, forKey: .thumbURL) ?? imageURL.

It seems we were previously decoding the thumbURL and setting the previewURL after all. Now this logic is gone, which might be a breaking change.

This does not exist, our API does not return any thumb_url for Images. Also, our ImageAttachmentPayload does not encode that value, so it would never be sent to the server even if has a customer you updated the previewUrl. So this is fine to remove

[martinmitrevski]

great work @nuno-vieira 👏

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
10 Code Smells

86.8% Coverage
0.0% Duplication