Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Account for unread messages for jtb button visibility #142

Closed
wants to merge 7 commits into from
Closed

Account for unread messages for jtb button visibility #142

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d76ffeb
Attempt to account for unread messages
smarizvi110 Sep 8, 2024
a455cbd
Typo fix
smarizvi110 Sep 15, 2024
98a8527
Fix logic
smarizvi110 Sep 15, 2024
ff36ecc
jtb press updates unread message bool
smarizvi110 Sep 15, 2024
bd66e57
Manual scroll to end updates unread messages bool
smarizvi110 Sep 15, 2024
7c8990b
Merge remote-tracking branch 'origin/main' into jtb-visibility-on-tim…
smarizvi110 Oct 7, 2024
b8824c6
Attempt to add unread message badge and jtb logic through Matrix SDK
smarizvi110 Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 138 additions & 30 deletions src/home/room_screen.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ use matrix_sdk::{
matrix_uri::MatrixId, uint, EventId, MatrixToUri, MatrixUri, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedRoomId, RoomId, UserId
},
OwnedServerName,
sync::UnreadNotificationsCount,
Room,
Client,
};
use matrix_sdk_ui::timeline::{
self, EventTimelineItem, MemberProfileChange, Profile, ReactionsByKeyBySender, RepliedToInfo,
Expand All @@ -38,6 +41,8 @@ use crate::{
};
use rangemap::RangeSet;

use crate::persistent_state::restore_session;

live_design! {
import makepad_draw::shader::std::*;
import makepad_widgets::base::*;
Expand Down Expand Up @@ -662,21 +667,50 @@ live_design! {
jump_to_bottom_button = <IconButton> {
width: 50, height: 50,
draw_icon: {svg_file: (ICO_JUMP_TO_BOTTOM)},
icon_walk: {width: 20, height: 20, margin: {top: 10, right: 4.5} }
// draw a circular background for the button
icon_walk: {width: 20, height: 20, margin: {top: 10, right: 4.5} },
draw_bg: {
instance background_color: #edededee,
fn pixel(self) -> vec4 {
let sdf = Sdf2d::viewport(self.pos * self.rect_size);
let c = self.rect_size * 0.5;
sdf.circle(c.x, c.x, c.x)
sdf.circle(c.x, c.x, c.x);
sdf.fill_keep(self.background_color);
return sdf.result
}
}
}
}

// Badge overlay for unread messages
unread_message_badge = <View> {
width: 20, height: 20,
align: {x: 1.0, y: -1.0},
margin: {top: -5.0, right: -5.0},
visible: false,

draw_bg: {
instance background_color: #FF0000FF,
fn pixel(self) -> vec4 {
let sdf = Sdf2d::viewport(self.pos * self.rect_size);
let c = self.rect_size * 0.5;
sdf.circle(c.x, c.x, c.x);
sdf.fill_keep(self.background_color);
return sdf.result;
}
}

// Text to display the unread message count
label = <Label> {
width: Fill,
height: Fill,
text: "0",
align: {x: 0.5, y: 0.5},
draw_text: {
instance color: #ffffff,
text_style: {font_size: 12.0},
}
}
}
}
}

IMG_SMILEY_FACE_BW = dep("crate://self/resources/img/smiley_face_bw.png")
Expand Down Expand Up @@ -940,9 +974,11 @@ struct RoomScreen {
#[rust] tl_state: Option<TimelineUiState>,
/// 5 secs timer when scroll ends
#[rust] fully_read_timer: Timer,
/// The Matrix SDK client (optional until initialized).
#[rust] client: Option<Client>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't put client here in the RoomScreen Struct

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you recommend letting this remain as global in the file, or do you have a better suggestion? The rationale for putting it here was because it's only used for the room in question that the user is using, and not elsewhere in this file.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created a new combine PR with the #86 issue here: #206 . Maybe you can see how I did it. You should be using sliding_async.rs for making matrix request

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alanpoon Thank you so much! I'll take this opportunity to learn more.

}

impl RoomScreen{
impl RoomScreen {
fn send_user_read_receipts_based_on_scroll_pos(
&mut self,
cx: &mut Cx,
Expand Down Expand Up @@ -1010,6 +1046,92 @@ impl RoomScreen{
tl_state.prev_first_index = Some(first_index);
}
}

async fn ensure_client_initialized(&mut self) -> anyhow::Result<()> {
if self.client.is_none() {
match restore_session(None).await {
Ok((client, _sync_token)) => {
self.client = Some(client);
log!("Client restored successfully");
Ok(())
}
Err(e) => {
log!("Failed to restore client session: {:?}", e);
Err(e)
}
}
} else {
Ok(())
}
}

async fn update_unread_notifications(&mut self) {
// Ensure the client is initialized
if let Err(e) = self.ensure_client_initialized().await {
log!("Error initializing client: {:?}", e);
return;
}

if let Some(client) = &self.client {
if let Some(room_id) = &self.room_id {
if let Some(room) = client.get_room(room_id) {
if let Ok(unread_notifications) = room.unread_notifications().await {
let unread_count = unread_notifications.notification_count;

if unread_count > 0 {
self.view(id!(unread_message_badge))
.set_text(&format!("{}", unread_count))
.set_visible(true);

let portal_list = self.portal_list(id!(timeline.list));
if !portal_list.is_at_end() {
self.view(id!(jump_to_bottom_button)).set_visible(true);
}
} else {
self.view(id!(unread_message_badge)).set_visible(false);
}
}
}
}
}
}

fn handle_jump_to_bottom_visibility(&mut self, cx: &mut Cx, actions: &ActionsBuf) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no need to wrap an existing piece of code in a function that is used only once. This unnecessary code change makes it hard for other to review your code change.

let portal_list = self.portal_list(id!(timeline.list));
let jump_to_bottom_view = self.view(id!(jump_to_bottom_view));

if portal_list.scrolled(actions) {
// TODO: is_at_end() isn't perfect, see: <https://github.com/makepad/makepad/issues/517>
if portal_list.is_at_end() {
jump_to_bottom_view.set_visible(false);
self.view(id!(unread_message_badge)).set_visible(false);
} else {
jump_to_bottom_view.set_visible(true);
}
}

const SCROLL_TO_BOTTOM_NUM_ANIMATION_ITEMS: usize = 30;
const SCROLL_TO_BOTTOM_SPEED: f64 = 90.0;
if self.button(id!(jump_to_bottom_button)).clicked(actions) {
portal_list.smooth_scroll_to_end(
cx,
SCROLL_TO_BOTTOM_NUM_ANIMATION_ITEMS,
SCROLL_TO_BOTTOM_SPEED,
);
jump_to_bottom_view.set_visible(false);
self.redraw(cx);
self.view(id!(unread_message_badge)).set_visible(false);
}
}

fn clone_for_async(&self) -> RoomScreen {
RoomScreen {
client: self.client.clone(),
room_id: self.room_id.clone(),
view: self.view.clone(),
..self.clone()
}
}
}

impl Widget for RoomScreen {
Expand All @@ -1018,12 +1140,20 @@ impl Widget for RoomScreen {
let widget_uid = self.widget_uid();
let pane = self.user_profile_sliding_pane(id!(user_profile_sliding_pane));

// Currently, a Signal event is only used to tell this widget
// that its timeline events have been updated in the background.
if let Event::Signal = event {
self.process_timeline_updates(cx);
// Update unread notifications in the background
let mut room_screen = self.clone_for_async();
tokio::spawn(async move {
if let Err(e) = room_screen.update_unread_notifications().await {
log!("Failed to update unread notifications: {:?}", e);
}
});
Comment on lines +1147 to +1151
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should be updating the Client state inside process_timeline_updates function instead of using tokio spawn when processing backend data.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you recommend going about that considering update_unread_notifications() is async?

}

self.handle_jump_to_bottom_visibility(cx, actions);
self.send_user_read_receipts_based_on_scroll_pos(cx, actions);

if let Event::Actions(actions) = event {
for action in actions {
// Handle actions on a message, e.g., clicking the reply button or clicking the reply preview.
Expand Down Expand Up @@ -1188,7 +1318,7 @@ impl Widget for RoomScreen {
error!("Failed to open URL {:?}. Error: {:?}", url, e);
}
}
}
}
}

// Handle sending any read receipts for the current logged-in user.
Expand Down Expand Up @@ -1228,28 +1358,6 @@ impl Widget for RoomScreen {
}
}

// Handle the jump to bottom button: update its visibility, and handle clicks.
{
let mut portal_list = self.portal_list(id!(timeline.list));
let jump_to_bottom_view = self.view(id!(jump_to_bottom_view));
if portal_list.scrolled(&actions) {
// TODO: is_at_end() isn't perfect, see: <https://github.com/makepad/makepad/issues/517>
jump_to_bottom_view.set_visible(!portal_list.is_at_end());
}

const SCROLL_TO_BOTTOM_NUM_ANIMATION_ITEMS: usize = 30;
const SCROLL_TO_BOTTOM_SPEED: f64 = 90.0;
if self.button(id!(jump_to_bottom_button)).clicked(&actions) {
portal_list.smooth_scroll_to_end(
cx,
SCROLL_TO_BOTTOM_NUM_ANIMATION_ITEMS,
SCROLL_TO_BOTTOM_SPEED,
);
jump_to_bottom_view.set_visible(false);
self.redraw(cx);
}
}

// Handle a typing action on the message input box.
if let Some(new_text) = self.text_input(id!(message_input)).changed(actions) {
submit_async_request(MatrixRequest::SendTypingNotice {
Expand Down