feat: add code reference handling to featureDev (#1831)

featureDev, a.k.a /dev in amazonq has two moments where references are handled. One, when it is shown in the diff view chat component, where all references are listed for the customer to see. Two, when the customer accepts code generation where these references are stored in the general chat session.

This PR is adding a storage for the reference logs and also sending the references to the chat view with the formatting that /dev expects.

Author: sannicm

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/controller/FeatureDevController.kt

@@ -257,16 +257,18 @@ class FeatureDevController(
             AmazonqTelemetry.isAcceptedCodeChanges(amazonqConversationId = session.conversationId, enabled = true)
 
             var filePaths: List<NewFileZipInfo> = emptyList()
-            var deletedFiles: Array<String> = emptyArray()
+            var deletedFiles: List<String> = emptyList()
+            var references: List<CodeReference> = emptyList()
 
             when (val state = session.sessionState) {
                 is PrepareCodeGenerationState -> {
                     filePaths = state.filePaths
                     deletedFiles = state.deletedFiles
+                    references = state.references
                 }
             }
 
-            session.insertChanges(filePaths = filePaths, deletedFiles = deletedFiles)
+            session.insertChanges(filePaths = filePaths, deletedFiles = deletedFiles, references = references)
 
             messenger.sendAnswer(
                 tabId = tabId,
@@ -460,8 +462,8 @@ class FeatureDevController(
             val state = session.sessionState
 
             var filePaths: List<NewFileZipInfo> = emptyList()
-            var deletedFiles: Array<String> = emptyArray()
-            var references: Array<CodeReference> = emptyArray()
+            var deletedFiles: List<String> = emptyList()
+            var references: List<CodeReference> = emptyList()
             var uploadId = ""
 
             when (state) {

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/messages/FeatureDevMessage.kt

@@ -8,7 +8,6 @@ import com.fasterxml.jackson.annotation.JsonValue
 import software.aws.toolkits.jetbrains.services.amazonq.auth.AuthFollowUpType
 import software.aws.toolkits.jetbrains.services.amazonq.messages.AmazonQMessage
 import software.aws.toolkits.jetbrains.services.cwc.messages.CodeReference
-import software.aws.toolkits.jetbrains.services.cwc.messages.RecommendationContentSpan
 import java.time.Instant
 import java.util.UUID
 
@@ -214,5 +213,4 @@ enum class FollowUpTypes(
 // Util classes
 data class ReducedCodeReference(
     val information: String,
-    val recommendationContentSpan: RecommendationContentSpan
 )

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/messages/FeatureDevMessagePublisherExtensions.kt

@@ -7,8 +7,8 @@ import software.aws.toolkits.jetbrains.services.amazonq.auth.AuthNeededState
 import software.aws.toolkits.jetbrains.services.amazonq.messages.MessagePublisher
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.session.NewFileZipInfo
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.session.SessionStatePhase
+import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.util.licenseText
 import software.aws.toolkits.jetbrains.services.cwc.messages.CodeReference
-import software.aws.toolkits.jetbrains.services.cwc.messages.RecommendationContentSpan
 import software.aws.toolkits.resources.message
 import java.util.UUID
 
@@ -171,23 +171,20 @@ suspend fun MessagePublisher.sendCodeResult(
     tabId: String,
     uploadId: String,
     filePaths: List<NewFileZipInfo>,
-    deletedFiles: Array<String>,
-    references: Array<CodeReference>
+    deletedFiles: List<String>,
+    references: List<CodeReference>
 ) {
     // It is being done this mapping as featureDev currently doesn't support fully references.
     val refs = references.filter { it.licenseName != null && it.url != null && it.repository != null }.map {
-        ReducedCodeReference(
-            information = it.information, // TODO: double check this references logic. As we have a licenseText function in vscode toolkit.
-            recommendationContentSpan = RecommendationContentSpan(start = 0, end = 0)
-        )
+        ReducedCodeReference(information = it.licenseText())
     }
 
     this.publish(
         CodeResultMessage(
             tabId = tabId,
             conversationId = uploadId,
             filePaths = filePaths.map { it.zipFilePath },
-            deletedFiles = deletedFiles.asList(),
+            deletedFiles = deletedFiles,
             references = refs
         )
     )

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/CodeGenerationState.kt

@@ -105,7 +105,7 @@ private suspend fun CodeGenerationState.generateCode(codeGenerationId: String):
         }
     }
 
-    return CodeGenerationResult(emptyList(), emptyArray(), emptyArray())
+    return CodeGenerationResult(emptyList(), emptyList(), emptyList())
 }
 
 fun registerNewFiles(newFileContents: Map<String, String>): List<NewFileZipInfo> = newFileContents.map {

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/PrepareCodeGenerationState.kt

@@ -18,9 +18,9 @@ class PrepareCodeGenerationState(
     override var approach: String,
     private var config: SessionStateConfig,
     val filePaths: List<NewFileZipInfo>,
-    val deletedFiles: Array<String>,
+    val deletedFiles: List<String>,
+    val references: List<CodeReference>,
     var uploadId: String,
-    val references: Array<CodeReference>,
     private val currentIteration: Int,
     private var messenger: MessagePublisher
 ) : SessionState {

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/Session.kt

@@ -11,6 +11,8 @@ import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.clients.Featur
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.conversationIdNotFound
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.messages.sendAsyncEventProgress
 import software.aws.toolkits.jetbrains.services.amazonqFeatureDev.util.createConversation
+import software.aws.toolkits.jetbrains.services.cwc.controller.ReferenceLogController
+import software.aws.toolkits.jetbrains.services.cwc.messages.CodeReference
 import software.aws.toolkits.telemetry.AmazonqTelemetry
 import kotlin.io.path.createDirectories
 import kotlin.io.path.deleteIfExists
@@ -76,8 +78,8 @@ class Session(val tabID: String, val project: Project) {
             approach = sessionState.approach,
             config = getSessionStateConfig(),
             filePaths = emptyList(),
-            deletedFiles = emptyArray(),
-            references = emptyArray(),
+            deletedFiles = emptyList(),
+            references = emptyList(),
             currentIteration = 0, // first code gen iteration
             uploadId = "", // There is no code gen uploadId so far
             messenger = messenger,
@@ -90,7 +92,7 @@ class Session(val tabID: String, val project: Project) {
     /**
      * Triggered by the Insert code follow-up button to apply code changes.
      */
-    fun insertChanges(filePaths: List<NewFileZipInfo>, deletedFiles: Array<String>) {
+    fun insertChanges(filePaths: List<NewFileZipInfo>, deletedFiles: List<String>, references: List<CodeReference>) {
         val projectRootPath = context.projectRoot.toNioPath()
 
         filePaths.forEach {
@@ -104,7 +106,7 @@ class Session(val tabID: String, val project: Project) {
             deleteFilePath.deleteIfExists()
         }
 
-        // TODO: References received from code generation should be logged.
+        ReferenceLogController.addReferenceLog(references, project)
     }
 
     suspend fun send(msg: String): Interaction {

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/SessionStateTypes.kt

@@ -43,15 +43,15 @@ data class NewFileZipInfo(
 
 data class CodeGenerationResult(
     var newFiles: List<NewFileZipInfo>,
-    var deletedFiles: Array<String>, // The string is the path of the file to be deleted
-    var references: Array<CodeReference>,
+    var deletedFiles: List<String>, // The string is the path of the file to be deleted
+    var references: List<CodeReference>,
 )
 
 @Suppress("ConstructorParameterNaming") // Unfortunately, this is exactly how the string json is received and is needed for parsing.
 data class CodeGenerationStreamResult(
     var new_file_contents: Map<String, String>,
-    var deleted_files: Array<String>,
-    var references: Array<CodeReference>,
+    var deleted_files: List<String>,
+    var references: List<CodeReference>,
 )
 
 @Suppress("ConstructorParameterNaming") // Unfortunately, this is exactly how the string json is received and is needed for parsing.

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/util/CodeReferenceExtensions.kt

@@ -0,0 +1,15 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.services.amazonqFeatureDev.util
+
+import software.aws.toolkits.jetbrains.services.codewhisperer.service.CodeWhispererLicenseInfoManager
+import software.aws.toolkits.jetbrains.services.cwc.messages.CodeReference
+
+fun CodeReference.licenseText(): String {
+    val licenseLink = CodeWhispererLicenseInfoManager.getInstance().getLicenseLink(this.licenseName.orEmpty())
+
+    return "<a href=\"${licenseLink}\" target=\"_blank\">" +
+        "${this.licenseName}" +
+        "</a> license from repository <a href=\"${this.url}\" target=\"_blank\">${this.repository}</a>"
+}

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/service/CodeWhispererLicenseInfoManager.kt

@@ -19,7 +19,7 @@ class CodeWhispererLicenseInfoManager {
         }
     }
 
-    fun getLicenseLink(code: String) = licenseLinks.getOrDefault(code, "")
+    fun getLicenseLink(code: String) = licenseLinks.getOrDefault(code, "https://spdx.org/licenses")
 
     companion object {
         fun getInstance(): CodeWhispererLicenseInfoManager = service()

plugins/toolkit/jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/toolwindow/CodeWhispererCodeReferenceComponents.kt

@@ -105,7 +105,7 @@ class CodeWhispererCodeReferenceComponents(private val project: Project) {
         text = message("codewhisperer.toolwindow.entry.suffix", path ?: "", choice, line)
     }.asCodeReferencePanelFont()
 
-    fun codeReferenceRecordPanel(ref: Reference, relativePath: String?, lineNums: String) = JPanel(GridBagLayout()).apply {
+    fun codeReferenceRecordPanel(ref: Reference, relativePath: String?, lineNums: String?) = JPanel(GridBagLayout()).apply {
         background = EditorColorsManager.getInstance().globalScheme.defaultBackground
         border = BorderFactory.createEmptyBorder(5, 0, 0, 0)
         add(acceptRecommendationPrefixText, inlineLabelConstraints)
@@ -132,7 +132,9 @@ class CodeWhispererCodeReferenceComponents(private val project: Project) {
             add(repoNameLink(ref.repository(), ref.url()), inlineLabelConstraints)
         }
 
-        add(acceptRecommendationSuffixText(relativePath, lineNums), inlineLabelConstraints)
+        if (!lineNums.isNullOrEmpty()) {
+            add(acceptRecommendationSuffixText(relativePath, lineNums), inlineLabelConstraints)
+        }
         addHorizontalGlue()
     }