Use reflection to determine product name and version for Telemetry (#4362)

* Use reflection to determine product name and version for Telemetry

* Fetch plugin metadata for metrics/UA dynamically where possible

* Add logic to dynamically inject AWS user agent per request

Author: breedloj

gradle/libs.versions.toml

@@ -22,7 +22,7 @@ mockito = "5.11.0"
 mockitoKotlin = "5.2.1"
 mockk = "1.13.10"
 node-gradle = "7.0.1"
-telemetryGenerator = "1.0.201"
+telemetryGenerator = "1.0.205"
 testLogger = "4.0.0"
 testRetry = "1.5.2"
 # test-only; platform provides slf4j transitively at runtime. <233, 1.7.36; >=233, 2.0.9

plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/util/UploadArtifact.kt

@@ -22,7 +22,7 @@ import java.net.HttpURLConnection
 private val logger = getLogger<FeatureDevClient>()
 fun uploadArtifactToS3(url: String, fileToUpload: File, checksumSha256: String, contentLength: Long, kmsArn: String?) {
     try {
-        HttpRequests.put(url, APPLICATION_ZIP).userAgent(AwsClientManager.userAgent).tuner {
+        HttpRequests.put(url, APPLICATION_ZIP).userAgent(AwsClientManager.getUserAgent()).tuner {
             it.setRequestProperty("Content-Type", APPLICATION_ZIP)
             it.setRequestProperty("Content-Length", contentLength.toString())
             it.setRequestProperty(CONTENT_SHA256, checksumSha256)

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/client/GumbyClient.kt

@@ -139,7 +139,7 @@ class GumbyClient(private val project: Project) {
      * Adapted from [CodeWhispererCodeScanSession]
      */
     fun uploadArtifactToS3(url: String, fileToUpload: File, checksum: String, kmsArn: String, shouldStop: () -> Boolean) {
-        HttpRequests.put(url, APPLICATION_ZIP).userAgent(AwsClientManager.userAgent).tuner {
+        HttpRequests.put(url, APPLICATION_ZIP).userAgent(AwsClientManager.getUserAgent()).tuner {
             it.setRequestProperty(CONTENT_SHA256, checksum)
             if (kmsArn.isNotEmpty()) {
                 it.setRequestProperty(SERVER_SIDE_ENCRYPTION, AWS_KMS)

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/AwsClientManager.kt

@@ -3,7 +3,6 @@
 
 package software.aws.toolkits.jetbrains.core
 
-import com.intellij.ide.plugins.PluginManager
 import com.intellij.openapi.Disposable
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.application.ApplicationNamesInfo
@@ -30,6 +29,7 @@ import software.aws.toolkits.jetbrains.core.credentials.AwsConnectionManager
 import software.aws.toolkits.jetbrains.core.credentials.CredentialManager
 import software.aws.toolkits.jetbrains.core.credentials.sso.bearer.BearerTokenProviderListener
 import software.aws.toolkits.jetbrains.core.region.AwsRegionProvider
+import software.aws.toolkits.jetbrains.services.telemetry.PluginResolver
 import software.aws.toolkits.jetbrains.settings.AwsSettings
 
 open class AwsClientManager : ToolkitClientManager(), Disposable {
@@ -63,7 +63,7 @@ open class AwsClientManager : ToolkitClientManager(), Disposable {
         )
     }
 
-    override val userAgent = AwsClientManager.userAgent
+    override fun userAgent() = getUserAgent()
 
     override fun dispose() {
         shutdown()
@@ -87,13 +87,16 @@ open class AwsClientManager : ToolkitClientManager(), Disposable {
         @JvmStatic
         fun getInstance(): ToolkitClientManager = service()
 
-        val userAgent: String by lazy {
-            val platformName = tryOrNull { ApplicationNamesInfo.getInstance().fullProductNameWithEdition.replace(' ', '-') }
-            val platformVersion = tryOrNull { ApplicationInfoEx.getInstanceEx().fullVersion.replace(' ', '-') }
-            val pluginVersion = tryOrNull { PluginManager.getPluginByClass(this::class.java)?.version }
-            "AWS-Toolkit-For-JetBrains/$pluginVersion $platformName/$platformVersion ClientId/${AwsSettings.getInstance().clientId}"
+        fun getUserAgent(): String {
+            val pluginResolver = PluginResolver.fromCurrentThread()
+            val pluginName = pluginResolver.product.toString().replace(" ", "-")
+            val pluginVersion = pluginResolver.version
+            return "$pluginName/$pluginVersion $platformName/$platformVersion ClientId/${AwsSettings.getInstance().clientId}"
         }
 
+        private val platformName = tryOrNull { ApplicationNamesInfo.getInstance().fullProductNameWithEdition.replace(' ', '-') }
+        private val platformVersion = tryOrNull { ApplicationInfoEx.getInstanceEx().fullVersion.replace(' ', '-') }
+
         val CUSTOMIZER_EP = ExtensionPointName<ToolkitClientCustomizer>("aws.toolkit.sdk.clientCustomizer")
     }
 }

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/HttpUtils.kt

@@ -9,17 +9,17 @@ import org.apache.http.entity.ContentType
 import java.nio.file.Path
 
 fun saveFileFromUrl(url: String, path: Path, indicator: ProgressIndicator? = null) =
-    HttpRequests.request(url).userAgent(AwsClientManager.userAgent).saveToFile(path.toFile(), indicator)
+    HttpRequests.request(url).userAgent(AwsClientManager.getUserAgent()).saveToFile(path.toFile(), indicator)
 
 fun readBytesFromUrl(url: String, indicator: ProgressIndicator? = null) =
-    HttpRequests.request(url).userAgent(AwsClientManager.userAgent).readBytes(indicator)
+    HttpRequests.request(url).userAgent(AwsClientManager.getUserAgent()).readBytes(indicator)
 
 fun getTextFromUrl(url: String): String =
-    HttpRequests.request(url).userAgent(AwsClientManager.userAgent).readString()
+    HttpRequests.request(url).userAgent(AwsClientManager.getUserAgent()).readString()
 
 fun writeJsonToUrl(url: String, jsonString: String, indicator: ProgressIndicator? = null): String =
     HttpRequests.post(url, ContentType.APPLICATION_JSON.toString())
-        .userAgent(AwsClientManager.userAgent)
+        .userAgent(AwsClientManager.getUserAgent())
         .connect { request ->
             request.write(jsonString)
             request.readString(indicator)

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/telemetry/ClientMetadata.kt

@@ -3,23 +3,28 @@
 
 package software.aws.toolkits.jetbrains.services.telemetry
 
-import com.intellij.ide.plugins.PluginManager
 import com.intellij.openapi.application.ApplicationInfo
 import com.intellij.openapi.application.ApplicationNamesInfo
 import com.intellij.openapi.util.SystemInfo
 import software.amazon.awssdk.services.toolkittelemetry.model.AWSProduct
 import software.aws.toolkits.jetbrains.settings.AwsSettings
 
 data class ClientMetadata(
-    val productName: AWSProduct = AWSProduct.AWS_TOOLKIT_FOR_JET_BRAINS,
-    val productVersion: String = PluginManager.getPluginByClass(this::class.java)?.version.toString(),
+    val awsProduct: AWSProduct,
+    val awsVersion: String,
     val clientId: String = AwsSettings.getInstance().clientId.toString(),
     val parentProduct: String = ApplicationNamesInfo.getInstance().fullProductNameWithEdition,
     val parentProductVersion: String = ApplicationInfo.getInstance().build.baselineVersion.toString(),
     val os: String = SystemInfo.OS_NAME,
     val osVersion: String = SystemInfo.OS_VERSION,
 ) {
     companion object {
-        val DEFAULT_METADATA = ClientMetadata()
+        fun getDefault(): ClientMetadata {
+            val pluginResolver = PluginResolver.fromCurrentThread()
+            return ClientMetadata(
+                awsProduct = pluginResolver.product,
+                awsVersion = pluginResolver.version
+            )
+        }
     }
 }

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/telemetry/DefaultTelemetryPublisher.kt

@@ -9,6 +9,7 @@ import software.amazon.awssdk.auth.credentials.AnonymousCredentialsProvider
 import software.amazon.awssdk.regions.Region
 import software.amazon.awssdk.services.cognitoidentity.CognitoIdentityClient
 import software.amazon.awssdk.services.toolkittelemetry.ToolkitTelemetryClient
+import software.amazon.awssdk.services.toolkittelemetry.model.AWSProduct
 import software.amazon.awssdk.services.toolkittelemetry.model.MetadataEntry
 import software.amazon.awssdk.services.toolkittelemetry.model.MetricDatum
 import software.amazon.awssdk.services.toolkittelemetry.model.Sentiment
@@ -20,34 +21,43 @@ import software.aws.toolkits.jetbrains.core.AwsSdkClient
 import software.aws.toolkits.jetbrains.core.coroutines.getCoroutineBgContext
 
 class DefaultTelemetryPublisher(
-    private val clientMetadata: ClientMetadata = ClientMetadata.DEFAULT_METADATA,
-    private val clientProvider: () -> ToolkitTelemetryClient
+    private val clientProvider: () -> ToolkitTelemetryClient,
+    private val clientMetadataProvider: (AWSProduct, String) -> ClientMetadata
 ) : TelemetryPublisher {
-    constructor() : this(clientProvider = { createDefaultTelemetryClient() })
+    constructor() : this(
+        clientProvider = { createDefaultTelemetryClient() },
+        clientMetadataProvider = { product, version -> ClientMetadata(product, version) }
+    )
 
     private val lazyClient = lazy { clientProvider() }
     private val client by lazyClient
 
     override suspend fun publish(metricEvents: Collection<MetricEvent>) {
         withContext(getCoroutineBgContext()) {
-            client.postMetrics {
-                it.awsProduct(clientMetadata.productName)
-                it.awsProductVersion(clientMetadata.productVersion)
-                it.clientID(clientMetadata.clientId)
-                it.os(clientMetadata.os)
-                it.osVersion(clientMetadata.osVersion)
-                it.parentProduct(clientMetadata.parentProduct)
-                it.parentProductVersion(clientMetadata.parentProductVersion)
-                it.metricData(metricEvents.toMetricData())
-            }
+            metricEvents.groupBy { Pair(it.awsProduct, it.awsVersion) }
+                .forEach { (productName, productVersion), events ->
+                    val clientMetadata = clientMetadataProvider(productName, productVersion)
+                    client.postMetrics {
+                        it.awsProduct(clientMetadata.awsProduct)
+                        it.awsProductVersion(clientMetadata.awsVersion)
+                        it.clientID(clientMetadata.clientId)
+                        it.os(clientMetadata.os)
+                        it.osVersion(clientMetadata.osVersion)
+                        it.parentProduct(clientMetadata.parentProduct)
+                        it.parentProductVersion(clientMetadata.parentProductVersion)
+                        it.metricData(events.toMetricData())
+                    }
+                }
         }
     }
 
     override suspend fun sendFeedback(sentiment: Sentiment, comment: String, metadata: Map<String, String>) {
         withContext(getCoroutineBgContext()) {
+            val pluginResolver = PluginResolver.fromCurrentThread()
+            val clientMetadata = clientMetadataProvider(pluginResolver.product, pluginResolver.version)
             client.postFeedback {
-                it.awsProduct(clientMetadata.productName)
-                it.awsProductVersion(clientMetadata.productVersion)
+                it.awsProduct(clientMetadata.awsProduct)
+                it.awsProductVersion(clientMetadata.awsVersion)
                 it.os(clientMetadata.os)
                 it.osVersion(clientMetadata.osVersion)
                 it.parentProduct(clientMetadata.parentProduct)

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/telemetry/PluginResolver.kt

@@ -0,0 +1,31 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.services.telemetry
+
+import com.intellij.ide.plugins.PluginManagerCore
+import software.amazon.awssdk.services.toolkittelemetry.model.AWSProduct
+
+class PluginResolver private constructor(callerStackTrace: Array<StackTraceElement>) {
+    private val pluginDescriptor by lazy {
+        callerStackTrace
+            .reversed()
+            .filter { it.className.startsWith("software.aws.toolkits") }
+            .firstNotNullOfOrNull { PluginManagerCore.getPluginDescriptorOrPlatformByClassName(it.className) }
+    }
+
+    val product: AWSProduct
+        get() = when (pluginDescriptor?.name) {
+            "amazon.q" -> AWSProduct.AMAZON_Q_FOR_JET_BRAINS
+            else -> AWSProduct.AWS_TOOLKIT_FOR_JET_BRAINS
+        }
+
+    val version: String
+        get() = pluginDescriptor?.version ?: "unknown"
+
+    companion object {
+        fun fromCurrentThread() = PluginResolver(Thread.currentThread().stackTrace)
+
+        fun fromStackTrace(stackTrace: Array<StackTraceElement>) = PluginResolver(stackTrace)
+    }
+}

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

@@ -6,6 +6,7 @@ package software.aws.toolkits.jetbrains.services.telemetry
 import com.intellij.openapi.Disposable
 import com.intellij.openapi.components.service
 import com.intellij.openapi.project.Project
+import software.amazon.awssdk.services.toolkittelemetry.model.AWSProduct
 import software.amazon.awssdk.services.toolkittelemetry.model.Sentiment
 import software.aws.toolkits.core.ConnectionSettings
 import software.aws.toolkits.core.telemetry.DefaultMetricEvent
@@ -26,7 +27,9 @@ import java.util.concurrent.atomic.AtomicBoolean
 
 data class MetricEventMetadata(
     val awsAccount: String = METADATA_NA,
-    val awsRegion: String = METADATA_NA
+    val awsRegion: String = METADATA_NA,
+    var awsProduct: AWSProduct = AWSProduct.AWS_TOOLKIT_FOR_JET_BRAINS,
+    var awsVersion: String = METADATA_NA
 )
 
 interface TelemetryListener {
@@ -49,6 +52,9 @@ abstract class TelemetryService(private val publisher: TelemetryPublisher, priva
             )
             else -> MetricEventMetadata()
         }
+        val pluginResolver = PluginResolver.fromCurrentThread()
+        metricEventMetadata.awsProduct = pluginResolver.product
+        metricEventMetadata.awsVersion = pluginResolver.version
         record(metricEventMetadata, buildEvent)
     }
 
@@ -69,6 +75,9 @@ abstract class TelemetryService(private val publisher: TelemetryPublisher, priva
         } else {
             MetricEventMetadata()
         }
+        val pluginResolver = PluginResolver.fromCurrentThread()
+        metricEventMetadata.awsProduct = pluginResolver.product
+        metricEventMetadata.awsVersion = pluginResolver.version
         record(metricEventMetadata, buildEvent)
     }
 
@@ -102,6 +111,8 @@ abstract class TelemetryService(private val publisher: TelemetryPublisher, priva
         val builder = DefaultMetricEvent.builder()
         builder.awsAccount(metricEventMetadata.awsAccount)
         builder.awsRegion(metricEventMetadata.awsRegion)
+        builder.awsProduct(metricEventMetadata.awsProduct)
+        builder.awsVersion(metricEventMetadata.awsVersion)
 
         buildEvent(builder)