fix: "Scanning CloudFormation templates..." #4020

Author: justinmk3

.changes/next-release/Bug Fix-b7a9021d-e848-46a3-8f6d-fd7017cb1784.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "\"Scanning CloudFormation templates...\" message `Cancel` button does not fully stop the scan"
+}

src/lambda/commands/createNewSamApp.ts

@@ -48,7 +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'
+import { openUrl, replaceVscodeVars } from '../../shared/utilities/vsCodeUtils'
 
 export const samInitTemplateFiles: string[] = ['template.yaml', 'template.yml']
 export const samInitReadmeFile: string = 'README.TOOLKIT.md'
@@ -395,8 +395,7 @@ export async function addInitialLaunchConfiguration(
         const targetDir: string = path.dirname(targetUri.fsPath)
         const filtered = configurations.filter(config => {
             let templatePath: string = (config.invokeTarget as TemplateTargetProperties).templatePath
-            // TODO: write utility function that does this for other variables too
-            templatePath = templatePath.replace('${workspaceFolder}', folder.uri.fsPath)
+            templatePath = replaceVscodeVars(templatePath, folder.uri.fsPath)
 
             return (
                 isTemplateTargetProperties(config.invokeTarget) &&

src/shared/fs/templateRegistry.ts

@@ -87,20 +87,21 @@ export class AsyncCloudFormationTemplateRegistry {
         }
 
         let perf: PerfLog
-        const cancelSetupPromise = new Timeout(30 * 60 * 1000) // 30 min
+        const cancelSetup = new Timeout(30 * 60 * 1000) // 30 min
         if (!this.setupPromise) {
             perf = new PerfLog('cfn: template registry setup')
-            this.setupPromise = this.asyncSetupFunc(this.instance, cancelSetupPromise)
+            this.setupPromise = this.asyncSetupFunc(this.instance, cancelSetup)
         }
         this.setupPromise.then(() => {
             if (perf) {
                 perf.done()
             }
             this.isSetup = true
-            cancelSetupPromise.dispose()
+            cancelSetup.dispose()
         })
         // Show user a message indicating setup is in progress
         if (this.setupProgressMessage === undefined) {
+            // TODO: use showMessageWithCancel() ?
             this.setupProgressMessage = vscode.window.withProgress(
                 {
                     location: vscode.ProgressLocation.Notification,
@@ -114,7 +115,7 @@ export class AsyncCloudFormationTemplateRegistry {
                     token.onCancellationRequested(() => {
                         // Allows for new message to be created if templateRegistry variable attempted to be used again
                         this.setupProgressMessage = undefined
-                        cancelSetupPromise.cancel()
+                        cancelSetup.cancel()
                     })
                     getLogger().debug('cfn: getInstance() requested, still initializing')
                     while (!this.isSetup) {

src/shared/fs/watchedFiles.ts

@@ -57,14 +57,21 @@ export function getExcludePattern() {
 const getExcludePatternOnce = once(getExcludePattern)
 
 /**
- * WatchedFiles lets us index files in the current registry. It is used
+ * WatchedFiles lets us watch files on the filesystem. It is used
  * for CFN templates among other things. WatchedFiles holds a list of pairs of
  * the absolute path to the file or "untitled:" URI along with a transform of it that is useful for
  * where it is used. For example, for templates, it parses the template and stores it.
  *
- * Initialize the registry by adding watch patterns and excluded patterns via
- * `addWatchPatterns`, `watchUntitledFiles`, and `addExcludedPattern` and then
- * calling the `rebuild` function to begin registering files.
+ * Initialize the registry by adding patterns, followed by a required call to `rebuild`.
+
+ * Example:
+ * ```
+ *     registry.addExcludedPattern(/.*[/\\]\.aws-sam([/\\].*|$)/)
+ *     registry.addExcludedPattern('**\/*.{yaml,yml}')
+ *     registry.addWatchPatterns([/.*devfile\.(yaml|yml)/i])
+ *     registry.watchUntitledFiles()
+ *     await registry.rebuild(cancellationTimeout)
+ * ```
  */
 export abstract class WatchedFiles<T> implements vscode.Disposable {
     private isWatching: boolean = false
@@ -284,34 +291,40 @@ export abstract class WatchedFiles<T> implements vscode.Disposable {
     /**
      * Builds/rebuilds registry using current glob and exclusion patterns. ***Necessary to init registry***.
      *
-     * @param cancellationTimeout Optional timeout that can trigger canceling additional loading on completion (manual or timed)
+     * @param cancel Optional timeout that can trigger canceling additional loading on completion (manual or timed)
      */
-    public async rebuild(cancellationTimeout?: Timeout): Promise<void> {
+    public async rebuild(cancel?: Timeout): Promise<void> {
         let skips = 0
+        let todo = 0
         this.isWatching = true
         this.reset()
 
         const exclude = getExcludePatternOnce()
-        getLogger().info(`${this.name}: Building registry with the following criteria: ${this.outputPatterns()}`)
-        for (let i = 0; i < this.globs.length && !cancellationTimeout?.completed; i++) {
+        getLogger().info(`${this.name}: building with: ${this.outputPatterns()}`)
+        for (let i = 0; i < this.globs.length && !cancel?.completed; i++) {
             const glob = this.globs[i]
             try {
                 const found = await vscode.workspace.findFiles(glob, exclude)
-                for (let j = 0; j < found.length && !cancellationTimeout?.completed; j++) {
-                    await this.addItem(found[j], true)
+                todo = found.length
+                for (let j = 0; j < found.length && !cancel?.completed; j++, todo--) {
+                    const r = await this.addItem(found[j], true)
+                    if (!r) {
+                        skips++
+                    }
                 }
             } catch (e) {
-                // file not processable
-                skips++
                 const err = e as Error
-                getLogger().error(`${this.name}: watchedFiles: findFiles("%s", "%s"): %s`, glob, exclude, err.message)
+                if (err.name !== 'Canceled') {
+                    // vscode may throw nonsense "Canceled" errors when stopping the debugger.
+                    getLogger().error(`%s: findFiles("%s", "%s"): %s`, this.name, glob, exclude, err.message)
+                }
             }
         }
         getLogger().info(
-            `${this.name}: Registered %s items%s%s`,
+            `${this.name}: processed %s items%s%s`,
             this.registryData.size,
-            cancellationTimeout?.completed ? ' (cancelled)' : '',
-            skips > 0 ? `, skipped ${skips} entries` : ''
+            cancel?.completed ? ` (cancelled, ${todo} left)` : '',
+            skips > 0 ? `, skipped ${skips}` : ''
         )
     }
 

src/shared/sam/debugger/awsSamDebugConfigurationValidator.ts

@@ -8,7 +8,7 @@ import * as fs from 'fs'
 import * as path from 'path'
 import { samImageLambdaRuntimes, samZipLambdaRuntimes } from '../../../lambda/models/samLambdaRuntime'
 import * as CloudFormation from '../../cloudformation/cloudformation'
-import { localize } from '../../utilities/vsCodeUtils'
+import { localize, replaceVscodeVars } from '../../utilities/vsCodeUtils'
 import {
     awsSamDebugRequestTypes,
     awsSamDebugTargetTypes,
@@ -69,8 +69,13 @@ export class DefaultAwsSamDebugConfigurationValidator implements AwsSamDebugConf
         ) {
             let cfnTemplate: CloudFormation.Template | undefined
             if (config.invokeTarget.templatePath) {
-                const fullpath = tryGetAbsolutePath(this.workspaceFolder, config.invokeTarget.templatePath)
+                // TODO: why wasn't ${workspaceFolder} resolved before now?
+                const resolvedPath = replaceVscodeVars(
+                    config.invokeTarget.templatePath,
+                    this.workspaceFolder?.uri.fsPath
+                )
                 // Normalize to absolute path for use in the runner.
+                const fullpath = tryGetAbsolutePath(this.workspaceFolder, resolvedPath)
                 config.invokeTarget.templatePath = fullpath
                 // Forcefully add to the registry in case the registry scan somehow missed the file. #2614
                 // If the user (launch config) gave an explicit path we should always "find" it.

src/shared/utilities/vsCodeUtils.ts

@@ -231,3 +231,13 @@ export async function openUrl(url: vscode.Uri): Promise<boolean> {
 export function isToolkitActive(): boolean {
     return isExtensionActive(VSCODE_EXTENSION_ID.awstoolkit)
 }
+
+/**
+ * Replaces magic vscode variables in a (launch config) user value.
+ */
+export function replaceVscodeVars(val: string, workspaceFolder?: string): string {
+    if (!workspaceFolder) {
+        return val
+    }
+    return val.replace('${workspaceFolder}', workspaceFolder)
+}