Add Message Reminders #3623

nuno-vieira · 2025-03-21T18:22:14Z

🔗 Issue Links

IOS-696

🎯 Goal

Add message reminders feature. This will allow users to save messages for later and get notified about them.

📝 Summary

New APIs:

Adds new Filter.isNil to make it easier to filter nil values
Adds ChatMessageController.createReminder()
Adds ChatMessageController.updateReminder()
Adds ChatMessageController.deleteReminder()
Adds ChatCurrentUserController.loadReminders() + loadMoreReminders()

Demo App new features:

Reminders Tab to show user's reminders
Message Cell has Saved for Later styling if it has been saved for reminder
Reminder actions when long pressing a message

Bonus:

Renames Filter+ChatChannel.swift to Filter+predicate so that we can start using it for other data and not only channels.
Changes Frankfurt C2 Environment to use the base URL of our staging by default.

🛠 Implementation

TODO

🎨 Showcase

TODO

🧪 Manual Testing Notes

In order to test the feature, you need to change the API Key to Frankfurt C2 Staging:

Open Demo App
Logout
Tap on Configuration
Tap on 1st option (AppKey)
Change to "Frankfurt C2 Staging"

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
Documentation has been updated in the docs-content repo

…sed everywhere

github-actions · 2025-03-21T18:23:17Z

	2 Warnings
⚠️	Please be sure to complete the `Contributor Checklist` in the Pull Request description
⚠️	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

nuno-vieira · 2025-03-21T18:24:48Z

DemoApp/Screens/DemoAppTabBarController.swift

+    func eventsController(_ controller: EventsController, didReceiveEvent event: Event) {
+        if AppConfig.shared.demoAppConfig.isRemindersEnabled,
+           let reminderDueEvent = event as? ReminderDueEvent {
+            handleReminderDueEvent(reminderDueEvent)
+        }
+    }


I'm not sure if this is going to stay the same since the goal is for the backend to send a remote push notification.

this doesn't feel complete without PN. Atm, we listen to WS event, and send local notification. But what if there's no active WS, do you know when push notifications would be supported?

Yes the Push needs to come from the server, I will delete this one that is done 👍

do you know when that would be ready?

Stream-SDK-Bot · 2025-03-21T18:26:20Z

SDK Size

`title`	`develop`	`branch`	`diff`	`status`
StreamChat	7.41 MB	7.77 MB	+363 KB	🟡
StreamChatUI	4.78 MB	4.84 MB	+65 KB	🟢

nuno-vieira · 2025-03-21T18:26:42Z

DemoApp/Screens/DemoReminderListVC.swift

+    var onLogout: (() -> Void)?
+    var onDisconnect: (() -> Void)?
+
+    private let currentUserController: CurrentChatUserController


At the moment, one controller is managing the different types of reminders. Although this works fine, we could also use a controller per reminder type. This way we would avoid having to many loadReminders requests. Since right now, whenever we switch the filter, we re-refetch the reminders. So yeah I might optimize this. WDYT?

Although this means we will have 4/5 currentUserControllers. Which is not very intuitive though 🤔 Maybe for the reminders feature it could be worth having a MessageReminderListController instead of using the current user controller which will observer unread counts etc..

I think it's fine to use one for the demo app - it shows how to use the API. It's up to customers to further optimize it, some might have different / less filters.

The thing is that we should show them how to optimize their integration code. This means less calls, and less stress to our servers 🤔

I wrote a longer reply to our Slack thread with a summary of supporting the idea of MessageReminderListController (mainly because reminders query has a filter)

ok, that's also fine with me 👍

Stream-SDK-Bot · 2025-03-21T18:30:46Z

SDK Performance

`target`	`metric`	`benchmark`	`branch`	`performance`	`status`
MessageList	Hitches total duration	10 ms	10.01 ms	-0.1% 🔽	🟡
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	4 ms per s	3.95 ms per s	1.25% 🔼	🟢
	Frame rate	75 fps	77.91 fps	3.88% 🔼	🟢
	Number of hitches	1	1.0	0.0% 🟰	🟢

Stream-SDK-Bot · 2025-03-21T19:00:46Z

SDK Size

`title`	`develop`	`branch`	`diff`	`status`
StreamChat	7.41 MB	7.77 MB	+364 KB	🟡
StreamChatUI	4.79 MB	4.84 MB	+49 KB	🟢

martinmitrevski

Looks great so far 👍 I think the most important thing is to check how / when push notifications will be supported - the due feature doesn't make much sense without it.
Additionally, apart from docs, we need a notion doc for other SDKs.

martinmitrevski · 2025-03-24T12:18:24Z

DemoApp/Screens/AppConfigViewController/AppConfigViewController.swift

@@ -50,7 +52,8 @@ class AppConfig {
            isLocationAttachmentsEnabled: false,
            tokenRefreshDetails: nil,
            shouldShowConnectionBanner: false,
-            isPremiumMemberFeatureEnabled: false
+            isPremiumMemberFeatureEnabled: false,
+            isRemindersEnabled: false


We should have it on by default

They are disabled, and enabled by default using our Developers Scheme. Since the design is not approved by our Designers, it is probably not a good idea to make it enabled by default 🤔 Although that applies to drafts as well

I would enable it for the default scheme as well. It helps with discoverability, and, let's be honest, you did a great job in the design part!

Ahah thanks, okay I will enable it by default 👍

martinmitrevski · 2025-03-24T12:22:08Z

DemoApp/Screens/DemoAppTabBarController.swift

+    func eventsController(_ controller: EventsController, didReceiveEvent event: Event) {
+        if AppConfig.shared.demoAppConfig.isRemindersEnabled,
+           let reminderDueEvent = event as? ReminderDueEvent {
+            handleReminderDueEvent(reminderDueEvent)
+        }
+    }


this doesn't feel complete without PN. Atm, we listen to WS event, and send local notification. But what if there's no active WS, do you know when push notifications would be supported?

martinmitrevski · 2025-03-24T12:25:18Z

DemoApp/Screens/DemoReminderListVC.swift

+    var onLogout: (() -> Void)?
+    var onDisconnect: (() -> Void)?
+
+    private let currentUserController: CurrentChatUserController


I think it's fine to use one for the demo app - it shows how to use the API. It's up to customers to further optimize it, some might have different / less filters.

martinmitrevski · 2025-03-24T13:22:03Z

Sources/StreamChat/APIClient/Endpoints/MessageEndpoints.swift

+            path: .reminders,
+            method: .post,
+            queryItems: nil,
+            requiresConnectionId: false,


how do we receive reminder events if we don't require connection id?

Yeah this might need to be true, will need to recheck

Although, I think reminders will be receive events even if you don't query them. Since you might not have a reminders list. But still want to get reminded of your reminders. So this is not needed AFAIK

ok, just checking - if it works without the connection id we can resolve this one.

martinmitrevski · 2025-03-24T13:22:59Z

Sources/StreamChat/APIClient/Endpoints/Payloads/MessagePayloads.swift

@@ -382,3 +386,68 @@ public struct Command: Codable, Hashable {
        self.args = args
    }
 }
+
+/// An object describing a reminder JSON payload.
+struct ReminderPayload: Decodable {


As mentioned on Slack, let's try using class here.

martinmitrevski · 2025-03-24T13:49:02Z

Sources/StreamChat/Query/MessageReminderListQuery.swift

+    static var createdAt: FilterKey<Scope, Date> { .init(rawValue: "created_at", keyPathString: #keyPath(MessageReminderDTO.createdAt)) }
+}
+
+public extension Filter where Scope: AnyMessageReminderListFilterScope {


how did you come up with these filters?

It is in the Notion's Backend Specs

Ah, or do you mean the helpers? If you mean the helpers, it is because it will be the most common filters, so I think it should be useful for customers

Copilot

Copilot reviewed 35 out of 55 changed files in this pull request and generated no comments.

Files not reviewed (20)

DemoApp/Screens/AppConfigViewController/AppConfigViewController.swift: Language not supported
DemoApp/Screens/DemoAppTabBarController.swift: Language not supported
DemoApp/Shared/DemoUsers.swift: Language not supported
DemoApp/Shared/StreamChatWrapper.swift: Language not supported
DemoApp/StreamChat/Components/DemoChatMessageActionsVC.swift: Language not supported
DemoApp/StreamChat/Components/DemoChatMessageContentView.swift: Language not supported
DemoApp/StreamChat/Components/DemoChatMessageLayoutOptionsResolver.swift: Language not supported
DemoApp/StreamChat/DemoAppCoordinator+DemoApp.swift: Language not supported
Sources/StreamChat/APIClient/Endpoints/EndpointPath+OfflineRequest.swift: Language not supported
Sources/StreamChat/APIClient/Endpoints/EndpointPath.swift: Language not supported
Sources/StreamChat/APIClient/Endpoints/MessageEndpoints.swift: Language not supported
Sources/StreamChat/APIClient/Endpoints/Payloads/MessagePayloads.swift: Language not supported
Sources/StreamChat/ChatClient+Environment.swift: Language not supported
Sources/StreamChat/ChatClient.swift: Language not supported
Sources/StreamChat/ChatClientFactory.swift: Language not supported
Sources/StreamChat/Controllers/CurrentUserController/CurrentUserController.swift: Language not supported
Sources/StreamChat/Controllers/MessageController/MessageController.swift: Language not supported
Sources/StreamChat/Database/DTOs/MessageDTO.swift: Language not supported
Sources/StreamChat/Database/DTOs/MessageReminderDTO.swift: Language not supported
Sources/StreamChat/Database/DatabaseSession.swift: Language not supported

sonarqubecloud · 2025-03-27T15:54:45Z

Quality Gate failed

Failed conditions
4.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

nuno-vieira added 25 commits March 14, 2025 17:48

Add new reminder endpoint paths

18800de

Add new Message Reminder Endpoints

56c59ba

Add MessageReminderListQuery

0400928

Change the default baseURL of Frankfurt C2 to staging env

24e93c6

Remove user_id from request payloads since this is server side only

0aa4543

Add MessageReminder and MessageReminderDTO

4af79fa

Add createReminder, updateReminder and deleteReminder actions

7c5f3e0

Add Message.reminder and update it or delete it when needed

d7b4d01

Add demo app example to create, update and delete reminders

62f81da

Add highlighted message view when saved for later in the demo app

bd01541

Add test coverage to Message Controller

a594a65

Add test coverage to MessagUpdater

0baaf7d

Add test coverage to ReminderPayload parsing

7d9d775

Expose Filter.isNil that wraps the.exists filter

595ad84

Rename Filter+ChatChannel to Filter+predicate so that it can be u…

da34150

…sed everywhere

Implementation of the Message Reminder Query

03f39d6

Add Reminder List Demo App UI Component

52ae315

Move reminder MessageUpdater functions to RemindersRepository

19275cf

Handle Reminder Events

f2e24f1

Fix forgotten hardcoded test in reminder list query

34dc436

Fix reminder list query tests

4de8c68

Add local push notification when reminder is expired

fbbf582

Fix reminder with empty text in the Reminder List Demo App UI

d186f7c

Add Demo App reminders feature flag

eded9cf

Improve the Filter+predicate documentation

Loading
Loading status checks…

6f51b94

nuno-vieira requested a review from a team as a code owner March 21, 2025 18:22

nuno-vieira commented Mar 21, 2025

View reviewed changes

Fix removeAllData tests

Loading
Loading status checks…

f6795ef

martinmitrevski reviewed Mar 24, 2025

View reviewed changes

nuno-vieira requested a review from Copilot March 27, 2025 14:58

Copilot AI reviewed Mar 27, 2025

View reviewed changes

Add reminders enabled by default on the demo app

Loading
Loading status checks…

1eca9b2

nuno-vieira force-pushed the add/snooze-messages branch from 60495fe to 1eca9b2 Compare March 27, 2025 15:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Message Reminders #3623

Add Message Reminders #3623

nuno-vieira commented Mar 21, 2025 •

edited

Loading

github-actions bot commented Mar 21, 2025

nuno-vieira Mar 21, 2025

martinmitrevski Mar 24, 2025

nuno-vieira Mar 24, 2025

martinmitrevski Mar 25, 2025

Stream-SDK-Bot commented Mar 21, 2025

nuno-vieira Mar 21, 2025 •

edited

Loading

martinmitrevski Mar 24, 2025

nuno-vieira Mar 24, 2025

laevandus Mar 25, 2025

martinmitrevski Mar 25, 2025

Stream-SDK-Bot commented Mar 21, 2025

Stream-SDK-Bot commented Mar 21, 2025 •

edited

Loading

martinmitrevski left a comment

martinmitrevski Mar 24, 2025

nuno-vieira Mar 24, 2025

martinmitrevski Mar 25, 2025

nuno-vieira Mar 26, 2025

martinmitrevski Mar 24, 2025

martinmitrevski Mar 24, 2025

martinmitrevski Mar 24, 2025

nuno-vieira Mar 24, 2025

nuno-vieira Mar 24, 2025 •

edited

Loading

martinmitrevski Mar 25, 2025

martinmitrevski Mar 24, 2025

martinmitrevski Mar 24, 2025

nuno-vieira Mar 24, 2025

nuno-vieira Mar 24, 2025

Copilot AI left a comment

sonarqubecloud bot commented Mar 27, 2025

Add Message Reminders #3623

Are you sure you want to change the base?

Add Message Reminders #3623

Conversation

nuno-vieira commented Mar 21, 2025 • edited Loading

🔗 Issue Links

🎯 Goal

📝 Summary

🛠 Implementation

🎨 Showcase

🧪 Manual Testing Notes

☑️ Contributor Checklist

github-actions bot commented Mar 21, 2025

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

Stream-SDK-Bot commented Mar 21, 2025

SDK Size

nuno-vieira Mar 21, 2025 • edited Loading

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

Choose a reason for hiding this comment

Stream-SDK-Bot commented Mar 21, 2025

SDK Performance

Stream-SDK-Bot commented Mar 21, 2025 • edited Loading

SDK Size

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

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

Choose a reason for hiding this comment

nuno-vieira Mar 24, 2025 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Mar 27, 2025

Quality Gate failed

nuno-vieira commented Mar 21, 2025 •

edited

Loading

nuno-vieira Mar 21, 2025 •

edited

Loading

Stream-SDK-Bot commented Mar 21, 2025 •

edited

Loading

nuno-vieira Mar 24, 2025 •

edited

Loading