feat(amazonq): show users estimated cost of /transform (aws#4767)

* feat(amazonq): show users estimated cost of /transform

* fix Lint

* remove unused imports

* fix Lint

* localize string

* add unit test

* update LOC threshold to 100K

* escape apostrophe to pass test

* escape apostrophe in text

* escape apostrophe correctly

* update text

* fix typo

* update unit test

* address comment

* move constant

* put constants together

---------

Co-authored-by: David Hasani <davhasan@amazon.com>

Author: dhasani23

.changes/next-release/feature-aad3e6d1-c259-4f42-ae2a-be2096853095.json

@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "feat(Amazon Q Code Transformation): show pro tier users estimated cost of /transform on projects over 100K lines"
+}

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

@@ -8,16 +8,13 @@ import com.intellij.openapi.components.service
 import com.intellij.openapi.project.Project
 import org.apache.commons.codec.digest.DigestUtils
 import software.amazon.awssdk.services.codewhispererruntime.model.TransformationStatus
-import software.aws.toolkits.jetbrains.core.gettingstarted.editor.ActiveConnection
-import software.aws.toolkits.jetbrains.core.gettingstarted.editor.ActiveConnectionType
-import software.aws.toolkits.jetbrains.core.gettingstarted.editor.BearerTokenFeatureSet
-import software.aws.toolkits.jetbrains.core.gettingstarted.editor.checkBearerConnectionValidity
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.CustomerSelection
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.JobId
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.ValidationResult
 import software.aws.toolkits.jetbrains.services.codemodernizer.state.CodeModernizerSessionState
 import software.aws.toolkits.jetbrains.services.codemodernizer.state.CodeTransformTelemetryState
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.calculateTotalLatency
+import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getAuthType
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getJavaVersionFromProjectSetting
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getMavenVersion
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.tryGetJdk
@@ -32,7 +29,6 @@ import software.aws.toolkits.telemetry.CodeTransformPatchViewerCancelSrcComponen
 import software.aws.toolkits.telemetry.CodeTransformPreValidationError
 import software.aws.toolkits.telemetry.CodeTransformVCSViewerSrcComponents
 import software.aws.toolkits.telemetry.CodetransformTelemetry
-import software.aws.toolkits.telemetry.CredentialSourceId
 import software.aws.toolkits.telemetry.Result
 import java.time.Instant
 import java.util.Base64
@@ -157,31 +153,17 @@ class CodeTransformTelemetryManager(private val project: Project) {
     fun dependenciesCopied() = CodetransformTelemetry.dependenciesCopied(codeTransformSessionId = sessionId)
 
     fun jobIsStartedFromChatPrompt() {
-        val connection = checkBearerConnectionValidity(project, BearerTokenFeatureSet.Q)
-        var authType: CredentialSourceId? = null
-        if (connection.connectionType == ActiveConnectionType.IAM_IDC && connection is ActiveConnection.ValidBearer) {
-            authType = CredentialSourceId.IamIdentityCenter
-        } else if (connection.connectionType == ActiveConnectionType.BUILDER_ID && connection is ActiveConnection.ValidBearer) {
-            authType = CredentialSourceId.AwsId
-        }
-        CodetransformTelemetry.jobIsStartedFromChatPrompt(codeTransformSessionId = sessionId, credentialSourceId = authType)
+        CodetransformTelemetry.jobIsStartedFromChatPrompt(codeTransformSessionId = sessionId, credentialSourceId = getAuthType(project))
     }
 
     /**
      * END - DEPRECATED METRICS (below are new metrics to keep)
      */
 
     fun initiateTransform(telemetryErrorMessage: String? = null) {
-        val connection = checkBearerConnectionValidity(project, BearerTokenFeatureSet.Q)
-        var authType: CredentialSourceId? = null
-        if (connection.connectionType == ActiveConnectionType.IAM_IDC && connection is ActiveConnection.ValidBearer) {
-            authType = CredentialSourceId.IamIdentityCenter
-        } else if (connection.connectionType == ActiveConnectionType.BUILDER_ID && connection is ActiveConnection.ValidBearer) {
-            authType = CredentialSourceId.AwsId
-        }
         CodetransformTelemetry.initiateTransform(
             codeTransformSessionId = sessionId,
-            credentialSourceId = authType,
+            credentialSourceId = getAuthType(project),
             result = if (telemetryErrorMessage.isNullOrEmpty()) Result.Succeeded else Result.Failed,
             reason = telemetryErrorMessage,
         )

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/constants/CodeModernizerUIConstants.kt

@@ -15,6 +15,11 @@ import javax.swing.BorderFactory
 
 const val FEATURE_NAME = "Amazon Q Transform"
 
+const val APPENDIX_TABLE_KEY = "-1"
+const val JOB_STATISTICS_TABLE_KEY = "0"
+const val LOC_THRESHOLD = 100000
+const val BILLING_RATE = 0.003
+
 class CodeModernizerUIConstants {
 
     object HEADER {

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/plan/CodeModernizerPlanEditor.kt

@@ -18,12 +18,18 @@ import com.intellij.ui.components.JBScrollPane
 import icons.AwsIcons
 import software.amazon.awssdk.services.codewhispererruntime.model.TransformationPlan
 import software.amazon.awssdk.services.codewhispererruntime.model.TransformationStep
+import software.aws.toolkits.jetbrains.services.codemodernizer.constants.APPENDIX_TABLE_KEY
 import software.aws.toolkits.jetbrains.services.codemodernizer.constants.CodeModernizerUIConstants
+import software.aws.toolkits.jetbrains.services.codemodernizer.constants.JOB_STATISTICS_TABLE_KEY
+import software.aws.toolkits.jetbrains.services.codemodernizer.constants.LOC_THRESHOLD
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.PlanTable
 import software.aws.toolkits.jetbrains.services.codemodernizer.plan.CodeModernizerPlanEditorProvider.Companion.MIGRATION_PLAN_KEY
+import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getAuthType
+import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getBillingText
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getTableMapping
 import software.aws.toolkits.jetbrains.services.codewhisperer.layout.CodeWhispererLayoutConfig.addHorizontalGlue
 import software.aws.toolkits.resources.message
+import software.aws.toolkits.telemetry.CredentialSourceId
 import java.awt.BorderLayout
 import java.awt.Color
 import java.awt.Component
@@ -51,9 +57,9 @@ import javax.swing.event.HyperlinkEvent
 import javax.swing.table.DefaultTableCellRenderer
 import javax.swing.table.DefaultTableModel
 
-class CodeModernizerPlanEditor(val project: Project, val virtualFile: VirtualFile) : UserDataHolderBase(), FileEditor {
+class CodeModernizerPlanEditor(val project: Project, private val virtualFile: VirtualFile) : UserDataHolderBase(), FileEditor {
     val plan = virtualFile.getUserData(MIGRATION_PLAN_KEY) ?: throw RuntimeException("Migration plan not found")
-    val tableMapping =
+    private val tableMapping =
         if (!plan.transformationSteps()[0].progressUpdates().isNullOrEmpty()) {
             getTableMapping(plan.transformationSteps()[0].progressUpdates())
         } else {
@@ -72,17 +78,39 @@ class CodeModernizerPlanEditor(val project: Project, val virtualFile: VirtualFil
                     )
                     // key "0" reserved for job statistics table
                     // comes from "name" field of each progressUpdate in step zero of plan
-                    if ("0" in tableMapping) {
+                    if (JOB_STATISTICS_TABLE_KEY in tableMapping) {
+                        val planTable = mapper.readValue(tableMapping[JOB_STATISTICS_TABLE_KEY], PlanTable::class.java)
+                        val linesOfCode = planTable.rows.find { it.name == "linesOfCode" }?.value?.toInt()
+                        if (linesOfCode != null && linesOfCode > LOC_THRESHOLD && getAuthType(project) == CredentialSourceId.IamIdentityCenter) {
+                            val billingText = getBillingText(linesOfCode)
+                            val billingTextComponent =
+                                JEditorPane("text/html", billingText).apply {
+                                    addHyperlinkListener { he ->
+                                        if (he.eventType == HyperlinkEvent.EventType.ACTIVATED) {
+                                            BrowserUtil.browse(he.url)
+                                        }
+                                    }
+                                    isEditable = false
+                                    isOpaque = false
+                                    alignmentX = Component.LEFT_ALIGNMENT
+                                    font =
+                                        font.deriveFont(
+                                            CodeModernizerUIConstants.FONT_CONSTRAINTS.BOLD,
+                                            CodeModernizerUIConstants.PLAN_CONSTRAINTS.SUBTITLE_FONT_SIZE,
+                                        )
+                                }
+                            add(billingTextComponent, CodeModernizerUIConstants.transformationPlanPlaneConstraint)
+                        }
                         add(
-                            transformationPlanInfo(mapper.readValue(tableMapping["0"], PlanTable::class.java)),
+                            transformationPlanInfo(planTable),
                             CodeModernizerUIConstants.transformationPlanPlaneConstraint,
                         )
                     }
                     add(transformationPlanPanel(plan), CodeModernizerUIConstants.transformationPlanPlaneConstraint)
                     // key "-1" reserved for appendix table
-                    if ("-1" in tableMapping) {
+                    if (APPENDIX_TABLE_KEY in tableMapping) {
                         add(
-                            transformationPlanAppendix(mapper.readValue(tableMapping["-1"], PlanTable::class.java)),
+                            transformationPlanAppendix(mapper.readValue(tableMapping[APPENDIX_TABLE_KEY], PlanTable::class.java)),
                             CodeModernizerUIConstants.transformationPlanPlaneConstraint,
                         )
                     }

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/utils/CodeTransformApiUtils.kt

@@ -21,9 +21,12 @@ import software.aws.toolkits.core.utils.WaiterUnrecoverableException
 import software.aws.toolkits.core.utils.Waiters.waitUntil
 import software.aws.toolkits.jetbrains.services.codemodernizer.CodeTransformTelemetryManager
 import software.aws.toolkits.jetbrains.services.codemodernizer.client.GumbyClient
+import software.aws.toolkits.jetbrains.services.codemodernizer.constants.BILLING_RATE
 import software.aws.toolkits.jetbrains.services.codemodernizer.model.JobId
+import software.aws.toolkits.resources.message
 import java.lang.Thread.sleep
 import java.time.Duration
+import java.util.Locale
 import java.util.concurrent.atomic.AtomicBoolean
 
 data class PollingResult(
@@ -128,3 +131,8 @@ suspend fun JobId.pollTransformationStatusAndPlan(
 fun getTableMapping(stepZeroProgressUpdates: List<TransformationProgressUpdate>) = stepZeroProgressUpdates.associate {
     it.name() to it.description()
 }
+
+fun getBillingText(linesOfCode: Int): String {
+    val estimatedCost = String.format(Locale.US, "%.2f", linesOfCode.times(BILLING_RATE))
+    return message("codemodernizer.migration_plan.header.billing_text", linesOfCode, BILLING_RATE, estimatedCost)
+}

plugins/amazonq/codetransform/jetbrains-community/src/software/aws/toolkits/jetbrains/services/codemodernizer/utils/CodeTransformUtils.kt

@@ -13,8 +13,13 @@ import software.aws.toolkits.jetbrains.core.credentials.AwsBearerTokenConnection
 import software.aws.toolkits.jetbrains.core.credentials.ToolkitConnectionManager
 import software.aws.toolkits.jetbrains.core.credentials.pinning.QConnection
 import software.aws.toolkits.jetbrains.core.credentials.sso.bearer.BearerTokenProvider
+import software.aws.toolkits.jetbrains.core.gettingstarted.editor.ActiveConnection
+import software.aws.toolkits.jetbrains.core.gettingstarted.editor.ActiveConnectionType
+import software.aws.toolkits.jetbrains.core.gettingstarted.editor.BearerTokenFeatureSet
+import software.aws.toolkits.jetbrains.core.gettingstarted.editor.checkBearerConnectionValidity
 import software.aws.toolkits.jetbrains.utils.actions.OpenBrowserAction
 import software.aws.toolkits.resources.message
+import software.aws.toolkits.telemetry.CredentialSourceId
 
 val STATES_WHERE_PLAN_EXIST = setOf(
     TransformationStatus.PLANNED,
@@ -44,6 +49,17 @@ fun refreshToken(project: Project) {
     provider.refresh()
 }
 
+fun getAuthType(project: Project): CredentialSourceId? {
+    val connection = checkBearerConnectionValidity(project, BearerTokenFeatureSet.Q)
+    var authType: CredentialSourceId? = null
+    if (connection.connectionType == ActiveConnectionType.IAM_IDC && connection is ActiveConnection.ValidBearer) {
+        authType = CredentialSourceId.IamIdentityCenter
+    } else if (connection.connectionType == ActiveConnectionType.BUILDER_ID && connection is ActiveConnection.ValidBearer) {
+        authType = CredentialSourceId.AwsId
+    }
+    return authType
+}
+
 fun getQTokenProvider(project: Project) = (
     ToolkitConnectionManager
         .getInstance(project)

plugins/amazonq/codetransform/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/codemodernizer/CodeWhispererCodeModernizerUtilsTest.kt

@@ -19,6 +19,7 @@ import software.amazon.awssdk.services.codewhispererruntime.model.AccessDeniedEx
 import software.amazon.awssdk.services.codewhispererruntime.model.TransformationProgressUpdate
 import software.amazon.awssdk.services.codewhispererruntime.model.TransformationStatus
 import software.amazon.awssdk.services.ssooidc.model.InvalidGrantException
+import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getBillingText
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.getTableMapping
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.pollTransformationStatusAndPlan
 import software.aws.toolkits.jetbrains.services.codemodernizer.utils.refreshToken
@@ -204,4 +205,16 @@ class CodeWhispererCodeModernizerUtilsTest : CodeWhispererCodeModernizerTestBase
         val expected = mapOf("0" to jobStats, "1" to depChanges, "2" to apiChanges, "-1" to fileChanges)
         assertThat(expected).isEqualTo(actual)
     }
+
+    @Test
+    fun `getBillingText on small project returns correct String`() {
+        val expected = "<html><body style=\"line-height:2; font-family: Arial, sans-serif; font-size: 14;\"><br>" +
+            "376 lines of code were submitted for transformation. If you reach the quota for lines of code included " +
+            "in your subscription, you will be charged $0.003 for each additional line of code. You might be charged up " +
+            "to $1.13 for this transformation. To avoid being charged, stop the transformation job before it completes. " +
+            "For more information on pricing and quotas, see <a href=\"https://aws.amazon.com/q/developer/pricing/\">" +
+            "Amazon Q Developer pricing</a>.</p>"
+        val actual = getBillingText(376)
+        assertThat(expected).isEqualTo(actual)
+    }
 }

plugins/core/resources/resources/software/aws/toolkits/resources/MessagesBundle.properties

@@ -668,6 +668,7 @@ codemodernizer.migration_plan.body.steps_intro_title=Planned transformation chan
 codemodernizer.migration_plan.body.steps_name=<html><body>{0}</body></html>
 codemodernizer.migration_plan.body.steps_scroll_top=<html><body style="font-family: Arial, sans-serif; font-size: 14;"><a href="#top">Scroll to top</a></body></html>
 codemodernizer.migration_plan.header.awsq=<html><body style="line-height:2; font-family: Arial, sans-serif; font-size: 14;">Amazon Q reviewed your code and generated a transformation plan. Amazon Q will suggest code changes according to the plan, and you can review the updated code before accepting changes to your files.</body></html>
+codemodernizer.migration_plan.header.billing_text=<html><body style="line-height:2; font-family: Arial, sans-serif; font-size: 14;"><br>{0} lines of code were submitted for transformation. If you reach the quota for lines of code included in your subscription, you will be charged ${1} for each additional line of code. You might be charged up to ${2} for this transformation. To avoid being charged, stop the transformation job before it completes. For more information on pricing and quotas, see <a href="https://aws.amazon.com/q/developer/pricing/">Amazon Q Developer pricing</a>.</p>
 codemodernizer.migration_plan.header.description=Plan to Transform your project
 codemodernizer.migration_plan.header.title=Code Transformation plan by Amazon Q
 codemodernizer.migration_plan.substeps.description_failed=Build failed