feat(appcomposer): add sync success/fail handling (#1521)

* feat(appcomposer): add sync success/fail handling

Problem:
The Sync button has no success/failure handling.

Solution:
This sends responses to the webview based on the status of
the Sync command. It also adds a telemetry event when the user
clicks the Sync button inside Composer.

* fix(appcomposer): remove unused message type, add deploy telemetry

* fix(appcomposer): update deployCompleted telemetry description

---------

Co-authored-by: Jacob Largent <[email protected]>

Author: JLargent42

src/applicationcomposer/handleMessage.ts

@@ -16,6 +16,7 @@ import {
     AddFileWatchRequestMessage,
     GenerateResourceRequestMessage,
     MessageType,
+    DeployRequestMessage,
 } from './types'
 import { saveFileMessageHandler } from './messageHandlers/saveFileMessageHandler'
 import { addFileWatchMessageHandler } from './messageHandlers/addFileWatchMessageHandler'
@@ -33,7 +34,7 @@ export async function handleMessage(message: unknown, context: WebviewContext) {
     if (messageType === MessageType.REQUEST) {
         switch (command) {
             case Command.INIT:
-                await initMessageHandler(context)
+                void initMessageHandler(context)
                 break
             case Command.LOAD_FILE:
                 void loadFileMessageHandler(message as LoadFileRequestMessage, context)
@@ -45,7 +46,7 @@ export async function handleMessage(message: unknown, context: WebviewContext) {
                 void addFileWatchMessageHandler(message as AddFileWatchRequestMessage, context)
                 break
             case Command.DEPLOY:
-                deployMessageHandler(context)
+                void deployMessageHandler(message as DeployRequestMessage, context)
                 break
             case Command.GENERATE_RESOURCE:
                 void generateResourceHandler(message as GenerateResourceRequestMessage, context)

src/applicationcomposer/messageHandlers/deployMessageHandler.ts

@@ -4,8 +4,31 @@
  */
 
 import vscode from 'vscode'
-import { WebviewContext } from '../types'
+import { Command, DeployRequestMessage, DeployResponseMessage, MessageType, WebviewContext } from '../types'
+import { SamSyncResult } from '../../shared/sam/sync'
+import { telemetry } from '../../shared/telemetry/telemetry'
 
-export function deployMessageHandler(context: WebviewContext) {
-    vscode.commands.executeCommand('aws.samcli.sync')
+export async function deployMessageHandler(message: DeployRequestMessage, context: WebviewContext) {
+    // SAM already handles success/failure, so we only log that the user clicked the deploy button
+    telemetry.appcomposer_deployClicked.emit()
+    const args = context.textDocument.uri
+    /* TODO Rework this command so that a failure case is returned
+     * We don't want to override the SAM Sync telemetry. The SAM telemetry catches all errors,
+     * so we instead check for an undefined response to determine failure. The downside is that
+     * we don't get failure reasons.
+     */
+    const result = (await vscode.commands.executeCommand('aws.samcli.sync', args)) as SamSyncResult
+    if (result?.isSuccess) {
+        vscode.window.showInformationMessage('SAM Sync succeeded!')
+        telemetry.appcomposer_deployCompleted.emit({ result: 'Succeeded' })
+    } else {
+        telemetry.appcomposer_deployCompleted.emit({ result: 'Failed' })
+    }
+    const response: DeployResponseMessage = {
+        command: Command.DEPLOY,
+        messageType: MessageType.RESPONSE,
+        eventId: message.eventId,
+        isSuccess: result?.isSuccess,
+    }
+    context.panel.webview.postMessage(response)
 }

src/applicationcomposer/types.ts

@@ -74,6 +74,15 @@ export interface FileChangedMessage extends Message {
     fileContents: string
 }
 
+export interface DeployRequestMessage extends Message {
+    eventId: string
+}
+
+export interface DeployResponseMessage extends Message {
+    eventId: string
+    isSuccess: boolean
+}
+
 export interface RequestMessage extends Message {
     command: Command
 }

src/shared/sam/sync.ts

@@ -528,8 +528,12 @@ export async function prepareSyncParams(arg: vscode.Uri | AWSTreeNodeBase | unde
     return baseParams
 }
 
+export type SamSyncResult = {
+    isSuccess: boolean
+}
+
 export function registerSync() {
-    async function runSync(deployType: SyncParams['deployType'], arg?: unknown) {
+    async function runSync(deployType: SyncParams['deployType'], arg?: unknown): Promise<SamSyncResult> {
         telemetry.record({ syncedResources: deployType === 'infra' ? 'AllResources' : 'CodeOnly' })
 
         const connection = Auth.instance.activeConnection
@@ -550,6 +554,9 @@ export function registerSync() {
 
         try {
             await runSamSync({ ...params, connection })
+            return {
+                isSuccess: true,
+            }
         } catch (err) {
             throw ToolkitError.chain(err, 'Failed to sync SAM application', { details: { ...params } })
         }

src/shared/telemetry/vscodeTelemetry.json

@@ -522,6 +522,14 @@
             "description": "Called after opening a template",
             "metadata": [{ "type": "hasChatAuth" }]
         },
+        {
+            "name": "appcomposer_deployClicked",
+            "description": "Called after clicking the Sync button"
+        },
+        {
+            "name": "appcomposer_deployCompleted",
+            "description": "Called after a Composer-triggered SAM Sync completes"
+        },
         {
             "name": "appcomposer_generateClicked",
             "description": "Called after generating a standard resource template partial",