BayernMessenger/matrix-sdk-android/src/androidTest/java/im/vector/matrix/android/session/room/timeline/ChunkEntityTest.kt

/*
 * Copyright 2019 New Vector Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package im.vector.matrix.android.session.room.timeline

import androidx.test.ext.junit.runners.AndroidJUnit4
import com.zhuinden.monarchy.Monarchy
import im.vector.matrix.android.InstrumentedTest
import im.vector.matrix.android.internal.database.helper.add
import im.vector.matrix.android.internal.database.helper.addAll
import im.vector.matrix.android.internal.database.helper.isUnlinked
import im.vector.matrix.android.internal.database.helper.lastStateIndex
import im.vector.matrix.android.internal.database.helper.merge
import im.vector.matrix.android.internal.database.model.ChunkEntity
import im.vector.matrix.android.internal.session.room.timeline.PaginationDirection
import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeListOfEvents
import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeMessageEvent
import im.vector.matrix.android.session.room.timeline.RoomDataHelper.createFakeRoomMemberEvent
import io.realm.Realm
import io.realm.RealmConfiguration
import io.realm.kotlin.createObject
import org.amshove.kluent.shouldBeFalse
import org.amshove.kluent.shouldBeTrue
import org.amshove.kluent.shouldEqual
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith


@RunWith(AndroidJUnit4::class)
internal class ChunkEntityTest : InstrumentedTest {

    private lateinit var monarchy: Monarchy

    @Before
    fun setup() {
        Realm.init(context())
        val testConfig = RealmConfiguration.Builder().inMemory().name("test-realm").build()
        monarchy = Monarchy.Builder().setRealmConfiguration(testConfig).build()
    }


    @Test
    fun add_shouldAdd_whenNotAlreadyIncluded() {
        monarchy.runTransactionSync { realm ->
            val chunk: ChunkEntity = realm.createObject()
            val fakeEvent = createFakeMessageEvent()
            chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
            chunk.timelineEvents.size shouldEqual 1
        }
    }

    @Test
    fun add_shouldNotAdd_whenAlreadyIncluded() {
        monarchy.runTransactionSync { realm ->
            val chunk: ChunkEntity = realm.createObject()
            val fakeEvent = createFakeMessageEvent()
            chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
            chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
            chunk.timelineEvents.size shouldEqual 1
        }
    }

    @Test
    fun add_shouldStateIndexIncremented_whenStateEventIsAddedForward() {
        monarchy.runTransactionSync { realm ->
            val chunk: ChunkEntity = realm.createObject()
            val fakeEvent = createFakeRoomMemberEvent()
            chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
            chunk.lastStateIndex(PaginationDirection.FORWARDS) shouldEqual 1
        }
    }

    @Test
    fun add_shouldStateIndexNotIncremented_whenNoStateEventIsAdded() {
        monarchy.runTransactionSync { realm ->
            val chunk: ChunkEntity = realm.createObject()
            val fakeEvent = createFakeMessageEvent()
            chunk.add("roomId", fakeEvent, PaginationDirection.FORWARDS)
            chunk.lastStateIndex(PaginationDirection.FORWARDS) shouldEqual 0
        }
    }

    @Test
    fun addAll_shouldStateIndexIncremented_whenStateEventsAreAddedForward() {
        monarchy.runTransactionSync { realm ->
            val chunk: ChunkEntity = realm.createObject()
            val fakeEvents = createFakeListOfEvents(30)
            val numberOfStateEvents = fakeEvents.filter { it.isStateEvent() }.size
            chunk.addAll("roomId", fakeEvents, PaginationDirection.FORWARDS)
            chunk.lastStateIndex(PaginationDirection.FORWARDS) shouldEqual numberOfStateEvents
        }
    }

    @Test
    fun addAll_shouldStateIndexDecremented_whenStateEventsAreAddedBackward() {
        monarchy.runTransactionSync { realm ->
            val chunk: ChunkEntity = realm.createObject()
            val fakeEvents = createFakeListOfEvents(30)
            val numberOfStateEvents = fakeEvents.filter { it.isStateEvent() }.size
            val lastIsState = fakeEvents.last().isStateEvent()
            val expectedStateIndex = if (lastIsState) -numberOfStateEvents + 1 else -numberOfStateEvents
            chunk.addAll("roomId", fakeEvents, PaginationDirection.BACKWARDS)
            chunk.lastStateIndex(PaginationDirection.BACKWARDS) shouldEqual expectedStateIndex
        }
    }

    @Test
    fun merge_shouldAddEvents_whenMergingBackward() {
        monarchy.runTransactionSync { realm ->
            val chunk1: ChunkEntity = realm.createObject()
            val chunk2: ChunkEntity = realm.createObject()
            chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS)
            chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS)
            chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
            chunk1.timelineEvents.size shouldEqual 60
        }
    }

    @Test
    fun merge_shouldAddOnlyDifferentEvents_whenMergingBackward() {
        monarchy.runTransactionSync { realm ->
            val chunk1: ChunkEntity = realm.createObject()
            val chunk2: ChunkEntity = realm.createObject()
            val eventsForChunk1 = createFakeListOfEvents(30)
            val eventsForChunk2 = eventsForChunk1 + createFakeListOfEvents(10)
            chunk1.isLastForward = true
            chunk2.isLastForward = false
            chunk1.addAll("roomId", eventsForChunk1, PaginationDirection.FORWARDS)
            chunk2.addAll("roomId", eventsForChunk2, PaginationDirection.BACKWARDS)
            chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
            chunk1.timelineEvents.size shouldEqual 40
            chunk1.isLastForward.shouldBeTrue()
        }
    }

    @Test
    fun merge_shouldEventsBeLinked_whenMergingLinkedWithUnlinked() {
        monarchy.runTransactionSync { realm ->
            val chunk1: ChunkEntity = realm.createObject()
            val chunk2: ChunkEntity = realm.createObject()
            chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = false)
            chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
            chunk1.isUnlinked().shouldBeFalse()
        }
    }

    @Test
    fun merge_shouldEventsBeUnlinked_whenMergingUnlinkedWithUnlinked() {
        monarchy.runTransactionSync { realm ->
            val chunk1: ChunkEntity = realm.createObject()
            val chunk2: ChunkEntity = realm.createObject()
            chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
            chunk1.isUnlinked().shouldBeTrue()
        }
    }

    @Test
    fun merge_shouldPrevTokenMerged_whenMergingForwards() {
        monarchy.runTransactionSync { realm ->
            val chunk1: ChunkEntity = realm.createObject()
            val chunk2: ChunkEntity = realm.createObject()
            val prevToken = "prev_token"
            chunk1.prevToken = prevToken
            chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk1.merge("roomId", chunk2, PaginationDirection.FORWARDS)
            chunk1.prevToken shouldEqual prevToken
        }
    }

    @Test
    fun merge_shouldNextTokenMerged_whenMergingBackwards() {
        monarchy.runTransactionSync { realm ->
            val chunk1: ChunkEntity = realm.createObject()
            val chunk2: ChunkEntity = realm.createObject()
            val nextToken = "next_token"
            chunk1.nextToken = nextToken
            chunk1.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk2.addAll("roomId", createFakeListOfEvents(30), PaginationDirection.BACKWARDS, isUnlinked = true)
            chunk1.merge("roomId", chunk2, PaginationDirection.BACKWARDS)
            chunk1.nextToken shouldEqual nextToken
        }
    }

}