Fireproof websites empty state and Feature pixels

app/src/androidTest/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt

@@ -1754,6 +1754,13 @@ class BrowserTabViewModelTest {
         assertFalse(browserViewState().canFireproofSite)
     }
 
+    @Test
+    fun whenFireproofWebsiteAddedThenPixelSent() {
+        loadUrl("http://example.com/", isBrowserShowing = true)
+        testee.onFireproofWebsiteClicked()
+        verify(mockPixel).fire(Pixel.PixelName.FIREPROOF_WEBSITE_ADDED)
+    }
+
     @Test
     fun whenUserClicksOnFireproofWebsiteSnackbarUndoActionThenFireproofWebsiteIsRemoved() {
         loadUrl("http://example.com/", isBrowserShowing = true)
@@ -1764,6 +1771,16 @@ class BrowserTabViewModelTest {
         assertTrue(browserViewState().canFireproofSite)
     }
 
+    @Test
+    fun whenUserClicksOnFireproofWebsiteSnackbarUndoActionThenPixelSent() {
+        loadUrl("http://example.com/", isBrowserShowing = true)
+        testee.onFireproofWebsiteClicked()
+        assertCommandIssued<Command.ShowFireproofWebSiteConfirmation> {
+            testee.onFireproofWebsiteSnackbarUndoClicked(this.fireproofWebsiteEntity)
+        }
+        verify(mockPixel).fire(Pixel.PixelName.FIREPROOF_WEBSITE_UNDO)
+    }
+
     private inline fun <reified T : Command> assertCommandIssued(instanceAssertions: T.() -> Unit = {}) {
         verify(mockCommandObserver, atLeastOnce()).onChanged(commandCaptor.capture())
         val issuedCommand = commandCaptor.allValues.find { it is T }

app/src/androidTest/java/com/duckduckgo/app/fire/fireproofwebsite/ui/FireproofWebsitesViewModelTest.kt

@@ -26,6 +26,7 @@ import com.duckduckgo.app.fire.fireproofwebsite.data.FireproofWebsiteDao
 import com.duckduckgo.app.fire.fireproofwebsite.data.FireproofWebsiteEntity
 import com.duckduckgo.app.fire.fireproofwebsite.ui.FireproofWebsitesViewModel.Command.ConfirmDeleteFireproofWebsite
 import com.duckduckgo.app.global.db.AppDatabase
+import com.duckduckgo.app.statistics.pixels.Pixel
 import com.nhaarman.mockitokotlin2.atLeastOnce
 import com.nhaarman.mockitokotlin2.mock
 import kotlinx.coroutines.ExperimentalCoroutinesApi
@@ -63,13 +64,15 @@ class FireproofWebsitesViewModelTest {
 
     private val mockViewStateObserver: Observer<FireproofWebsitesViewModel.ViewState> = mock()
 
+    private val mockPixel: Pixel = mock()
+
     @Before
     fun before() {
         db = Room.inMemoryDatabaseBuilder(InstrumentationRegistry.getInstrumentation().targetContext, AppDatabase::class.java)
             .allowMainThreadQueries()
             .build()
         fireproofWebsiteDao = db.fireproofWebsiteDao()
-        viewModel = FireproofWebsitesViewModel(fireproofWebsiteDao, coroutineRule.testDispatcherProvider)
+        viewModel = FireproofWebsitesViewModel(fireproofWebsiteDao, coroutineRule.testDispatcherProvider, mockPixel)
         viewModel.command.observeForever(mockCommandObserver)
         viewModel.viewState.observeForever(mockViewStateObserver)
     }
@@ -101,6 +104,15 @@ class FireproofWebsitesViewModelTest {
         assertTrue(viewStateCaptor.value.fireproofWebsitesEntities.isEmpty())
     }
 
+    @Test
+    fun whenUserConfirmsToDeleteThenPixelSent() {
+        givenFireproofWebsiteDomain("domain.com")
+
+        viewModel.delete(FireproofWebsiteEntity("domain.com"))
+
+        verify(mockPixel).fire(Pixel.PixelName.FIREPROOF_WEBSITE_DELETED)
+    }
+
     @Test
     fun whenViewModelInitialisedThenViewStateShowsCurrentFireproofWebsites() {
         givenFireproofWebsiteDomain("domain.com")

app/src/main/java/com/duckduckgo/app/browser/BrowserTabViewModel.kt

@@ -722,16 +722,16 @@ class BrowserTabViewModel(
                 fireproofWebsiteDao.insert(fireproofWebsiteEntity)
             }
             if (id >= 0) {
+                pixel.fire(PixelName.FIREPROOF_WEBSITE_ADDED)
                 command.value = ShowFireproofWebSiteConfirmation(fireproofWebsiteEntity = fireproofWebsiteEntity)
             }
         }
     }
 
     fun onFireproofWebsiteSnackbarUndoClicked(fireproofWebsiteEntity: FireproofWebsiteEntity) {
-        viewModelScope.launch {
-            withContext(dispatchers.io()) {
-                fireproofWebsiteDao.delete(fireproofWebsiteEntity)
-            }
+        viewModelScope.launch(dispatchers.io()) {
+            fireproofWebsiteDao.delete(fireproofWebsiteEntity)
+            pixel.fire(PixelName.FIREPROOF_WEBSITE_UNDO)
         }
     }
 

app/src/main/java/com/duckduckgo/app/fire/fireproofwebsite/ui/FireproofWebsiteAdapter.kt

@@ -22,26 +22,26 @@ import android.view.View
 import android.view.ViewGroup
 import android.widget.ImageView
 import android.widget.PopupMenu
-import androidx.annotation.StringRes
 import androidx.recyclerview.widget.RecyclerView
 import com.duckduckgo.app.browser.R
 import com.duckduckgo.app.fire.fireproofwebsite.data.FireproofWebsiteEntity
 import com.duckduckgo.app.fire.fireproofwebsite.data.website
 import com.duckduckgo.app.global.faviconLocation
 import com.duckduckgo.app.global.image.GlideApp
-import kotlinx.android.synthetic.main.view_fireproof_website_description.view.*
 import kotlinx.android.synthetic.main.view_fireproof_website_entry.view.*
 import timber.log.Timber
-import java.lang.IllegalArgumentException
 
 class FireproofWebsiteAdapter(
-    private val viewModel: FireproofWebsitesViewModel,
-    @StringRes private val listDescriptionStringRes: Int
+    private val viewModel: FireproofWebsitesViewModel
 ) : RecyclerView.Adapter<FireproofWebSiteViewHolder>() {
 
-    companion object Type {
+    companion object {
         const val FIREPROOF_WEBSITE_TYPE = 0
         const val DESCRIPTION_TYPE = 1
+        const val EMPTY_STATE_TYPE = 2
+
+        const val DESCRIPTION_ITEM_SIZE = 1
+        const val EMPTY_HINT_ITEM_SIZE = 1
     }
 
     var fireproofWebsites: List<FireproofWebsiteEntity> = emptyList()
@@ -57,6 +57,10 @@ class FireproofWebsiteAdapter(
                 val view = inflater.inflate(R.layout.view_fireproof_website_entry, parent, false)
                 FireproofWebSiteViewHolder.FireproofWebsiteItemViewHolder(view, viewModel)
             }
+            EMPTY_STATE_TYPE -> {
+                val view = inflater.inflate(R.layout.view_fireproof_website_empty_hint, parent, false)
+                FireproofWebSiteViewHolder.FireproofWebsiteEmptyHintViewHolder(view)
+            }
             DESCRIPTION_TYPE -> {
                 val view = inflater.inflate(R.layout.view_fireproof_website_description, parent, false)
                 FireproofWebSiteViewHolder.FireproofWebsiteDescriptionViewHolder(view)
@@ -66,32 +70,45 @@ class FireproofWebsiteAdapter(
     }
 
     override fun getItemViewType(position: Int): Int {
-        return if ((fireproofWebsites.size - 1) < position) {
+        return if (position == 0) {
             DESCRIPTION_TYPE
         } else {
-            FIREPROOF_WEBSITE_TYPE
+            getListItemType()
         }
     }
 
     override fun onBindViewHolder(holder: FireproofWebSiteViewHolder, position: Int) {
         when (holder) {
-            is FireproofWebSiteViewHolder.FireproofWebsiteDescriptionViewHolder -> holder.bind(listDescriptionStringRes)
-            is FireproofWebSiteViewHolder.FireproofWebsiteItemViewHolder -> holder.bind(fireproofWebsites[position])
+            is FireproofWebSiteViewHolder.FireproofWebsiteItemViewHolder -> holder.bind(fireproofWebsites[getWebsiteItemPosition(position)])
         }
     }
 
     override fun getItemCount(): Int {
-        return fireproofWebsites.size + 1
+        return getItemsSize() + DESCRIPTION_ITEM_SIZE
     }
-}
 
-sealed class FireproofWebSiteViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
+    private fun getItemsSize() = if (fireproofWebsites.isEmpty()) {
+        EMPTY_HINT_ITEM_SIZE
+    } else {
+        fireproofWebsites.size
+    }
+
+    private fun getWebsiteItemPosition(position: Int) = position - DESCRIPTION_ITEM_SIZE
 
-    class FireproofWebsiteDescriptionViewHolder(itemView: View) : FireproofWebSiteViewHolder(itemView) {
-        fun bind(@StringRes text: Int) = with(itemView) {
-            fireproofWebsiteDescription.setText(text)
+    private fun getListItemType(): Int {
+        return if (fireproofWebsites.isEmpty()) {
+            EMPTY_STATE_TYPE
+        } else {
+            FIREPROOF_WEBSITE_TYPE
         }
     }
+}
+
+sealed class FireproofWebSiteViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
+
+    class FireproofWebsiteDescriptionViewHolder(itemView: View) : FireproofWebSiteViewHolder(itemView)
+
+    class FireproofWebsiteEmptyHintViewHolder(itemView: View) : FireproofWebSiteViewHolder(itemView)
 
     class FireproofWebsiteItemViewHolder(itemView: View, private val viewModel: FireproofWebsitesViewModel) : FireproofWebSiteViewHolder(itemView) {
 

app/src/main/java/com/duckduckgo/app/fire/fireproofwebsite/ui/FireproofWebsitesActivity.kt

@@ -45,7 +45,7 @@ class FireproofWebsitesActivity : DuckDuckGoActivity() {
     }
 
     private fun setupFireproofWebsiteRecycler() {
-        adapter = FireproofWebsiteAdapter(viewModel, R.string.fireproofWebsiteFeatureDescription)
+        adapter = FireproofWebsiteAdapter(viewModel)
         recycler.adapter = adapter
     }
 

app/src/main/java/com/duckduckgo/app/fire/fireproofwebsite/ui/FireproofWebsitesViewModel.kt

@@ -22,11 +22,14 @@ import com.duckduckgo.app.fire.fireproofwebsite.data.FireproofWebsiteEntity
 import com.duckduckgo.app.fire.fireproofwebsite.ui.FireproofWebsitesViewModel.Command.ConfirmDeleteFireproofWebsite
 import com.duckduckgo.app.global.DispatcherProvider
 import com.duckduckgo.app.global.SingleLiveEvent
+import com.duckduckgo.app.statistics.pixels.Pixel
+import com.duckduckgo.app.statistics.pixels.Pixel.PixelName.FIREPROOF_WEBSITE_DELETED
 import kotlinx.coroutines.launch
 
 class FireproofWebsitesViewModel(
     private val dao: FireproofWebsiteDao,
-    private val dispatcherProvider: DispatcherProvider
+    private val dispatcherProvider: DispatcherProvider,
+    private val pixel: Pixel
 ) : ViewModel() {
 
     data class ViewState(
@@ -66,6 +69,7 @@ class FireproofWebsitesViewModel(
     fun delete(entity: FireproofWebsiteEntity) {
         viewModelScope.launch(dispatcherProvider.io()) {
             dao.delete(entity)
+            pixel.fire(FIREPROOF_WEBSITE_DELETED)
         }
     }
 }

app/src/main/java/com/duckduckgo/app/global/ViewModelFactory.kt

@@ -210,6 +210,7 @@ class ViewModelFactory @Inject constructor(
     private fun fireproofWebsiteViewModel() =
         FireproofWebsitesViewModel(
             dao = fireproofWebsiteDao,
-            dispatcherProvider = dispatcherProvider
+            dispatcherProvider = dispatcherProvider,
+            pixel = pixel
         )
 }

app/src/main/java/com/duckduckgo/app/statistics/pixels/Pixel.kt

@@ -175,9 +175,11 @@ interface Pixel {
         COOKIE_DATABASE_OPEN_ERROR("m_cdb_oe"),
         COOKIE_DATABASE_DELETE_ERROR("m_cdb_de"),
         COOKIE_DATABASE_CORRUPTED_ERROR("m_cdb_ce"),
-
         COOKIE_DATABASE_EXCEPTION_OPEN_ERROR("m_cdb_e_oe"),
-        COOKIE_DATABASE_EXCEPTION_DELETE_ERROR("m_cdb_e_de")
+        COOKIE_DATABASE_EXCEPTION_DELETE_ERROR("m_cdb_e_de"),
+        FIREPROOF_WEBSITE_ADDED("m_fw_a"),
+        FIREPROOF_WEBSITE_DELETED("m_fw_d"),
+        FIREPROOF_WEBSITE_UNDO("m_fw_u")
     }
 
     object PixelParameter {

app/src/main/java/com/duckduckgo/app/tabs/ui/TabSwitcherActivity.kt

@@ -85,7 +85,7 @@ class TabSwitcherActivity : DuckDuckGoActivity(), TabSwitcherListener, Coroutine
         setContentView(R.layout.activity_tab_switcher)
         extractIntentExtras()
         configureViewReferences()
-       setupToolbar(toolbar)
+        setupToolbar(toolbar)
         configureRecycler()
         configureObservers()
     }

app/src/main/res/layout/view_fireproof_website_description.xml

@@ -29,5 +29,7 @@
         android:textColor="?attr/settingsMinorTextColor"
         android:textSize="14sp"
         android:textStyle="normal"
+        android:justificationMode="inter_word"
+        android:text="@string/fireproofWebsiteFeatureDescription"
         tools:text="Lorem ipsum dolor sit amet" />
 </LinearLayout>

app/src/main/res/layout/view_fireproof_website_empty_hint.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?><!--
+  ~ Copyright (c) 2020 DuckDuckGo
+  ~
+  ~ 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.
+  -->
+
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content"
+    android:paddingTop="24dp"
+    android:paddingStart="16dp"
+    android:paddingEnd="16dp"
+    android:paddingBottom="24dp">
+
+    <com.google.android.material.textview.MaterialTextView
+        android:id="@+id/fireproofWebsiteEmptyHint"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:fontFamily="sans-serif"
+        android:lineSpacingExtra="4sp"
+        android:gravity="center"
+        android:textColor="?attr/fireproofWebsiteTitleTextColor"
+        android:textSize="16sp"
+        android:textStyle="normal"
+        android:text="@string/fireproofWebsiteEmptyListHint"
+        tools:text="Lorem ipsum dolor sit amet" />
+</LinearLayout>

app/src/main/res/values/string-untranslated.xml

@@ -39,6 +39,7 @@
     <string name="fireproofWebsiteSnackbarConfirmation">&lt;b>%s&lt;/b> is now fireproof! Visit Settings to learn more.</string>
     <string name="fireproofWebsiteSnackbarAction">Undo</string>
     <string name="fireproofWebsiteDeleteConfirmMessage">Are you sure you want to delete &lt;b>%s&lt;/b>?</string>
+    <string name="fireproofWebsiteEmptyListHint">No websites fireproofed yet</string>
     <string name="fireproofWebsiteFeatureDescription">Websites rely on cookies to keep you signed in. When you Fireproof a site, cookies won\'t be erased and you\'ll stay signed in, even after using the Fire Button.</string>
     <string name="fireproofWebsiteOverflowContentDescription">More options for fireproof website %s</string>
     <string name="fireproofWebsiteDeleteConfirmTitle">Confirm</string>