Adding enabled experiments to feedback metdata (#3167)

Author: kiiadi

jetbrains-core/src/software/aws/toolkits/jetbrains/core/experiments/ToolkitExperiment.kt

@@ -157,6 +157,7 @@ internal class ToolkitExperimentManager : PersistentStateComponent<ExperimentSta
         internal val EXPERIMENT_CHANGED = Topic.create("experiment service enable state changed", ToolkitExperimentStateChangedListener::class.java)
         internal fun getInstance(): ToolkitExperimentManager = service()
         internal fun visibleExperiments(): List<ToolkitExperiment> = EP_NAME.extensionList.filterNot { it.hidden }
+        internal fun enabledExperiments(): List<ToolkitExperiment> = EP_NAME.extensionList.filter { it.isEnabled() }
     }
 }
 

jetbrains-core/src/software/aws/toolkits/jetbrains/services/telemetry/TelemetryService.kt

@@ -19,9 +19,11 @@ import software.aws.toolkits.core.telemetry.TelemetryPublisher
 import software.aws.toolkits.core.utils.tryOrNull
 import software.aws.toolkits.jetbrains.core.credentials.activeRegion
 import software.aws.toolkits.jetbrains.core.credentials.getConnectionSettings
+import software.aws.toolkits.jetbrains.core.experiments.ToolkitExperimentManager
 import software.aws.toolkits.jetbrains.core.getResourceIfPresent
 import software.aws.toolkits.jetbrains.services.sts.StsResources
 import software.aws.toolkits.jetbrains.settings.AwsSettings
+import software.aws.toolkits.jetbrains.ui.feedback.ENABLED_EXPERIMENTS
 import java.util.concurrent.atomic.AtomicBoolean
 
 data class MetricEventMetadata(
@@ -115,7 +117,8 @@ abstract class TelemetryService(private val publisher: TelemetryPublisher, priva
     }
 
     suspend fun sendFeedback(sentiment: Sentiment, comment: String, metadata: Map<String, String> = emptyMap()) {
-        publisher.sendFeedback(sentiment, comment, metadata)
+        val experiments = ToolkitExperimentManager.enabledExperiments().joinToString(",") { it.id }
+        publisher.sendFeedback(sentiment, comment, metadata + (ENABLED_EXPERIMENTS to experiments))
     }
 
     companion object {

jetbrains-core/src/software/aws/toolkits/jetbrains/ui/feedback/Constants.kt

@@ -4,3 +4,4 @@
 package software.aws.toolkits.jetbrains.ui.feedback
 
 const val FEEDBACK_SOURCE = "source"
+const val ENABLED_EXPERIMENTS = "experimentsEnabled"

jetbrains-core/tst/software/aws/toolkits/jetbrains/services/telemetry/TelemetryServiceTest.kt

@@ -5,10 +5,14 @@ package software.aws.toolkits.jetbrains.services.telemetry
 
 import com.intellij.ide.highlighter.ProjectFileType
 import com.intellij.openapi.project.ex.ProjectManagerEx
+import com.intellij.testFramework.DisposableRule
+import com.intellij.testFramework.ExtensionTestUtil
 import com.intellij.testFramework.PlatformTestUtil
 import com.intellij.testFramework.ProjectRule
 import com.intellij.testFramework.TemporaryDirectory
 import com.intellij.testFramework.createTestOpenProjectOptions
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.runBlockingTest
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.After
 import org.junit.Rule
@@ -19,23 +23,29 @@ import org.mockito.kotlin.mock
 import org.mockito.kotlin.stub
 import org.mockito.kotlin.times
 import org.mockito.kotlin.verify
+import software.amazon.awssdk.services.toolkittelemetry.model.Sentiment
 import software.aws.toolkits.core.credentials.CredentialIdentifier
 import software.aws.toolkits.core.region.AwsRegion
 import software.aws.toolkits.core.telemetry.DefaultMetricEvent.Companion.METADATA_INVALID
 import software.aws.toolkits.core.telemetry.DefaultMetricEvent.Companion.METADATA_NOT_SET
 import software.aws.toolkits.core.telemetry.MetricEvent
 import software.aws.toolkits.core.telemetry.TelemetryBatcher
 import software.aws.toolkits.core.telemetry.TelemetryPublisher
+import software.aws.toolkits.core.utils.test.aString
 import software.aws.toolkits.jetbrains.core.MockResourceCacheRule
 import software.aws.toolkits.jetbrains.core.credentials.AwsConnectionManager
 import software.aws.toolkits.jetbrains.core.credentials.ConnectionState
 import software.aws.toolkits.jetbrains.core.credentials.MockAwsConnectionManager
 import software.aws.toolkits.jetbrains.core.credentials.MockAwsConnectionManager.ProjectAccountSettingsManagerRule
 import software.aws.toolkits.jetbrains.core.credentials.MockCredentialManagerRule
 import software.aws.toolkits.jetbrains.core.credentials.waitUntilConnectionStateIsStable
+import software.aws.toolkits.jetbrains.core.experiments.DummyExperiment
+import software.aws.toolkits.jetbrains.core.experiments.ToolkitExperimentManager
+import software.aws.toolkits.jetbrains.core.experiments.setState
 import software.aws.toolkits.jetbrains.core.region.MockRegionProviderRule
 import software.aws.toolkits.jetbrains.services.sts.StsResources
 import software.aws.toolkits.jetbrains.settings.AwsSettings
+import software.aws.toolkits.jetbrains.ui.feedback.ENABLED_EXPERIMENTS
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit
 
@@ -62,6 +72,10 @@ class TelemetryServiceTest {
     @Rule
     val connectionSettingsManager = ProjectAccountSettingsManagerRule(projectRule)
 
+    @JvmField
+    @Rule
+    val disposableRule = DisposableRule()
+
     @After
     fun tearDown() {
         AwsSettings.getInstance().isTelemetryEnabled = false
@@ -243,6 +257,28 @@ class TelemetryServiceTest {
         }
     }
 
+    @Test
+    @ExperimentalCoroutinesApi
+    fun experimentStatusIsIncludedInFeedback() = runBlockingTest {
+        val fooExperiment = DummyExperiment()
+        val barExperiment = DummyExperiment()
+        val bloopExperiment = DummyExperiment()
+        ExtensionTestUtil.maskExtensions(ToolkitExperimentManager.EP_NAME, listOf(fooExperiment, barExperiment, bloopExperiment), disposableRule.disposable)
+
+        fooExperiment.setState(true)
+        barExperiment.setState(true)
+
+        val publisher = mock<TelemetryPublisher>()
+        val telemetryService = TestTelemetryService(publisher = publisher, batcher = mock())
+
+        val comment = aString()
+
+        telemetryService.sendFeedback(Sentiment.NEGATIVE, comment)
+        telemetryService.dispose()
+
+        verify(publisher).sendFeedback(Sentiment.NEGATIVE, comment, mapOf(ENABLED_EXPERIMENTS to "${fooExperiment.id},${barExperiment.id}"))
+    }
+
     @Test
     fun disposeClosesThePublisher() {
         val mockPublisher = mock<TelemetryPublisher>()