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.

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

improve handling of events which failed to send #427

Merged
merged 1 commit into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions commet/lib/client/matrix/matrix_room.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,16 @@ class MatrixRoom extends Room {
_onUpdate.add(null);
}
}

@override
Future<void> cancelSend(TimelineEvent event) async {
final mxEvent = event as MatrixTimelineEvent;
await mxEvent.event.cancelSend();
}

@override
Future<void> retrySend(TimelineEvent event) async {
final mxEvent = event as MatrixTimelineEvent;
await mxEvent.event.sendAgain();
}
}
2 changes: 1 addition & 1 deletion commet/lib/client/matrix/matrix_timeline.dart
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ class MatrixTimeline extends Timeline {
}

void onEventRemoved(index) {
events.removeAt(index);
onRemove.add(index);
events.removeAt(index);
}

@override
Expand Down
4 changes: 4 additions & 0 deletions commet/lib/client/room.dart
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ abstract class Room {
List<ProcessedAttachment> processedAttachments,
});

Future<void> cancelSend(TimelineEvent event);

Future<void> retrySend(TimelineEvent event);

/// Add an emoticon reaction to a message
Future<TimelineEvent?> addReaction(
TimelineEvent reactingTo, Emoticon reaction);
Expand Down
7 changes: 4 additions & 3 deletions commet/lib/client/timeline.dart
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,10 @@ enum EventRelationshipType { reply }
abstract class Timeline {
late List<TimelineEvent> events = List.empty(growable: true);
final Map<String, TimelineEvent> _eventsDict = {};
late StreamController<int> onEventAdded = StreamController.broadcast();
late StreamController<int> onChange = StreamController.broadcast();
late StreamController<int> onRemove = StreamController.broadcast();
late StreamController<int> onEventAdded =
StreamController.broadcast(sync: true);
late StreamController<int> onChange = StreamController.broadcast(sync: true);
late StreamController<int> onRemove = StreamController.broadcast(sync: true);
late Client client;
late Room room;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,10 @@ class RoomTimelineWidgetViewState extends State<RoomTimelineWidgetView> {
historyItemsCount = timeline.events.length - recentItemsCount;
}
var removed = eventKeys.removeAt(index);

assert(timeline.events[index].eventId == removed.$2);

setState(() {});
}

void onAfterFirstFrame(_) {
Expand Down
105 changes: 75 additions & 30 deletions commet/lib/ui/molecules/timeline_events/timeline_event_menu.dart
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ class TimelineEventMenu {
"If a message was sent with an effect, this prompts to replay the effect",
name: "promptReplayMessageEffect");

String get promptCancelEventSend => Intl.message("Cancel",
desc:
"When a message failed to send, this prompts to cancel sending the event",
name: "promptCancelEventSend");

String get promptRetryEventSend => Intl.message("Retry",
desc:
"When a message failed to send, this prompts to retry sending the event",
name: "promptRetryEventSend");

TimelineEventMenu({
required this.timeline,
required this.event,
Expand All @@ -62,46 +72,81 @@ class TimelineEventMenu {
this.onActionFinished,
this.isThreadTimeline = false,
}) {
bool canEditEvent = event is TimelineEventMessage &&
timeline.room.permissions.canUserEditMessages &&
event.senderId == timeline.room.client.self!.identifier &&
setEditingEvent != null;

bool canDeleteEvent = timeline.canDeleteEvent(event);
bool canEditEvent = false;
bool canSaveAttachment = false;
bool canAddReaction = false;
bool canReplyInThread = false;
bool canCopy = false;
bool canEditPinState = false;
bool canPin = false;
bool canUnpin = false;
bool hasEffect = false;
bool canReply = false;
bool canDeleteEvent = false;

bool canReply = event is TimelineEventMessage ||
event is TimelineEventSticker ||
event is TimelineEventEmote;
bool canRetrySend = event.status == TimelineEventStatus.error;
bool canCancelSend = event.status == TimelineEventStatus.error;

bool canSaveAttachment = false;
if (event is TimelineEventMessage) {
canSaveAttachment =
(event as TimelineEventMessage).attachments?.isNotEmpty == true;
}
var effects = timeline.room.client.getComponent<MessageEffectComponent>();
var emoticons = timeline.room.getComponent<RoomEmoticonComponent>();
bool canAddReaction =
(event is TimelineEventMessage || event is TimelineEventSticker) &&
emoticons != null;
var pins = timeline.room.getComponent<PinnedMessagesComponent>();

bool canReplyInThread = !isThreadTimeline && event is TimelineEventMessage;
if (event.status == TimelineEventStatus.synced) {
canEditEvent = event is TimelineEventMessage &&
timeline.room.permissions.canUserEditMessages &&
event.senderId == timeline.room.client.self!.identifier &&
setEditingEvent != null;

bool canCopy = event is TimelineEventMessage;
canDeleteEvent = timeline.canDeleteEvent(event) &&
event.status == TimelineEventStatus.synced;

var pins = timeline.room.getComponent<PinnedMessagesComponent>();
canReply = event is TimelineEventMessage ||
event is TimelineEventSticker ||
event is TimelineEventEmote;

bool canEditPinState = pins?.canPinMessages == true &&
(event is TimelineEventMessage ||
event is TimelineEventSticker ||
event is TimelineEventEmote);
bool isPinned = pins?.isMessagePinned(event.eventId) == true;
bool canPin = canEditPinState && !isPinned;
bool canUnpin = canEditPinState && isPinned;
if (event is TimelineEventMessage) {
canSaveAttachment =
(event as TimelineEventMessage).attachments?.isNotEmpty == true;
}

var effects = timeline.room.client.getComponent<MessageEffectComponent>();
canAddReaction =
(event is TimelineEventMessage || event is TimelineEventSticker) &&
emoticons != null;

canReplyInThread = !isThreadTimeline && event is TimelineEventMessage;

bool hasEffect = effects?.hasEffect(event) == true;
canCopy = event is TimelineEventMessage;

canEditPinState = pins?.canPinMessages == true &&
(event is TimelineEventMessage ||
event is TimelineEventSticker ||
event is TimelineEventEmote);

bool isPinned = pins?.isMessagePinned(event.eventId) == true;

canPin = canEditPinState && !isPinned;
canUnpin = canEditPinState && isPinned;

hasEffect = effects?.hasEffect(event) == true;
}

primaryActions = [
if (canRetrySend)
TimelineEventMenuEntry(
name: promptRetryEventSend,
icon: Icons.refresh,
action: (BuildContext context) {
timeline.room.retrySend(event);
onActionFinished?.call();
}),
if (canCancelSend)
TimelineEventMenuEntry(
name: promptCancelEventSend,
icon: Icons.cancel,
action: (BuildContext context) {
timeline.room.cancelSend(event);
onActionFinished?.call();
}),
if (hasEffect)
TimelineEventMenuEntry(
name: promptReplayMessageEffect,
Expand Down Expand Up @@ -143,7 +188,7 @@ class TimelineEventMenu {
name: CommonStrings.promptAddReaction,
icon: Icons.add_reaction,
secondaryMenuBuilder: (context, dismissSecondaryMenu) {
return EmojiPicker(emoticons.availableEmoji,
return EmojiPicker(emoticons!.availableEmoji,
preferredTooltipDirection: AxisDirection.left,
onEmoticonPressed: (emote) async {
timeline.room.addReaction(event, emote);
Expand Down
21 changes: 15 additions & 6 deletions commet/lib/ui/molecules/timeline_events/timeline_view_entry.dart
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ import 'package:commet/ui/molecules/timeline_events/timeline_event_menu.dart';
import 'package:commet/ui/molecules/timeline_events/timeline_event_menu_dialog.dart';
import 'package:flutter/material.dart';

import 'package:tiamat/tiamat.dart' as tiamat;

class TimelineViewEntry extends StatefulWidget {
const TimelineViewEntry(
{required this.timeline,
Expand Down Expand Up @@ -118,6 +116,8 @@ class TimelineViewEntryState extends State<TimelineViewEntry>
return TimelineEventWidgetDisplayType.message;
} else if (event is TimelineEventGeneric) {
return TimelineEventWidgetDisplayType.generic;
} else if (event.status == TimelineEventStatus.error) {
return TimelineEventWidgetDisplayType.generic;
} else {
return TimelineEventWidgetDisplayType.hidden;
}
Expand Down Expand Up @@ -187,18 +187,27 @@ class TimelineViewEntryState extends State<TimelineViewEntry>
return Container();
}

if (status == TimelineEventStatus.sending) {
if (status == TimelineEventStatus.sending ||
status == TimelineEventStatus.error) {
result = Opacity(
opacity: 0.5,
child: result,
);
}

if (status == TimelineEventStatus.error) {
result = Column(
result = Row(
mainAxisSize: MainAxisSize.min,
children: [
result,
const tiamat.Text.error("Failed to send"),
Padding(
padding: const EdgeInsets.fromLTRB(8, 0, 8, 0),
child: Icon(
Icons.error,
size: 14,
color: Theme.of(context).colorScheme.error,
),
),
Expanded(child: result),
],
);
}
Expand Down