Skip to content

Emit metric on OAuth callback failure #5060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 7, 2024
Merged

Emit metric on OAuth callback failure #5060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc5efc0
Emit metric on OAuth failure
rli Nov 7, 2024
f152097
Update ToolkitOAuthService.kt
rli Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion ...nity/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
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

Check warning on line 36 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt

View workflow job for this annotation

GitHub Actions / Qodana Community for JVM

Usage of redundant or deprecated syntax or deprecated symbols 

Remove deprecated symbol import

Check warning on line 36 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt

View workflow job for this annotation

GitHub Actions / Qodana Community for JVM

Usage of redundant or deprecated syntax or deprecated symbols 

'AwsTelemetry' is deprecated. Use type-safe metric builders

Check warning

Code scanning / QDJVMC

Usage of redundant or deprecated syntax or deprecated symbols Warning

Remove deprecated symbol import

Check warning

Code scanning / QDJVMC

Usage of redundant or deprecated syntax or deprecated symbols Warning

'AwsTelemetry' is deprecated. Use type-safe metric builders
import software.aws.toolkits.telemetry.MetricResult
import java.math.BigInteger
import java.time.Instant
import java.util.Base64
Expand Down Expand Up @@ -189,13 +192,23 @@
"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(

Check warning on line 203 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt

View workflow job for this annotation

GitHub Actions / Qodana Community for JVM

Usage of redundant or deprecated syntax or deprecated symbols 

'AwsTelemetry' is deprecated. Use type-safe metric builders

Check warning

Code scanning / QDJVMC

Usage of redundant or deprecated syntax or deprecated symbols Warning

'AwsTelemetry' is deprecated. Use type-safe metric builders
project = null,

Check warning on line 204 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt

View check run for this annotation

Codecov / codecov/patch

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt#L203-L204 

Added lines #L203 - L204 were not covered by tests
credentialStartUrl = toolkitRequest?.registration?.issuerUrl,
result = MetricResult.Failed,
reason = error,
reasonDesc = errorDescription,
authType = AuthType.PKCE

Check warning on line 209 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt

View check run for this annotation

Codecov / codecov/patch

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/credentials/sso/pkce/ToolkitOAuthService.kt#L206-L209 

Added lines #L206 - L209 were not covered by tests
)

mapOf(
"error" to errorString
)
Expand Down
5 changes: 3 additions & 2 deletions ...core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
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
Expand Down Expand Up @@ -197,7 +198,7 @@
reason = e.message,
credentialSourceId = CredentialSourceId.AwsId,
isReAuth = isReauth,
authType = getAuthType()
authType = getAuthType(SONO_REGION)

Check warning on line 201 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt

View check run for this annotation

Codecov / codecov/patch

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt#L201 

Added line #L201 was not covered by tests
)
AuthTelemetry.addConnection(
result = Result.Failed,
Expand All @@ -217,7 +218,7 @@
result = Result.Succeeded,
credentialSourceId = CredentialSourceId.AwsId,
isReAuth = isReauth,
authType = getAuthType()
authType = getAuthType(SONO_REGION)

Check warning on line 221 in plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt

View check run for this annotation

Codecov / codecov/patch

plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/core/webview/LoginBrowser.kt#L221 

Added line #L221 was not covered by tests
)
AuthTelemetry.addConnection(
result = Result.Succeeded,
Expand Down
2 changes: 1 addition & 1 deletion ...rains-community/src/software/aws/toolkits/jetbrains/core/webview/WebviewTelemetryUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading