Track collapsable client events, that are handled optimistically (#444) #768
+256
−31
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,184 @@ | ||||||
| // Copyright © 2022-2023 IT ENGINEERING MANAGEMENT INC, | ||||||
| // <https://github.com/team113> | ||||||
| // | ||||||
| // This program is free software: you can redistribute it and/or modify it under | ||||||
| // the terms of the GNU Affero General Public License v3.0 as published by the | ||||||
| // Free Software Foundation, either version 3 of the License, or (at your | ||||||
| // option) any later version. | ||||||
| // | ||||||
| // This program is distributed in the hope that it will be useful, but WITHOUT | ||||||
| // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||||||
| // FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License v3.0 for | ||||||
| // more details. | ||||||
| // | ||||||
| // You should have received a copy of the GNU Affero General Public License v3.0 | ||||||
| // along with this program. If not, see | ||||||
| // <https://www.gnu.org/licenses/agpl-3.0.html>. | ||||||
|
|
||||||
| import 'package:get/get.dart'; | ||||||
| import 'package:mutex/mutex.dart'; | ||||||
|
|
||||||
| import '/store/event/my_user.dart'; | ||||||
| import '/store/event/chat.dart'; | ||||||
| import 'log.dart'; | ||||||
|
|
||||||
| /// Tracker for optimistic events. | ||||||
| class EventPool { | ||||||
| /// Adds [PoolEntry] to this [EventPool] and awaits for handling. | ||||||
| Future<void> add(PoolEntry? event) async { | ||||||
| Log.debug('add($event)', '$runtimeType'); | ||||||
|
|
||||||
| if (event != null) { | ||||||
| if (_collapses[event.key] != null) { | ||||||
| if (!(_collapses[event.key] == event)) { | ||||||
|
There was a problem hiding this comment.
Suggested change
? |
||||||
| // Collapse with registred [PoolEntry] | ||||||
|
10000
There was a problem hiding this comment.
Suggested change
|
||||||
| _collapses.remove(event.key); | ||||||
| } | ||||||
| } else { | ||||||
| _collapses[event.key] = event; | ||||||
|
|
||||||
| _locks[event.key] ??= Mutex(); | ||||||
| await _locks[event.key]?.protect(() async { | ||||||
| await _collapsableWrapper(event); | ||||||
| }); | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /// Indicates whether [PoolEntry] should be ignored. | ||||||
| bool ignore(PoolEntry? event) { | ||||||
| Log.debug('ignore($event)', '$runtimeType'); | ||||||
|
|
||||||
| if (event != null) { | ||||||
| final PoolEntry? waiter = | ||||||
| _ignores[event.key]?.firstWhereOrNull((element) => event == element); | ||||||
| if (waiter != null) { | ||||||
| _ignores[event.key]!.remove(waiter); | ||||||
| return true; | ||||||
| } | ||||||
| } | ||||||
| return false; | ||||||
| } | ||||||
|
|
||||||
| /// [Mutex]es guarding synchronized call [PoolEntry] handlers. | ||||||
| final Map<int, Mutex> _locks = {}; | ||||||
|
Comment on lines
+49
to
+64
There was a problem hiding this comment. |
||||||
|
|
||||||
| /// [PoolEntry]es, that should be ignored when resieved from back. | ||||||
| final Map<int, List<PoolEntry>> _ignores = {}; | ||||||
|
|
||||||
| /// [PoolEntry]es, that should be collapsed with event of same type. | ||||||
| final Map<int, PoolEntry> _collapses = {}; | ||||||
|
|
||||||
| /// Implements collapsable behavior for handle [PoolEntry]. | ||||||
| Future<dynamic> _collapsableWrapper(PoolEntry event) async { | ||||||
| if (_collapses[event.key] != event) { | ||||||
| // This event was collapsed. | ||||||
| return; | ||||||
| } else { | ||||||
| _collapses.remove(event.key); | ||||||
| } | ||||||
|
|
||||||
| _ignores[event.key] ??= []; | ||||||
| _ignores[event.key]!.add(event); | ||||||
|
|
||||||
| await event.handler?.call(); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /// Entry for tracking events in [EventPool]. | ||||||
| class PoolEntry { | ||||||
| PoolEntry( | ||||||
| {required this.key, | ||||||
| required this.propsHash, | ||||||
| required this.type, | ||||||
| this.handler}); | ||||||
|
There was a problem hiding this comment.
Suggested change
https://dart.dev/effective-dart/style#consider-changing-your-code-to-make-it-more-formatter-friendly |
||||||
|
|
||||||
| /// Handler of this [PoolEntry]. | ||||||
| /// | ||||||
| /// It would be called when handlers of other [PoolEntry] with same [key] | ||||||
| /// would be complited. | ||||||
|
There was a problem hiding this comment.
Поставьте spell checker в Ваш IDE. |
||||||
| final Future<void> Function()? handler; | ||||||
|
|
||||||
| /// [EventType] of this [PoolEntry]. | ||||||
| final EventType type; | ||||||
|
|
||||||
| /// Key of this [PoolEntry]. | ||||||
| final int key; | ||||||
|
|
||||||
| /// Stores hashed valuable properties of event, realted to this [PoolEntry]. | ||||||
| final int propsHash; | ||||||
|
|
||||||
| @override | ||||||
| int get hashCode => propsHash; | ||||||
|
|
||||||
| @override | ||||||
| bool operator ==(Object other) => | ||||||
| other is PoolEntry && propsHash == other.propsHash; | ||||||
|
Comment on lines
+111
to
+116
There was a problem hiding this comment. Я не уверен, что за сравнения такого рода должен отвечать этот |
||||||
|
|
||||||
| @override | ||||||
| String toString() => '$runtimeType($type, $key, $propsHash)'; | ||||||
| } | ||||||
|
|
||||||
| /// Types of tracking events. | ||||||
| enum EventType { | ||||||
| myUserMuteChatsToggled, | ||||||
| chatFavoriteToggled; | ||||||
| } | ||||||
|
Comment on lines
+123
to
+126
There was a problem hiding this comment. Почему утилита знает о специфике стора? |
||||||
|
|
||||||
| /// Extension adding [PoolEntry] construction from a [MyUserEvent]. | ||||||
| extension MyUserEventToPoolEntryExtension on MyUserEvent { | ||||||
| /// Constructs a new [PoolEntry] from this [MyUserEvent]. | ||||||
| PoolEntry? toPoolEntry([Future<void> Function()? handler]) { | ||||||
| return switch (kind) { | ||||||
| MyUserEventKind.userMuted => PoolEntry( | ||||||
| type: EventType.myUserMuteChatsToggled, | ||||||
| key: EventType.myUserMuteChatsToggled.hashCode, | ||||||
| propsHash: Object.hash( | ||||||
| EventType.myUserMuteChatsToggled, | ||||||
| true, | ||||||
| ), | ||||||
| handler: handler, | ||||||
| ), | ||||||
| MyUserEventKind.unmuted => PoolEntry( | ||||||
| type: EventType.myUserMuteChatsToggled, | ||||||
| key: EventType.myUserMuteChatsToggled.hashCode, | ||||||
| propsHash: Object.hash( | ||||||
| EventType.myUserMuteChatsToggled, | ||||||
| false, | ||||||
| ), | ||||||
| handler: handler, | ||||||
| ), | ||||||
| _ => null, | ||||||
| }; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /// Extension adding [PoolEntry] construction from a [ChatEvent]. | ||||||
| extension ChatEventToPoolEntryExtension on ChatEvent { | ||||||
| /// Constructs a new [PoolEntry] from this [ChatEvent]. | ||||||
| PoolEntry? toPoolEntry([Future<void> Function()? handler]) { | ||||||
| return switch (kind) { | ||||||
| ChatEventKind.favorited => PoolEntry( | ||||||
| type: EventType.chatFavoriteToggled, | ||||||
|
Comment on lines
+159
to
+162
There was a problem hiding this comment. Не уверен вовсе, что есть смысл в создании неких |
||||||
| key: Object.hash(EventType.chatFavoriteToggled, chatId), | ||||||
| propsHash: Object.hash( | ||||||
| EventType.chatFavoriteToggled, | ||||||
| chatId, | ||||||
| true, | ||||||
| ), | ||||||
| handler: handler, | ||||||
| ), | ||||||
| ChatEventKind.unfavorited => PoolEntry( | ||||||
| type: EventType.chatFavoriteToggled, | ||||||
| key: Object.hash(EventType.chatFavoriteToggled, chatId), | ||||||
| propsHash: Object.hash( | ||||||
| EventType.chatFavoriteToggled, | ||||||
| chatId, | ||||||
| false, | ||||||
| ), | ||||||
| handler: handler, | ||||||
| ), | ||||||
| _ => null, | ||||||
| }; | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
А почему это в домене лежит? Разве это часть бизнес-логики? Нет, это ведь просто деталь реализации.