feat: add conversation id on error messages (#4472)

sannicm · web-flow · commit acde0a229375 · 2024-05-16T10:07:18.000-07:00
diff --git a/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/controller/FeatureDevController.kt b/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/controller/FeatureDevController.kt
@@ -220,7 +220,8 @@ class FeatureDevController(
                     tabId = message.tabId,
                     errMessage = message("amazonqFeatureDev.exception.open_diff_failed"),
                     retries = 0,
-                    phase = session.sessionState.phase
+                    phase = session.sessionState.phase,
+                    conversationId = session.conversationIdUnsafe
                 )
             }
         }
@@ -268,7 +269,8 @@ class FeatureDevController(
                 tabId = tabId,
                 errMessage = message ?: message("amazonqFeatureDev.exception.request_failed"),
                 retries = retriesRemaining(session),
-                phase = session?.sessionState?.phase
+                phase = session?.sessionState?.phase,
+                conversationId = session?.conversationIdUnsafe
             )
         }
     }
@@ -284,7 +286,8 @@ class FeatureDevController(
                 tabId = tabId,
                 errMessage = message ?: message("amazonqFeatureDev.exception.request_failed"),
                 retries = retriesRemaining(session),
-                phase = session.sessionState.phase
+                phase = session.sessionState.phase,
+                conversationId = session.conversationIdUnsafe
             )
         }
     }
@@ -353,7 +356,8 @@ class FeatureDevController(
                 tabId = tabId,
                 errMessage = message ?: message("amazonqFeatureDev.exception.insert_code_failed"),
                 retries = retriesRemaining(session),
-                phase = session?.sessionState?.phase
+                phase = session?.sessionState?.phase,
+                conversationId = session?.conversationIdUnsafe
             )
         }
     }
@@ -434,7 +438,8 @@ class FeatureDevController(
                 messenger.sendError(
                     tabId = tabId,
                     errMessage = err.message,
-                    retries = retriesRemaining(session)
+                    retries = retriesRemaining(session),
+                    conversationId = session?.conversationIdUnsafe
                 )
                 messenger.sendSystemPrompt(
                     tabId = tabId,
@@ -450,7 +455,12 @@ class FeatureDevController(
                 messenger.sendMonthlyLimitError(tabId = tabId)
                 messenger.sendChatInputEnabledMessage(tabId, enabled = false)
             } else if (err is PlanIterationLimitError) {
-                messenger.sendError(tabId = tabId, errMessage = err.message, retries = retriesRemaining(session))
+                messenger.sendError(
+                    tabId = tabId,
+                    errMessage = err.message,
+                    retries = retriesRemaining(session),
+                    conversationId = session?.conversationIdUnsafe
+                )
                 messenger.sendSystemPrompt(
                     tabId = tabId,
                     followUp = listOf(
@@ -468,7 +478,12 @@ class FeatureDevController(
                 )
                 messenger.sendUpdatePlaceholder(tabId = tabId, newPlaceholder = message("amazonqFeatureDev.placeholder.after_code_generation"))
             } else if (err is CodeIterationLimitError) {
-                messenger.sendError(tabId = tabId, errMessage = err.message, retries = retriesRemaining(session))
+                messenger.sendError(
+                    tabId = tabId,
+                    errMessage = err.message,
+                    retries = retriesRemaining(session),
+                    conversationId = session?.conversationIdUnsafe
+                )
                 messenger.sendSystemPrompt(
                     tabId = tabId,
                     followUp = listOf(
@@ -486,7 +501,8 @@ class FeatureDevController(
                     tabId = tabId,
                     errMessage = msg ?: message("amazonqFeatureDev.exception.request_failed"),
                     retries = retriesRemaining(session),
-                    phase = session?.sessionState?.phase
+                    phase = session?.sessionState?.phase,
+                    conversationId = session?.conversationIdUnsafe
                 )
             }
 
@@ -558,7 +574,8 @@ class FeatureDevController(
                 tabId = tabId,
                 errMessage = message ?: message("amazonqFeatureDev.exception.retry_request_failed"),
                 retries = retriesRemaining(session),
-                phase = session?.sessionState?.phase
+                phase = session?.sessionState?.phase,
+                conversationId = session?.conversationIdUnsafe,
             )
         } finally {
             // Finish processing the event
diff --git a/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/messages/FeatureDevMessagePublisherExtensions.kt b/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/messages/FeatureDevMessagePublisherExtensions.kt
@@ -118,12 +118,14 @@ suspend fun MessagePublisher.sendChatInputEnabledMessage(tabId: String, enabled:
     this.publish(chatInputEnabledMessage)
 }
 
-suspend fun MessagePublisher.sendError(tabId: String, errMessage: String, retries: Int, phase: SessionStatePhase? = null) {
+suspend fun MessagePublisher.sendError(tabId: String, errMessage: String, retries: Int, phase: SessionStatePhase? = null, conversationId: String? = null) {
+    val conversationIdText = if (conversationId == null) "" else "\n\nConversation ID: **$conversationId**"
+
     if (retries == 0) {
         this.sendAnswer(
             tabId = tabId,
             messageType = FeatureDevMessageType.Answer,
-            message = message("amazonqFeatureDev.no_retries.error_text"),
+            message = message("amazonqFeatureDev.no_retries.error_text") + conversationIdText,
         )
 
         this.sendAnswer(
@@ -145,14 +147,14 @@ suspend fun MessagePublisher.sendError(tabId: String, errMessage: String, retrie
             this.sendErrorMessage(
                 tabId = tabId,
                 title = message("amazonqFeatureDev.approach_gen.error_text"),
-                message = errMessage,
+                message = errMessage + conversationIdText,
             )
         }
         else -> {
             this.sendErrorMessage(
                 tabId = tabId,
                 title = message("amazonqFeatureDev.error_text"),
-                message = errMessage,
+                message = errMessage + conversationIdText,
             )
         }
     }
diff --git a/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/Session.kt b/plugins/amazonq/chat/jetbrains-community/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/Session.kt
@@ -152,6 +152,9 @@ class Session(val tabID: String, val project: Project) {
             }
         }
 
+    val conversationIdUnsafe: String?
+        get() = _conversationId
+
     val sessionState: SessionState
         get() {
             if (_state == null) {

Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,8 @@ class FeatureDevController(`
`220`	`220`	`tabId = message.tabId,`
`221`	`221`	`errMessage = message("amazonqFeatureDev.exception.open_diff_failed"),`
`222`	`222`	`retries = 0,`
`223`		`- phase = session.sessionState.phase`
	`223`	`+ phase = session.sessionState.phase,`
	`224`	`+ conversationId = session.conversationIdUnsafe`
`224`	`225`	`)`
`225`	`226`	`}`
`226`	`227`	`}`
`@@ -268,7 +269,8 @@ class FeatureDevController(`
`268`	`269`	`tabId = tabId,`
`269`	`270`	`errMessage = message ?: message("amazonqFeatureDev.exception.request_failed"),`
`270`	`271`	`retries = retriesRemaining(session),`
`271`		`- phase = session?.sessionState?.phase`
	`272`	`+ phase = session?.sessionState?.phase,`
	`273`	`+ conversationId = session?.conversationIdUnsafe`
`272`	`274`	`)`
`273`	`275`	`}`
`274`	`276`	`}`
`@@ -284,7 +286,8 @@ class FeatureDevController(`
`284`	`286`	`tabId = tabId,`
`285`	`287`	`errMessage = message ?: message("amazonqFeatureDev.exception.request_failed"),`
`286`	`288`	`retries = retriesRemaining(session),`
`287`		`- phase = session.sessionState.phase`
	`289`	`+ phase = session.sessionState.phase,`
	`290`	`+ conversationId = session.conversationIdUnsafe`
`288`	`291`	`)`
`289`	`292`	`}`
`290`	`293`	`}`
`@@ -353,7 +356,8 @@ class FeatureDevController(`
`353`	`356`	`tabId = tabId,`
`354`	`357`	`errMessage = message ?: message("amazonqFeatureDev.exception.insert_code_failed"),`
`355`	`358`	`retries = retriesRemaining(session),`
`356`		`- phase = session?.sessionState?.phase`
	`359`	`+ phase = session?.sessionState?.phase,`
	`360`	`+ conversationId = session?.conversationIdUnsafe`
`357`	`361`	`)`
`358`	`362`	`}`
`359`	`363`	`}`
`@@ -434,7 +438,8 @@ class FeatureDevController(`
`434`	`438`	`messenger.sendError(`
`435`	`439`	`tabId = tabId,`
`436`	`440`	`errMessage = err.message,`
`437`		`- retries = retriesRemaining(session)`
	`441`	`+ retries = retriesRemaining(session),`
	`442`	`+ conversationId = session?.conversationIdUnsafe`
`438`	`443`	`)`
`439`	`444`	`messenger.sendSystemPrompt(`
`440`	`445`	`tabId = tabId,`
`@@ -450,7 +455,12 @@ class FeatureDevController(`
`450`	`455`	`messenger.sendMonthlyLimitError(tabId = tabId)`
`451`	`456`	`messenger.sendChatInputEnabledMessage(tabId, enabled = false)`
`452`	`457`	`} else if (err is PlanIterationLimitError) {`
`453`		`- messenger.sendError(tabId = tabId, errMessage = err.message, retries = retriesRemaining(session))`
	`458`	`+ messenger.sendError(`
	`459`	`+ tabId = tabId,`
	`460`	`+ errMessage = err.message,`
	`461`	`+ retries = retriesRemaining(session),`
	`462`	`+ conversationId = session?.conversationIdUnsafe`
	`463`	`+ )`
`454`	`464`	`messenger.sendSystemPrompt(`
`455`	`465`	`tabId = tabId,`
`456`	`466`	`followUp = listOf(`
`@@ -468,7 +478,12 @@ class FeatureDevController(`
`468`	`478`	`)`
`469`	`479`	`messenger.sendUpdatePlaceholder(tabId = tabId, newPlaceholder = message("amazonqFeatureDev.placeholder.after_code_generation"))`
`470`	`480`	`} else if (err is CodeIterationLimitError) {`
`471`		`- messenger.sendError(tabId = tabId, errMessage = err.message, retries = retriesRemaining(session))`
	`481`	`+ messenger.sendError(`
	`482`	`+ tabId = tabId,`
	`483`	`+ errMessage = err.message,`
	`484`	`+ retries = retriesRemaining(session),`
	`485`	`+ conversationId = session?.conversationIdUnsafe`
	`486`	`+ )`
`472`	`487`	`messenger.sendSystemPrompt(`
`473`	`488`	`tabId = tabId,`
`474`	`489`	`followUp = listOf(`
`@@ -486,7 +501,8 @@ class FeatureDevController(`
`486`	`501`	`tabId = tabId,`
`487`	`502`	`errMessage = msg ?: message("amazonqFeatureDev.exception.request_failed"),`
`488`	`503`	`retries = retriesRemaining(session),`
`489`		`- phase = session?.sessionState?.phase`
	`504`	`+ phase = session?.sessionState?.phase,`
	`505`	`+ conversationId = session?.conversationIdUnsafe`
`490`	`506`	`)`
`491`	`507`	`}`
`492`	`508`
`@@ -558,7 +574,8 @@ class FeatureDevController(`
`558`	`574`	`tabId = tabId,`
`559`	`575`	`errMessage = message ?: message("amazonqFeatureDev.exception.retry_request_failed"),`
`560`	`576`	`retries = retriesRemaining(session),`
`561`		`- phase = session?.sessionState?.phase`
	`577`	`+ phase = session?.sessionState?.phase,`
	`578`	`+ conversationId = session?.conversationIdUnsafe,`
`562`	`579`	`)`
`563`	`580`	`} finally {`
`564`	`581`	`// Finish processing the event`
Original file line number	Diff line number	Diff line change
`@@ -118,12 +118,14 @@ suspend fun MessagePublisher.sendChatInputEnabledMessage(tabId: String, enabled:`
`118`	`118`	`this.publish(chatInputEnabledMessage)`
`119`	`119`	`}`
`120`	`120`
`121`		`-suspend fun MessagePublisher.sendError(tabId: String, errMessage: String, retries: Int, phase: SessionStatePhase? = null) {`
	`121`	`+suspend fun MessagePublisher.sendError(tabId: String, errMessage: String, retries: Int, phase: SessionStatePhase? = null, conversationId: String? = null) {`
	`122`	`+ val conversationIdText = if (conversationId == null) "" else "\n\nConversation ID: $conversationId"`
	`123`	`+`
`122`	`124`	`if (retries == 0) {`
`123`	`125`	`this.sendAnswer(`
`124`	`126`	`tabId = tabId,`
`125`	`127`	`messageType = FeatureDevMessageType.Answer,`
`126`		`- message = message("amazonqFeatureDev.no_retries.error_text"),`
	`128`	`+ message = message("amazonqFeatureDev.no_retries.error_text") + conversationIdText,`
`127`	`129`	`)`
`128`	`130`
`129`	`131`	`this.sendAnswer(`
`@@ -145,14 +147,14 @@ suspend fun MessagePublisher.sendError(tabId: String, errMessage: String, retrie`
`145`	`147`	`this.sendErrorMessage(`
`146`	`148`	`tabId = tabId,`
`147`	`149`	`title = message("amazonqFeatureDev.approach_gen.error_text"),`
`148`		`- message = errMessage,`
	`150`	`+ message = errMessage + conversationIdText,`
`149`	`151`	`)`
`150`	`152`	`}`
`151`	`153`	`else -> {`
`152`	`154`	`this.sendErrorMessage(`
`153`	`155`	`tabId = tabId,`
`154`	`156`	`title = message("amazonqFeatureDev.error_text"),`
`155`		`- message = errMessage,`
	`157`	`+ message = errMessage + conversationIdText,`
`156`	`158`	`)`
`157`	`159`	`}`
`158`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,9 @@ class Session(val tabID: String, val project: Project) {`
`152`	`152`	`}`
`153`	`153`	`}`
`154`	`154`
	`155`	`+ val conversationIdUnsafe: String?`
	`156`	`+ get() = _conversationId`
	`157`	`+`
`155`	`158`	`val sessionState: SessionState`
`156`	`159`	`get() {`
`157`	`160`	`if (_state == null) {`