telemetry(messages): maybeShowMinVscodeWarning

Author: justinmk3

package-lock.json

@@ -14,6 +14,8 @@ import { fs } from '../shared/fs/fs'
 import { getIdeProperties, getIdeType, isAmazonQ, isCloud9, isCn, productName } from './extensionUtilities'
 import * as localizedText from './localizedText'
 import { AmazonQPromptSettings, ToolkitPromptSettings } from './settings'
+import { showMessage } from './utilities/messages'
+import { getTelemetryReasonDesc } from './errors'
 
 const localize = nls.loadMessageBundle()
 
@@ -26,20 +28,24 @@ export async function maybeShowMinVscodeWarning(minVscode: string) {
         return
     }
     const updateButton = `Update ${vscode.env.appName}`
+    const msg = `${productName()} will soon require VS Code ${minVscode} or newer. The currently running version ${vscode.version} will no longer receive updates.`
     if (getIdeType() === 'vscode' && semver.lt(vscode.version, minVscode)) {
-        void vscode.window
-            .showWarningMessage(
-                `${productName()} will soon require VS Code ${minVscode} or newer. The currently running version ${vscode.version} will no longer receive updates.`,
-                updateButton,
-                localizedText.dontShow
-            )
-            .then(async (resp) => {
-                if (resp === updateButton) {
-                    await vscode.commands.executeCommand('update.checkForUpdate')
-                } else if (resp === localizedText.dontShow) {
-                    void settings.disablePrompt('minIdeVersion')
-                }
-            })
+        void showMessage(
+            'warn',
+            msg,
+            [updateButton, localizedText.dontShow],
+            {},
+            {
+                id: 'maybeShowMinVscodeWarning',
+                reasonDesc: getTelemetryReasonDesc(msg),
+            }
+        ).then(async (resp) => {
+            if (resp === updateButton) {
+                await vscode.commands.executeCommand('update.checkForUpdate')
+            } else if (resp === localizedText.dontShow) {
+                void settings.disablePrompt('minIdeVersion')
+            }
+        })
     }
 }
 

packages/core/src/shared/extensionStartup.ts

@@ -16,8 +16,9 @@ import { getIcon, codicon } from '../icons'
 import globals from '../extensionGlobals'
 import { openUrl } from './vsCodeUtils'
 import { AmazonQPromptSettings, ToolkitPromptSettings } from '../../shared/settings'
-import { telemetry } from '../telemetry/telemetry'
+import { telemetry, ToolkitShowNotification } from '../telemetry/telemetry'
 import { vscodeComponent } from '../vscode/commands2'
+import { getTelemetryReasonDesc } from '../errors'
 
 export const messages = {
     editCredentials(icon: boolean) {
@@ -35,21 +36,32 @@ export function makeFailedWriteMessage(filename: string): string {
     return message
 }
 
-function showMessageWithItems(
-    message: string,
+export function showMessage(
     kind: 'info' | 'warn' | 'error' = 'error',
+    message: string,
     items: string[] = [],
-    useModal: boolean = false
-): Thenable<string | undefined> {
-    switch (kind) {
-        case 'info':
-            return vscode.window.showInformationMessage(message, { modal: useModal }, ...items)
-        case 'warn':
-            return vscode.window.showWarningMessage(message, { modal: useModal }, ...items)
-        case 'error':
-        default:
-            return vscode.window.showErrorMessage(message, { modal: useModal }, ...items)
+    options: vscode.MessageOptions & { telemetry?: boolean } = {},
+    metric: Partial<ToolkitShowNotification> = {
+        id: 'unknown',
+        component: 'editor',
     }
+): Thenable<string | undefined> {
+    return telemetry.toolkit_showNotification.run(async (span) => {
+        span.record({
+            passive: true,
+            ...metric,
+        })
+
+        switch (kind) {
+            case 'info':
+                return vscode.window.showInformationMessage(message, options, ...items)
+            case 'warn':
+                return vscode.window.showWarningMessage(message, options, ...items)
+            case 'error':
+            default:
+                return vscode.window.showErrorMessage(message, options, ...items)
+        }
+    })
 }
 
 /**
@@ -75,7 +87,16 @@ export async function showMessageWithUrl(
     const uri = typeof url === 'string' ? vscode.Uri.parse(url) : url
     const items = [...extraItems, urlItem]
 
-    const p = showMessageWithItems(message, kind, items, useModal)
+    const p = showMessage(
+        kind,
+        message,
+        items,
+        { modal: useModal },
+        {
+            id: 'showMessageWithUrl',
+            reasonDesc: getTelemetryReasonDesc(message),
+        }
+    )
     return p.then<string | undefined>((selection) => {
         if (selection === urlItem) {
             void openUrl(uri)
@@ -102,7 +123,16 @@ export async function showViewLogsMessage(
     const logsItem = localize('AWS.generic.message.viewLogs', 'View Logs...')
     const items = [...extraItems, logsItem]
 
-    const p = showMessageWithItems(message, kind, items)
+    const p = showMessage(
+        kind,
+        message,
+        items,
+        {},
+        {
+            id: 'showViewLogsMessage',
+            reasonDesc: getTelemetryReasonDesc(message),
+        }
+    )
     return p.then<string | undefined>((selection) => {
         if (selection === logsItem) {
             globals.logOutputChannel.show(true)

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

@@ -21,6 +21,7 @@ import globals from '../../shared/extensionGlobals'
 import { createQuickStartWebview, maybeShowMinVscodeWarning } from '../../shared/extensionStartup'
 import { fs } from '../../shared'
 import { getTestWindow } from './vscode/window'
+import { assertTelemetry } from '../testUtil'
 
 describe('extensionUtilities', function () {
     it('maybeShowMinVscodeWarning', async () => {
@@ -30,6 +31,7 @@ describe('extensionUtilities', function () {
             /will soon require .* 99\.0\.0 or newer. The currently running version .* will no longer receive updates./
         const msg = await getTestWindow().waitForMessage(expectedMsg)
         msg.close()
+        assertTelemetry('toolkit_showNotification', [])
     })
 
     describe('createQuickStartWebview', async function () {