Merge branch 'main' into index_finish_bug

leigaol · web-flow · commit 222bef6cced5 · 2024-11-07T18:58:59.000-08:00
diff --git a/.changes/3.38.json b/.changes/3.38.json
@@ -0,0 +1,14 @@
+{
+  "date" : "2024-11-07",
+  "version" : "3.38",
+  "entries" : [ {
+    "type" : "bugfix",
+    "description" : "Improve the position that inline chat shortcut hint is shown in editor"
+  }, {
+    "type" : "bugfix",
+    "description" : "Improve `@workspace` index start stop strategy"
+  }, {
+    "type" : "bugfix",
+    "description" : "Fixed an issue where Q inline won't appear in JetBrains remote 2024.2+"
+  } ]
+}
diff --git a/.changes/next-release/bugfix-1b531ca4-5b80-48d9-89e7-ac88adc77ad5.json b/.changes/next-release/bugfix-1b531ca4-5b80-48d9-89e7-ac88adc77ad5.json
diff --git a/.changes/next-release/bugfix-4fee3628-1445-40f3-b164-2b0d3c12bd19.json b/.changes/next-release/bugfix-4fee3628-1445-40f3-b164-2b0d3c12bd19.json
diff --git a/.changes/next-release/bugfix-eb803511-b66c-454e-a832-ca189572d1af.json b/.changes/next-release/bugfix-eb803511-b66c-454e-a832-ca189572d1af.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# _3.38_ (2024-11-07)
+- **(Bug Fix)** Improve the position that inline chat shortcut hint is shown in editor
+- **(Bug Fix)** Improve `@workspace` index start stop strategy
+- **(Bug Fix)** Fixed an issue where Q inline won't appear in JetBrains remote 2024.2+
+
 # _3.37_ (2024-10-31)
 - **(Bug Fix)** Amazon Q /dev: Fix the issue resulting in the first request per conversation to /dev failing
 - **(Bug Fix)** Fix inline chat shortcut hint breaking text selection on remote editors
diff --git a/gradle.properties b/gradle.properties
@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 # Toolkit Version
-toolkitVersion=3.38-SNAPSHOT
+toolkitVersion=3.39-SNAPSHOT
 
 # Publish Settings
 publishToken=
diff --git a/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/DiskCache.kt b/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/DiskCache.kt
@@ -32,6 +32,7 @@ import software.aws.toolkits.core.utils.touch
 import software.aws.toolkits.core.utils.tryDirOp
 import software.aws.toolkits.core.utils.tryFileOp
 import software.aws.toolkits.core.utils.tryOrNull
+import software.aws.toolkits.jetbrains.services.telemetry.scrubNames
 import software.aws.toolkits.telemetry.AuthTelemetry
 import software.aws.toolkits.telemetry.Result
 import java.io.InputStream
@@ -111,7 +112,7 @@ class DiskCache(
                 source = "loadClientRegistration",
                 result = Result.Failed,
                 reason = "Failed to load Client Registration",
-                reasonDesc = "Load Step:$stage failed. Unable to load file"
+                reasonDesc = "Load Step:$stage failed. Cache file does not exist"
             )
             return null
         }
@@ -136,7 +137,7 @@ class DiskCache(
                 source = "invalidateClientRegistration",
                 result = Result.Failed,
                 reason = "Failed to invalidate Client Registration",
-                reasonDesc = e.message ?: e::class.java.name
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name
             )
             throw e
         }
@@ -152,7 +153,7 @@ class DiskCache(
                 source = "invalidateAccessToken",
                 result = Result.Failed,
                 reason = "Failed to invalidate Access Token",
-                reasonDesc = e.message ?: e::class.java.name
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name
             )
             throw e
         }
@@ -186,7 +187,7 @@ class DiskCache(
                 source = "invalidateAccessToken",
                 result = Result.Failed,
                 reason = "Failed to invalidate Access Token",
-                reasonDesc = e.message ?: e::class.java.name
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name
             )
             throw e
         }
@@ -282,7 +283,7 @@ class DiskCache(
                 source = "writeKey",
                 result = Result.Failed,
                 reason = "Failed to write to cache",
-                reasonDesc = e.message ?: e::class.java.name
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name
             )
             throw e
         }
diff --git a/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/SsoAccessTokenProvider.kt b/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/SsoAccessTokenProvider.kt
@@ -24,6 +24,7 @@ import software.aws.toolkits.jetbrains.core.credentials.sono.SONO_URL
 import software.aws.toolkits.jetbrains.core.credentials.sso.pkce.PKCE_CLIENT_NAME
 import software.aws.toolkits.jetbrains.core.credentials.sso.pkce.ToolkitOAuthService
 import software.aws.toolkits.jetbrains.core.webview.getAuthType
+import software.aws.toolkits.jetbrains.services.telemetry.scrubNames
 import software.aws.toolkits.jetbrains.utils.assertIsNonDispatchThread
 import software.aws.toolkits.jetbrains.utils.sleepWithCancellation
 import software.aws.toolkits.resources.AwsCoreBundle
@@ -183,7 +184,7 @@ class SsoAccessTokenProvider(
                 source = "accessToken",
                 result = Result.Failed,
                 reason = "Failed to write AccessToken to cache",
-                reasonDesc = e.message ?: e::class.java.name,
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name,
             )
             throw e
         }
@@ -225,7 +226,7 @@ class SsoAccessTokenProvider(
                 source = "registerDAGClient",
                 result = Result.Failed,
                 reason = "Failed to write DeviceAuthorizationClientRegistration to cache",
-                reasonDesc = e.message ?: e::class.java.name
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name
             )
             throw e
         }
@@ -277,7 +278,7 @@ class SsoAccessTokenProvider(
                 source = "registerPkceClient",
                 result = Result.Failed,
                 reason = "Failed to write PKCEClientRegistration to cache",
-                reasonDesc = e.message ?: e::class.java.name
+                reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name
             )
             throw e
         }
diff --git a/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt b/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt
@@ -32,6 +32,9 @@ import software.aws.toolkits.jetbrains.core.credentials.sso.PKCEAuthorizationGra
 import software.aws.toolkits.jetbrains.core.credentials.sso.PKCEClientRegistration
 import software.aws.toolkits.jetbrains.core.credentials.sso.bearer.buildUnmanagedSsoOidcClient
 import software.aws.toolkits.resources.AwsCoreBundle
+import software.aws.toolkits.telemetry.AuthType
+import software.aws.toolkits.telemetry.AwsTelemetry
+import software.aws.toolkits.telemetry.MetricResult
 import java.math.BigInteger
 import java.time.Instant
 import java.util.Base64
@@ -189,13 +192,23 @@ internal class ToolkitOAuthCallbackHandler : OAuthCallbackHandlerBase() {
                 "scopes" to ApplicationNamesInfo.getInstance().fullProductName
             )
         } else {
-            val (error, errorDescription) = (oAuthResult.request as? ToolkitOAuthRequest)?.error ?: OAuthError(null, null)
+            val toolkitRequest = (oAuthResult.request as? ToolkitOAuthRequest)
+            val (error, errorDescription) = toolkitRequest?.error ?: OAuthError(null, null)
             val errorString = if (error != null && errorDescription != null) {
                 "$error: $errorDescription"
             } else {
                 errorDescription ?: error ?: AwsCoreBundle.message("general.unknown_error")
             }
 
+            AwsTelemetry.loginWithBrowser(
+                project = null,
+                credentialStartUrl = toolkitRequest?.registration?.issuerUrl,
+                result = MetricResult.Failed,
+                reason = error,
+                reasonDesc = errorDescription,
+                authType = AuthType.PKCE
+            )
+
             mapOf(
                 "error" to errorString
             )
diff --git a/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt b/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt
@@ -36,6 +36,7 @@ import software.aws.toolkits.jetbrains.core.credentials.reauthConnectionIfNeeded
 import software.aws.toolkits.jetbrains.core.credentials.sono.CODECATALYST_SCOPES
 import software.aws.toolkits.jetbrains.core.credentials.sono.IDENTITY_CENTER_ROLE_ACCESS_SCOPE
 import software.aws.toolkits.jetbrains.core.credentials.sono.Q_SCOPES
+import software.aws.toolkits.jetbrains.core.credentials.sono.SONO_REGION
 import software.aws.toolkits.jetbrains.core.credentials.sono.SONO_URL
 import software.aws.toolkits.jetbrains.core.credentials.sso.PendingAuthorization
 import software.aws.toolkits.jetbrains.core.credentials.sso.bearer.InteractiveBearerTokenProvider
@@ -197,7 +198,7 @@ abstract class LoginBrowser(
                 reason = e.message,
                 credentialSourceId = CredentialSourceId.AwsId,
                 isReAuth = isReauth,
-                authType = getAuthType()
+                authType = getAuthType(SONO_REGION)
             )
             AuthTelemetry.addConnection(
                 result = Result.Failed,
@@ -217,7 +218,7 @@ abstract class LoginBrowser(
                 result = Result.Succeeded,
                 credentialSourceId = CredentialSourceId.AwsId,
                 isReAuth = isReauth,
-                authType = getAuthType()
+                authType = getAuthType(SONO_REGION)
             )
             AuthTelemetry.addConnection(
                 result = Result.Succeeded,
diff --git a/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/WebviewTelemetryUtils.kt b/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/WebviewTelemetryUtils.kt
@@ -9,7 +9,7 @@ import software.aws.toolkits.jetbrains.core.credentials.sono.Q_SCOPES
 import software.aws.toolkits.telemetry.AuthType
 import software.aws.toolkits.telemetry.FeatureId
 
-fun getAuthType(region: String = "us-east-1"): AuthType {
+fun getAuthType(region: String): AuthType {
     val isCommercialRegion = !region.startsWith("us-gov") && !region.startsWith("us-iso") && !region.startsWith("cn")
     if (!Registry.`is`("aws.dev.useDAG") && isCommercialRegion) {
         return AuthType.PKCE
diff --git a/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/telemetry/TelemetryUtils.kt b/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/telemetry/TelemetryUtils.kt
@@ -200,3 +200,69 @@ val ALLOWED_CODE_EXTENSIONS = setOf(
     "yml",
     "zig"
 )
+
+fun scrubNames(messageToBeScrubbed: String, username: String? = getSystemUserName()): String {
+    var scrubbedMessage = ""
+    var processedMessage = messageToBeScrubbed
+    if (!username.isNullOrEmpty() && username.length > 2) {
+        processedMessage = processedMessage.replace(username, "x")
+    }
+
+    // Replace contiguous whitespace with 1 space.
+    processedMessage = processedMessage.replace(Regex("""\s+"""), " ")
+
+    // 1. split on whitespace.
+    // 2. scrub words that match username or look like filepaths.
+    val words = processedMessage.split(Regex("""\s+"""))
+    for (word in words) {
+        val pathSegments = word.split(Regex("""[/\\]""")).filter { it != "" }
+        if (pathSegments.size < 2) {
+            // Not a filepath.
+            scrubbedMessage += " $word"
+            continue
+        }
+
+        // Replace all (non-allowlisted) ASCII filepath segments with "x".
+        // "/foo/bar/aws/sso/" => "/x/x/aws/sso/"
+        var scrubbed = ""
+        // Get the frontmatter ("/", "../", "~/", or "./").
+        val start = slashdot.find(word.trimStart())?.value.orEmpty()
+        val firstVal = pathSegments[0].trimStart().replace(slashdot, "")
+
+        val ps = pathSegments.filterIndexed { i, _ -> i != 0 }.toMutableList()
+        ps.add(0, firstVal)
+
+        for (seg in ps) {
+            when {
+                driveLetterRegex.matches(seg) -> scrubbed += seg
+                commonFilePathPatterns.contains(seg) -> scrubbed += "/$seg"
+                else -> {
+                    // Save the first non-ASCII (unicode) char, if any.
+                    val nonAscii = Regex("""[^\p{ASCII}]""").find(seg)?.value.orEmpty()
+                    // Replace all chars (except [^…]) with "x" .
+                    val ascii = seg.replace(Regex("""[^$\[\](){}:;'" ]+"""), "x")
+                    scrubbed += "/${ascii}$nonAscii"
+                }
+            }
+        }
+
+        // includes leading '.', eg: '.json'
+        val fileExt = fileExtRegex.find(pathSegments.last())?.value.orEmpty()
+        val newString = " ${start.replace(Regex("""\\"""), "/")}${scrubbed.removePrefix("//").removePrefix("/").removePrefix("\\")}$fileExt"
+        scrubbedMessage += newString
+    }
+
+    return scrubbedMessage.trim()
+}
+
+val fileExtRegex = Regex("""\.[^./]+$""")
+val slashdot = Regex("""^[~.]*[/\\]*""")
+
+/** Allowlisted filepath segments. */
+val commonFilePathPatterns = setOf(
+    "~", ".", "..", ".aws", "aws", "sso", "cache", "credentials", "config",
+    "Users", "users", "home", "tmp", "aws-toolkit-jetbrains"
+)
+val driveLetterRegex = Regex("""^[a-zA-Z]:""")
+
+fun getSystemUserName(): String? = System.getProperty("user.name") ?: null
diff --git a/plugins/core/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/telemetry/TelemetryUtilsTest.kt b/plugins/core/jetbrains-community/tst/software/aws/toolkits/jetbrains/services/telemetry/TelemetryUtilsTest.kt
@@ -0,0 +1,66 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.jetbrains.services.telemetry
+
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.Arguments
+import org.junit.jupiter.params.provider.MethodSource
+import java.util.stream.Stream
+
+class TelemetryUtilsTest {
+
+    @ParameterizedTest
+    @MethodSource("scrubNamesTestCases")
+    fun testScrubNames(input: String, expected: String) {
+        val fakeUser = "jdoe123"
+        assertThat(expected).isEqualTo(scrubNames(input, fakeUser))
+    }
+
+    companion object {
+        @JvmStatic
+        fun scrubNamesTestCases(): Stream<Arguments> = Stream.of(
+            Arguments.of("", ""),
+            Arguments.of("a ./ b", "a ./ b"),
+            Arguments.of("a ../ b", "a ../ b"),
+            Arguments.of("a /.. b", "a /.. b"),
+            Arguments.of("a //..// b", "a //..// b"),
+            Arguments.of("a / b", "a / b"),
+            Arguments.of("a ~/ b", "a ~/ b"),
+            Arguments.of("a //// b", "a //// b"),
+            Arguments.of("a .. b", "a .. b"),
+            Arguments.of("a . b", "a . b"),
+            Arguments.of("      lots      of         space       ", "lots of space"),
+            Arguments.of(
+                "Failed to save c:/fooß/aïböcß/aób∑c/∑ö/ππ¨p/ö/a/bar123öabc/baz.txt no permissions (error!)",
+                "Failed to save c:/xß/xï/xó/x∑/xπ/xö/x/xö/x.txt no permissions (error!)"
+            ),
+            Arguments.of(
+                "user: jdoe123 file: C:/Users/user1/.aws/sso/cache/abc123.json (regex: /foo/)",
+                "user: x file: C:/Users/x/.aws/sso/cache/x.json (regex: /x/)"
+            ),
+            Arguments.of("/Users/user1/foo.jso", "/Users/x/x.jso"),
+            Arguments.of("/Users/user1/foo.js", "/Users/x/x.js"),
+            Arguments.of("/Users/user1/noFileExtension", "/Users/x/x"),
+            Arguments.of("/Users/user1/minExtLength.a", "/Users/x/x.a"),
+            Arguments.of("/Users/user1/extIsNum.123456", "/Users/x/x.123456"),
+            Arguments.of("/Users/user1/foo.looooooooongextension", "/Users/x/x.looooooooongextension"),
+            Arguments.of("/Users/user1/multipleExts.ext1.ext2.ext3", "/Users/x/x.ext3"),
+            Arguments.of("c:\\fooß\\bar\\baz.txt", "c:/xß/x/x.txt"),
+            Arguments.of("unc path: \\\\server$\\pipename\\etc END", "unc path: //x$/x/x END"),
+            Arguments.of(
+                "c:\\Users\\user1\\.aws\\sso\\cache\\abc123.json jdoe123 abc",
+                "c:/Users/x/.aws/sso/cache/x.json x abc"
+            ),
+            Arguments.of("unix /home/jdoe123/.aws/config failed", "unix /home/x/.aws/config failed"),
+            Arguments.of("unix ~jdoe123/.aws/config failed", "unix ~x/.aws/config failed"),
+            Arguments.of("unix ../../.aws/config failed", "unix ../../.aws/config failed"),
+            Arguments.of("unix ~/.aws/config failed", "unix ~/.aws/config failed"),
+            Arguments.of(
+                "/Users/user1/.aws/sso/cache/abc123.json no space",
+                "/Users/x/.aws/sso/cache/x.json no space"
+            )
+        )
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ import software.aws.toolkits.core.utils.touch`
`32`	`32`	`import software.aws.toolkits.core.utils.tryDirOp`
`33`	`33`	`import software.aws.toolkits.core.utils.tryFileOp`
`34`	`34`	`import software.aws.toolkits.core.utils.tryOrNull`
	`35`	`+import software.aws.toolkits.jetbrains.services.telemetry.scrubNames`
`35`	`36`	`import software.aws.toolkits.telemetry.AuthTelemetry`
`36`	`37`	`import software.aws.toolkits.telemetry.Result`
`37`	`38`	`import java.io.InputStream`
`@@ -111,7 +112,7 @@ class DiskCache(`
`111`	`112`	`source = "loadClientRegistration",`
`112`	`113`	`result = Result.Failed,`
`113`	`114`	`reason = "Failed to load Client Registration",`
`114`		`- reasonDesc = "Load Step:$stage failed. Unable to load file"`
	`115`	`+ reasonDesc = "Load Step:$stage failed. Cache file does not exist"`
`115`	`116`	`)`
`116`	`117`	`return null`
`117`	`118`	`}`
`@@ -136,7 +137,7 @@ class DiskCache(`
`136`	`137`	`source = "invalidateClientRegistration",`
`137`	`138`	`result = Result.Failed,`
`138`	`139`	`reason = "Failed to invalidate Client Registration",`
`139`		`- reasonDesc = e.message ?: e::class.java.name`
	`140`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name`
`140`	`141`	`)`
`141`	`142`	`throw e`
`142`	`143`	`}`
`@@ -152,7 +153,7 @@ class DiskCache(`
`152`	`153`	`source = "invalidateAccessToken",`
`153`	`154`	`result = Result.Failed,`
`154`	`155`	`reason = "Failed to invalidate Access Token",`
`155`		`- reasonDesc = e.message ?: e::class.java.name`
	`156`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name`
`156`	`157`	`)`
`157`	`158`	`throw e`
`158`	`159`	`}`
`@@ -186,7 +187,7 @@ class DiskCache(`
`186`	`187`	`source = "invalidateAccessToken",`
`187`	`188`	`result = Result.Failed,`
`188`	`189`	`reason = "Failed to invalidate Access Token",`
`189`		`- reasonDesc = e.message ?: e::class.java.name`
	`190`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name`
`190`	`191`	`)`
`191`	`192`	`throw e`
`192`	`193`	`}`
`@@ -282,7 +283,7 @@ class DiskCache(`
`282`	`283`	`source = "writeKey",`
`283`	`284`	`result = Result.Failed,`
`284`	`285`	`reason = "Failed to write to cache",`
`285`		`- reasonDesc = e.message ?: e::class.java.name`
	`286`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name`
`286`	`287`	`)`
`287`	`288`	`throw e`
`288`	`289`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ import software.aws.toolkits.jetbrains.core.credentials.sono.SONO_URL`
`24`	`24`	`import software.aws.toolkits.jetbrains.core.credentials.sso.pkce.PKCE_CLIENT_NAME`
`25`	`25`	`import software.aws.toolkits.jetbrains.core.credentials.sso.pkce.ToolkitOAuthService`
`26`	`26`	`import software.aws.toolkits.jetbrains.core.webview.getAuthType`
	`27`	`+import software.aws.toolkits.jetbrains.services.telemetry.scrubNames`
`27`	`28`	`import software.aws.toolkits.jetbrains.utils.assertIsNonDispatchThread`
`28`	`29`	`import software.aws.toolkits.jetbrains.utils.sleepWithCancellation`
`29`	`30`	`import software.aws.toolkits.resources.AwsCoreBundle`
`@@ -183,7 +184,7 @@ class SsoAccessTokenProvider(`
`183`	`184`	`source = "accessToken",`
`184`	`185`	`result = Result.Failed,`
`185`	`186`	`reason = "Failed to write AccessToken to cache",`
`186`		`- reasonDesc = e.message ?: e::class.java.name,`
	`187`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name,`
`187`	`188`	`)`
`188`	`189`	`throw e`
`189`	`190`	`}`
`@@ -225,7 +226,7 @@ class SsoAccessTokenProvider(`
`225`	`226`	`source = "registerDAGClient",`
`226`	`227`	`result = Result.Failed,`
`227`	`228`	`reason = "Failed to write DeviceAuthorizationClientRegistration to cache",`
`228`		`- reasonDesc = e.message ?: e::class.java.name`
	`229`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name`
`229`	`230`	`)`
`230`	`231`	`throw e`
`231`	`232`	`}`
`@@ -277,7 +278,7 @@ class SsoAccessTokenProvider(`
`277`	`278`	`source = "registerPkceClient",`
`278`	`279`	`result = Result.Failed,`
`279`	`280`	`reason = "Failed to write PKCEClientRegistration to cache",`
`280`		`- reasonDesc = e.message ?: e::class.java.name`
	`281`	`+ reasonDesc = e.message?.let { scrubNames(it) } ?: e::class.java.name`
`281`	`282`	`)`
`282`	`283`	`throw e`
`283`	`284`	`}`