telemetry: "aws_openUrl" for URL click #3214

Extract openUrl() and use it from common places.

Author: justinmk3

src/credentials/sso/model.ts

@@ -14,6 +14,7 @@ import { getLogger } from '../../shared/logger/logger'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { CancellationError } from '../../shared/utilities/timeoutUtils'
 import { ssoAuthHelpUrl } from '../../shared/constants'
+import { openUrl } from '../../shared/utilities/vsCodeUtils'
 
 export interface SsoToken {
     /**
@@ -76,16 +77,8 @@ export interface SsoProfile {
 
 export const builderIdStartUrl = 'https://view.awsapps.com/start'
 
-const tryOpenHelpUrl = (url: string) =>
-    telemetry.aws_openUrl
-        .run(async span => {
-            span.record({ url })
-            const didOpen = await vscode.env.openExternal(vscode.Uri.parse(url))
-            if (!didOpen) {
-                throw new CancellationError('user')
-            }
-        })
-        .catch(e => getLogger().verbose('auth: failed to open help URL: %s', e))
+const tryOpenHelpUrl = (url: vscode.Uri) =>
+    openUrl(url).catch(e => getLogger().verbose('auth: failed to open help URL: %s', e))
 
 export async function openSsoPortalLink(
     startUrl: string,

src/shared/constants.ts

@@ -16,7 +16,7 @@ export const hostedFilesBaseUrl: string = 'https://d3rrggjwfhwld2.cloudfront.net
 export const endpointsFileUrl: string = 'https://idetoolkits.amazonwebservices.com/endpoints.json'
 export const aboutCredentialsFileUrl: string =
     'https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html'
-export const samAboutInstallUrl: string = 'https://aws.amazon.com/serverless/sam/'
+export const samAboutInstallUrl = vscode.Uri.parse('https://aws.amazon.com/serverless/sam/')
 export const vscodeMarketplaceUrl: string =
     'https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode'
 export const githubUrl: string = 'https://github.com/aws/aws-toolkit-vscode'
@@ -30,7 +30,9 @@ export const documentationUrl: string = isCloud9()
  * - alternative?: codecatalyst/latest/userguide/sign-up-create-resources.html
  */
 export const authHelpUrl = 'https://docs.aws.amazon.com/general/latest/gr/differences-aws_builder_id.html'
-export const ssoAuthHelpUrl = 'https://docs.aws.amazon.com/singlesignon/latest/userguide/howtosignin.html'
+export const ssoAuthHelpUrl = vscode.Uri.parse(
+    'https://docs.aws.amazon.com/singlesignon/latest/userguide/howtosignin.html'
+)
 export const credentialHelpUrl: string =
     'https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/setup-credentials.html'
 export const ssoCredentialsHelpUrl: string =

src/shared/sam/cli/samCliDetection.ts

@@ -71,7 +71,7 @@ function notifyUserSamCliNotDetected(SamCliSettings: SamCliSettings): void {
         )
         .then(async userResponse => {
             if (userResponse === learnMore) {
-                await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(samAboutInstallUrl))
+                await vscode.commands.executeCommand('vscode.open', samAboutInstallUrl)
             } else if (userResponse === browseToSamCli) {
                 const location: vscode.Uri[] | undefined = await vscode.window.showOpenDialog({
                     canSelectFiles: true,

src/shared/sam/cli/samCliValidationNotification.ts

@@ -3,13 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { openUrl } from '../../../shared/utilities/vsCodeUtils'
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 
 import { samAboutInstallUrl, vscodeMarketplaceUrl } from '../../constants'
 import { getIdeProperties } from '../../extensionUtilities'
-import { telemetry } from '../../telemetry/telemetry'
-import { CancellationError } from '../../utilities/timeoutUtils'
 import {
     InvalidSamCliError,
     InvalidSamCliVersionError,
@@ -31,13 +30,7 @@ export interface SamCliValidationNotificationAction {
 const actionGoToSamCli: SamCliValidationNotificationAction = {
     label: localize('AWS.samcli.userChoice.visit.install.url', 'Get SAM CLI'),
     invoke: async () => {
-        telemetry.aws_openUrl.run(async span => {
-            span.record({ url: samAboutInstallUrl })
-            const didOpen = await vscode.env.openExternal(vscode.Uri.parse(samAboutInstallUrl))
-            if (!didOpen) {
-                throw new CancellationError('user')
-            }
-        })
+        openUrl(samAboutInstallUrl)
     },
 }
 

src/shared/sam/sync.ts

@@ -43,6 +43,7 @@ import { getOverriddenParameters } from '../../lambda/config/parameterUtils'
 import { addTelemetryEnvVar } from './cli/samCliInvokerUtils'
 import { samSyncUrl, samInitDocUrl } from '../constants'
 import { getAwsConsoleUrl } from '../awsConsole'
+import { openUrl } from '../utilities/vsCodeUtils'
 
 const localize = nls.loadMessageBundle()
 
@@ -206,7 +207,7 @@ function createTemplatePrompter() {
         noItemsFoundItem: {
             label: localize('aws.sam.noWorkspace', 'No SAM template.yaml file(s) found. Select for help'),
             data: undefined,
-            onClick: () => vscode.env.openExternal(samInitDocUrl),
+            onClick: () => openUrl(samInitDocUrl),
         },
     })
 }

src/shared/ui/buttons.ts

@@ -9,6 +9,7 @@ import { documentationUrl } from '../constants'
 import { getIcon } from '../icons'
 import { WizardControl, WIZARD_EXIT, WIZARD_RETRY } from '../wizards/wizard'
 import { getIdeProperties } from '../extensionUtilities'
+import { openUrl } from '../utilities/vsCodeUtils'
 
 const localize = nls.loadMessageBundle()
 const helpTooltip = localize('AWS.command.help', 'View Toolkit Documentation')
@@ -29,7 +30,6 @@ export interface QuickInputButton<T> extends vscode.QuickInputButton {
  *
  * @param uri Opens the URI upon clicking
  * @param tooltip Optional tooltip for button
- * @param url Optional URL to open when button is clicked
  */
 export function createHelpButton(
     uri: string | vscode.Uri = documentationUrl,
@@ -52,7 +52,7 @@ export class QuickInputLinkButton implements QuickInputButton<void> {
     }
 
     public onClick(): void {
-        vscode.env.openExternal(this.uri)
+        openUrl(this.uri)
     }
 }
 

src/shared/utilities/vsCodeUtils.ts

@@ -8,7 +8,8 @@ import * as nls from 'vscode-nls'
 import { getIdeProperties } from '../extensionUtilities'
 import * as pathutils from './pathUtils'
 import { getLogger } from '../logger/logger'
-import { Timeout, waitTimeout, waitUntil } from './timeoutUtils'
+import { CancellationError, Timeout, waitTimeout, waitUntil } from './timeoutUtils'
+import { telemetry } from '../telemetry/telemetry'
 
 // TODO: Consider NLS initialization/configuration here & have packages to import localize from here
 export const localize = nls.loadMessageBundle()
@@ -162,3 +163,19 @@ export function reloadWindowPrompt(message: string): void {
         }
     })
 }
+
+/**
+ * Opens a URL in the system web browser. Throws `CancellationError`
+ * if user dismisses the vscode confirmation prompt.
+ */
+export async function openUrl(url: vscode.Uri): Promise<boolean> {
+    return telemetry.aws_openUrl.run(async span => {
+        span.record({ url: url.toString() })
+        const didOpen = await vscode.env.openExternal(url)
+        if (!didOpen) {
+            throw new CancellationError('user')
+            // getLogger().verbose('failed to open URL: %s', e)
+        }
+        return didOpen
+    })
+}