refactor(amazonq): refactor, remove shortAnswer to suit the API changes, display the plan summary to the customer #5453

Randall-Jiang · 2025-03-07T01:55:10Z

Problem

Before re:Invent, we used shortAnswer to pass data such as the test file path. However, this approach is unreliable in a long term. To improve stability, we decided to refactor the backend API by replacing shortAnswer with packageInfo and targetFileInfo. These new fields will now carry the values previously stored in shortAnswer, ensuring a more structured and reliable data transfer mechanism.

Solution

Remove the shortAnswer and replace it with packageInfo and targetFileInfo.

To-Do

Handle the situation when status == stopped.

Checklist

My code follows the code style of this project
I have added tests to cover my changes
A short description of the change has been added to the CHANGELOG if the change is customer-facing in the IDE.
I have added metrics for my changes (if required)

License

I confirm that my contribution is made under the terms of the Apache 2.0 license.

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

...c/software/aws/toolkits/jetbrains/services/amazonqCodeTest/model/PackageAndTargetFileInfo.kt

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

samgst-amazon · 2025-03-10T22:35:47Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

                }

+                // TO DO
+                // add TestGenerationJobStatus.STOPPED status
+
                // If job status is Failed and has no ShortAnswer then there might be some issue in the backend.


is this still true?

no, i think that is no in to-do any more

Yeah we can remove this comment

laileni-aws · 2025-03-11T19:40:28Z

.changes/next-release/removal-b760081f-faf1-4fc9-8bea-4dc39c36dc7d.json

@@ -0,0 +1,4 @@
+{


We don't need change log for this IMO.

Better to add change log for Plan summary

laileni-aws · 2025-03-11T19:42:17Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

-                                footer = listOf(testFileName)
-                            ),
-                            messageIdOverride = codeTestResponseContext.testSummaryMessageId
+                var packageInfoList = testGenerationResponse.testGenerationJob().packageInfoList()


packageInfoList is declared at L176

laileni-aws · 2025-03-11T19:50:34Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

-                        throw CodeTestException("TestGenFailedError: ${shortAnswer.planSummary}", "TestGenFailedError", shortAnswer.planSummary)
-                    }
+
+                val packageInfoList = testGenerationResponse.testGenerationJob().packageInfoList()


Why we are declaring this again? Any specific reason.

previously the L176 declaration is not the correct one, will remove this in the new commit

laileni-aws · 2025-03-11T19:52:37Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

                }

+                // TO DO


QQ: Do we have TestGenerationJobStatus.STOPPED field from backend?

laileni-aws · 2025-03-11T19:53:29Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

-                    if (shortAnswer.stopIteration == "true") {
-                        throw CodeTestException("TestGenFailedError: ${shortAnswer.planSummary}", "TestGenFailedError", shortAnswer.planSummary)
+                if (previousIterationContext == null) {
+                    val packageInfoList = testGenerationResponse.testGenerationJob().packageInfoList()


Can we declare these variables globally to the function?

laileni-aws · 2025-03-11T19:55:40Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

+                                )
+                            }
+                        } catch (e: Exception) {
+                            LOG.debug("failed to process package info: ${e.message}")


This Log does not give good insight to the user and developer to debug.

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

laileni-aws · 2025-03-11T20:01:34Z

...ns-community/src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/session/Session.kt

@@ -37,14 +37,18 @@ data class Session(val tabId: String) {
    // First iteration will have a value of 1
    var iteration: Int = 0
    var projectRoot: String = "/"
-    var shortAnswer: ShortAnswer = ShortAnswer()
+
+    // var shortAnswer: ShortAnswer = ShortAnswer()


Remove commented code

laileni-aws · 2025-03-12T00:26:34Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

            }
-
-            // polling every 2 seconds to reduce # of API calls


Can you include this comment

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

laileni-aws · 2025-03-12T00:29:20Z

...ns-community/src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/session/Session.kt

    var selectedFile: VirtualFile? = null
    var testFileRelativePathToProjectRoot: String = ""
    var testFileName: String = ""
    var viewDiffMessageId: String? = null
    var openedDiffFile: VirtualFile? = null
    val generatedTestDiffs = mutableMapOf<String, String>()
-    var codeReferences: List<ShortAnswerReference>? = null
+


unnecessary line

laileni-aws · 2025-03-12T00:30:57Z

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

+                    .replace(Regex("\\s*```$"), "") // Remove trailing triple backticks
+                    .trim()
+
+                val fullMessage = """


Rename fullMessage to summary or something relevant.

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt

rli · 2025-03-12T04:38:34Z

plugins/core/sdk-codegen/codegen-resources/codewhispererruntime/service-2.json

can we figure out why this keeps happening?

rli · 2025-03-12T05:15:56Z

.changes/next-release/feature-862af662-3a71-4203-aa1b-bfa41af24b42.json

@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "display plan summary to customer"


changelogs do not meet bar for what will be shown to customer

laileni-aws · 2025-03-12T18:18:10Z

.changes/next-release/feature-862af662-3a71-4203-aa1b-bfa41af24b42.json

@@ -0,0 +1,4 @@
+{
+  "type" : "feature",
+  "description" : "Amazonq /test now display the plan summary to customer"


AmazonQ /test now displays a concise test plan summary to users.

API refactor

5361d63

github-advanced-security bot found potential problems Mar 7, 2025

View reviewed changes

Randall-Jiang changed the title ~~(feat) API refactor~~ refactor(amazonQ): refactor, remove shortAnswer to suit the API changes Mar 8, 2025

Randall-Jiang added 2 commits March 7, 2025 17:55

update the code

3994d40

add contribution file

8d8742e

Randall-Jiang changed the title ~~refactor(amazonQ): refactor, remove shortAnswer to suit the API changes~~ refactor(amazonq): refactor, remove shortAnswer to suit the API changes Mar 8, 2025

Randall-Jiang marked this pull request as ready for review March 8, 2025 01:59

Randall-Jiang requested review from a team as code owners March 8, 2025 01:59

github-advanced-security bot found potential problems Mar 8, 2025

View reviewed changes

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt Fixed Show fixed Hide fixed

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt Fixed Show fixed Hide fixed

Randall-Jiang marked this pull request as draft March 10, 2025 17:44

Randall-Jiang closed this Mar 10, 2025

Randall-Jiang reopened this Mar 10, 2025

Randall-Jiang marked this pull request as ready for review March 10, 2025 17:45

correct the Endpoint

e8cee82

Randall-Jiang force-pushed the API-refactor branch from 83c52fc to e8cee82 Compare March 10, 2025 17:54

Randall-Jiang added 2 commits March 10, 2025 14:54

add plan summary to the card

af58afe

remove the unused command

8c9e332

samgst-amazon reviewed Mar 10, 2025

View reviewed changes

Randall-Jiang added 3 commits March 11, 2025 11:10

formatting the plan summary

759854d

nit change

42b2a19

nit

937e251

laileni-aws reviewed Mar 11, 2025

View reviewed changes

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt Show resolved Hide resolved

laileni-aws reviewed Mar 11, 2025

View reviewed changes

Randall-Jiang added 3 commits March 11, 2025 15:55

address comment

7eb362f

remove unused comment

7a7e442

add changelog

63fb0ed

Randall-Jiang changed the title ~~refactor(amazonq): refactor, remove shortAnswer to suit the API changes~~ refactor(amazonq): refactor, remove shortAnswer to suit the API changes, display the plan summary to the customer Mar 11, 2025

address comment

f1d44db

Randall-Jiang force-pushed the API-refactor branch from 7507e97 to f1d44db Compare March 12, 2025 00:07

laileni-aws reviewed Mar 12, 2025

View reviewed changes

.../src/software/aws/toolkits/jetbrains/services/amazonqCodeTest/CodeWhispererUTGChatManager.kt Show resolved Hide resolved

laileni-aws reviewed Mar 12, 2025

View reviewed changes

put the short answer method to plain text

3480d4c

Randall-Jiang force-pushed the API-refactor branch from 9a03a36 to 3480d4c Compare March 12, 2025 00:39

address comment

3386c28

laileni-aws approved these changes Mar 12, 2025

View reviewed changes

laileni-aws requested a review from samgst-amazon March 12, 2025 00:52

github-advanced-security bot found potential problems Mar 12, 2025

View reviewed changes

rli reviewed Mar 12, 2025

View reviewed changes

plugins/core/sdk-codegen/codegen-resources/codewhispererruntime/service-2.json Outdated

Copy link

Contributor

rli Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we figure out why this keeps happening?

rli reviewed Mar 12, 2025

View reviewed changes

laileni-aws reviewed Mar 12, 2025

View reviewed changes

laileni-aws requested a review from rli March 12, 2025 18:20

formatting the service-2 json to remove extra space

c01a48d

Randall-Jiang force-pushed the API-refactor branch from 14cd758 to c01a48d Compare March 12, 2025 19:31

Randall-Jiang added 2 commits March 12, 2025 12:33

fix lint issue

028a051

remove the redundant qualifier name

650c45f

Randall-Jiang force-pushed the API-refactor branch from c904a51 to 650c45f Compare March 12, 2025 20:24

fix indenting issue

465676f

Randall-Jiang force-pushed the API-refactor branch from 2e82a65 to 465676f Compare March 12, 2025 20:44

Randall-Jiang added 2 commits March 12, 2025 13:45

Delete the wrong changelog

3b8568f

Update the changeLog

cc2bcf9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(amazonq): refactor, remove shortAnswer to suit the API changes, display the plan summary to the customer #5453

refactor(amazonq): refactor, remove shortAnswer to suit the API changes, display the plan summary to the customer #5453

Randall-Jiang commented Mar 7, 2025 •

edited by laileni-aws

Loading

samgst-amazon Mar 10, 2025

Randall-Jiang Mar 11, 2025

laileni-aws Mar 11, 2025

laileni-aws Mar 11, 2025

laileni-aws Mar 11, 2025

laileni-aws Mar 11, 2025

laileni-aws Mar 11, 2025 •

edited

Loading

Randall-Jiang Mar 11, 2025

laileni-aws Mar 11, 2025

laileni-aws Mar 11, 2025 •

edited

Loading

laileni-aws Mar 11, 2025

laileni-aws Mar 11, 2025

laileni-aws Mar 12, 2025

laileni-aws Mar 12, 2025

laileni-aws Mar 12, 2025

rli Mar 12, 2025

rli Mar 12, 2025

laileni-aws Mar 12, 2025

refactor(amazonq): refactor, remove shortAnswer to suit the API changes, display the plan summary to the customer #5453

Are you sure you want to change the base?

refactor(amazonq): refactor, remove shortAnswer to suit the API changes, display the plan summary to the customer #5453

Conversation

Randall-Jiang commented Mar 7, 2025 • edited by laileni-aws Loading

Problem

Solution

To-Do

Checklist

License

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laileni-aws Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laileni-aws Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Randall-Jiang commented Mar 7, 2025 •

edited by laileni-aws

Loading

laileni-aws Mar 11, 2025 •

edited

Loading

laileni-aws Mar 11, 2025 •

edited

Loading