refactor: deduplicate messages, avoid unnecessary exports #4679

Author: justinmk3

packages/core/src/codecatalyst/auth.ts

@@ -6,6 +6,7 @@
 import * as vscode from 'vscode'
 import { onAccessDeniedException, CodeCatalystClient, createClient } from '../shared/clients/codecatalystClient'
 import { Auth } from '../auth/auth'
+import * as localizedText from '../shared/localizedText'
 import { getSecondaryAuth } from '../auth/secondaryAuth'
 import { getLogger } from '../shared/logger'
 import { ToolkitError, isAwsError } from '../shared/errors'
@@ -195,15 +196,12 @@ export class CodeCatalystAuthenticationProvider {
     }
 
     public async showReauthenticationPrompt(conn: Connection, isPartialExpiration?: boolean): Promise<void> {
-        const expiredMessage =
-            'Connection expired. To continue using CodeCatalyst, connect with AWS Builder ID or AWS IAM Identity center.'
         const partiallyExpiredMessage =
             'CodeCatalyst connection has expired. Amazon Q/CodeWhisperer is still connected.'
 
         await showReauthenticateMessage({
-            message: isPartialExpiration ? partiallyExpiredMessage : expiredMessage,
-            connect: 'Connect with AWS',
-            doNotShow: "Don't Show Again",
+            message: isPartialExpiration ? partiallyExpiredMessage : localizedText.connectionExpired('CodeCatalyst'),
+            connect: localizedText.connect,
             suppressId: 'codeCatalystConnectionExpired',
             reauthFunc: async () => {
                 await this.auth.reauthenticate(conn)

packages/core/src/codewhisperer/models/constants.ts

@@ -241,8 +241,6 @@ export const ssoConfigAlertMessageShareData = `This setting doesn\’t apply, si
 
 export const settingsLearnMore = 'Learn More about CodeWhisperer Settings'
 
-export const connectWithAWSBuilderId = `Connect with AWS`
-
 export const freeTierLimitReached = 'You have reached the monthly fair use limit of code recommendations.'
 
 export const freeTierLimitReachedCodeScan = 'You have reached the monthly quota of code scans.'
@@ -260,10 +258,6 @@ export const failedToConnectAwsBuilderId = `Failed to connect to AWS Builder ID`
 
 export const failedToConnectIamIdentityCenter = `Failed to connect to IAM Identity Center`
 
-export const connectionExpired = `Connection expired. To continue using Amazon Q/CodeWhisperer, connect with AWS Builder ID or AWS IAM Identity center.`
-
-export const DoNotShowAgain = `Don\'t Show Again`
-
 export const stopScanMessage =
     'Stop security scan? This scan will be counted as one complete scan towards your monthly security scan limits.'
 

packages/core/src/codewhisperer/util/authUtil.ts

@@ -4,7 +4,7 @@
  */
 
 import * as vscode from 'vscode'
-import * as CodeWhispererConstants from '../models/constants'
+import * as localizedText from '../../shared/localizedText'
 import { Auth } from '../../auth/auth'
 import { ToolkitError } from '../../shared/errors'
 import { getSecondaryAuth } from '../../auth/secondaryAuth'
@@ -367,9 +367,8 @@ export class AuthUtil {
         }
 
         await showReauthenticateMessage({
-            message: CodeWhispererConstants.connectionExpired,
-            connect: CodeWhispererConstants.connectWithAWSBuilderId,
-            doNotShow: CodeWhispererConstants.DoNotShowAgain,
+            message: localizedText.connectionExpired('Amazon Q/CodeWhisperer'),
+            connect: localizedText.connect,
             suppressId: 'codeWhispererConnectionExpired',
             reauthFunc: async () => {
                 await this.reauthenticate()

packages/core/src/shared/localizedText.ts

@@ -26,6 +26,14 @@ export const dontShow = localize('aws.generic.doNotShowAgain', "Don't Show Again
 export const loadMore = localize('AWS.generic.loadMore', 'Load More')
 export const learnMore = localize('AWS.generic.learnMore', 'Learn More')
 export const proceed = localize('AWS.generic.proceed', 'Proceed')
+export const connect = localize('AWS.auth.connect', 'Connect with AWS')
+export function connectionExpired(name: string) {
+    return localize(
+        'AWS.auth.expired',
+        'Connection expired. To continue using {0}, connect with AWS Builder ID or AWS IAM Identity center.',
+        name
+    )
+}
 
 export const checklogs = () =>
     localize(

packages/core/src/shared/settings.ts

@@ -581,7 +581,7 @@ export function fromExtensionManifest<T extends TypeDescriptor & Partial<Section
 }
 
 const prompts = settingsProps['aws.suppressPrompts'].properties
-export type PromptName = keyof typeof prompts
+type PromptName = keyof typeof prompts
 
 /**
  * Controls flags for prompts that allow the user to hide them. Usually this is presented as

packages/core/src/shared/utilities/messages.ts

@@ -15,7 +15,7 @@ import { addCodiconToString } from './textUtilities'
 import { getIcon, codicon } from '../icons'
 import globals from '../extensionGlobals'
 import { openUrl } from './vsCodeUtils'
-import { PromptSettings, PromptName } from '../../shared/settings'
+import { PromptSettings } from '../../shared/settings'
 
 export const messages = {
     editCredentials(icon: boolean) {
@@ -145,21 +145,18 @@ export async function showConfirmationMessage({
  *
  * @param message the line informing the user that they need to reauthenticate
  * @param connect the text to display on the "connect" button
- * @param doNotShow the text to display on the "do not show again" button
  * @param suppressId the ID of the prompt in
  * @param reauthFunc the function called if the "connect" button is clicked
  */
 export async function showReauthenticateMessage({
     message,
     connect,
-    doNotShow,
     suppressId,
     reauthFunc,
 }: {
     message: string
     connect: string
-    doNotShow: string
-    suppressId: PromptName
+    suppressId: Parameters<PromptSettings['isPromptEnabled']>[0]
     reauthFunc: () => Promise<void>
 }) {
     const settings = PromptSettings.instance
@@ -168,10 +165,10 @@ export async function showReauthenticateMessage({
         return
     }
 
-    await vscode.window.showInformationMessage(message, connect, doNotShow).then(async resp => {
+    await vscode.window.showInformationMessage(message, connect, localizedText.dontShow).then(async resp => {
         if (resp === connect) {
             await reauthFunc()
-        } else if (resp === doNotShow) {
+        } else if (resp === localizedText.dontShow) {
             await settings.disablePrompt(suppressId)
         }
     })