feat(cloudformation): Update CloudFormation feature with latest changes (#8303)

Includes all CloudFormation improvements and fixes from November 9th
through November 17th:
- Integration tests and LSP server workflow scripts
- Online error handling improvements
- CommaDelimitedList validation and boolean support
- Restart server command fixes and autocomplete improvements
- CFN init typing and consolidated commands
- LSP logs and exception handling
- Pagination and search in import/clone commands
- Resource type request handling
- Environment command error handling
- Project creation UI improvements
- LSP integration tests for offline features
- Reference-counted status bar implementation
- Expand/collapse arrow and resource messaging updates
- Stack events and resources loading improvements
- Validation workflow enhancements
- Resource management and provider naming
- Non-blocking CFN operations and restart LSP functionality
- Deep linking to stack information views
- E2E test infrastructure setup
- Deployment workflow alignment
- Cached CFN server offline support
- LSP installation process updates
- Startup fixes and permission handling
- AWS Explorer CFN panel integration
- Deployment mode prompts and stack view coordination
- Overview integration and parameter extraction fixes
- Panel metrics and telemetry improvements
- S3 upload support and file selection
- Icon updates and environment warnings
- Command palette fixes and document management
- Related resources workflow improvements
- Windows target fixes and validation improvements
- Environment naming and resource state management
- Stack description and telemetry configuration
- Deployment/validation icons and usage tracking
- Permission handling and resource loading
- Environment file selection and experimental flag removal
- Endpoint configuration and ChangeSet diff redesign
- S3 upload validation and inline completion removal
- Stack output viewing and installation cleanup
- Resource detail views and change set functionality
- Dry run fixes and icon updates
- Related resources API and change set commands
- Stack event fetching and authentication updates
- Drift indication and change set deletion
- Credential encryption and diff viewer improvements
- CFN init UI and empty node set handling
- Stack overview pages and environment selection
- View diff improvements and resource command updates
- CloudFormation prefix usage and change set logic
- Command execution controls and deployment confirmation
- Document management and resource node simplification
- Region management and settings updates
- Resource/stack pagination and explorer node additions
- Version selection and color fixes
- Stack refresh listeners and LSP server locator improvements
- CFN-lint/guard settings and diff provider enhancements
- Managed resource import warnings and resource import support
- Telemetry/client ID configuration and regionality improvements
- Clone/stack info restoration and package.json updates
- LSP stream improvements and authentication fixes

## Problem


## Solution


---

- Treat all work as PUBLIC. Private `feature/x` branches will not be
squash-merged at release time.
- Your code changes must meet the guidelines in
[CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines).
- License: I confirm that my contribution is made under the terms of the
Apache 2.0 license.

---------

Co-authored-by: manodnyab <[email protected]>

Author: kddejong

.github/CODEOWNERS

@@ -2,3 +2,4 @@
 packages/core/src/codewhisperer/ @aws/codewhisperer-team
 packages/core/src/amazonqFeatureDev/ @aws/earlybird
 packages/core/src/awsService/accessanalyzer/ @aws/access-analyzer
+packages/core/src/awsService/cloudformation/ @aws/cfn-dev-productivity

packages/core/src/awsService/cloudformation/artifacts/awsDocumentationLinks.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const ResourceIdentifierDocumentationUrl =
+    'https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html'

packages/core/src/awsService/cloudformation/cfn-init/cfnEnvironmentManager.ts

@@ -13,6 +13,7 @@ import {
     DeploymentConfig,
     CfnEnvironmentFileSelectorItem as DeploymentFileDetail,
     CfnEnvironmentFileSelectorItem,
+    unselectedValue,
 } from './cfnProjectTypes'
 import path from 'path'
 import fs from '../../../shared/fs/fs'
@@ -26,12 +27,15 @@ import { DocumentInfo } from './cfnEnvironmentRequestType'
 import { parseCfnEnvironmentFiles } from './cfnEnvironmentApi'
 import { LanguageClient } from 'vscode-languageclient/node'
 import { Parameter } from '@aws-sdk/client-cloudformation'
-import { convertRecordToParameters, convertRecordToTags } from './utils'
+import {
+    convertRecordToParameters,
+    convertRecordToTags,
+    getConfigPath,
+    getEnvironmentDir,
+    getProjectDir,
+} from './utils'
 
 export class CfnEnvironmentManager implements Disposable {
-    private readonly cfnProjectPath = 'cfn-project'
-    private readonly configFile = 'cfn-config.json'
-    private readonly environmentsDirectory = 'environments'
     private readonly selectedEnvironmentKey = 'aws.cloudformation.selectedEnvironment'
     private readonly auth = Auth.instance
     private listeners: (() => void)[] = []
@@ -98,8 +102,8 @@ export class CfnEnvironmentManager implements Disposable {
     }
 
     private async isProjectInitialized(): Promise<boolean> {
-        const configPath = await this.getConfigPath()
-        const projectDirectory = await this.getProjectDir()
+        const configPath = await getConfigPath()
+        const projectDirectory = await getProjectDir()
 
         return (await fs.existsFile(configPath)) && (await fs.existsDir(projectDirectory))
     }
@@ -114,6 +118,8 @@ export class CfnEnvironmentManager implements Disposable {
             await globals.context.workspaceState.update(this.selectedEnvironmentKey, environmentName)
 
             await this.syncEnvironmentWithProfile(environment)
+        } else {
+            await globals.context.workspaceState.update(this.selectedEnvironmentKey, undefined)
         }
 
         this.notifyListeners()
@@ -133,7 +139,7 @@ export class CfnEnvironmentManager implements Disposable {
     }
 
     public async fetchAvailableEnvironments(): Promise<CfnEnvironmentLookup> {
-        const configPath = await this.getConfigPath()
+        const configPath = await getConfigPath()
         const config = JSON.parse(await fs.readFileText(configPath)) as CfnConfig
 
         return config.environments
@@ -151,7 +157,7 @@ export class CfnEnvironmentManager implements Disposable {
         }
 
         try {
-            const environmentDir = await this.getEnvironmentDir(environmentName)
+            const environmentDir = await getEnvironmentDir(environmentName)
             const files = await fs.readdir(environmentDir)
 
             const filesToParse: DocumentInfo[] = await Promise.all(
@@ -194,6 +200,18 @@ export class CfnEnvironmentManager implements Disposable {
         return await this.environmentFileSelector.selectEnvironmentFile(selectorItems, requiredParameters.length)
     }
 
+    public async refreshSelectedEnvironment() {
+        const environmentName = this.getSelectedEnvironmentName()
+        const availableEnvironments = await this.fetchAvailableEnvironments()
+
+        // unselect environment if an environment was manually deleted
+        if (environmentName && !availableEnvironments[environmentName]) {
+            await this.setSelectedEnvironment(unselectedValue, availableEnvironments)
+
+            return undefined
+        }
+    }
+
     private async createEnvironmentFileSelectorItem(
         fileName: string,
         deploymentConfig: DeploymentConfig,
@@ -243,30 +261,6 @@ export class CfnEnvironmentManager implements Disposable {
         }
     }
 
-    public async getEnvironmentDir(environmentName: string): Promise<string> {
-        const workspaceRoot = workspace.workspaceFolders?.[0]?.uri.fsPath
-        if (!workspaceRoot) {
-            throw new Error('No workspace folder found')
-        }
-        return path.join(workspaceRoot, this.cfnProjectPath, this.environmentsDirectory, environmentName)
-    }
-
-    private async getConfigPath(): Promise<string> {
-        const workspaceRoot = workspace.workspaceFolders?.[0]?.uri.fsPath
-        if (!workspaceRoot) {
-            throw new Error('No workspace folder found')
-        }
-        return path.join(workspaceRoot, this.cfnProjectPath, this.configFile)
-    }
-
-    private async getProjectDir(): Promise<string> {
-        const workspaceRoot = workspace.workspaceFolders?.[0]?.uri.fsPath
-        if (!workspaceRoot) {
-            throw new Error('No workspace folder found')
-        }
-        return path.join(workspaceRoot, this.cfnProjectPath)
-    }
-
     dispose(): void {
         // No resources to dispose
     }

packages/core/src/awsService/cloudformation/cfn-init/cfnInitCliCaller.ts

@@ -6,6 +6,7 @@
 import * as path from 'path'
 import * as vscode from 'vscode'
 import { ChildProcess } from '../../../shared/utilities/processUtils'
+import { extractErrorMessage } from '../utils'
 
 export interface EnvironmentOption {
     name: string
@@ -63,10 +64,16 @@ export class CfnInitCliCaller {
                 },
             })
 
-            return result.exitCode === 0
-                ? { success: true, output: result.stdout || undefined }
-                : { success: false, error: result.stderr || `Process exited with code ${result.exitCode}` }
+            if (result.exitCode === 0) {
+                return { success: true, output: result.stdout || undefined }
+            } else {
+                void vscode.window.showWarningMessage(
+                    `cfn init command returned exit code ${result.exitCode}: ${result.stderr} - ${result.stdout} - ${extractErrorMessage(result.error)}`
+                )
+                return { success: false, error: result.stderr || `Process exited with code ${result.exitCode}` }
+            }
         } catch (error) {
+            void vscode.window.showErrorMessage(`Error executing cfn init command: ${extractErrorMessage(error)}`)
             return { success: false, error: error instanceof Error ? error.message : String(error) }
         }
     }

packages/core/src/awsService/cloudformation/cfn-init/cfnInitUiInterface.ts

@@ -8,6 +8,9 @@ import { CfnInitCliCaller, EnvironmentOption } from './cfnInitCliCaller'
 import { Auth } from '../../../auth/auth'
 import { promptForConnection } from '../../../auth/utils'
 import { getEnvironmentName, getProjectName, getProjectPath } from '../ui/inputBox'
+import fs from '../../../shared/fs/fs'
+import path from 'path'
+import { unselectedValue } from './cfnProjectTypes'
 
 interface FormState {
     projectName?: string
@@ -22,8 +25,22 @@ export class CfnInitUiInterface {
 
     async promptForCreate() {
         try {
-            // Set default project path
-            this.state.projectPath = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath || process.cwd()
+            // Set default project path with validation
+            const defaultPath = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath || process.cwd()
+
+            // Validate default path
+            try {
+                await fs.checkPerms(defaultPath, '*w*')
+                const cfnProjectPath = path.join(defaultPath, 'cfn-project')
+                const cfnProjectExists = await fs.existsDir(cfnProjectPath)
+
+                // Only use default if it's valid and doesn't have cfn-project
+                this.state.projectPath = cfnProjectExists ? undefined : defaultPath
+            } catch {
+                // Default path is invalid, leave undefined to force user selection
+                this.state.projectPath = undefined
+            }
+
             await this.showForm()
         } catch (error) {
             void vscode.window.showErrorMessage(`CFN Init failed: ${error}`)
@@ -40,12 +57,12 @@ export class CfnInitUiInterface {
             const updateItems = () => {
                 const items = [
                     {
-                        label: `${this.state.projectName ? '[✓]' : '[ ]'} Project Name`,
-                        detail: this.state.projectName || 'Click to set project name',
+                        label: `Project Name`,
+                        detail: this.state.projectName || unselectedValue,
                     },
                     {
-                        label: `${this.state.projectPath ? '[✓]' : '[ ]'} Project Path`,
-                        detail: this.state.projectPath || 'Click to set project path',
+                        label: `Project Path`,
+                        detail: this.state.projectPath || unselectedValue,
                     },
                 ]
 
@@ -57,10 +74,11 @@ export class CfnInitUiInterface {
                     })
                 }
 
-                items.push({
+                const addEnvItem = {
                     label: '$(plus) Add Environment (At least one required)',
                     detail: 'Configure a new deployment environment',
-                })
+                }
+                items.push(addEnvItem)
 
                 if (this.state.environments.length > 0) {
                     items.push({
@@ -69,7 +87,24 @@ export class CfnInitUiInterface {
                     })
                 }
 
+                const createProjectItem = {
+                    label: '$(check) Create Project',
+                    detail: 'Create the CloudFormation project with current configuration',
+                }
+                items.push(createProjectItem)
+
                 quickPick.items = items
+
+                // Highlight first undefined state property
+                if (!this.state.projectName) {
+                    quickPick.activeItems = [items[0]]
+                } else if (!this.state.projectPath) {
+                    quickPick.activeItems = [items[1]]
+                } else if (this.state.environments.length === 0) {
+                    quickPick.activeItems = [addEnvItem]
+                } else {
+                    quickPick.activeItems = [createProjectItem]
+                }
             }
 
             updateItems()
@@ -98,23 +133,21 @@ export class CfnInitUiInterface {
                     await this.addEnvironment()
                 } else if (selected.label.includes('Delete Environment')) {
                     await this.deleteEnvironment()
+                } else if (selected.label.includes('Create Project')) {
+                    if (await this.isFormStateValid()) {
+                        quickPick.hide()
+                        resolve(true)
+                        await this.executeProject()
+                    }
+                    return
                 }
 
                 updateItems()
                 quickPick.show()
             })
 
             quickPick.onDidTriggerButton(async () => {
-                if (!this.state.projectName) {
-                    void vscode.window.showWarningMessage('Project name is required')
-                    return
-                }
-                if (!this.state.projectPath) {
-                    void vscode.window.showWarningMessage('Project path is required')
-                    return
-                }
-                if (this.state.environments.length === 0) {
-                    void vscode.window.showWarningMessage('At least one environment is required')
+                if (!(await this.isFormStateValid())) {
                     return
                 }
                 quickPick.hide()
@@ -127,6 +160,23 @@ export class CfnInitUiInterface {
         })
     }
 
+    private async isFormStateValid(): Promise<boolean> {
+        if (!this.state.projectName) {
+            void vscode.window.showWarningMessage('Project name is required')
+            return false
+        }
+        if (!this.state.projectPath) {
+            void vscode.window.showWarningMessage('Project path is required')
+            return false
+        }
+        if (this.state.environments.length === 0) {
+            void vscode.window.showWarningMessage('At least one environment is required')
+            return false
+        }
+
+        return true
+    }
+
     async collectEnvironmentConfig(): Promise<EnvironmentOption | undefined> {
         const envName = await getEnvironmentName()
 

packages/core/src/awsService/cloudformation/cfn-init/cfnProjectTypes.ts

@@ -37,3 +37,5 @@ export type CfnEnvironmentFileSelectorItem = {
     compatibleParameters?: Parameter[]
     optionalFlags?: ChangeSetOptionalFlags
 }
+
+export const unselectedValue = '-'

packages/core/src/awsService/cloudformation/cfn-init/utils.ts

@@ -4,6 +4,12 @@
  */
 
 import { Parameter, Tag } from '@aws-sdk/client-cloudformation'
+import path from 'path'
+import { workspace } from 'vscode'
+
+const cfnProjectPath = 'cfn-project'
+const configFile = 'cfn-config.json'
+const environmentsDirectory = 'environments'
 
 export function convertRecordToParameters(parameters: Record<string, string>): Parameter[] {
     return Object.entries(parameters).map(([key, value]) => ({
@@ -30,3 +36,27 @@ export function convertParametersToRecord(parameters: Parameter[]): Record<strin
 export function convertTagsToRecord(tags: Tag[]): Record<string, string> {
     return Object.fromEntries(tags.filter((tag) => tag.Key && tag.Value).map((tag) => [tag.Key!, tag.Value!]))
 }
+
+export async function getEnvironmentDir(environmentName: string): Promise<string> {
+    const workspaceRoot = getWorkspaceRoot()
+    return path.join(workspaceRoot, cfnProjectPath, environmentsDirectory, environmentName)
+}
+
+export async function getConfigPath(): Promise<string> {
+    const workspaceRoot = getWorkspaceRoot()
+    return path.join(workspaceRoot, cfnProjectPath, configFile)
+}
+
+export async function getProjectDir(): Promise<string> {
+    const workspaceRoot = getWorkspaceRoot()
+    return path.join(workspaceRoot, cfnProjectPath)
+}
+
+export function getWorkspaceRoot(): string {
+    const workspaceRoot = workspace.workspaceFolders?.[0]?.uri.fsPath
+    if (!workspaceRoot) {
+        throw new Error('You must open a workspace to use CFN environment commands')
+    }
+
+    return workspaceRoot
+}