Skip to content

SenseOfProtection experiment: Cohort survey param #5889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright (c) 2025 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.survey.rmf

import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionToggles
import com.duckduckgo.di.scopes.AppScope
import com.duckduckgo.survey.api.SurveyParameterPlugin
import com.squareup.anvil.annotations.ContributesMultibinding
import javax.inject.Inject

// Added while senseOfProtectionNewUserExperimentApr25 is active
@ContributesMultibinding(AppScope::class)
class SenseOfProtectionCohortSurveyParameterPlugin @Inject constructor(
private val senseOfProtectionToggles: SenseOfProtectionToggles,
) : SurveyParameterPlugin {
override val surveyParamKey: String = "senseProtectionCohort"

override suspend fun evaluate(): String = senseOfProtectionToggles.senseOfProtectionNewUserExperimentApr25().getCohort()?.name.orEmpty()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nalcalag shouldn't we checking that experiment is active?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we check if the experiment is active, a cohort will be assigned and we don't want that. We created a new survey for the experiment, so as soon as the experiment is disabled, we should also disable the survey or remove this survey param if they want to keep it.

}
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ import androidx.lifecycle.asLiveData
import androidx.lifecycle.viewModelScope
import com.duckduckgo.anvil.annotations.ContributesViewModel
import com.duckduckgo.app.browser.SwipingTabsFeatureProvider
import com.duckduckgo.app.browser.favicon.FaviconManager
import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionExperiment
import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionToggles.Cohorts.VARIANT_2
import com.duckduckgo.app.browser.favicon.FaviconManager
import com.duckduckgo.app.pixels.AppPixelName
import com.duckduckgo.app.pixels.AppPixelName.TAB_MANAGER_GRID_VIEW_BUTTON_CLICKED
import com.duckduckgo.app.pixels.AppPixelName.TAB_MANAGER_INFO_PANEL_DISMISSED
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
package com.duckduckgo.app.survey.rmf

import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionToggles
import com.duckduckgo.app.browser.senseofprotection.SenseOfProtectionToggles.Cohorts
import com.duckduckgo.feature.toggles.api.Toggle
import com.duckduckgo.feature.toggles.api.Toggle.State.Cohort
import kotlinx.coroutines.test.runTest
import org.junit.Assert.assertEquals
import org.junit.Test
import org.mockito.kotlin.doReturn
import org.mockito.kotlin.mock
import org.mockito.kotlin.whenever

class TemporaryDefaultSurveyParametersPluginTest {

private val mockSenseOfProtectionToggles: SenseOfProtectionToggles = mock()

@Test
fun givenUserAssignedToModifiedControlThenCohortParamEvaluatesToModifiedControl() = runTest {
val modifiedControlCohort = Cohort(Cohorts.MODIFIED_CONTROL.cohortName, 1)
val mockToggle: Toggle = mock {
on { it.isEnabled() } doReturn true
on { it.getCohort() } doReturn modifiedControlCohort
}
whenever(mockSenseOfProtectionToggles.senseOfProtectionNewUserExperimentApr25()).thenReturn(mockToggle)

val plugin = SenseOfProtectionCohortSurveyParameterPlugin(mockSenseOfProtectionToggles)

assertEquals("modifiedControl", plugin.evaluate())
}

@Test
fun givenUserAssignedToVariant1ThenCohortParamEvaluatesToVariant1() = runTest {
val modifiedControlCohort = Cohort(Cohorts.VARIANT_1.cohortName, 1)
val mockToggle: Toggle = mock {
on { it.isEnabled() } doReturn true
on { it.getCohort() } doReturn modifiedControlCohort
}
whenever(mockSenseOfProtectionToggles.senseOfProtectionNewUserExperimentApr25()).thenReturn(mockToggle)

val plugin = SenseOfProtectionCohortSurveyParameterPlugin(mockSenseOfProtectionToggles)

assertEquals("variant1", plugin.evaluate())
}

@Test
fun givenUserAssignedToVariant2ThenCohortParamEvaluatesToVariant2() = runTest {
val modifiedControlCohort = Cohort(Cohorts.VARIANT_2.cohortName, 2)
val mockToggle: Toggle = mock {
on { it.isEnabled() } doReturn true
on { it.getCohort() } doReturn modifiedControlCohort
}
whenever(mockSenseOfProtectionToggles.senseOfProtectionNewUserExperimentApr25()).thenReturn(mockToggle)

val plugin = SenseOfProtectionCohortSurveyParameterPlugin(mockSenseOfProtectionToggles)

assertEquals("variant2", plugin.evaluate())
}

@Test
fun givenNotAssignedOnSenseOfProtectionExperimentThenCohortParamEvaluatesToEmptyString() = runTest {
val mockToggle: Toggle = mock {
on { it.isEnabled() } doReturn false
on { it.getCohort() } doReturn null
}
whenever(mockSenseOfProtectionToggles.senseOfProtectionNewUserExperimentApr25()).thenReturn(mockToggle)

val plugin = SenseOfProtectionCohortSurveyParameterPlugin(mockSenseOfProtectionToggles)

assertEquals("", plugin.evaluate())
}
}
Loading