put method

Future<RxChatImpl> put(
  1. DtoChat chat, {
  2. bool pagination = false,
  3. bool updateVersion = true,
  4. bool ignoreVersion = false,
})

Puts the provided chat to Pagination and local storage.

Puts it always, if ignoreVersion is true, or otherwise compares the stored version with the provided one.

Overwrites the stored version with the provided, if updateVersion is true. Disabling it makes the chat update its fields, if version is lower, yet doesn't update the version.

Note, that if chat isn't stored, then this always puts it and stores the version, despite the parameters.

Implementation

Future<RxChatImpl> put(
  DtoChat chat, {
  bool pagination = false,
  bool updateVersion = true,
  bool ignoreVersion = false,
}) async {
  Log.debug(
    'put($chat, $pagination, $updateVersion, $ignoreVersion)',
    '$runtimeType',
  );

  final ChatId chatId = chat.value.id;
  final RxChatImpl? saved = chats[chatId];

  // [Chat.firstItem] is maintained locally only for [Pagination] reasons.
  chat.value.firstItem ??= saved?.chat.value.firstItem;

  // Check the versions first, if [ignoreVersion] is `false`.
  if (saved != null && !ignoreVersion) {
    if (saved.ver != null && saved.ver! > chat.ver) {
      if (pagination) {
        paginated[chatId] ??= saved;
      } else {
        await _pagination?.put(chat);
      }

      return saved;
    }
  }

  final RxChatImpl rxChat = _add(chat, pagination: pagination);

  // Favorite [DtoChat]s will be put to local storage through
  // [DriftGraphQlPageProvider].
  if (chat.value.favoritePosition == null) {
    await _chatLocal.txn(() async {
      DtoChat? saved;

      // If version is ignored, there's no need to retrieve the stored chat.
      if (!ignoreVersion || !updateVersion) {
        saved = await _chatLocal.read(chatId, force: true);
      }

      // [Chat.firstItem] is maintained locally only for [Pagination] reasons.
      chat.value.firstItem ??=
          saved?.value.firstItem ?? rxChat.chat.value.firstItem;

      if (saved == null || (saved.ver <= chat.ver || ignoreVersion)) {
        // Set the version to the [saved] one, if not [updateVersion].
        if (saved != null && !updateVersion) {
          chat.ver = saved.ver;

          // [Chat.membersCount] shouldn't be updated, if [updateVersion] is
          // `false`, as it gets updated during [ChatEventKind.itemPosted]
          // event processing.
          chat.value.membersCount = saved.value.membersCount;
        }

        await _chatLocal.upsert(chat, force: true);
      }
    });
  }

  // [pagination] is `true`, if the [chat] is received from [Pagination],
  // thus otherwise we should try putting it to it.
  if (!pagination && !chat.value.isHidden) {
    await _pagination?.put(chat);
  }

  return rxChat;
}