/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package mozilla.components.browser.storage.sync

import androidx.test.ext.junit.runners.AndroidJUnit4
import kotlinx.coroutines.runBlocking
import mozilla.appservices.places.BookmarkRoot
import mozilla.appservices.places.PlacesException
import mozilla.components.concept.storage.BookmarkInfo
import mozilla.components.concept.storage.BookmarkNode
import mozilla.components.concept.storage.BookmarkNodeType
import mozilla.components.support.test.robolectric.testContext
import org.junit.After
import org.junit.Assert.assertEquals
import org.junit.Assert.assertNotNull
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Assert.fail
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
class PlacesBookmarksStorageTest {
    private lateinit var bookmarks: PlacesBookmarksStorage

    @Before
    fun setup() = runBlocking {
        bookmarks = PlacesBookmarksStorage(testContext)
        // There's a database on disk which needs to be cleaned up between tests.
        bookmarks.writer.deleteEverything()
    }

    @After
    fun cleanup() = runBlocking {
        bookmarks.cleanup()
    }

    @Test
    fun `get bookmarks tree by root, recursive or not`() = runBlocking {
        val tree = bookmarks.getTree(BookmarkRoot.Root.id)!!
        assertEquals(BookmarkRoot.Root.id, tree.guid)
        assertNotNull(tree.children)
        assertEquals(4, tree.children!!.size)

        var children = tree.children!!.map { it.guid }
        assertTrue(BookmarkRoot.Mobile.id in children)
        assertTrue(BookmarkRoot.Unfiled.id in children)
        assertTrue(BookmarkRoot.Toolbar.id in children)
        assertTrue(BookmarkRoot.Menu.id in children)

        // Non-recursive means children of children aren't fetched.
        for (child in tree.children!!) {
            assertNull(child.children)
            assertEquals(BookmarkRoot.Root.id, child.parentGuid)
            assertEquals(BookmarkNodeType.FOLDER, child.type)
        }

        val deepTree = bookmarks.getTree(BookmarkRoot.Root.id, true)!!
        assertEquals(BookmarkRoot.Root.id, deepTree.guid)
        assertNotNull(deepTree.children)
        assertEquals(4, deepTree.children!!.size)

        children = deepTree.children!!.map { it.guid }
        assertTrue(BookmarkRoot.Mobile.id in children)
        assertTrue(BookmarkRoot.Unfiled.id in children)
        assertTrue(BookmarkRoot.Toolbar.id in children)
        assertTrue(BookmarkRoot.Menu.id in children)

        // Recursive means children of children are fetched.
        for (child in deepTree.children!!) {
            // For an empty tree, we expect to see empty lists.
            assertEquals(emptyList<BookmarkNode>(), child.children)
            assertEquals(BookmarkRoot.Root.id, child.parentGuid)
            assertEquals(BookmarkNodeType.FOLDER, child.type)
        }
    }

    @Test
    fun `bookmarks APIs smoke testing - basic operations`() = runBlocking {
        val url = "http://www.mozilla.org"

        assertEquals(emptyList<BookmarkNode>(), bookmarks.getBookmarksWithUrl(url))
        assertEquals(emptyList<BookmarkNode>(), bookmarks.searchBookmarks("mozilla"))

        val insertedItem = bookmarks.addItem(BookmarkRoot.Mobile.id, url, "Mozilla", 5)

        with(bookmarks.getBookmarksWithUrl(url)) {
            assertEquals(1, this.size)
            with(this[0]) {
                assertEquals(insertedItem, this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
                assertEquals("Mozilla", this.title)
                assertEquals(BookmarkRoot.Mobile.id, this.parentGuid)
                // Clamped to actual range. 'Mobile' was empty, so we get 0 back.
                assertEquals(0, this.position)
                assertEquals("http://www.mozilla.org/", this.url)
            }
        }

        val folderGuid = bookmarks.addFolder(BookmarkRoot.Mobile.id, "Test Folder", null)
        bookmarks.updateNode(insertedItem, BookmarkInfo(
            parentGuid = folderGuid, title = null, position = -3, url = null
        ))
        with(bookmarks.getBookmarksWithUrl(url)) {
            assertEquals(1, this.size)
            with(this[0]) {
                assertEquals(insertedItem, this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
                assertEquals("Mozilla", this.title)
                assertEquals(folderGuid, this.parentGuid)
                assertEquals(0, this.position)
                assertEquals("http://www.mozilla.org/", this.url)
            }
        }

        val separatorGuid = bookmarks.addSeparator(folderGuid, 1)
        with(bookmarks.getTree(folderGuid)!!) {
            assertEquals(2, this.children!!.size)
            assertEquals(BookmarkNodeType.SEPARATOR, this.children!![1].type)
        }

        assertTrue(bookmarks.deleteNode(separatorGuid))
        with(bookmarks.getTree(folderGuid)!!) {
            assertEquals(1, this.children!!.size)
            assertEquals(BookmarkNodeType.ITEM, this.children!![0].type)
        }

        with(bookmarks.searchBookmarks("mozilla")) {
            assertEquals(1, this.size)
            assertEquals("http://www.mozilla.org/", this[0].url)
        }

        with(bookmarks.getBookmark(folderGuid)!!) {
            assertEquals(folderGuid, this.guid)
            assertEquals("Test Folder", this.title)
            assertEquals(BookmarkRoot.Mobile.id, this.parentGuid)
        }

        assertTrue(bookmarks.deleteNode(folderGuid))

        for (root in listOf(
            BookmarkRoot.Mobile, BookmarkRoot.Root, BookmarkRoot.Menu, BookmarkRoot.Toolbar, BookmarkRoot.Unfiled)
        ) {
            try {
                bookmarks.deleteNode(root.id)
                fail("Expected root deletion for ${root.id} to fail")
            } catch (e: PlacesException) {}
        }

        with(bookmarks.searchBookmarks("mozilla")) {
            assertTrue(this.isEmpty())
        }
    }

    @Test
    fun `bookmarks import v0 empty`() {
        // Doesn't have a schema or a set user_version pragma.
        val path = getTestPath("databases/empty-v0.db").absolutePath
        try {
            bookmarks.importFromFennec(path)
            fail("Expected v0 database to be unsupported")
        } catch (e: PlacesException) {
            // This is a little brittle, but the places library doesn't have a proper error type for this.
            assertEquals("Database version 0 is not supported", e.message)
        }
    }

    @Test
    fun `bookmarks import v34 populated`() = runBlocking {
        val path = getTestPath("databases/history-v34.db").absolutePath

        // Need to import history first before we import bookmarks.
        PlacesHistoryStorage(testContext).importFromFennec(path)
        bookmarks.importFromFennec(path)

        with(bookmarks.getTree(BookmarkRoot.Root.id)!!) {
            assertEquals(4, this.children!!.size)
            val children = this.children!!.map { it.guid }
            assertTrue(BookmarkRoot.Mobile.id in children)
            assertTrue(BookmarkRoot.Unfiled.id in children)
            assertTrue(BookmarkRoot.Toolbar.id in children)
            assertTrue(BookmarkRoot.Menu.id in children)
        }

        with(bookmarks.getTree(BookmarkRoot.Mobile.id)!!) {
            assertEquals(3, this.children!!.size)
            with(this.children!![0]) {
                assertEquals("Firefox: About your browser", this.title)
                assertEquals("about:firefox", this.url)
                assertEquals("t4ov0nhBpPAY", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![1]) {
                assertEquals("Firefox: Customize with add-ons", this.title)
                assertEquals("https://addons.mozilla.org/android?utm_source=inproduct&utm_medium=default-bookmarks&utm_campaign=mobileandroid", this.url)
                assertEquals("dhoCQAToruIT", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![2]) {
                assertEquals("Firefox: Support", this.title)
                assertEquals("https://support.mozilla.org/products/mobile?utm_source=inproduct&utm_medium=default-bookmarks&utm_campaign=mobileandroid", this.url)
                assertEquals("gIqii_3QBZWG", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
        }
    }

    @Test
    fun `bookmarks import v38 populated`() = runBlocking {
        val path = getTestPath("databases/populated-v38.db").absolutePath

        // Need to import history first before we import bookmarks.
        PlacesHistoryStorage(testContext).importFromFennec(path)
        bookmarks.importFromFennec(path)

        with(bookmarks.getTree(BookmarkRoot.Root.id)!!) {
            assertEquals(4, this.children!!.size)
            val children = this.children!!.map { it.guid }
            assertTrue(BookmarkRoot.Mobile.id in children)
            assertTrue(BookmarkRoot.Unfiled.id in children)
            assertTrue(BookmarkRoot.Toolbar.id in children)
            assertTrue(BookmarkRoot.Menu.id in children)
        }

        with(bookmarks.getTree(BookmarkRoot.Mobile.id)!!) {
            assertEquals(7, this.children!!.size)
            with(this.children!![0]) {
                assertEquals("Firefox: About your browser", this.title)
                assertEquals("about:firefox", this.url)
                assertEquals("9MVmaUmIEKST", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![1]) {
                assertEquals("Firefox: Customize with add-ons", this.title)
                assertEquals("https://addons.mozilla.org/android?utm_source=inproduct&utm_medium=default-bookmarks&utm_campaign=mobileandroid", this.url)
                assertEquals("-wR8auFiXifM", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![2]) {
                assertEquals("Firefox: Support", this.title)
                assertEquals("https://support.mozilla.org/products/mobile?utm_source=inproduct&utm_medium=default-bookmarks&utm_campaign=mobileandroid", this.url)
                assertEquals("UUJ5Ru2TouvB", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![3]) {
                assertEquals("Problem loading page", this.title)
                assertEquals("file:///", this.url)
                assertEquals("YWIdMNLBXzUa", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![4]) {
                assertEquals("Kotaku - The Gamer's Guide", this.title)
                assertEquals("http://kotaku.com/", this.url)
                assertEquals("_nrbwE-uDI4w", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![5]) {
                assertEquals("News, sport and opinion from the Guardian's US edition | The Guardian", this.title)
                assertEquals("https://www.theguardian.com/us", this.url)
                assertEquals("9pdaS9QzEwYy", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![6]) {
                assertEquals("Rollins Pass - Wikipedia", this.title)
                assertEquals("https://en.m.wikipedia.org/wiki/Rollins_Pass#/random", this.url)
                assertEquals("mEFfANXkYH6T", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
        }
    }

    @Test
    fun `bookmarks import v39 populated`() = runBlocking {
        val path = getTestPath("databases/populated-v39.db").absolutePath

        // Need to import history first before we import bookmarks.
        PlacesHistoryStorage(testContext).importFromFennec(path)
        bookmarks.importFromFennec(path)

        with(bookmarks.getTree(BookmarkRoot.Root.id)!!) {
            assertEquals(4, this.children!!.size)
            val children = this.children!!.map { it.guid }
            assertTrue(BookmarkRoot.Mobile.id in children)
            assertTrue(BookmarkRoot.Unfiled.id in children)
            assertTrue(BookmarkRoot.Toolbar.id in children)
            assertTrue(BookmarkRoot.Menu.id in children)

            // Note that we dropped the special "pinned" folder during a migration.
            // See https://github.com/mozilla/application-services/issues/1989
        }

        with(bookmarks.getTree(BookmarkRoot.Mobile.id)!!) {
            assertEquals(6, this.children!!.size)
            with(this.children!![0]) {
                assertEquals("Business & Financial News, Breaking US & International News | Reuters", this.title)
                assertEquals("https://mobile.reuters.com/", this.url)
                assertEquals("2hazimCy0hhS", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![1]) {
                assertEquals("There is a way to protect your privacy. Join Firefox.", this.title)
                assertEquals("https://www.mozilla.org/en-US/firefox/accounts/", this.url)
                assertEquals("mUcVvqUfJs6r", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![2]) {
                assertEquals("Internet for people, not profit — Mozilla", this.title)
                assertEquals("https://www.mozilla.org/en-US/", this.url)
                assertEquals("tL-ucG5eaoG-", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![3]) {
                assertEquals("Firefox: About your browser", this.title)
                assertEquals("about:firefox", this.url)
                assertEquals("kR_18w0gDLHq", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![4]) {
                assertEquals("Firefox: Customize with add-ons", this.title)
                assertEquals("https://addons.mozilla.org/android?utm_source=inproduct&utm_medium=default-bookmarks&utm_campaign=mobileandroid", this.url)
                assertEquals("bTuLpp58gwqw", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
            with(this.children!![5]) {
                assertEquals("Firefox: Support", this.title)
                assertEquals("https://support.mozilla.org/products/mobile?utm_source=inproduct&utm_medium=default-bookmarks&utm_campaign=mobileandroid", this.url)
                assertEquals("nbfDW0QSBEKu", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
        }
    }

    @Test
    fun `bookmarks pinned sites read v39`() = runBlocking {
        val path = getTestPath("databases/pinnedSites-v39.db").absolutePath

        with(bookmarks.readPinnedSitesFromFennec(path)) {
            assertEquals(2, this.size)

            with(this[0]) {
                assertEquals("Featured extensions for Android – Add-ons for Firefox Android (en-US)", this.title)
                assertEquals("https://addons.mozilla.org/en-US/android/collections/4757633/mob/?page=1&collection_sort=-popularity", this.url)
                assertEquals("6l1ow_W7naMw", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }

            with(this[1]) {
                assertEquals("Internet for people, not profit — Mozilla", this.title)
                assertEquals("https://www.mozilla.org/en-US/", this.url)
                assertEquals("dgC3t6q9HIuR", this.guid)
                assertEquals(BookmarkNodeType.ITEM, this.type)
            }
        }
    }

    @Test
    fun `bookmarks pinned sites read empty v39`() = runBlocking {
        val path = getTestPath("databases/populated-v39.db").absolutePath

        assertEquals(0, bookmarks.readPinnedSitesFromFennec(path).size)
    }
}
