Add privacy grade to omnibar

Author: subsymbolic

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

@@ -20,11 +20,12 @@ import android.arch.core.executor.testing.InstantTaskExecutorRule
 import android.arch.lifecycle.Observer
 import android.net.Uri
 import com.duckduckgo.app.browser.BrowserViewModel.NavigationCommand
-import com.duckduckgo.app.browser.BrowserViewModel.ViewState
 import com.duckduckgo.app.browser.omnibar.OmnibarEntryConverter
+import com.duckduckgo.app.privacymonitor.model.PrivacyGrade
 import com.duckduckgo.app.privacymonitor.store.PrivacyMonitorRepository
 import com.duckduckgo.app.privacymonitor.store.TermsOfServiceStore
 import com.duckduckgo.app.trackerdetection.model.TrackerNetworks
+import com.duckduckgo.app.trackerdetection.model.TrackingEvent
 import com.nhaarman.mockito_kotlin.mock
 import org.junit.After
 import org.junit.Assert.*
@@ -41,7 +42,6 @@ class BrowserViewModelTest {
     @Suppress("unused")
     var instantTaskExecutorRule = InstantTaskExecutorRule()
 
-    private lateinit var viewStateObserver: Observer<ViewState>
     private lateinit var queryObserver: Observer<String>
     private lateinit var navigationObserver: Observer<NavigationCommand>
     private lateinit var termsOfServiceStore: TermsOfServiceStore
@@ -55,20 +55,17 @@ class BrowserViewModelTest {
 
     @Before
     fun before() {
-        viewStateObserver = mock()
         queryObserver = mock()
         navigationObserver = mock()
         termsOfServiceStore = mock()
         testee = BrowserViewModel(testOmnibarConverter, DuckDuckGoUrlDetector(), termsOfServiceStore, TrackerNetworks(), PrivacyMonitorRepository())
         testee.query.observeForever(queryObserver)
-        testee.viewState.observeForever(viewStateObserver)
         testee.navigation.observeForever(navigationObserver)
     }
 
     @After
     fun after() {
         testee.query.removeObserver(queryObserver)
-        testee.viewState.removeObserver(viewStateObserver)
         testee.navigation.removeObserver(navigationObserver)
     }
 
@@ -159,4 +156,34 @@ class BrowserViewModelTest {
         testee.urlChanged("")
         assertFalse(testee.userDismissedKeyboard())
     }
+
+    @Test
+    fun whenLoadingStartedThenPrivacyGradeIsCleared() {
+        testee.loadingStarted()
+        assertNull(testee.viewState.value!!.privacyGrade)
+    }
+
+    @Test
+    fun whenUrlChangedThenPrivacyGradeIsReset() {
+        testee.urlChanged("https://example.com")
+        assertEquals(PrivacyGrade.B, testee.viewState.value!!.privacyGrade)
+    }
+
+    @Test
+    fun whenTrackerDetectedThenPrivacyGradeIsUpdated() {
+        testee.urlChanged("https://example.com")
+        testee.trackerDetected(TrackingEvent("", "", null, false))
+        assertEquals(PrivacyGrade.C, testee.viewState.value!!.privacyGrade)
+    }
+
+    @Test
+    fun whenInitialisedThenPrivacyGradeIsNotShown() {
+        assertFalse(testee.viewState.value!!.showPrivacyGrade)
+    }
+
+    @Test
+    fun whenUrlUpdatedThenPrivacyGradeIsShown() {
+        testee.urlChanged((""))
+        assertTrue(testee.viewState.value!!.showPrivacyGrade)
+    }
 }

app/src/androidTest/java/com/duckduckgo/app/privacymonitor/PrivacyMonitorGradeExtensionTest.kt

@@ -19,6 +19,7 @@ package com.duckduckgo.app.privacymonitor
 import com.duckduckgo.app.privacymonitor.HttpsStatus.*
 import com.duckduckgo.app.privacymonitor.model.TermsOfService
 import com.duckduckgo.app.privacymonitor.ui.improvedScore
+import com.duckduckgo.app.privacymonitor.ui.potentialScore
 import com.duckduckgo.app.privacymonitor.ui.score
 import com.duckduckgo.app.trackerdetection.model.TrackerNetwork
 import com.nhaarman.mockito_kotlin.mock
@@ -134,9 +135,8 @@ class PrivacyMonitorGradeExtensionTest {
         assertEquals(defaultScore + 1, privacyMonitor.score)
     }
 
-
     @Test
-    fun whenImprovedScoreThenTrackerMetricsIgnored() {
+    fun whenPotentialScoreThenTrackerMetricsIgnored() {
         val privacyMonitor = monitor(
                 TrackerNetwork("", "", 5, true),
                 TermsOfService(classification = "D"),
@@ -145,23 +145,50 @@ class PrivacyMonitorGradeExtensionTest {
                 2,
                 true)
         assertEquals(defaultScore + 6, privacyMonitor.score)
-        assertEquals(defaultScore + 3, privacyMonitor.improvedScore)
+        assertEquals(defaultScore + 3, privacyMonitor.potentialScore)
+    }
+
+    @Test
+    fun whenAllTrackersBlockedThenImporvedScoreIsEqualToPotentialScore() {
+        val privacyMonitor = monitor(
+                TrackerNetwork("", "", 5, true),
+                TermsOfService(classification = "D"),
+                NONE,
+                5,
+                2,
+                true,
+                allTrackerBlocked = true)
+        assertEquals(privacyMonitor.potentialScore, privacyMonitor.improvedScore)
+    }
+
+    @Test
+    fun whenNotAllTrackersBlockedThenImprovedScoreIsEqualToScore() {
+        val privacyMonitor = monitor(
+                TrackerNetwork("", "", 5, true),
+                TermsOfService(classification = "D"),
+                NONE,
+                5,
+                2,
+                true,
+                allTrackerBlocked = false)
+        assertEquals(privacyMonitor.score, privacyMonitor.improvedScore)
     }
 
     private fun monitor(memberNetwork: TrackerNetwork? = null,
                         terms: TermsOfService = TermsOfService(),
                         https: HttpsStatus = SECURE,
                         trackerCount: Int = 0,
                         majorTrackerCount: Int = 0,
-                        hasObscureTracker: Boolean = false): PrivacyMonitor {
-
+                        hasObscureTracker: Boolean = false,
+                        allTrackerBlocked: Boolean = true): PrivacyMonitor {
         val monitor: PrivacyMonitor = mock()
         whenever(monitor.memberNetwork).thenReturn(memberNetwork)
         whenever(monitor.termsOfService).thenReturn(terms)
         whenever(monitor.trackerCount).thenReturn(trackerCount)
         whenever(monitor.majorNetworkCount).thenReturn(majorTrackerCount)
         whenever(monitor.hasObscureTracker).thenReturn(hasObscureTracker)
         whenever(monitor.https).thenReturn(https)
+        whenever(monitor.allTrackersBlocked).thenReturn(allTrackerBlocked)
         return monitor
     }
 }

app/src/androidTest/java/com/duckduckgo/app/privacymonitor/ui/PrivacyDashboardViewModelTest.kt

@@ -130,7 +130,6 @@ class PrivacyDashboardViewModelTest {
         whenever(settingStore.privacyOn).thenReturn(false)
         val monitor = monitor()
         whenever(monitor.allTrackersBlocked).thenReturn(false)
-        whenever(monitor.majorNetworkCount).thenReturn(2)
         testee.onPrivacyMonitorChanged(monitor)
         assertEquals(getStringResource(R.string.privacyProtectionDisabled), testee.viewState.value?.heading)
     }

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

@@ -35,6 +35,8 @@ import com.duckduckgo.app.browser.omnibar.OnBackKeyListener
 import com.duckduckgo.app.global.DuckDuckGoActivity
 import com.duckduckgo.app.global.ViewModelFactory
 import com.duckduckgo.app.global.view.*
+import com.duckduckgo.app.privacymonitor.model.PrivacyGrade
+import com.duckduckgo.app.privacymonitor.model.PrivacyGrade.Companion.Grade
 import com.duckduckgo.app.privacymonitor.ui.PrivacyDashboardActivity
 import com.duckduckgo.app.privacymonitor.ui.PrivacyDashboardActivity.Companion.REQUEST_DASHBOARD
 import com.duckduckgo.app.privacymonitor.ui.PrivacyDashboardActivity.Companion.RESULT_RELOAD
@@ -110,6 +112,8 @@ class BrowserActivity : DuckDuckGoActivity() {
             true -> showClearButton()
             false -> hideClearButton()
         }
+
+        updatePrivacyGrade(viewState.privacyGrade, viewState.showPrivacyGrade)
     }
 
     private fun showClearButton() {
@@ -126,6 +130,19 @@ class BrowserActivity : DuckDuckGoActivity() {
         }
     }
 
+    private fun updatePrivacyGrade(@Grade privacyGrade: Long?, show: Boolean) {
+        val resource = when (privacyGrade) {
+            PrivacyGrade.A -> R.drawable.privacygrade_icon_a
+            PrivacyGrade.B -> R.drawable.privacygrade_icon_b
+            PrivacyGrade.C -> R.drawable.privacygrade_icon_c
+            PrivacyGrade.D -> R.drawable.privacygrade_icon_d
+            else -> R.drawable.privacygrade_icon_unknown
+        }
+        val menuItem = toolbar.menu.findItem(R.id.privacy_dashboard)
+        menuItem?.icon = getDrawable(resource)
+        menuItem?.isVisible = show
+    }
+
     private fun shouldUpdateUrl(viewState: BrowserViewModel.ViewState, url: String?) =
             viewState.url != null && !viewState.isEditing && urlInput.isDifferent(url)
 

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

@@ -21,9 +21,11 @@ import android.arch.lifecycle.ViewModel
 import com.duckduckgo.app.browser.omnibar.OmnibarEntryConverter
 import com.duckduckgo.app.global.SingleLiveEvent
 import com.duckduckgo.app.privacymonitor.SiteMonitor
+import com.duckduckgo.app.privacymonitor.model.PrivacyGrade.Companion.Grade
 import com.duckduckgo.app.privacymonitor.model.TermsOfService
 import com.duckduckgo.app.privacymonitor.store.PrivacyMonitorRepository
 import com.duckduckgo.app.privacymonitor.store.TermsOfServiceStore
+import com.duckduckgo.app.privacymonitor.ui.improvedGrade
 import com.duckduckgo.app.trackerdetection.model.TrackerNetworks
 import com.duckduckgo.app.trackerdetection.model.TrackingEvent
 import timber.log.Timber
@@ -42,7 +44,9 @@ class BrowserViewModel(
             val url: String? = null,
             val isEditing: Boolean = false,
             val browserShowing: Boolean = false,
-            val showClearButton: Boolean = false
+            val showClearButton: Boolean = false,
+            @Grade val privacyGrade: Long? = null,
+            val showPrivacyGrade: Boolean = false
     )
 
     /* Observable data for Activity to subscribe to */
@@ -94,7 +98,7 @@ class BrowserViewModel(
         Timber.v("Loading started")
         viewState.value = currentViewState().copy(isLoading = true)
         siteMonitor = null
-        postSiteMonitor()
+        onSiteMonitorChanged()
     }
 
     override fun loadingFinished() {
@@ -104,7 +108,7 @@ class BrowserViewModel(
 
     override fun urlChanged(url: String?) {
         Timber.v("Url changed: $url")
-        var newViewState = currentViewState().copy(url = url, browserShowing = true)
+        var newViewState = currentViewState().copy(url = url, browserShowing = true, showPrivacyGrade = true)
 
         if (duckDuckGoUrlDetector.isDuckDuckGoUrl(url)) {
             newViewState = newViewState.copy(url = lastQuery)
@@ -113,21 +117,22 @@ class BrowserViewModel(
         if (url != null) {
             val terms = termsOfServiceStore.retrieveTerms(url) ?: TermsOfService()
             siteMonitor = SiteMonitor(url, terms, trackerNetworks)
-            postSiteMonitor()
+            onSiteMonitorChanged()
         }
     }
 
     override fun trackerDetected(event: TrackingEvent) {
         siteMonitor?.trackerDetected(event)
-        postSiteMonitor()
+        onSiteMonitorChanged()
     }
 
     override fun pageHasHttpResources() {
         siteMonitor?.hasHttpResources = true
-        postSiteMonitor()
+        onSiteMonitorChanged()
     }
 
-    private fun postSiteMonitor() {
+    private fun onSiteMonitorChanged() {
+        viewState.postValue(currentViewState().copy(privacyGrade = siteMonitor?.improvedGrade))
         privacyMonitorRepository.privacyMonitor.postValue(siteMonitor)
     }
 

app/src/main/java/com/duckduckgo/app/privacymonitor/ui/PrivacyDashboardViewModel.kt

@@ -89,7 +89,7 @@ class PrivacyDashboardViewModel(private val context: Context,
     private fun updatePrivacyMonitor(monitor: PrivacyMonitor) {
         this.monitor = monitor
         viewState.value = viewState.value?.copy(
-                privacyBanner = privacyBanner(),
+                privacyBanner = privacyBanner(monitor.improvedGrade),
                 domain = monitor.uri?.host ?: "",
                 heading = headingText(),
                 httpsIcon = httpsIcon(monitor.https),
@@ -108,15 +108,15 @@ class PrivacyDashboardViewModel(private val context: Context,
             settingsStore.privacyOn = enabled
             viewState.value = viewState.value?.copy(
                     heading = headingText(),
-                    privacyBanner = privacyBanner(),
+                    privacyBanner = privacyBanner(monitor?.improvedGrade),
                     toggleEnabled = enabled
             )
         }
     }
 
     private fun headingText(): String {
         val monitor = monitor
-        if (monitor != null && monitor.allTrackersBlocked) {
+        if (monitor != null) {
             val before = monitor.grade
             val after = monitor.improvedGrade
             if (before != after) {
@@ -127,15 +127,6 @@ class PrivacyDashboardViewModel(private val context: Context,
         return context.getString(resource)
     }
 
-    @DrawableRes
-    private fun privacyBanner(): Int {
-        val monitor = monitor ?: return R.drawable.privacygrade_banner_unknown
-        if (monitor.allTrackersBlocked) {
-            return privacyBanner(monitor.improvedGrade)
-        }
-        return privacyBanner(monitor.grade)
-    }
-
     private fun privacyBanner(grade: Long?): Int {
         if (settingsStore.privacyOn) {
             return privacyBannerOn(grade)

app/src/main/java/com/duckduckgo/app/privacymonitor/ui/PrivacyMonitorGradeExtension.kt

@@ -35,7 +35,7 @@ val PrivacyMonitor.score: Int
         return score
     }
 
-val PrivacyMonitor.improvedScore: Int
+val PrivacyMonitor.potentialScore: Int
     get() = baseScore
 
 
@@ -50,14 +50,27 @@ private val PrivacyMonitor.baseScore: Int
         return score
     }
 
+val PrivacyMonitor.improvedScore: Int
+    get() {
+        if (allTrackersBlocked) {
+            return potentialScore
+        }
+        return score
+    }
+
 @PrivacyGrade.Companion.Grade
 val PrivacyMonitor.grade: Long
     get() = calculateGrade(score)
 
+@PrivacyGrade.Companion.Grade
+val PrivacyMonitor.potentialGrade: Long
+    get() = calculateGrade(potentialScore)
+
 @PrivacyGrade.Companion.Grade
 val PrivacyMonitor.improvedGrade: Long
     get() = calculateGrade(improvedScore)
 
+
 @PrivacyGrade.Companion.Grade
 private fun calculateGrade(score: Int): Long {
     return when {

app/src/main/res/drawable/privacygrade_icon_a.xml

@@ -0,0 +1,30 @@
+<!--
+  ~ Copyright (c) 2017 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.
+  -->
+
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+        android:width="22dp"
+        android:height="22dp"
+        android:viewportWidth="22.0"
+        android:viewportHeight="22.0">
+    <path
+        android:pathData="M9.74,12.305h2.52l-1.25,-3.74z"
+        android:fillType="nonZero"
+        android:fillColor="#A7A8AB"/>
+    <path
+        android:pathData="M11,0C4.925,0 0,4.925 0,11s4.925,11 11,11 11,-4.925 11,-11A11,11 0,0 0,11 0zM13.45,15.965l-0.5,-1.43L9.045,14.535l-0.5,1.43L5.65,15.965l3.735,-9.93h3.23l3.735,9.93h-2.9z"
+        android:fillType="nonZero"
+        android:fillColor="#A7A8AB"/>
+</vector>