famedlysdk/test/timeline_test.dart

/*
 *   Ansible inventory script used at Famedly GmbH for managing many hosts
 *   Copyright (C) 2019, 2020 Famedly GmbH
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License 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 for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import 'package:famedlysdk/matrix_api.dart';
import 'package:test/test.dart';
import 'package:famedlysdk/src/client.dart';
import 'package:famedlysdk/src/room.dart';
import 'package:famedlysdk/src/timeline.dart';
import 'package:famedlysdk/src/utils/event_update.dart';
import 'package:famedlysdk/src/utils/room_update.dart';
import 'fake_matrix_api.dart';

void main() {
  /// All Tests related to the MxContent
  group('Timeline', () {
    final roomID = '!1234:example.com';
    final testTimeStamp = DateTime.now().millisecondsSinceEpoch;
    var updateCount = 0;
    var insertList = <int>[];

    var client = Client('testclient',
        httpClient: FakeMatrixApi(), sendMessageTimeoutSeconds: 5);

    var room = Room(
        id: roomID, client: client, prev_batch: '1234', roomAccountData: {});
    var timeline = Timeline(
        room: room,
        events: [],
        onUpdate: () {
          updateCount++;
        },
        onInsert: (int insertID) {
          insertList.add(insertID);
        });

    test('Create', () async {
      await client.checkHomeserver('https://fakeServer.notExisting');

      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': '2',
            'origin_server_ts': testTimeStamp - 1000
          },
          sortOrder: room.newSortOrder));
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': '1',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));

      expect(timeline.sub != null, true);

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 2);
      expect(insertList, [0, 0]);
      expect(insertList.length, timeline.events.length);
      expect(timeline.events.length, 2);
      expect(timeline.events[0].eventId, '1');
      expect(timeline.events[0].sender.id, '@alice:example.com');
      expect(timeline.events[0].originServerTs.millisecondsSinceEpoch,
          testTimeStamp);
      expect(timeline.events[0].body, 'Testcase');
      expect(
          timeline.events[0].originServerTs.millisecondsSinceEpoch >
              timeline.events[1].originServerTs.millisecondsSinceEpoch,
          true);
      expect(timeline.events[0].receipts, []);

      room.roomAccountData['m.receipt'] = BasicRoomEvent.fromJson({
        'type': 'm.receipt',
        'content': {
          '@alice:example.com': {
            'event_id': '1',
            'ts': 1436451550453,
          }
        },
        'room_id': roomID,
      });

      await Future.delayed(Duration(milliseconds: 50));

      expect(timeline.events[0].receipts.length, 1);
      expect(timeline.events[0].receipts[0].user.id, '@alice:example.com');

      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.redaction',
          content: {
            'type': 'm.room.redaction',
            'content': {'reason': 'spamming'},
            'sender': '@alice:example.com',
            'redacts': '2',
            'event_id': '3',
            'origin_server_ts': testTimeStamp + 1000
          },
          sortOrder: room.newSortOrder));

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 3);
      expect(insertList, [0, 0]);
      expect(insertList.length, timeline.events.length);
      expect(timeline.events.length, 2);
      expect(timeline.events[1].redacted, true);
    });

    test('Send message', () async {
      await room.sendTextEvent('test', txid: '1234');

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 5);
      expect(insertList, [0, 0, 0]);
      expect(insertList.length, timeline.events.length);
      final eventId = timeline.events[0].eventId;
      expect(eventId.startsWith('\$event'), true);
      expect(timeline.events[0].status, 1);

      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'test'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': eventId,
            'unsigned': {'transaction_id': '1234'},
            'origin_server_ts': DateTime.now().millisecondsSinceEpoch
          },
          sortOrder: room.newSortOrder));

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 6);
      expect(insertList, [0, 0, 0]);
      expect(insertList.length, timeline.events.length);
      expect(timeline.events[0].eventId, eventId);
      expect(timeline.events[0].status, 2);
    });

    test('Send message with error', () async {
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 0,
            'event_id': 'abc',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 7);
      await room.sendTextEvent('test', txid: 'errortxid');
      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 9);
      await room.sendTextEvent('test', txid: 'errortxid2');
      await Future.delayed(Duration(milliseconds: 50));
      await room.sendTextEvent('test', txid: 'errortxid3');
      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 13);
      expect(insertList, [0, 0, 0, 0, 0, 0, 0]);
      expect(insertList.length, timeline.events.length);
      expect(timeline.events[0].status, -1);
      expect(timeline.events[1].status, -1);
      expect(timeline.events[2].status, -1);
    });

    test('Remove message', () async {
      await timeline.events[0].remove();

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 14);

      expect(insertList, [0, 0, 0, 0, 0, 0, 0]);
      expect(timeline.events.length, 6);
      expect(timeline.events[0].status, -1);
    });

    test('Resend message', () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': -1,
            'event_id': 'new-test-event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'newresend'},
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, -1);
      await timeline.events[0].sendAgain();

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 17);

      expect(insertList, [0, 0, 0, 0, 0, 0, 0, 0]);
      expect(timeline.events.length, 1);
      expect(timeline.events[0].status, 1);
    });

    test('Request history', () async {
      timeline.events.clear();
      await room.requestHistory();

      await Future.delayed(Duration(milliseconds: 50));

      expect(updateCount, 20);
      expect(timeline.events.length, 3);
      expect(timeline.events[0].eventId, '3143273582443PhrSn:example.org');
      expect(timeline.events[1].eventId, '2143273582443PhrSn:example.org');
      expect(timeline.events[2].eventId, '1143273582443PhrSn:example.org');
      expect(room.prev_batch, 't47409-4357353_219380_26003_2265');
      await timeline.events[2].redact(reason: 'test', txid: '1234');
    });

    test('Clear cache on limited timeline', () async {
      client.onRoomUpdate.add(RoomUpdate(
        id: roomID,
        membership: Membership.join,
        notification_count: 0,
        highlight_count: 0,
        limitedTimeline: true,
        prev_batch: 'blah',
      ));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events.isEmpty, true);
    });

    test('sort errors on top', () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': -1,
            'event_id': 'abc',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': 'def',
            'origin_server_ts': testTimeStamp + 5
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, -1);
      expect(timeline.events[1].status, 2);
    });

    test('sending event to failed update', () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 0,
            'event_id': 'will-fail',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 0);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': -1,
            'event_id': 'will-fail',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, -1);
      expect(timeline.events.length, 1);
    });
    test('sending an event and the http request finishes first, 0 -> 1 -> 2',
        () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 0,
            'event_id': 'transaction',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 0);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 1,
            'event_id': '\$event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'transaction'}
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 1);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': '\$event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'transaction'}
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 2);
      expect(timeline.events.length, 1);
    });
    test('sending an event where the sync reply arrives first, 0 -> 2 -> 1',
        () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'event_id': 'transaction',
            'origin_server_ts': testTimeStamp,
            'unsigned': {
              MessageSendingStatusKey: 0,
              'transaction_id': 'transaction',
            },
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 0);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'event_id': '\$event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {
              'transaction_id': 'transaction',
              MessageSendingStatusKey: 2,
            },
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 2);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'event_id': '\$event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {
              'transaction_id': 'transaction',
              MessageSendingStatusKey: 1,
            },
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 2);
      expect(timeline.events.length, 1);
    });
    test('sending an event 0 -> -1 -> 2', () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 0,
            'event_id': 'transaction',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 0);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': -1,
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'transaction'},
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, -1);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': '\$event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'transaction'},
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 2);
      expect(timeline.events.length, 1);
    });
    test('sending an event 0 -> 2 -> -1', () async {
      timeline.events.clear();
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 0,
            'event_id': 'transaction',
            'origin_server_ts': testTimeStamp
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 0);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': 2,
            'event_id': '\$event',
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'transaction'},
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 2);
      expect(timeline.events.length, 1);
      client.onEvent.add(EventUpdate(
          type: EventUpdateType.timeline,
          roomID: roomID,
          eventType: 'm.room.message',
          content: {
            'type': 'm.room.message',
            'content': {'msgtype': 'm.text', 'body': 'Testcase'},
            'sender': '@alice:example.com',
            'status': -1,
            'origin_server_ts': testTimeStamp,
            'unsigned': {'transaction_id': 'transaction'},
          },
          sortOrder: room.newSortOrder));
      await Future.delayed(Duration(milliseconds: 50));
      expect(timeline.events[0].status, 2);
      expect(timeline.events.length, 1);
    });
  });
}