From 679faffbaf219b7e22e357e7ce56bd6ab898783c Mon Sep 17 00:00:00 2001 From: Sahil Kumar Date: Wed, 30 Mar 2022 20:43:21 +0530 Subject: [PATCH] fix(llc): segregate mute from channel mutes Signed-off-by: xsahil03x --- .../lib/src/core/models/channel_mute.dart | 37 +++++++++++++++++++ .../lib/src/core/models/channel_mute.g.dart | 17 +++++++++ .../stream_chat/lib/src/core/models/mute.dart | 14 +++---- .../lib/src/core/models/mute.g.dart | 5 ++- .../lib/src/core/models/own_user.dart | 5 ++- .../lib/src/core/models/own_user.g.dart | 2 +- .../fixtures/{mute.json => channel_mute.json} | 0 ...{mute_test.dart => channel_mute_test.dart} | 6 +-- .../test/src/core/models/own_user_test.dart | 5 ++- 9 files changed, 75 insertions(+), 16 deletions(-) create mode 100644 packages/stream_chat/lib/src/core/models/channel_mute.dart create mode 100644 packages/stream_chat/lib/src/core/models/channel_mute.g.dart rename packages/stream_chat/test/fixtures/{mute.json => channel_mute.json} (100%) rename packages/stream_chat/test/src/core/models/{mute_test.dart => channel_mute_test.dart} (70%) diff --git a/packages/stream_chat/lib/src/core/models/channel_mute.dart b/packages/stream_chat/lib/src/core/models/channel_mute.dart new file mode 100644 index 00000000..67410afc --- /dev/null +++ b/packages/stream_chat/lib/src/core/models/channel_mute.dart @@ -0,0 +1,37 @@ +import 'package:json_annotation/json_annotation.dart'; +import 'package:stream_chat/src/core/models/channel_model.dart'; +import 'package:stream_chat/src/core/models/user.dart'; + +part 'channel_mute.g.dart'; + +/// The class that contains the information about a muted user +@JsonSerializable(createToJson: false) +class ChannelMute { + /// Constructor used for json serialization + ChannelMute({ + required this.user, + required this.channel, + required this.createdAt, + required this.updatedAt, + this.expires, + }); + + /// Create a new instance from a json + factory ChannelMute.fromJson(Map json) => + _$ChannelMuteFromJson(json); + + /// The user that performed the muting action + final User user; + + /// The target user + final ChannelModel channel; + + /// The date in which the use was muted + final DateTime createdAt; + + /// The date of the last update + final DateTime updatedAt; + + /// The date in which the mute expires + final DateTime? expires; +} diff --git a/packages/stream_chat/lib/src/core/models/channel_mute.g.dart b/packages/stream_chat/lib/src/core/models/channel_mute.g.dart new file mode 100644 index 00000000..9b6d00c1 --- /dev/null +++ b/packages/stream_chat/lib/src/core/models/channel_mute.g.dart @@ -0,0 +1,17 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'channel_mute.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +ChannelMute _$ChannelMuteFromJson(Map json) => ChannelMute( + user: User.fromJson(json['user'] as Map), + channel: ChannelModel.fromJson(json['channel'] as Map), + createdAt: DateTime.parse(json['created_at'] as String), + updatedAt: DateTime.parse(json['updated_at'] as String), + expires: json['expires'] == null + ? null + : DateTime.parse(json['expires'] as String), + ); diff --git a/packages/stream_chat/lib/src/core/models/mute.dart b/packages/stream_chat/lib/src/core/models/mute.dart index 857b34a1..02c91784 100644 --- a/packages/stream_chat/lib/src/core/models/mute.dart +++ b/packages/stream_chat/lib/src/core/models/mute.dart @@ -1,7 +1,5 @@ import 'package:json_annotation/json_annotation.dart'; -import 'package:stream_chat/src/core/models/channel_model.dart'; import 'package:stream_chat/src/core/models/user.dart'; -import 'package:stream_chat/src/core/util/serializer.dart'; part 'mute.g.dart'; @@ -11,27 +9,27 @@ class Mute { /// Constructor used for json serialization Mute({ required this.user, - required this.channel, + required this.target, required this.createdAt, required this.updatedAt, + this.expires, }); /// Create a new instance from a json factory Mute.fromJson(Map json) => _$MuteFromJson(json); /// The user that performed the muting action - @JsonKey(includeIfNull: false, toJson: Serializer.readOnly) final User user; /// The target user - @JsonKey(includeIfNull: false, toJson: Serializer.readOnly) - final ChannelModel channel; + final User target; /// The date in which the use was muted - @JsonKey(includeIfNull: false, toJson: Serializer.readOnly) final DateTime createdAt; /// The date of the last update - @JsonKey(includeIfNull: false, toJson: Serializer.readOnly) final DateTime updatedAt; + + /// The date in which the mute expires + final DateTime? expires; } diff --git a/packages/stream_chat/lib/src/core/models/mute.g.dart b/packages/stream_chat/lib/src/core/models/mute.g.dart index f57fd312..a0d908a8 100644 --- a/packages/stream_chat/lib/src/core/models/mute.g.dart +++ b/packages/stream_chat/lib/src/core/models/mute.g.dart @@ -8,7 +8,10 @@ part of 'mute.dart'; Mute _$MuteFromJson(Map json) => Mute( user: User.fromJson(json['user'] as Map), - channel: ChannelModel.fromJson(json['channel'] as Map), + target: User.fromJson(json['target'] as Map), createdAt: DateTime.parse(json['created_at'] as String), updatedAt: DateTime.parse(json['updated_at'] as String), + expires: json['expires'] == null + ? null + : DateTime.parse(json['expires'] as String), ); diff --git a/packages/stream_chat/lib/src/core/models/own_user.dart b/packages/stream_chat/lib/src/core/models/own_user.dart index 5246f48e..6133dd76 100644 --- a/packages/stream_chat/lib/src/core/models/own_user.dart +++ b/packages/stream_chat/lib/src/core/models/own_user.dart @@ -1,4 +1,5 @@ import 'package:json_annotation/json_annotation.dart'; +import 'package:stream_chat/src/core/models/channel_mute.dart'; import 'package:stream_chat/src/core/util/serializer.dart'; import 'package:stream_chat/stream_chat.dart'; @@ -79,7 +80,7 @@ class OwnUser extends User { bool? banned, DateTime? banExpires, List? teams, - List? channelMutes, + List? channelMutes, List? devices, List? mutes, int? totalUnreadCount, @@ -142,7 +143,7 @@ class OwnUser extends User { /// List of channels muted by the user. @JsonKey(includeIfNull: false) - final List channelMutes; + final List channelMutes; /// Total unread messages by the user. @JsonKey(includeIfNull: false) diff --git a/packages/stream_chat/lib/src/core/models/own_user.g.dart b/packages/stream_chat/lib/src/core/models/own_user.g.dart index be8f2d45..6cae18ee 100644 --- a/packages/stream_chat/lib/src/core/models/own_user.g.dart +++ b/packages/stream_chat/lib/src/core/models/own_user.g.dart @@ -18,7 +18,7 @@ OwnUser _$OwnUserFromJson(Map json) => OwnUser( totalUnreadCount: json['total_unread_count'] as int? ?? 0, unreadChannels: json['unread_channels'] as int? ?? 0, channelMutes: (json['channel_mutes'] as List?) - ?.map((e) => Mute.fromJson(e as Map)) + ?.map((e) => ChannelMute.fromJson(e as Map)) .toList() ?? const [], id: json['id'] as String, diff --git a/packages/stream_chat/test/fixtures/mute.json b/packages/stream_chat/test/fixtures/channel_mute.json similarity index 100% rename from packages/stream_chat/test/fixtures/mute.json rename to packages/stream_chat/test/fixtures/channel_mute.json diff --git a/packages/stream_chat/test/src/core/models/mute_test.dart b/packages/stream_chat/test/src/core/models/channel_mute_test.dart similarity index 70% rename from packages/stream_chat/test/src/core/models/mute_test.dart rename to packages/stream_chat/test/src/core/models/channel_mute_test.dart index f1f7b606..4c63db00 100644 --- a/packages/stream_chat/test/src/core/models/mute_test.dart +++ b/packages/stream_chat/test/src/core/models/channel_mute_test.dart @@ -1,14 +1,14 @@ import 'package:stream_chat/src/core/models/channel_model.dart'; -import 'package:stream_chat/src/core/models/mute.dart'; +import 'package:stream_chat/src/core/models/channel_mute.dart'; import 'package:stream_chat/src/core/models/user.dart'; import 'package:test/test.dart'; import '../../utils.dart'; void main() { - group('src/models/mute', () { + group('src/models/channel_mute', () { test('should parse json correctly', () { - final mute = Mute.fromJson(jsonFixture('mute.json')); + final mute = ChannelMute.fromJson(jsonFixture('channel_mute.json')); expect(mute.channel, isA()); expect(mute.user, isA()); expect(mute.createdAt, DateTime.parse('2020-12-04T10:39:06.512021Z')); diff --git a/packages/stream_chat/test/src/core/models/own_user_test.dart b/packages/stream_chat/test/src/core/models/own_user_test.dart index 430e9c36..e0dc7801 100644 --- a/packages/stream_chat/test/src/core/models/own_user_test.dart +++ b/packages/stream_chat/test/src/core/models/own_user_test.dart @@ -1,4 +1,5 @@ import 'package:mocktail/mocktail.dart'; +import 'package:stream_chat/src/core/models/channel_mute.dart'; import 'package:stream_chat/stream_chat.dart'; import 'package:test/test.dart'; @@ -6,12 +7,14 @@ import '../../utils.dart'; class MockMute extends Mock implements Mute {} +class ChannelMockMute extends Mock implements ChannelMute {} + class MockDevice extends Mock implements Device {} void main() { final devices = [MockDevice(), MockDevice()]; final mutes = [MockMute(), MockMute()]; - final channelMutes = [MockMute()]; + final channelMutes = [ChannelMockMute()]; final createdAt = DateTime.parse('2021-05-03 12:39:21.817646'); final updatedAt = DateTime.parse('2021-04-03 12:39:21.817646'); final lastActive = DateTime.parse('2021-03-03 12:39:21.817646');