Add feedback and broken site form to android

app/src/androidTest/java/com/duckduckgo/app/feedback/ui/FeedbackViewModelTest.kt

@@ -0,0 +1,142 @@
+package com.duckduckgo.app.feedback.ui
+
+import android.arch.core.executor.testing.InstantTaskExecutorRule
+import android.arch.lifecycle.Observer
+import com.duckduckgo.app.InstantSchedulersRule
+import com.duckduckgo.app.feedback.api.FeedbackSender
+import com.duckduckgo.app.feedback.ui.FeedbackViewModel.*
+import com.nhaarman.mockito_kotlin.*
+import org.junit.Assert.*
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import org.mockito.Mock
+import org.mockito.MockitoAnnotations
+
+class FeedbackViewModelTest {
+
+    @get:Rule
+    @Suppress("unused")
+    var instantTaskExecutorRule = InstantTaskExecutorRule()
+
+    @get:Rule
+    @Suppress("unused")
+    val schedulers = InstantSchedulersRule()
+
+    @Mock
+    private lateinit var mockFeedbackSender: FeedbackSender
+
+    @Mock
+    private lateinit var mockCommandObserver: Observer<FeedbackViewModel.Command>
+
+    private lateinit var testee: FeedbackViewModel
+
+    private val viewState: FeedbackViewModel.ViewState
+        get() = testee.viewState.value!!
+
+    @Before
+    fun before() {
+        MockitoAnnotations.initMocks(this)
+        testee = FeedbackViewModel(mockFeedbackSender)
+        testee.command.observeForever(mockCommandObserver)
+    }
+
+    @Test
+    fun whenInitializedThenCannotSubmit() {
+        assertFalse(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenBrokenUrlSwitchedOnWithNoUrlThenUrlFocused() {
+        testee.onBrokenSiteUrlChanged(null)
+        testee.onBrokenSiteChanged(true)
+        verify(mockCommandObserver).onChanged(Command.FocusUrl)
+    }
+
+    @Test
+    fun whenBrokenUrlSwitchedOnWithUrlThenMessageFocused() {
+        testee.onBrokenSiteUrlChanged("http://example.com")
+        testee.onBrokenSiteChanged(true)
+        verify(mockCommandObserver).onChanged(Command.FocusMessage)
+    }
+
+    @Test
+    fun whenBrokenUrlOnWithUrlThenCanSubmit() {
+        testee.onBrokenSiteChanged(true)
+        testee.onBrokenSiteUrlChanged("http://example.com")
+        assertTrue(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenBrokenUrlOnWithNullUrlThenCannotSubmit() {
+        testee.onBrokenSiteChanged(true)
+        testee.onBrokenSiteUrlChanged(null)
+        assertFalse(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenBrokenUrlOnWithBlankUrlThenCannotSubmit() {
+        testee.onBrokenSiteChanged(true)
+        testee.onBrokenSiteUrlChanged(" ")
+        assertFalse(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenBrokenUrlOffWithMessageThenCanSubmit() {
+        testee.onBrokenSiteChanged(false)
+        testee.onFeedbackMessageChanged("Feedback message")
+        assertTrue(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenBrokenUrlOffWithNullMessageThenCannotSubmit() {
+        testee.onBrokenSiteChanged(false)
+        testee.onFeedbackMessageChanged(null)
+        assertFalse(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenBrokenUrlOffWithBlankMessageThenCannotSubmit() {
+        testee.onBrokenSiteChanged(false)
+        testee.onFeedbackMessageChanged(" ")
+        assertFalse(viewState.submitAllowed)
+    }
+
+    @Test
+    fun whenCanSubmitBrokenUrlAndSubmitPressedThenFeedbackSubmitted() {
+        val url = "http://example.com"
+        testee.onBrokenSiteChanged(true)
+        testee.onBrokenSiteUrlChanged(url)
+        testee.onSubmitPressed()
+
+        verify(mockFeedbackSender).submitBrokenSiteFeedback(null, url)
+        verify(mockCommandObserver).onChanged(Command.ConfirmAndFinish)
+    }
+
+    @Test
+    fun whenCannotSubmitBrokenUrlAndSubmitPressedThenFeedbackNotSubmitted() {
+        testee.onBrokenSiteChanged(true)
+        testee.onSubmitPressed()
+        verify(mockFeedbackSender, never()).submitBrokenSiteFeedback(any(), any())
+        verify(mockCommandObserver, never()).onChanged(Command.ConfirmAndFinish)
+    }
+
+    @Test
+    fun whenCanSubmitMessageAndSubmitPressedThenFeedbackSubmitted() {
+        val message = "Message"
+        testee.onBrokenSiteChanged(false)
+        testee.onFeedbackMessageChanged(message)
+        testee.onSubmitPressed()
+        verify(mockFeedbackSender).submitGeneralFeedback(message)
+        verify(mockCommandObserver).onChanged(Command.ConfirmAndFinish)
+    }
+
+    @Test
+    fun whenCannotSubmitMessageAndSubmitPressedThenFeedbackNotSubmitted() {
+        testee.onBrokenSiteChanged(false)
+        testee.onSubmitPressed()
+        verify(mockFeedbackSender, never()).submitGeneralFeedback(any())
+        verify(mockCommandObserver, never()).onChanged(Command.ConfirmAndFinish)
+    }
+
+}

app/src/main/AndroidManifest.xml

@@ -98,6 +98,10 @@
         <activity
             android:name="com.duckduckgo.app.settings.SettingsActivity"
             android:label="@string/settingsActivityTitle" />
+        <activity
+            android:name="com.duckduckgo.app.feedback.ui.FeedbackActivity"
+            android:label="@string/feedbackActivityTitle"
+            android:theme="@style/ModalCardTheme" />
         <activity
             android:name="com.duckduckgo.app.about.AboutDuckDuckGoActivity"
             android:label="@string/aboutActivityTitle"
@@ -123,7 +127,7 @@
 
         <activity
             android:name=".defaultBrowsing.DefaultBrowserInfoActivity"
-            android:theme="@style/Theme.AppCompat.Translucent" />
+            android:theme="@style/ModalCardTheme" />
     </application>
 
 </manifest>

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

@@ -26,6 +26,7 @@ import com.duckduckgo.app.bookmarks.ui.BookmarksActivity
 import com.duckduckgo.app.browser.BrowserViewModel.Command
 import com.duckduckgo.app.browser.BrowserViewModel.Command.Query
 import com.duckduckgo.app.browser.BrowserViewModel.Command.Refresh
+import com.duckduckgo.app.feedback.ui.FeedbackActivity
 import com.duckduckgo.app.global.DuckDuckGoActivity
 import com.duckduckgo.app.global.ViewModelFactory
 import com.duckduckgo.app.global.intentText
@@ -184,6 +185,10 @@ class BrowserActivity : DuckDuckGoActivity() {
         viewModel.onOpenInNewTabRequested(query)
     }
 
+    fun launchBrokenSiteFeedback(url: String?) {
+        startActivity(FeedbackActivity.intent(this, true, url))
+    }
+
     fun launchSettings() {
         startActivity(SettingsActivity.intent(this))
     }
@@ -192,7 +197,6 @@ class BrowserActivity : DuckDuckGoActivity() {
         startActivity(BookmarksActivity.intent(this))
     }
 
-
     override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
         if (requestCode == DASHBOARD_REQUEST_CODE) {
             viewModel.receivedDashboardResult(resultCode)

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

@@ -201,8 +201,9 @@ class BrowserTabFragment : Fragment(), FindListener {
             onMenuItemClicked(view.newTabPopupMenuItem) { browserActivity?.launchNewTab() }
             onMenuItemClicked(view.bookmarksPopupMenuItem) { browserActivity?.launchBookmarks() }
             onMenuItemClicked(view.addBookmarksPopupMenuItem) { addBookmark() }
-            onMenuItemClicked(view.settingsPopupMenuItem) { browserActivity?.launchSettings() }
             onMenuItemClicked(view.findInPageMenuItem) { viewModel.userRequestingToFindInPage() }
+            onMenuItemClicked(view.brokenSitePopupMenuItem) { browserActivity?.launchBrokenSiteFeedback(viewModel.url.value) }
+            onMenuItemClicked(view.settingsPopupMenuItem) { browserActivity?.launchSettings() }
             onMenuItemClicked(view.requestDesktopSiteCheckMenuItem) {
                 viewModel.desktopSiteModeToggled(
                         urlString = webView?.url,

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

@@ -510,6 +510,7 @@ class BrowserTabViewModel(
 
     fun resetView() {
         site = null
+        url.value = null
         onSiteChanged()
         initializeViewStates()
     }

app/src/main/java/com/duckduckgo/app/di/AndroidBindingModule.kt

@@ -20,6 +20,7 @@ import com.duckduckgo.app.bookmarks.ui.BookmarksActivity
 import com.duckduckgo.app.browser.BrowserActivity
 import com.duckduckgo.app.browser.BrowserTabFragment
 import com.duckduckgo.app.browser.defaultBrowsing.DefaultBrowserInfoActivity
+import com.duckduckgo.app.feedback.ui.FeedbackActivity
 import com.duckduckgo.app.job.AppConfigurationJobService
 import com.duckduckgo.app.launch.LaunchActivity
 import com.duckduckgo.app.onboarding.ui.OnboardingActivity
@@ -70,6 +71,10 @@ abstract class AndroidBindingModule {
     @ContributesAndroidInjector
     abstract fun privacyTermsActivity(): PrivacyPracticesActivity
 
+    @ActivityScoped
+    @ContributesAndroidInjector
+    abstract fun feedbackActivity(): FeedbackActivity
+
     @ActivityScoped
     @ContributesAndroidInjector
     abstract fun settingsActivity(): SettingsActivity

app/src/main/java/com/duckduckgo/app/di/NetworkModule.kt

@@ -19,12 +19,17 @@ package com.duckduckgo.app.di
 import android.app.job.JobScheduler
 import android.content.Context
 import com.duckduckgo.app.autocomplete.api.AutoCompleteService
+import com.duckduckgo.app.feedback.api.FeedbackSender
+import com.duckduckgo.app.feedback.api.FeedbackService
+import com.duckduckgo.app.feedback.api.FeedbackSubmitter
 import com.duckduckgo.app.global.AppUrl.Url
 import com.duckduckgo.app.global.api.ApiRequestInterceptor
 import com.duckduckgo.app.global.job.JobBuilder
 import com.duckduckgo.app.httpsupgrade.api.HttpsUpgradeListService
 import com.duckduckgo.app.job.AppConfigurationSyncer
 import com.duckduckgo.app.job.ConfigurationDownloader
+import com.duckduckgo.app.statistics.VariantManager
+import com.duckduckgo.app.statistics.store.StatisticsDataStore
 import com.duckduckgo.app.surrogates.api.ResourceSurrogateListService
 import com.duckduckgo.app.trackerdetection.api.TrackerListService
 import com.squareup.moshi.Moshi
@@ -83,6 +88,13 @@ class NetworkModule {
     fun surrogatesService(retrofit: Retrofit): ResourceSurrogateListService =
         retrofit.create(ResourceSurrogateListService::class.java)
 
+    @Provides
+    fun feedbackService(retrofit: Retrofit): FeedbackService =
+        retrofit.create(FeedbackService::class.java)
+
+    @Provides
+    fun feedbackSender(statisticsStore: StatisticsDataStore, variantManager: VariantManager, feedbackSerice: FeedbackService): FeedbackSender =
+        FeedbackSubmitter(statisticsStore, variantManager, feedbackSerice)
 
     @Provides
     @Singleton

app/src/main/java/com/duckduckgo/app/feedback/api/FeedbackSender.kt

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2018 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.
+ */
+
+package com.duckduckgo.app.feedback.api
+
+import android.annotation.SuppressLint
+import android.os.Build
+import com.duckduckgo.app.browser.BuildConfig
+import com.duckduckgo.app.feedback.api.FeedbackService.Platform
+import com.duckduckgo.app.feedback.api.FeedbackService.Reason
+import com.duckduckgo.app.statistics.VariantManager
+import com.duckduckgo.app.statistics.store.StatisticsDataStore
+import io.reactivex.schedulers.Schedulers
+import timber.log.Timber
+
+interface FeedbackSender {
+    fun submitGeneralFeedback(comment: String)
+    fun submitBrokenSiteFeedback(comment: String?, url: String)
+}
+
+class FeedbackSubmitter(
+    private val statisticsStore: StatisticsDataStore,
+    private val variantManager: VariantManager,
+    private val service: FeedbackService
+) : FeedbackSender {
+
+    @SuppressLint("CheckResult")
+    override fun submitGeneralFeedback(comment: String) {
+        submitFeedback(Reason.GENERAL, comment, "")
+    }
+
+    override fun submitBrokenSiteFeedback(comment: String?, url: String) {
+        submitFeedback(Reason.BROKEN_SITE, comment ?: "", url)
+    }
+
+    private fun submitFeedback(type: String, comment: String, url: String) {
+        service.feedback(
+            type,
+            url,
+            comment,
+            Platform.ANDROID,
+            Build.VERSION.SDK_INT,
+            Build.MANUFACTURER,
+            Build.MODEL,
+            BuildConfig.VERSION_NAME,
+            atbWithVariant()
+        )
+            .subscribeOn(Schedulers.io())
+            .subscribe({
+                Timber.v("Feedback submission succeeded")
+            }, {
+                Timber.w("Feedback submission failed ${it.localizedMessage}")
+            })
+    }
+
+    private fun atbWithVariant(): String {
+        return statisticsStore.atb?.formatWithVariant(variantManager.getVariant()) ?: ""
+    }
+}

app/src/main/java/com/duckduckgo/app/feedback/api/FeedbackService.kt

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2018 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.
+ */
+
+package com.duckduckgo.app.feedback.api
+
+import io.reactivex.Observable
+import okhttp3.ResponseBody
+import retrofit2.http.Field
+import retrofit2.http.FormUrlEncoded
+import retrofit2.http.POST
+
+interface FeedbackService {
+
+    object Platform {
+        const val ANDROID = "Android"
+    }
+
+    object Reason {
+        const val BROKEN_SITE = "broken_site"
+        const val GENERAL = "general"
+    }
+
+    @FormUrlEncoded
+    @POST("/feedback.js?type=app-feedback")
+    fun feedback(
+        @Field("reason") reason: String,
+        @Field("url") url: String,
+        @Field("comment") comment: String,
+        @Field("platform") platform: String,
+        @Field("os") api: Int,
+        @Field("manufacturer") manufacturer: String,
+        @Field("model") model: String,
+        @Field("v") appVersion: String,
+        @Field("atb") atb: String
+    ): Observable<ResponseBody>
+}