-
Notifications
You must be signed in to change notification settings - Fork 241
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Emit telemetry change event before persisting setting (#4637)
- Loading branch information
Showing
2 changed files
with
76 additions
and
1 deletion.
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
75 changes: 75 additions & 0 deletions
75
.../core/jetbrains-community/tst/software/aws/toolkits/jetbrains/settings/AwsSettingsTest.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,75 @@ | ||
// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package software.aws.toolkits.jetbrains.settings | ||
|
||
import com.intellij.openapi.application.ApplicationManager | ||
import com.intellij.testFramework.DisposableRule | ||
import com.intellij.testFramework.ProjectRule | ||
import com.intellij.testFramework.replaceService | ||
import org.assertj.core.api.Assertions.assertThat | ||
import org.junit.Rule | ||
import org.junit.jupiter.api.BeforeEach | ||
import org.junit.jupiter.api.Test | ||
import org.mockito.kotlin.argumentCaptor | ||
import org.mockito.kotlin.inOrder | ||
import org.mockito.kotlin.mock | ||
import org.mockito.kotlin.spy | ||
import software.aws.toolkits.core.telemetry.TelemetryBatcher | ||
import software.aws.toolkits.core.telemetry.TelemetryPublisher | ||
import software.aws.toolkits.jetbrains.services.telemetry.NoOpPublisher | ||
import software.aws.toolkits.jetbrains.services.telemetry.TelemetryService | ||
|
||
class AwsSettingsTest { | ||
private class TestTelemetryService( | ||
publisher: TelemetryPublisher = NoOpPublisher(), | ||
batcher: TelemetryBatcher | ||
) : TelemetryService(publisher, batcher) | ||
|
||
@Rule | ||
@JvmField | ||
val projectRule = ProjectRule() | ||
|
||
@Rule | ||
@JvmField | ||
val disposableRule = DisposableRule() | ||
|
||
private lateinit var telemetryService: TelemetryService | ||
private lateinit var batcher: TelemetryBatcher | ||
private lateinit var awsSettings: DefaultAwsSettings | ||
private lateinit var awsConfiguration: AwsConfiguration | ||
|
||
@BeforeEach | ||
fun setup() { | ||
batcher = mock() | ||
telemetryService = spy(TestTelemetryService(batcher = batcher)) | ||
awsSettings = spy(DefaultAwsSettings()) | ||
awsConfiguration = spy(AwsConfiguration()) | ||
awsSettings.loadState(awsConfiguration) | ||
ApplicationManager.getApplication().replaceService(TelemetryService::class.java, telemetryService, disposableRule.disposable) | ||
ApplicationManager.getApplication().replaceService(AwsSettings::class.java, awsSettings, disposableRule.disposable) | ||
} | ||
|
||
@Test | ||
fun `telemetry event batched before setting isTelemetryEnabled to false`() { | ||
verifyTelemetryEventOrder(false) | ||
} | ||
|
||
@Test | ||
fun `telemetry event batched before setting isTelemetryEnabled to true`() { | ||
verifyTelemetryEventOrder(true) | ||
} | ||
|
||
private fun verifyTelemetryEventOrder(value: Boolean) { | ||
val inOrder = inOrder(telemetryService, batcher, awsConfiguration) | ||
val changeCaptor = argumentCaptor<Boolean>() | ||
val onChangeEventCaptor = argumentCaptor<(Boolean) -> Unit>() | ||
|
||
AwsSettings.getInstance().isTelemetryEnabled = value | ||
|
||
inOrder.verify(telemetryService).setTelemetryEnabled(changeCaptor.capture(), onChangeEventCaptor.capture()) | ||
assertThat(changeCaptor.firstValue).isEqualTo(value) | ||
inOrder.verify(batcher).onTelemetryEnabledChanged(value, onChangeEventCaptor.firstValue) | ||
inOrder.verify(awsConfiguration).isTelemetryEnabled = value | ||
} | ||
} |