-
Notifications
You must be signed in to change notification settings - Fork 871
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
UI for the showing/hiding/dismissing/accessing the survey
- Loading branch information
Showing
14 changed files
with
602 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
.../main/java/com/duckduckgo/autofill/impl/ui/credential/management/survey/AutofillSurvey.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| /* | ||
| * Copyright (c) 2024 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.autofill.impl.ui.credential.management.survey | ||
|
|
||
| import androidx.core.net.toUri | ||
| import com.duckduckgo.app.statistics.store.StatisticsDataStore | ||
| import com.duckduckgo.app.usage.app.AppDaysUsedRepository | ||
| import com.duckduckgo.appbuildconfig.api.AppBuildConfig | ||
| import com.duckduckgo.autofill.impl.configuration.integration.JavascriptCommunicationSupport | ||
| import com.duckduckgo.autofill.impl.store.InternalAutofillStore | ||
| import com.duckduckgo.autofill.impl.ui.credential.management.survey.AutofillSurvey.SurveyDetails | ||
| import com.duckduckgo.autofill.impl.ui.credential.management.survey.AutofillSurveyImpl.Companion.SurveyParams.IN_APP | ||
| import com.duckduckgo.autofill.impl.ui.credential.management.survey.AutofillSurveyImpl.Companion.SurveyParams.NUMBER_PASSWORD_BUCKET_LOTS | ||
| import com.duckduckgo.autofill.impl.ui.credential.management.survey.AutofillSurveyImpl.Companion.SurveyParams.NUMBER_PASSWORD_BUCKET_MANY | ||
| import com.duckduckgo.autofill.impl.ui.credential.management.survey.AutofillSurveyImpl.Companion.SurveyParams.NUMBER_PASSWORD_BUCKET_NONE | ||
| import com.duckduckgo.autofill.impl.ui.credential.management.survey.AutofillSurveyImpl.Companion.SurveyParams.NUMBER_PASSWORD_BUCKET_SOME | ||
| import com.duckduckgo.browser.api.UserBrowserProperties | ||
| import com.duckduckgo.common.utils.DispatcherProvider | ||
| import com.duckduckgo.di.scopes.AppScope | ||
| import com.squareup.anvil.annotations.ContributesBinding | ||
| import java.util.* | ||
| import javax.inject.Inject | ||
| import kotlinx.coroutines.flow.firstOrNull | ||
| import kotlinx.coroutines.withContext | ||
|
|
||
| interface AutofillSurvey { | ||
| suspend fun firstUnusedSurvey(): SurveyDetails? | ||
| suspend fun recordSurveyAsUsed(id: String) | ||
|
|
||
| data class SurveyDetails( | ||
| val id: String, | ||
| val url: String, | ||
| ) | ||
| } | ||
|
|
||
| @ContributesBinding(AppScope::class) | ||
| class AutofillSurveyImpl @Inject constructor( | ||
| private val statisticsStore: StatisticsDataStore, | ||
| private val userBrowserProperties: UserBrowserProperties, | ||
| private val appBuildConfig: AppBuildConfig, | ||
| private val appDaysUsedRepository: AppDaysUsedRepository, | ||
| private val dispatchers: DispatcherProvider, | ||
| private val autofillSurveyStore: AutofillSurveyStore, | ||
| private val javascriptCommunicationSupport: JavascriptCommunicationSupport, | ||
| private val internalAutofillStore: InternalAutofillStore, | ||
| ) : AutofillSurvey { | ||
|
|
||
| override suspend fun firstUnusedSurvey(): SurveyDetails? { | ||
| if (!canShowSurvey()) return null | ||
| val survey = availableSurveys.firstOrNull { !surveyTakenPreviously(it.id) } ?: return null | ||
| return survey.copy(url = survey.url.addSurveyParameters()) | ||
| } | ||
|
|
||
| private fun canShowSurvey(): Boolean { | ||
| return deviceSetToEnglish() && javascriptCommunicationSupport.supportsModernIntegration() | ||
| } | ||
|
|
||
| override suspend fun recordSurveyAsUsed(id: String) { | ||
| autofillSurveyStore.recordSurveyWasShown(id) | ||
| } | ||
|
|
||
| private fun deviceSetToEnglish(): Boolean { | ||
| return appBuildConfig.deviceLocale.language == Locale("en").language | ||
| } | ||
|
|
||
| private suspend fun surveyTakenPreviously(surveyId: String): Boolean { | ||
| return autofillSurveyStore.hasSurveyBeenTaken(surveyId) | ||
| } | ||
|
|
||
| private suspend fun String.addSurveyParameters(): String { | ||
| return withContext(dispatchers.io()) { | ||
| val urlBuilder = toUri() | ||
| .buildUpon() | ||
| .appendQueryParameter(SurveyParams.ATB, statisticsStore.atb?.version ?: "") | ||
| .appendQueryParameter(SurveyParams.ATB_VARIANT, statisticsStore.variant) | ||
| .appendQueryParameter(SurveyParams.DAYS_INSTALLED, "${userBrowserProperties.daysSinceInstalled()}") | ||
| .appendQueryParameter(SurveyParams.ANDROID_VERSION, "${appBuildConfig.sdkInt}") | ||
| .appendQueryParameter(SurveyParams.APP_VERSION, appBuildConfig.versionName) | ||
| .appendQueryParameter(SurveyParams.MANUFACTURER, appBuildConfig.manufacturer) | ||
| .appendQueryParameter(SurveyParams.MODEL, appBuildConfig.model) | ||
| .appendQueryParameter(SurveyParams.SOURCE, IN_APP) | ||
| .appendQueryParameter(SurveyParams.LAST_ACTIVE_DATE, appDaysUsedRepository.getLastActiveDay()) | ||
| .appendQueryParameter(SurveyParams.NUMBER_PASSWORDS, bucketSavedPasswords(internalAutofillStore.getCredentialCount().firstOrNull())) | ||
|
|
||
| urlBuilder.build().toString() | ||
| } | ||
| } | ||
|
|
||
| private fun bucketSavedPasswords(passwordsSaved: Int?): String { | ||
| return when { | ||
| passwordsSaved == null -> NUMBER_PASSWORD_BUCKET_NONE | ||
| passwordsSaved < 3 -> NUMBER_PASSWORD_BUCKET_NONE | ||
| passwordsSaved < 10 -> NUMBER_PASSWORD_BUCKET_SOME | ||
| passwordsSaved < 50 -> NUMBER_PASSWORD_BUCKET_MANY | ||
| else -> NUMBER_PASSWORD_BUCKET_LOTS | ||
| } | ||
| } | ||
|
|
||
| companion object { | ||
| private val availableSurveys = listOf( | ||
| SurveyDetails( | ||
| id = "autofill-2024-04-26", | ||
| url = "https://selfserve.decipherinc.com/survey/selfserve/32ab/240308", | ||
| ), | ||
| ) | ||
|
|
||
| private object SurveyParams { | ||
| const val ATB = "atb" | ||
| const val ATB_VARIANT = "var" | ||
| const val DAYS_INSTALLED = "delta" | ||
| const val ANDROID_VERSION = "av" | ||
| const val APP_VERSION = "ddgv" | ||
| const val MANUFACTURER = "man" | ||
| const val MODEL = "mo" | ||
| const val LAST_ACTIVE_DATE = "da" | ||
| const val SOURCE = "src" | ||
| const val IN_APP = "in_app" | ||
| const val NUMBER_PASSWORDS = "saved_passwords" | ||
| const val NUMBER_PASSWORD_BUCKET_NONE = "none" | ||
| const val NUMBER_PASSWORD_BUCKET_SOME = "some" | ||
| const val NUMBER_PASSWORD_BUCKET_MANY = "many" | ||
| const val NUMBER_PASSWORD_BUCKET_LOTS = "lots" | ||
| } | ||
| } | ||
| } |
67 changes: 67 additions & 0 deletions
67
.../java/com/duckduckgo/autofill/impl/ui/credential/management/survey/AutofillSurveyStore.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright (c) 2024 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.autofill.impl.ui.credential.management.survey | ||
|
|
||
| import android.content.Context | ||
| import android.content.SharedPreferences | ||
| import androidx.core.content.edit | ||
| import com.duckduckgo.common.utils.DispatcherProvider | ||
| import com.duckduckgo.di.scopes.AppScope | ||
| import com.squareup.anvil.annotations.ContributesBinding | ||
| import dagger.SingleInstanceIn | ||
| import javax.inject.Inject | ||
| import kotlinx.coroutines.withContext | ||
|
|
||
| interface AutofillSurveyStore { | ||
| suspend fun hasSurveyBeenTaken(id: String): Boolean | ||
| suspend fun recordSurveyWasShown(id: String) | ||
| } | ||
|
|
||
| @ContributesBinding(AppScope::class) | ||
| @SingleInstanceIn(AppScope::class) | ||
| class AutofillSurveyStoreImpl @Inject constructor( | ||
| private val context: Context, | ||
| private val dispatchers: DispatcherProvider, | ||
| ) : AutofillSurveyStore { | ||
|
|
||
| private val prefs: SharedPreferences by lazy { | ||
| context.getSharedPreferences(PREFS_FILE_NAME, Context.MODE_PRIVATE) | ||
| } | ||
|
|
||
| override suspend fun hasSurveyBeenTaken(id: String): Boolean { | ||
| return withContext(dispatchers.io()) { | ||
| val previousSurveys = prefs.getStringSet(SURVEY_IDS, mutableSetOf()) ?: mutableSetOf() | ||
| previousSurveys.contains(id) | ||
| } | ||
| } | ||
|
|
||
| override suspend fun recordSurveyWasShown(id: String) { | ||
| withContext(dispatchers.io()) { | ||
| val currentValue = prefs.getStringSet(SURVEY_IDS, mutableSetOf()) ?: mutableSetOf() | ||
| val newValue = currentValue.toMutableSet() | ||
| newValue.add(id) | ||
| prefs.edit { | ||
| putStringSet(SURVEY_IDS, newValue) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| companion object { | ||
| private const val PREFS_FILE_NAME = "autofill_survey_store" | ||
| private const val SURVEY_IDS = "survey_ids" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.