telemetry: aws_openUrl #3566

justinmk3 · web-flow · commit 97a0b3cd3945 · 2023-06-12T09:28:34.000-07:00
Capture metrics for generic URLs.
diff --git a/src/apprunner/wizards/codeRepositoryWizard.ts b/src/apprunner/wizards/codeRepositoryWizard.ts
@@ -22,6 +22,7 @@ import {
     apprunnerCreateServiceDocsUrl,
 } from '../../shared/constants'
 import { Wizard, WIZARD_BACK } from '../../shared/wizards/wizard'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 const localize = nls.loadMessageBundle()
 
@@ -149,7 +150,7 @@ export function createConnectionPrompter(client: AppRunnerClient) {
         detail: 'Click for documentation on creating a new GitHub connection for App Runner',
         data: {} as any,
         invalidSelection: true,
-        onClick: () => vscode.env.openExternal(vscode.Uri.parse(apprunnerConnectionHelpUrl)),
+        onClick: () => openUrl(vscode.Uri.parse(apprunnerConnectionHelpUrl)),
     }
 
     const errorItem = {
diff --git a/src/apprunner/wizards/deploymentButton.ts b/src/apprunner/wizards/deploymentButton.ts
@@ -11,6 +11,7 @@ import { apprunnerPricingUrl } from '../../shared/constants'
 import { PromptSettings } from '../../shared/settings'
 import { getIcon } from '../../shared/icons'
 import { dontShow } from '../../shared/localizedText'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 const localize = nls.loadMessageBundle()
 
@@ -41,7 +42,7 @@ async function showDeploymentCostNotification(): Promise<void> {
 
         vscode.window.showInformationMessage(notice, viewPricing, dontShow).then(async button => {
             if (button === viewPricing) {
-                vscode.env.openExternal(pricingUri)
+                openUrl(pricingUri)
                 await showDeploymentCostNotification()
             } else if (button === dontShow) {
                 settings.disablePrompt('apprunnerNotifyPricing')
diff --git a/src/auth/credentials/utils.ts b/src/auth/credentials/utils.ts
@@ -16,6 +16,7 @@ import { Timeout, waitTimeout } from '../../shared/utilities/timeoutUtils'
 import { fromExtensionManifest } from '../../shared/settings'
 import { Profile } from './sharedCredentials'
 import { createInputBox, promptUser } from '../../shared/ui/input'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 const credentialsTimeout = 300000 // 5 minutes
 const credentialsProgressDelay = 1000
@@ -45,7 +46,7 @@ export function showLoginFailedMessage(credentialsId: string, errMsg: string): v
         buttons
     ).then((selection: string | undefined) => {
         if (selection === getHelp) {
-            vscode.env.openExternal(vscode.Uri.parse(authHelpUrl))
+            openUrl(vscode.Uri.parse(authHelpUrl))
         }
         if (selection === editCreds) {
             vscode.commands.executeCommand('aws.credentials.edit')
diff --git a/src/auth/utils.ts b/src/auth/utils.ts
@@ -41,6 +41,7 @@ import {
 import { Commands } from '../shared/vscode/commands2'
 import { Auth } from './auth'
 import { validateIsNewSsoUrl, validateSsoUrlFormat } from './sso/validation'
+import { openUrl } from '../shared/utilities/vsCodeUtils'
 
 export async function promptForConnection(auth: Auth, type?: 'iam' | 'sso') {
     const resp = await createConnectionPrompter(auth, type).prompt()
@@ -215,7 +216,7 @@ export async function showRegionPrompter(
 }
 
 Commands.register('aws.auth.help', async () => {
-    vscode.env.openExternal(vscode.Uri.parse(authHelpUrl))
+    openUrl(vscode.Uri.parse(authHelpUrl))
     telemetry.aws_help.emit()
 })
 
diff --git a/src/cdk/explorer/rootNode.ts b/src/cdk/explorer/rootNode.ts
@@ -8,7 +8,7 @@ import { cdkDocumentationUrl } from '../../shared/constants'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { TreeNode } from '../../shared/treeview/resourceTreeDataProvider'
 import { createPlaceholderItem } from '../../shared/treeview/utils'
-import { localize } from '../../shared/utilities/vsCodeUtils'
+import { localize, openUrl } from '../../shared/utilities/vsCodeUtils'
 import { Commands } from '../../shared/vscode/commands2'
 import { detectCdkProjects } from './detectCdkProjects'
 import { AppNode } from './nodes/appNode'
@@ -50,6 +50,6 @@ export const cdkNode = new CdkRootNode()
 export const refreshCdkExplorer = Commands.register('aws.cdk.refresh', cdkNode.refresh.bind(cdkNode))
 
 Commands.register('aws.cdk.viewDocs', () => {
-    vscode.env.openExternal(vscode.Uri.parse(cdkDocumentationUrl))
+    openUrl(vscode.Uri.parse(cdkDocumentationUrl))
     telemetry.aws_help.emit({ name: 'cdk' })
 })
diff --git a/src/codecatalyst/explorer.ts b/src/codecatalyst/explorer.ts
@@ -16,6 +16,7 @@ import { ConnectedDevEnv, getDevfileLocation, getThisDevEnv } from './model'
 import * as codecatalyst from './model'
 import { getLogger } from '../shared/logger'
 import { Connection, isBuilderIdConnection } from '../auth/connection'
+import { openUrl } from '../shared/utilities/vsCodeUtils'
 
 export const getStartedCommand = Commands.register(
     'aws.codecatalyst.getStarted',
@@ -28,7 +29,7 @@ export const getStartedCommand = Commands.register(
 )
 
 const learnMoreCommand = Commands.register('aws.learnMore', async (docsUrl: vscode.Uri) => {
-    return vscode.env.openExternal(docsUrl)
+    return openUrl(docsUrl)
 })
 
 // Only used in rare cases on C9
diff --git a/src/codewhisperer/activation.ts b/src/codewhisperer/activation.ts
@@ -48,6 +48,7 @@ import { CodeWhispererCodeCoverageTracker } from './tracker/codewhispererCodeCov
 import { AuthUtil } from './util/authUtil'
 import { ImportAdderProvider } from './service/importAdderProvider'
 import { TelemetryHelper } from './util/telemetryHelper'
+import { openUrl } from '../shared/utilities/vsCodeUtils'
 
 const performance = globalThis.performance ?? require('perf_hooks').performance
 
@@ -96,7 +97,7 @@ export async function activate(context: ExtContext): Promise<void> {
                         )
                         .then(async resp => {
                             if (resp === CodeWhispererConstants.settingsLearnMore) {
-                                vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
+                                openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
                             }
                         })
                 }
@@ -111,7 +112,7 @@ export async function activate(context: ExtContext): Promise<void> {
                         )
                         .then(async resp => {
                             if (resp === CodeWhispererConstants.settingsLearnMore) {
-                                vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
+                                openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
                             }
                         })
                 }
diff --git a/src/codewhisperer/commands/basicCommands.ts b/src/codewhisperer/commands/basicCommands.ts
@@ -18,6 +18,7 @@ import { ReferenceLogViewProvider } from '../service/referenceLogViewProvider'
 import { AuthUtil } from '../util/authUtil'
 import { isCloud9 } from '../../shared/extensionUtilities'
 import { InlineCompletionService } from '../service/inlineCompletionService'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 export const toggleCodeSuggestions = Commands.declare(
     'aws.codeWhisperer.toggleCodeSuggestion',
@@ -64,7 +65,7 @@ export const showReferenceLog = Commands.declare(
 )
 
 export const showIntroduction = Commands.declare('aws.codeWhisperer.introduction', () => async () => {
-    vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUriGeneral))
+    openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUriGeneral))
 })
 
 export const showSecurityScan = Commands.declare(
@@ -116,13 +117,12 @@ export const showSsoSignIn = Commands.declare('aws.codeWhisperer.sso', () => asy
 
 export const showLearnMore = Commands.declare('aws.codeWhisperer.learnMore', () => async () => {
     telemetry.ui_click.emit({ elementId: 'cw_learnMore_Cta' })
-
-    vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUriGeneral))
+    openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUriGeneral))
 })
 
 // TODO: Use a different URI
 export const showFreeTierLimit = Commands.declare('aws.codeWhisperer.freeTierLimit', () => async () => {
-    vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
+    openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))
 })
 
 export const updateReferenceLog = Commands.declare(
diff --git a/src/codewhisperer/commands/startSecurityScan.ts b/src/codewhisperer/commands/startSecurityScan.ts
@@ -31,6 +31,7 @@ import { getDirSize } from '../../shared/filesystemUtilities'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { TelemetryHelper } from '../util/telemetryHelper'
 import { isAwsError } from '../../shared/errors'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 const performance = globalThis.performance ?? require('perf_hooks').performance
 const securityScanOutputChannel = vscode.window.createOutputChannel('CodeWhisperer Security Scan Logs')
@@ -284,7 +285,7 @@ export function showScanCompletedNotification(total: number, scannedFiles: Set<s
             if (value === CodeWhispererConstants.showScannedFilesMessage) {
                 vscode.commands.executeCommand(CodeWhispererConstants.codeScanLogsOutputChannelId)
             } else if (value === learnMore) {
-                vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.securityScanLearnMoreUri))
+                openUrl(vscode.Uri.parse(CodeWhispererConstants.securityScanLearnMoreUri))
             }
         })
 }
diff --git a/src/dynamicResources/activation.ts b/src/dynamicResources/activation.ts
@@ -17,6 +17,7 @@ import { ResourceTypeNode } from './explorer/nodes/resourceTypeNode'
 import { resourceFileGlobPattern } from './awsResourceManager'
 import { Commands } from '../shared/vscode/commands2'
 import globals from '../shared/extensionGlobals'
+import { openUrl } from '../shared/utilities/vsCodeUtils'
 
 const localize = nls.loadMessageBundle()
 
@@ -94,7 +95,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
             }
         }),
         Commands.register('aws.resources.viewDocs', async (node: ResourceTypeNode) => {
-            await vscode.env.openExternal(vscode.Uri.parse(node.metadata.documentation))
+            await openUrl(vscode.Uri.parse(node.metadata.documentation))
         }),
         vscode.workspace.onDidChangeTextDocument(textDocumentEvent => {
             if (resourceDiagnostics.has(textDocumentEvent.document.uri)) {
diff --git a/src/ecs/activation.ts b/src/ecs/activation.ts
@@ -12,6 +12,7 @@ import { getResourceFromTreeNode } from '../shared/treeview/utils'
 import { Instance } from '../shared/utilities/typeConstructors'
 import { Service } from './model'
 import { telemetry } from '../shared/telemetry/telemetry'
+import { openUrl } from '../shared/utilities/vsCodeUtils'
 
 export async function activate(ctx: ExtContext): Promise<void> {
     ctx.extensionContext.subscriptions.push(runCommandInContainer, openTaskInTerminal)
@@ -29,7 +30,7 @@ export async function activate(ctx: ExtContext): Promise<void> {
             })
         }),
         Commands.register('aws.ecs.viewDocumentation', async () => {
-            vscode.env.openExternal(vscode.Uri.parse(ecsDocumentationUrl))
+            openUrl(vscode.Uri.parse(ecsDocumentationUrl))
         })
     )
 }
diff --git a/src/eventSchemas/wizards/schemaCodeDownloadWizard.ts b/src/eventSchemas/wizards/schemaCodeDownloadWizard.ts
@@ -26,6 +26,7 @@ import * as codeLang from '../models/schemaCodeLangs'
 
 import { SchemaItemNode } from '../explorer/schemaItemNode'
 import { recentlyUsed } from '../../shared/localizedText'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 export interface SchemaCodeDownloadWizardContext {
     readonly schemaLangs: ImmutableSet<codeLang.SchemaCodeLangs>
@@ -77,7 +78,7 @@ export class DefaultSchemaCodeDownloadWizardContext extends WizardContext implem
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(eventBridgeSchemasDocUrl))
+                    openUrl(vscode.Uri.parse(eventBridgeSchemasDocUrl))
                 }
             },
         })
@@ -115,7 +116,7 @@ export class DefaultSchemaCodeDownloadWizardContext extends WizardContext implem
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(eventBridgeSchemasDocUrl))
+                    openUrl(vscode.Uri.parse(eventBridgeSchemasDocUrl))
                 }
             },
         })
diff --git a/src/extension.ts b/src/extension.ts
@@ -67,6 +67,7 @@ import { Logging } from './shared/logger/commands'
 import { UriHandler } from './shared/vscode/uriHandler'
 import { telemetry } from './shared/telemetry/telemetry'
 import { Auth } from './auth/auth'
+import { openUrl } from './shared/utilities/vsCodeUtils'
 
 let localize: nls.LocalizeFunc
 
@@ -177,15 +178,15 @@ export async function activate(context: vscode.ExtensionContext) {
             ),
             // register URLs in extension menu
             Commands.register('aws.help', async () => {
-                vscode.env.openExternal(vscode.Uri.parse(documentationUrl))
+                openUrl(vscode.Uri.parse(documentationUrl))
                 telemetry.aws_help.emit()
             }),
             Commands.register('aws.github', async () => {
-                vscode.env.openExternal(vscode.Uri.parse(githubUrl))
+                openUrl(vscode.Uri.parse(githubUrl))
                 telemetry.aws_showExtensionSource.emit()
             }),
             Commands.register('aws.createIssueOnGitHub', async () => {
-                vscode.env.openExternal(vscode.Uri.parse(githubCreateIssueUrl))
+                openUrl(vscode.Uri.parse(githubCreateIssueUrl))
                 telemetry.aws_reportPluginIssue.emit()
             }),
             Commands.register('aws.quickStart', async () => {
diff --git a/src/lambda/commands/createNewSamApp.ts b/src/lambda/commands/createNewSamApp.ts
@@ -48,6 +48,7 @@ import globals from '../../shared/extensionGlobals'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { LambdaArchitecture, Result, Runtime } from '../../shared/telemetry/telemetry'
 import { getTelemetryReason, getTelemetryResult } from '../../shared/errors'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 export const samInitTemplateFiles: string[] = ['template.yaml', 'template.yml']
 export const samInitReadmeFile: string = 'README.TOOLKIT.md'
@@ -309,7 +310,7 @@ export async function createNewSamApplication(
                 )
                 .then(async buttonText => {
                     if (buttonText === helpText) {
-                        vscode.env.openExternal(vscode.Uri.parse(launchConfigDocUrl))
+                        openUrl(vscode.Uri.parse(launchConfigDocUrl))
                     }
                 })
         }
@@ -435,7 +436,7 @@ async function showCompletionNotification(appName: string, configs: string): Pro
     if (action === openJson) {
         await openLaunchJsonFile()
     } else if (action === learnMore) {
-        vscode.env.openExternal(vscode.Uri.parse(debugNewSamAppUrl))
+        openUrl(vscode.Uri.parse(debugNewSamAppUrl))
     }
 }
 
diff --git a/src/lambda/models/samLambdaRuntime.ts b/src/lambda/models/samLambdaRuntime.ts
@@ -13,6 +13,7 @@ import { isCloud9 } from '../../shared/extensionUtilities'
 import { PrompterButtons } from '../../shared/ui/buttons'
 import { createQuickPick, DataQuickPickItem, QuickPickPrompter } from '../../shared/ui/pickerPrompter'
 import { supportedLambdaRuntimesUrl } from '../../shared/constants'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 export enum RuntimeFamily {
     Unknown,
@@ -155,7 +156,7 @@ function handleDeprecatedRuntime(runtime: Runtime) {
         )
         .then(button => {
             if (button === moreInfo) {
-                vscode.env.openExternal(vscode.Uri.parse(supportedLambdaRuntimesUrl))
+                openUrl(vscode.Uri.parse(supportedLambdaRuntimesUrl))
             }
         })
     throw new Error(`Runtime ${runtime} is deprecated, see: ${supportedLambdaRuntimesUrl}`)
diff --git a/src/lambda/wizards/samDeployWizard.ts b/src/lambda/wizards/samDeployWizard.ts
@@ -42,6 +42,7 @@ import { SamCliSettings } from '../../shared/sam/cli/samCliSettings'
 import { getIcon } from '../../shared/icons'
 import { DefaultS3Client } from '../../shared/clients/s3Client'
 import { telemetry } from '../../shared/telemetry/telemetry'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const CREATE_NEW_BUCKET = localize('AWS.command.s3.createBucket', 'Create Bucket...')
@@ -251,7 +252,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                    openUrl(vscode.Uri.parse(samDeployDocUrl))
                 }
             },
         })
@@ -291,7 +292,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                         if (button === vscode.QuickInputButtons.Back) {
                             resolve(undefined)
                         } else if (button === this.helpButton) {
-                            vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                            openUrl(vscode.Uri.parse(samDeployDocUrl))
                         }
                     },
                 })
@@ -335,7 +336,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                         if (button === vscode.QuickInputButtons.Back) {
                             resolve(undefined)
                         } else if (button === this.helpButton) {
-                            vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                            openUrl(vscode.Uri.parse(samDeployDocUrl))
                         }
                     },
                 })
@@ -384,7 +385,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                    openUrl(vscode.Uri.parse(samDeployDocUrl))
                 }
             },
         })
@@ -454,7 +455,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                    openUrl(vscode.Uri.parse(samDeployDocUrl))
                 } else if (button === createBucket) {
                     resolve([{ label: CREATE_NEW_BUCKET }])
                 } else if (button === enterBucket) {
@@ -510,7 +511,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                    openUrl(vscode.Uri.parse(samDeployDocUrl))
                 } else if (bucketProps.buttonHandler) {
                     bucketProps.buttonHandler(button, inputBox, resolve, reject)
                 }
@@ -554,7 +555,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                    openUrl(vscode.Uri.parse(samDeployDocUrl))
                 }
             },
         })
@@ -607,7 +608,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
                 if (button === vscode.QuickInputButtons.Back) {
                     resolve(undefined)
                 } else if (button === this.helpButton) {
-                    vscode.env.openExternal(vscode.Uri.parse(samDeployDocUrl))
+                    openUrl(vscode.Uri.parse(samDeployDocUrl))
                 }
             },
         })
diff --git a/src/s3/fileViewerManager.ts b/src/s3/fileViewerManager.ts
diff --git a/src/shared/awsContextCommands.ts b/src/shared/awsContextCommands.ts
diff --git a/src/shared/debug/launchConfiguration.ts b/src/shared/debug/launchConfiguration.ts
diff --git a/src/shared/sam/debugger/awsSamDebugger.ts b/src/shared/sam/debugger/awsSamDebugger.ts
diff --git a/src/shared/utilities/cliUtils.ts b/src/shared/utilities/cliUtils.ts
diff --git a/src/shared/wizards/multiStepWizard.ts b/src/shared/wizards/multiStepWizard.ts

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ import { CodeWhispererCodeCoverageTracker } from './tracker/codewhispererCodeCov`
`48`	`48`	`import { AuthUtil } from './util/authUtil'`
`49`	`49`	`import { ImportAdderProvider } from './service/importAdderProvider'`
`50`	`50`	`import { TelemetryHelper } from './util/telemetryHelper'`
	`51`	`+import { openUrl } from '../shared/utilities/vsCodeUtils'`
`51`	`52`
`52`	`53`	`const performance = globalThis.performance ?? require('perf_hooks').performance`
`53`	`54`
`@@ -96,7 +97,7 @@ export async function activate(context: ExtContext): Promise<void> {`
`96`	`97`	`)`
`97`	`98`	`.then(async resp => {`
`98`	`99`	`if (resp === CodeWhispererConstants.settingsLearnMore) {`
`99`		`- vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))`
	`100`	`+ openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))`
`100`	`101`	`}`
`101`	`102`	`})`
`102`	`103`	`}`
`@@ -111,7 +112,7 @@ export async function activate(context: ExtContext): Promise<void> {`
`111`	`112`	`)`
`112`	`113`	`.then(async resp => {`
`113`	`114`	`if (resp === CodeWhispererConstants.settingsLearnMore) {`
`114`		`- vscode.env.openExternal(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))`
	`115`	`+ openUrl(vscode.Uri.parse(CodeWhispererConstants.learnMoreUri))`
`115`	`116`	`}`
`116`	`117`	`})`
`117`	`118`	`}`