Update telemetry (#2604)

manodnyab · web-flow · commit 6c60bea81b27 · 2021-05-18T09:51:36.000-07:00
diff --git a/core/src/software/aws/toolkits/core/credentials/CredentialProviderFactory.kt b/core/src/software/aws/toolkits/core/credentials/CredentialProviderFactory.kt
@@ -15,6 +15,11 @@ interface CredentialProviderFactory {
      */
     val id: String
 
+    /**
+     * ID used to indicate where credentials are stored or retrieved from
+     */
+    val credentialSourceId: CredentialSourceId
+
     /**
      * Invoked on creation of the factory to update the credential system with what [CredentialIdentifier] this factory
      * is capable of creating. The provided [credentialLoadCallback] is capable of being invoked multiple times in the case that
diff --git a/core/src/software/aws/toolkits/core/credentials/ToolkitCredentialsProvider.kt b/core/src/software/aws/toolkits/core/credentials/ToolkitCredentialsProvider.kt
@@ -14,6 +14,13 @@ enum class CredentialType {
     SsoProfile
 }
 
+enum class CredentialSourceId {
+    SharedCredentials,
+    SdkStore,
+    Ec2,
+    EnvVars
+}
+
 /**
  * Represents a possible credential provider that can be used within the toolkit.
  *
diff --git a/gradle.properties b/gradle.properties
@@ -16,7 +16,7 @@ awsSdkVersion=2.16.36
 coroutinesVersion=1.3.3
 detektVersion=1.16.0
 jacksonVersion=2.11.1
-telemetryVersion=0.0.96
+telemetryVersion=1.0.3
 commonsMarkVersion=0.17.1
 jgitVersion=5.11.0.202103091610-r
 
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/ChangeConnectionSettingsMenu.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/ChangeConnectionSettingsMenu.kt
@@ -169,9 +169,7 @@ internal class ChangeRegionAction(private val region: AwsRegion) : ToggleAction(
                 )
             }
 
-            AwsTelemetry.setRegion(
-                regionId = region.id
-            )
+            AwsTelemetry.setRegion(e.project)
         }
     }
 }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/CredentialManager.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/CredentialManager.kt
@@ -130,7 +130,10 @@ class DefaultCredentialManager : CredentialManager() {
                         removeProvider(it)
                         count.decrementAndGet()
                     }
-                    AwsTelemetry.loadCredentials(credentialSourceId = providerFactory.id, value = count.get().toDouble())
+                    AwsTelemetry.loadCredentials(
+                        credentialSourceId = providerFactory.credentialSourceId.toTelemetryCredentialSourceId(),
+                        value = count.get().toDouble()
+                    )
                 }
             }
         }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/CredentialSourceId.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/CredentialSourceId.kt
@@ -0,0 +1,15 @@
+// Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.core.credentials
+
+import software.aws.toolkits.core.credentials.CredentialSourceId
+import software.aws.toolkits.telemetry.CredentialSourceId as TelemetryCredentialSourceId
+
+fun CredentialSourceId?.toTelemetryCredentialSourceId(): TelemetryCredentialSourceId = when (this) {
+    CredentialSourceId.SharedCredentials -> TelemetryCredentialSourceId.SharedCredentials
+    CredentialSourceId.SdkStore -> TelemetryCredentialSourceId.SdkStore
+    CredentialSourceId.Ec2 -> TelemetryCredentialSourceId.Ec2
+    CredentialSourceId.EnvVars -> TelemetryCredentialSourceId.EnvVars
+    else -> TelemetryCredentialSourceId.Other
+}
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/profiles/ProfileCredentialProviderFactory.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/core/credentials/profiles/ProfileCredentialProviderFactory.kt
@@ -23,6 +23,7 @@ import software.aws.toolkits.core.ToolkitClientManager
 import software.aws.toolkits.core.credentials.CredentialIdentifier
 import software.aws.toolkits.core.credentials.CredentialIdentifierBase
 import software.aws.toolkits.core.credentials.CredentialProviderFactory
+import software.aws.toolkits.core.credentials.CredentialSourceId
 import software.aws.toolkits.core.credentials.CredentialType
 import software.aws.toolkits.core.credentials.CredentialsChangeEvent
 import software.aws.toolkits.core.credentials.CredentialsChangeListener
@@ -86,6 +87,7 @@ class ProfileCredentialProviderFactory(private val ssoCache: SsoCache = diskCach
     private val profileHolder = ProfileHolder()
 
     override val id = PROFILE_FACTORY_ID
+    override val credentialSourceId: CredentialSourceId = CredentialSourceId.SharedCredentials
 
     override fun setUp(credentialLoadCallback: CredentialsChangeListener) {
         // Load the initial data, then start the background watcher
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/DeleteTagAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/DeleteTagAction.kt
@@ -49,7 +49,7 @@ class DeleteTagAction : ExplorerNodeAction<EcrTagNode>(message("ecr.delete.tag.a
         )
 
         if (response != Messages.OK) {
-            EcrTelemetry.deleteTags(project, Result.Cancelled, selected.size.toDouble())
+            EcrTelemetry.deleteTags(project = project, result = Result.Cancelled, value = selected.size.toDouble())
             return
         }
 
@@ -78,14 +78,14 @@ class DeleteTagAction : ExplorerNodeAction<EcrTagNode>(message("ecr.delete.tag.a
                             content = message("ecr.delete.tag.succeeded", selected.size, repositoryName)
                         )
                         project.refreshAwsTree(EcrResources.listTags(repositoryName))
-                        EcrTelemetry.deleteTags(project, Result.Succeeded, selected.size.toDouble())
+                        EcrTelemetry.deleteTags(project = project, result = Result.Succeeded, value = selected.size.toDouble())
                     } catch (e: Exception) {
                         LOG.error(e) { "Exception thrown while trying to delete ${selected.size} tags" }
                         notifyError(
                             project = project,
                             content = message("ecr.delete.tag.failed", selected.size, repositoryName)
                         )
-                        EcrTelemetry.deleteTags(project, Result.Failed, selected.size.toDouble())
+                        EcrTelemetry.deleteTags(project = project, result = Result.Failed, value = selected.size.toDouble())
                     }
                 }
             }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/PushToRepositoryAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/ecr/actions/PushToRepositoryAction.kt
@@ -45,7 +45,6 @@ import software.amazon.awssdk.services.ecr.EcrClient
 import software.aws.toolkits.core.utils.error
 import software.aws.toolkits.core.utils.getLogger
 import software.aws.toolkits.jetbrains.core.awsClient
-import software.aws.toolkits.jetbrains.core.credentials.activeRegion
 import software.aws.toolkits.jetbrains.core.explorer.ExplorerDataKeys
 import software.aws.toolkits.jetbrains.services.ecr.DockerRunConfiguration
 import software.aws.toolkits.jetbrains.services.ecr.DockerfileEcrPushRequest
@@ -91,7 +90,7 @@ class PushToRepositoryAction :
 
         if (!result) {
             // user cancelled; noop
-            EcrTelemetry.deployImage(project, Result.Cancelled, project.activeRegion().id)
+            EcrTelemetry.deployImage(project, Result.Cancelled)
             return
         }
 
@@ -124,7 +123,6 @@ class PushToRepositoryAction :
                 EcrTelemetry.deployImage(
                     project,
                     result,
-                    regionId = project.activeRegion().id,
                     ecrDeploySource = type
                 )
             }
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/upload/CreateFunctionDialog.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/upload/CreateFunctionDialog.kt
@@ -13,7 +13,6 @@ import org.jetbrains.annotations.TestOnly
 import software.amazon.awssdk.services.lambda.model.PackageType
 import software.amazon.awssdk.services.lambda.model.Runtime
 import software.aws.toolkits.core.lambda.validOrNull
-import software.aws.toolkits.jetbrains.core.credentials.activeRegion
 import software.aws.toolkits.jetbrains.core.explorer.refreshAwsTree
 import software.aws.toolkits.jetbrains.core.help.HelpIds
 import software.aws.toolkits.jetbrains.services.lambda.Lambda.findPsiElementsForHandler
@@ -73,7 +72,6 @@ class CreateFunctionDialog(private val project: Project, private val initialRunt
         LambdaTelemetry.deploy(
             project,
             result = Result.Cancelled,
-            regionId = project.activeRegion().id,
             lambdaPackageType = LambdaPackageType.from(view.configSettings.packageType().toString()),
             initialDeploy = true
         )
@@ -106,11 +104,9 @@ class CreateFunctionDialog(private val project: Project, private val initialRunt
             LambdaTelemetry.deploy(
                 project,
                 result = Result.Succeeded,
-                regionId = project.activeRegion().id,
                 lambdaPackageType = packageType,
                 initialDeploy = true
             )
-
             project.refreshAwsTree(LambdaResources.LIST_FUNCTIONS)
         }
 
@@ -119,7 +115,6 @@ class CreateFunctionDialog(private val project: Project, private val initialRunt
             LambdaTelemetry.deploy(
                 project,
                 result = Result.Failed,
-                regionId = project.activeRegion().id,
                 lambdaPackageType = packageType,
                 initialDeploy = true
             )
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/upload/UpdateFunctionCodeDialog.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/lambda/upload/UpdateFunctionCodeDialog.kt
@@ -11,7 +11,6 @@ import com.intellij.openapi.ui.ValidationInfo
 import com.intellij.util.text.nullize
 import org.jetbrains.annotations.TestOnly
 import software.amazon.awssdk.services.lambda.model.PackageType
-import software.aws.toolkits.jetbrains.core.credentials.activeRegion
 import software.aws.toolkits.jetbrains.core.help.HelpIds
 import software.aws.toolkits.jetbrains.services.lambda.Lambda.findPsiElementsForHandler
 import software.aws.toolkits.jetbrains.services.lambda.LambdaBuilder
@@ -58,7 +57,6 @@ class UpdateFunctionCodeDialog(private val project: Project, private val initial
         LambdaTelemetry.deploy(
             project,
             result = Result.Cancelled,
-            regionId = project.activeRegion().id,
             lambdaPackageType = LambdaPackageType.from(initialSettings.packageType.toString()),
             initialDeploy = false
         )
@@ -88,7 +86,6 @@ class UpdateFunctionCodeDialog(private val project: Project, private val initial
             LambdaTelemetry.deploy(
                 project,
                 result = Result.Succeeded,
-                regionId = project.activeRegion().id,
                 lambdaPackageType = LambdaPackageType.from(initialSettings.packageType.toString()),
                 initialDeploy = false
             )
@@ -99,7 +96,6 @@ class UpdateFunctionCodeDialog(private val project: Project, private val initial
             LambdaTelemetry.deploy(
                 project,
                 result = Result.Failed,
-                regionId = project.activeRegion().id,
                 lambdaPackageType = LambdaPackageType.from(initialSettings.packageType.toString()),
                 initialDeploy = false
             )
diff --git a/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/objectActions/UploadObjectAction.kt b/jetbrains-core/src/software/aws/toolkits/jetbrains/services/s3/objectActions/UploadObjectAction.kt
@@ -70,9 +70,9 @@ fun uploadObjects(project: Project, treeTable: S3TreeTable, files: List<VirtualF
                 }
             }
 
-            S3Telemetry.uploadObjects(project, Result.Succeeded, files.size.toDouble())
+            S3Telemetry.uploadObjects(project = project, result = Result.Succeeded, value = files.size.toDouble())
         } catch (e: Exception) {
-            S3Telemetry.uploadObjects(project, Result.Failed, files.size.toDouble())
+            S3Telemetry.uploadObjects(project = project, result = Result.Failed, value = files.size.toDouble())
         } finally {
             if (changeMade) {
                 treeTable.invalidateLevel(parentNode)
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/core/credentials/CredentialManagerTest.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/core/credentials/CredentialManagerTest.kt
@@ -17,6 +17,7 @@ import software.aws.toolkits.core.credentials.CredentialIdentifier
 import software.aws.toolkits.core.credentials.CredentialIdentifierBase
 import software.aws.toolkits.core.credentials.CredentialProviderFactory
 import software.aws.toolkits.core.credentials.CredentialProviderNotFoundException
+import software.aws.toolkits.core.credentials.CredentialSourceId
 import software.aws.toolkits.core.credentials.CredentialsChangeEvent
 import software.aws.toolkits.core.credentials.CredentialsChangeListener
 import software.aws.toolkits.core.region.AwsRegion
@@ -218,6 +219,7 @@ class CredentialManagerTest {
     ) : CredentialProviderFactory {
         private val credentialsMapping = mutableMapOf<String, TestCredentialProviderIdentifier>()
         private lateinit var callback: CredentialsChangeListener
+        override val credentialSourceId: CredentialSourceId = CredentialSourceId.SharedCredentials
 
         override fun setUp(credentialLoadCallback: CredentialsChangeListener) {
             callback = credentialLoadCallback
diff --git a/jetbrains-core/tst/software/aws/toolkits/jetbrains/core/credentials/MockCredentialsManager.kt b/jetbrains-core/tst/software/aws/toolkits/jetbrains/core/credentials/MockCredentialsManager.kt
@@ -12,6 +12,7 @@ import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider
 import software.aws.toolkits.core.credentials.CredentialIdentifier
 import software.aws.toolkits.core.credentials.CredentialIdentifierBase
 import software.aws.toolkits.core.credentials.CredentialProviderFactory
+import software.aws.toolkits.core.credentials.CredentialSourceId
 import software.aws.toolkits.core.credentials.CredentialsChangeListener
 import software.aws.toolkits.core.credentials.ToolkitCredentialsProvider
 import software.aws.toolkits.core.region.AwsRegion
@@ -76,6 +77,7 @@ class MockCredentialsManager : CredentialManager() {
 
     private object MockCredentialProviderFactory : CredentialProviderFactory {
         override val id: String = "mockCredentialProviderFactory"
+        override val credentialSourceId: CredentialSourceId = CredentialSourceId.SharedCredentials
 
         override fun setUp(credentialLoadCallback: CredentialsChangeListener) {}
 

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,13 @@ enum class CredentialType {`
`14`	`14`	`SsoProfile`
`15`	`15`	`}`
`16`	`16`
	`17`	`+enum class CredentialSourceId {`
	`18`	`+ SharedCredentials,`
	`19`	`+ SdkStore,`
	`20`	`+ Ec2,`
	`21`	`+ EnvVars`
	`22`	`+}`
	`23`	`+`
`17`	`24`	`/**`
`18`	`25`	`* Represents a possible credential provider that can be used within the toolkit.`
`19`	`26`	`*`
Original file line number	Diff line number	Diff line change
`@@ -169,9 +169,7 @@ internal class ChangeRegionAction(private val region: AwsRegion) : ToggleAction(`
`169`	`169`	`)`
`170`	`170`	`}`
`171`	`171`
`172`		`- AwsTelemetry.setRegion(`
`173`		`- regionId = region.id`
`174`		`- )`
	`172`	`+ AwsTelemetry.setRegion(e.project)`
`175`	`173`	`}`
`176`	`174`	`}`
`177`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,10 @@ class DefaultCredentialManager : CredentialManager() {`
`130`	`130`	`removeProvider(it)`
`131`	`131`	`count.decrementAndGet()`
`132`	`132`	`}`
`133`		`- AwsTelemetry.loadCredentials(credentialSourceId = providerFactory.id, value = count.get().toDouble())`
	`133`	`+ AwsTelemetry.loadCredentials(`
	`134`	`+ credentialSourceId = providerFactory.credentialSourceId.toTelemetryCredentialSourceId(),`
	`135`	`+ value = count.get().toDouble()`
	`136`	`+ )`
`134`	`137`	`}`
`135`	`138`	`}`
`136`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class DeleteTagAction : ExplorerNodeAction<EcrTagNode>(message("ecr.delete.tag.a`
`49`	`49`	`)`
`50`	`50`
`51`	`51`	`if (response != Messages.OK) {`
`52`		`- EcrTelemetry.deleteTags(project, Result.Cancelled, selected.size.toDouble())`
	`52`	`+ EcrTelemetry.deleteTags(project = project, result = Result.Cancelled, value = selected.size.toDouble())`
`53`	`53`	`return`
`54`	`54`	`}`
`55`	`55`
`@@ -78,14 +78,14 @@ class DeleteTagAction : ExplorerNodeAction<EcrTagNode>(message("ecr.delete.tag.a`
`78`	`78`	`content = message("ecr.delete.tag.succeeded", selected.size, repositoryName)`
`79`	`79`	`)`
`80`	`80`	`project.refreshAwsTree(EcrResources.listTags(repositoryName))`
`81`		`- EcrTelemetry.deleteTags(project, Result.Succeeded, selected.size.toDouble())`
	`81`	`+ EcrTelemetry.deleteTags(project = project, result = Result.Succeeded, value = selected.size.toDouble())`
`82`	`82`	`} catch (e: Exception) {`
`83`	`83`	`LOG.error(e) { "Exception thrown while trying to delete ${selected.size} tags" }`
`84`	`84`	`notifyError(`
`85`	`85`	`project = project,`
`86`	`86`	`content = message("ecr.delete.tag.failed", selected.size, repositoryName)`
`87`	`87`	`)`
`88`		`- EcrTelemetry.deleteTags(project, Result.Failed, selected.size.toDouble())`
	`88`	`+ EcrTelemetry.deleteTags(project = project, result = Result.Failed, value = selected.size.toDouble())`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`	`}`