feat(codewhisperer): show repo url in reference tracker #2803

Author: zixlin7

.changes/next-release/Feature-e1ab608d-6d2e-4bfb-83d8-ffe3ec6e8227.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "CodeWhisperer: References include a link to the source repository if possible."
+}

src/codewhisperer/service/referenceLogViewProvider.ts

@@ -72,7 +72,6 @@ export class ReferenceLogViewProvider implements vscode.WebviewViewProvider {
                 editor.document.positionAt(
                     TelemetryHelper.instance.cursorOffset + reference.recommendationContentSpan.end - 1
                 ).line + 1
-            const license = `<a href=${LicenseUtil.getLicenseHtml(reference.licenseName)}>${reference.licenseName}</a>`
             let lineInfo = ``
             if (firstCharLineNumber === lastCharLineNumber) {
                 lineInfo = `(line at ${firstCharLineNumber})`
@@ -82,7 +81,14 @@ export class ReferenceLogViewProvider implements vscode.WebviewViewProvider {
             if (text != ``) {
                 text += `And `
             }
-            const repository = reference.repository != undefined ? reference.repository : 'unknown'
+
+            let license = `<a href=${LicenseUtil.getLicenseHtml(reference.licenseName)}>${reference.licenseName}</a>`
+            let repository = reference.repository?.length ? reference.repository : 'unknown'
+            if (reference.url?.length) {
+                repository = `<a href=${reference.url}>${reference.repository}</a>`
+                license = reference.licenseName || 'unknown'
+            }
+
             text +=
                 CodeWhispererConstants.referenceLogText(
                     `<br><code>${code}</code><br>`,

src/test/codewhisperer/service/referenceLogViewProvider.test.ts

@@ -5,13 +5,14 @@
 import * as assert from 'assert'
 import { createMockTextEditor, resetCodeWhispererGlobalVariables } from '../testUtil'
 import { ReferenceLogViewProvider } from '../../../codewhisperer/service/referenceLogViewProvider'
+import { LicenseUtil } from '../../../codewhisperer/util/licenseUtil'
 
 describe('referenceLogViewProvider', function () {
     beforeEach(function () {
         resetCodeWhispererGlobalVariables()
     })
     describe('getReferenceLog', async function () {
-        it('Should return expected reference log string', function () {
+        it('Should return expected reference log string with link to license if there is no url', function () {
             const currentTime = new Date()
             const currentTimeString = currentTime.toLocaleString()
             currentTime.setSeconds(currentTime.getSeconds() + 1)
@@ -34,6 +35,36 @@ describe('referenceLogViewProvider', function () {
             assert.ok(actualTime === currentTimeString || actualTime === nextTimeString)
             assert.ok(actual.includes('MIT'))
             assert.ok(actual.includes('def two_su'))
+            assert.ok(actual.includes(LicenseUtil.getLicenseHtml('MIT')))
+        })
+
+        it('Should return expected reference log string with link to the repo url if present', function () {
+            const currentTime = new Date()
+            const currentTimeString = currentTime.toLocaleString()
+            currentTime.setSeconds(currentTime.getSeconds() + 1)
+            const nextTimeString = currentTime.toLocaleString()
+            const mockEditor = createMockTextEditor()
+            const recommendation = `def two_sum(nums, target):`
+            const mockUrl = 'https://www.amazon.com'
+            const fakeReferences = [
+                {
+                    message: '',
+                    licenseName: 'MIT',
+                    repository: 'TEST_REPO',
+                    url: mockUrl,
+                    recommendationContentSpan: {
+                        start: 0,
+                        end: 10,
+                    },
+                },
+            ]
+            const actual = ReferenceLogViewProvider.getReferenceLog(recommendation, fakeReferences, mockEditor)
+            const actualTime = actual.substring(1, actual.indexOf(']'))
+            assert.ok(actualTime === currentTimeString || actualTime === nextTimeString)
+            assert.ok(actual.includes('MIT'))
+            assert.ok(actual.includes('def two_su'))
+            assert.ok(actual.includes(mockUrl))
+            assert.ok(!actual.includes(LicenseUtil.getLicenseHtml('MIT')))
         })
     })
 })