Skip to content

update RealtimeMessage for allRead/allSeen event #198

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
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
1 change: 1 addition & 0 deletions packages/stream_feed/lib/src/core/models/index.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export 'following.dart';
export 'foreign_id_time_pair.dart';
export 'group.dart';
export 'lookup_attribute.dart';
export 'mark_read_seen.dart';
export 'notification_feed_meta.dart';
export 'open_graph_data.dart';
export 'reaction.dart';
Expand Down
60 changes: 60 additions & 0 deletions packages/stream_feed/lib/src/core/models/mark_read_seen.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
import 'package:equatable/equatable.dart';
import 'package:meta/meta.dart';

enum ReadState { all, current, ids }

class MarkRead extends Equatable {
final List<String>? ids;
final ReadState readState;
const MarkRead({this.ids, this.readState = ReadState.ids});

factory MarkRead.fromJson(dynamic markRead) {
MarkRead? result;
if (markRead is List) {
result = MarkRead(
ids: List<String>.from(markRead.map((x) => x)),
);
}
if (markRead is String) {
result = MarkRead(
readState: markRead == 'all' ? ReadState.all : ReadState.current,
);
}
return result!;
}

Map<String, dynamic> toJson() => {
"mark_read": readState == ReadState.ids ? ids : readState.name,
};

@override
List<Object?> get props => [ids, readState];
}

class MarkSeen extends Equatable {
final List<String>? ids;
final ReadState readState;
const MarkSeen({this.ids, this.readState = ReadState.ids});

factory MarkSeen.fromJson(dynamic markSeen) {
MarkSeen? result;
if (markSeen is List) {
result = MarkSeen(
ids: List<String>.from(markSeen.map((x) => x)),
);
}
if (markSeen is String) {
result = MarkSeen(
readState: markSeen == 'all' ? ReadState.all : ReadState.current,
);
}
return result!;
}

Map<String, dynamic> toJson() => {
"mark_seen": readState == ReadState.ids ? ids : readState.name,
};

@override
List<Object?> get props => [ids, readState];
}
27 changes: 19 additions & 8 deletions packages/stream_feed/lib/src/core/models/realtime_message.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import 'package:equatable/equatable.dart';
import 'package:json_annotation/json_annotation.dart';

import 'package:stream_feed/src/core/models/feed_id.dart';

import 'package:stream_feed/src/core/models/foreign_id_time_pair.dart';
import 'package:stream_feed/src/core/models/mark_read_seen.dart';
import 'package:stream_feed/src/core/util/mark_read_seen_converter.dart';
import 'package:stream_feed/src/core/util/utc_converter.dart';
import 'package:stream_feed/stream_feed.dart';

Expand All @@ -22,16 +27,19 @@ part 'realtime_message.g.dart';
/// or `latest_reactions`
@JsonSerializable(genericArgumentFactories: true)
@DateTimeUTCConverter()
@MarkReadConverter()
@MarkSeenConverter()
class RealtimeMessage<A, Ob, T, Or> extends Equatable {
/// Builds a [RealtimeMessage].
const RealtimeMessage({
required this.feed,
this.deleted = const <String>[],
this.deletedForeignIds = const <ForeignIdTimePair>[],
this.newActivities,
this.appId,
this.publishedAt,
});
const RealtimeMessage(
{required this.feed,
this.deleted = const <String>[],
this.deletedForeignIds = const <ForeignIdTimePair>[],
this.newActivities,
this.appId,
this.publishedAt,
this.markRead,
this.markSeen});

/// Create a new instance from a JSON object
factory RealtimeMessage.fromJson(
Expand Down Expand Up @@ -68,6 +76,9 @@ class RealtimeMessage<A, Ob, T, Or> extends Equatable {
},
);

final MarkSeen? markSeen;
final MarkRead? markRead;

/// Name of the feed this update was published on
@JsonKey(toJson: FeedId.toId, fromJson: FeedId.fromId)
final FeedId? feed;
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import 'package:json_annotation/json_annotation.dart';
import 'package:stream_feed/src/core/models/mark_read_seen.dart';

class MarkReadConverter implements JsonConverter<MarkRead, dynamic> {
const MarkReadConverter();

@override
MarkRead fromJson(dynamic json) => MarkRead.fromJson(json);

@override
Map<String, dynamic> toJson(MarkRead markRead) =>
markRead.toJson(); //formatDateWithOffset(json);
}

class MarkSeenConverter implements JsonConverter<MarkSeen, dynamic> {
const MarkSeenConverter();

@override
MarkSeen fromJson(dynamic json) => MarkSeen.fromJson(json);

@override
Map<String, dynamic> toJson(MarkSeen markSeen) =>
markSeen.toJson(); //formatDateWithOffset(json);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"new": [],
"deleted": [],
"deleted_foreign_ids": [],
"mark_read": "all"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"new": [],
"deleted": [],
"deleted_foreign_ids": [],
"mark_read": [
"123"
]
}
17 changes: 17 additions & 0 deletions packages/stream_feed/test/models_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ import 'dart:convert';
import 'dart:typed_data';

import 'package:stream_feed/src/core/models/follow_relation.dart';
import 'package:stream_feed/src/core/models/follow_stats.dart';
import 'package:stream_feed/src/core/models/followers.dart';
import 'package:stream_feed/src/core/models/following.dart';
import 'package:stream_feed/src/core/models/group.dart';
import 'package:stream_feed/src/core/models/mark_read_seen.dart';
import 'package:stream_feed/src/core/models/notification_feed_meta.dart';
import 'package:stream_feed/src/core/models/paginated_reactions.dart';
import 'package:stream_feed/src/core/models/personalized_feed.dart';
import 'package:stream_feed/src/core/util/utc_converter.dart';
Expand Down Expand Up @@ -155,6 +161,17 @@ void main() {
);
});

test('issue-193', () {
final fixture = RealtimeMessage<User, String, String?, String?>.fromJson(
jsonFixture('realtime_message_issue193.json'));
expect(fixture.markRead, MarkRead(ids: ["123"]));
});

test('issue-193-bis', () {
final fixture = RealtimeMessage<User, String, String?, String?>.fromJson(
jsonFixture('realtime_message_issue193-bis.json'));
expect(fixture.markRead, MarkRead(readState: ReadState.all));
});
test('issue-89', () {
final fixture = RealtimeMessage<User, String, String?, String?>.fromJson(
jsonFixture('realtime_message_issue89.json'),
Expand Down