Add Static Location and Live Location Support #3531

nuno-vieira · 2024-12-13T02:00:55Z

🔗 Issue Links

Resolves https://linear.app/stream/issue/IOS-578/location-attachment

🎯 Goal

Adds support for static and live location attachments in the Low-Level Client SDK.

The UI has been implemented in the Demo App to demonstrate how to use the new location APIs.
A guide should be written in the stream documentation on how to use the location APIs.

📝 Summary

New APIs:

ChatChannelController
- sendStaticLocation() - Sends a static location message to the channel.
- startLiveLocationSharing() - Starts a live location-sharing message in the channel.
- stopLiveLocationSharing() - Stops sharing the live location message in the channel.
ChatMessageController
- updateMessage() - Updates the message partially. (It was missing from the SDK)
- updateLiveLocation() - Updates the message's live location attachment if it has one.
- stopLiveLocationSharing() - Stops sharing the live location attachment if it has one.
CurrentChatUserController
- updateLiveLocation() - Updates the location of all active live location messages for the current user. Internally, it uses the Message Controller to update each message that has a live location attachment.
CurrentChatUserControllerDelegate
- didStartSharingLiveLocation() - Notifies whenever the current user is sharing a live location.
- didStopSharingLiveLocation() - Notifies whenever the current user stops sharing a live location.
- didChangeActiveLiveLocationMessages() - Notifies whenever the live location messages update.
Throttler
- The Throttler was part of the UI SDK somehow, so it was moved to the LLC and made public like the Debouncer.
ChatMessage
- staticLocationAttachments - Returns the attachments of .staticLocation type.
- liveLocationAttachments - Returns the attachments of .liveLocation type.
AttachmentType
- .staticLocation
- .liveLocation
ChatMessageLiveLocationAttachment & LiveLocationAttachmentPayload
ChatMessageStaticLocationAttachment & StaticLocationAttachmentPayload

Out of Scope

End Time: The backend does not support this out of the box yet, and there's no contract yet for this. But we should add this as soon as possible since all of the common apps have this feature.
Multi-Device: At the moment, there is no protection against the user sharing the location between multiple devices. The location will be shared from both devices since, at the moment, we don't have a way to attach the device ID or the device model to an attachment. Since this is an edge case, it can be left for future improvement.

🛠 Implementation

TODO

🎨 Showcase

Demo:

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-01-03.at.17.38.38.mp4

🧪 Manual Testing Notes

TODO

☑️ 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)

martinmitrevski

Couldn't test a lot, since a had constant crashes (shared details on Slack). Let's figure that out first, then I will do another round.

DemoApp/Screens/DemoAppTabBarController.swift

martinmitrevski · 2024-12-24T13:17:04Z

...treamChat/Components/CustomAttachments/LocationAttachment/LocationDetailViewController.swift

+        userName: String
+    ) {
+        if let existingAnnotation = userAnnotation {
+            UIView.animate(withDuration: 5) {


why do we need to do 5 second long animation?

This is mostly to have a smooth animation. It simulates the pin constantly being moved since the animation is always running. It looks quite good this way. But it is also possible to have an hard animation like WhatsApp, but for now this is quite smooth

martinmitrevski · 2024-12-24T13:18:23Z

DemoApp/StreamChat/StreamChatWrapper+DemoApp.swift

-        client?.registerAttachment(LocationAttachmentPayload.self)
+
+        // Custom Attachments
+        if AppConfig.shared.demoAppConfig.isLocationAttachmentsEnabled {


I think it should be always on, since it's the demo app. Our config screen becomes very complex at this point.

It was disabled by default before, but since we now support locations out of the box, I can enable it by default. That said, I prefer not to do so because it involves sensitive data. Customers could easily misuse it and potentially spam our server.

…location message to a channel

…urrent user location

…ler`

…ting a message

…dated

…when the user should start and stop location sharing

…rotect against abusive updates

github-actions · 2025-01-03T22:02:15Z

	1 Warning
⚠️	Big PR

	1 Message
📖	There seems to be app changes but CHANGELOG wasn't modified. Please include an entry if the PR includes user-facing changes. You can find it at CHANGELOG.md.

Generated by 🚫 Danger

Stream-SDK-Bot · 2025-01-03T22:05:46Z

SDK Size

`title`	`develop`	`branch`	`diff`	`status`
StreamChat	6.98 MB	7.07 MB	+93 KB	🟢
StreamChatUI	4.77 MB	4.77 MB	-1 KB	🚀

laevandus · 2025-01-06T09:07:50Z

Sources/StreamChat/Controllers/ChannelController/ChannelController.swift

+    /// In order to
+    ///
+    /// - Parameters:
+    ///  - location: The location information.
+    ///  - text: The text of the message.
+    ///  - extraData: Additional extra data of the message object.
+    ///  - completion: Called when saving the message to the local DB finishes,
+    ///  not when the message reaches the server.


Seems like a formatting issue

laevandus · 2025-01-06T09:09:10Z

Sources/StreamChat/Controllers/ChannelController/ChannelController.swift

+    public func sendStaticLocation(
+        _ location: LocationAttachmentInfo,
+        text: String? = nil,
+        messageId: MessageId? = nil,
+        quotedMessageId: MessageId? = nil,
+        extraData: [String: RawJSON] = [:],
+        completion: ((Result<MessageId, Error>) -> Void)? = nil
+    ) {


Planning to add similar functions to Chat?

Should we move most of the logic in these action methods to separate handler/sender for making them reusable for Chat?
TypingEventsSender, ReadStateHandler?

laevandus · 2025-01-06T09:11:25Z

Sources/StreamChat/Controllers/MessageController/MessageController.swift

+    ///   - attachments: The attachments to be updated.
+    ///   - extraData: The additional data to be updated.
+    ///   - completion: Called when the server updates the message.
+    public func updateMessage(


partialUpdateMessage/partialMessageUpdate for matching to the common naming pattern?

The reason I did not put this name is because editMesasge is kinda already a partial update as well. All the existing data will remain the same. At least the end result will be the same, even though internally we provide the non-changed data to the server.

The only real diff between the editMessage, and updateMessage, is that one is scheduled, and the other one is not 🤔

laevandus · 2025-01-06T09:13:40Z

Sources/StreamChat/Controllers/ChannelController/ChannelController.swift

+    final class ActiveLiveLocationAlreadyExists: ClientError {
+        let messageId: MessageId
+
+        public init(messageId: MessageId) {


laevandus · 2025-01-06T09:13:59Z

Sources/StreamChat/Controllers/ChannelController/ChannelController.swift

@@ -1766,7 +1955,7 @@ private extension ChatChannelController {

 // MARK: - Errors

-extension ClientError {
+public extension ClientError {


Keeping it internal?

nuno-vieira added 🌐 SDK: StreamChat (LLC) Tasks related to the StreamChat LLC SDK ✅ Feature An issue or PR related to a feature labels Dec 18, 2024

martinmitrevski reviewed Dec 24, 2024

View reviewed changes

nuno-vieira marked this pull request as ready for review January 3, 2025 17:40

nuno-vieira requested a review from a team as a code owner January 3, 2025 17:40

nuno-vieira changed the title ~~[WIP] Add Static Location and Live Location Support~~ Add Static Location and Live Location Support Jan 3, 2025

nuno-vieira added 24 commits January 3, 2025 21:47

Add static and live location payloads

e92b976

Update the demo app to use static location attachment

2783c87

Add new ChannelController.sendStaticLocation() to instantly send a …

8c6cee0

…location message to a channel

Change the Demo App to send the current location instead of dummy ones

d6c93f7

Add location background mode to Demo App

9655c90

Add staticLocation to the attachments register

a5b32b0

Create a CurrentUserLocationProvider to make it easier to fetch the c…

3bc1297

…urrent user location

Fix not being able to part live location payload

f3e5045

Update DemoApp to support live location attachments

13d5819

Add support for partial message update in MessageUpdater

f641c9f

Expose the Throttler (Revert this, and use it internally)

0911527

Add shareLiveLocation() and stopLiveLocation() to `ChannelControl…

8b51741

…ler`

Refactor logic to fetch current active locations + Improve API

6181eeb

Add extra data to location attachment payloads

e162979

Add LocationAttachmentInfo to be used as argument

8341995

Add text to partial message update endpoint

7b99d83

Add ChatMessageController.updateMessage() to support partially upda…

f8f8746

…ting a message

Change location live updates APIs

4aaaa1e

Improve Demo App Location Provider

36d9827

Improve API by observing active live locations messages

4804d55

Fixed starting monitoring location whenever an active location was up…

73e4746

…dated

Make the API even easier and add additional delegate methods to know …

5621419

…when the user should start and stop location sharing

Move the Throttler to LLC, just like the Debouncer

2d656ec

Move the Throttling to the current user controller to automatically p…

8272607

…rotect against abusive updates

nuno-vieira added 9 commits January 3, 2025 21:52

Add bottom sheet to stop location sharing

748fa4c

Add stopLiveLocationSharing() to Message Controller

587aac6

Fix stop sharing button not working

55ce2b9

FIx bottom sheet logic

9a24f6c

Add static pin in detail view

4b0fdd1

Fix sharing location for other users active location messages

3878960

Finish logic for location snapshot view when static vs live

3741aa3

Add live location status view in the snapshot view

6f197d4

Minor cleanup

70218c2

nuno-vieira force-pushed the add/location-attachments branch from 5e5a9ab to 70218c2 Compare January 3, 2025 22:01

Fix copyright

fe3d7d9

nuno-vieira added 2 commits January 3, 2025 23:01

Fix loading indicator snapshot view

f3bcf20

Remove support of mixed attachments to locations

f47491f

laevandus reviewed Jan 6, 2025

View reviewed changes

nuno-vieira added 10 commits January 6, 2025 16:13

Add MessageEndpoints test coverage

1940134

Add test coverage to message updater

59c2448

Add test coverage to Message Repository

d352f2e

Add test coverage to message attachments extensions

2910b3f

Add test coverage to parsing attachments

b9aca84

Add test coverage to MessageDTO

35346d3

Add message updater mock

c6b223c

ActiveLiveLocationAlreadyExists init should not be public

4fc7b6d

Add test coverage to Message Controller

e3be6ee

Add test coverage to Channel Controller

223c7b1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Static Location and Live Location Support #3531

Add Static Location and Live Location Support #3531

nuno-vieira commented Dec 13, 2024 •

edited

Loading

martinmitrevski left a comment

martinmitrevski Dec 24, 2024

nuno-vieira Jan 3, 2025

martinmitrevski Dec 24, 2024

nuno-vieira Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025

Stream-SDK-Bot commented Jan 3, 2025 •

edited

Loading

laevandus Jan 6, 2025

laevandus Jan 6, 2025

laevandus Jan 6, 2025

laevandus Jan 6, 2025 •

edited

Loading

nuno-vieira Jan 6, 2025 •

edited

Loading

laevandus Jan 6, 2025

laevandus Jan 6, 2025

Add Static Location and Live Location Support #3531

Are you sure you want to change the base?

Add Static Location and Live Location Support #3531

Conversation

nuno-vieira commented Dec 13, 2024 • edited Loading

🔗 Issue Links

🎯 Goal

📝 Summary

New APIs:

Out of Scope

🛠 Implementation

🎨 Showcase

🧪 Manual Testing Notes

☑️ Contributor Checklist

martinmitrevski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nuno-vieira Jan 3, 2025 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 3, 2025

Stream-SDK-Bot commented Jan 3, 2025 • edited Loading

SDK Size

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laevandus Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

nuno-vieira Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nuno-vieira commented Dec 13, 2024 •

edited

Loading

nuno-vieira Jan 3, 2025 •

edited

Loading

Stream-SDK-Bot commented Jan 3, 2025 •

edited

Loading

laevandus Jan 6, 2025 •

edited

Loading

nuno-vieira Jan 6, 2025 •

edited

Loading