feat(sam): remove "code only" experiment, add --no-watch #3284

Problem:
* SAM CLI 1.78.0 includes a "smarter" `sync`, making the "code only"
  experimental option redundant.
* Specifying the `watch` flag in `samconfig.toml` causes an unexpected UX.

Solution:
* Remove the "code only" experiment.
* Add `--no-watch` if applicable (for older SAM CLI).
* Add one-time notification to update SAM CLI for perf improvements.
  * Only shows when running "Sync Serverless Application (formerly Deploy)".
* Create ECR repo if it doesn't exist.

Author: JadenSimon

.changes/next-release/Breaking Change-d94b0f2d-6101-47ec-8610-1a6af22c3b0c.json

@@ -0,0 +1,4 @@
+{
+	"type": "Breaking Change",
+	"description": "\"Sync SAM Application\" will now always ignore the 'watch' flag in `samconfig.toml`. The Toolkit does not support running `sam sync` in 'watch' mode."
+}

.changes/next-release/Removal-7536f996-054b-4383-96dd-66549146f5fb.json

@@ -0,0 +1,4 @@
+{
+	"type": "Removal",
+	"description": "`aws.experiments.samSyncCode` has been removed as similiar functionality is now in SAM CLI by default in 1.78.0."
+}

package.json

@@ -224,17 +224,12 @@
                     "type": "object",
                     "markdownDescription": "%AWS.configuration.description.experiments%",
                     "default": {
-                        "jsonResourceModification": false,
-                        "samSyncCode": false
+                        "jsonResourceModification": false
                     },
                     "properties": {
                         "jsonResourceModification": {
                             "type": "boolean",
                             "default": false
-                        },
-                        "samSyncCode": {
-                            "type": "boolean",
-                            "default": false
                         }
                     },
                     "additionalProperties": false
@@ -951,10 +946,6 @@
                     "command": "aws.samcli.sync",
                     "when": "!config.aws.samcli.legacyDeploy"
                 },
-                {
-                    "command": "aws.samcli.syncCode",
-                    "when": "config.aws.experiments.samSyncCode && !config.aws.samcli.legacyDeploy"
-                },
                 {
                     "command": "aws.s3.copyPath",
                     "when": "false"
@@ -1194,11 +1185,6 @@
                     "when": "!config.aws.samcli.legacyDeploy && view == aws.explorer",
                     "group": "3_lambda@3"
                 },
-                {
-                    "command": "aws.samcli.syncCode",
-                    "when": "config.aws.experiments.samSyncCode && !config.aws.samcli.legacyDeploy && view == aws.explorer",
-                    "group": "3_lambda@4"
-                },
                 {
                     "command": "aws.quickStart",
                     "when": "view == aws.explorer",
@@ -1266,11 +1252,6 @@
                     "when": "!config.aws.samcli.legacyDeploy && isFileSystemResource && resourceFilename =~ /^(template\\.(json|yml|yaml))|(samconfig\\.toml)$/",
                     "group": "z_aws@1"
                 },
-                {
-                    "command": "aws.samcli.syncCode",
-                    "when": "config.aws.experiments.samSyncCode && !config.aws.samcli.legacyDeploy && isFileSystemResource && resourceFilename =~ /^(template\\.(json|yml|yaml))|(samconfig\\.toml)$/",
-                    "group": "z_aws@2"
-                },
                 {
                     "command": "aws.uploadLambda",
                     "when": "explorerResourceIsFolder || isFileSystemResource && resourceFilename =~ /^template\\.(json|yml|yaml)$/",
@@ -1383,11 +1364,6 @@
                     "when": "!config.aws.samcli.legacyDeploy && view == aws.explorer && viewItem =~ /^(awsLambdaNode|awsRegionNode|awsCloudFormationRootNode)$/",
                     "group": "1@2"
                 },
-                {
-                    "command": "aws.samcli.syncCode",
-                    "when": "config.aws.experiments.samSyncCode && !config.aws.samcli.legacyDeploy && view == aws.explorer && viewItem =~ /^(awsLambdaNode|awsRegionNode|awsCloudFormationRootNode)$/",
-                    "group": "1@3"
-                },
                 {
                     "command": "aws.ecr.copyTagUri",
                     "when": "view == aws.explorer && viewItem == awsEcrTagNode",
@@ -3060,11 +3036,6 @@
                 "title": "%AWS.command.samcli.sync%",
                 "category": "%AWS.title%"
             },
-            {
-                "command": "aws.samcli.syncCode",
-                "title": "%AWS.command.samcli.syncCode%",
-                "category": "%AWS.title%"
-            },
             {
                 "command": "aws.codeWhisperer",
                 "title": "%AWS.command.codewhisperer.title%",

package.nls.json

@@ -146,8 +146,7 @@
     "AWS.command.iot.setDefaultPolicy": "Set as Default",
     "AWS.command.iot.viewPolicyVersion": "View...",
     "AWS.command.iot.copyEndpoint": "Copy Endpoint...",
-    "AWS.command.samcli.sync": "Sync SAM Application",
-    "AWS.command.samcli.syncCode": "Sync SAM Application (code only)",
+    "AWS.command.samcli.sync": "Sync SAM Application (formerly Deploy)",
     "AWS.command.s3.downloadFileAs": "Download As...",
     "AWS.command.s3.editFile": "Edit File",
     "AWS.command.s3.openFile": "Open File",

src/shared/clients/ecrClient.ts

@@ -67,9 +67,9 @@ export class DefaultEcrClient {
         return collection.filter(isNonNullable).map(list => list.map(repo => (assertHasProps(repo), repo)))
     }
 
-    public async createRepository(repositoryName: string): Promise<void> {
+    public async createRepository(repositoryName: string) {
         const sdkClient = await this.createSdkClient()
-        await sdkClient.createRepository({ repositoryName: repositoryName }).promise()
+        return sdkClient.createRepository({ repositoryName: repositoryName }).promise()
     }
 
     public async deleteRepository(repositoryName: string): Promise<void> {

src/shared/constants.ts

@@ -17,6 +17,9 @@ export const endpointsFileUrl: string = 'https://idetoolkits.amazonwebservices.c
 export const aboutCredentialsFileUrl: string =
     'https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html'
 export const samAboutInstallUrl = vscode.Uri.parse('https://aws.amazon.com/serverless/sam/')
+export const samUpgradeUrl = vscode.Uri.parse(
+    'https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/manage-sam-cli-versions.html#manage-sam-cli-versions-upgrade'
+)
 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'

src/shared/sam/sync.ts

@@ -41,9 +41,10 @@ import { parse } from 'semver'
 import { isAutomation } from '../vscode/env'
 import { getOverriddenParameters } from '../../lambda/config/parameterUtils'
 import { addTelemetryEnvVar } from './cli/samCliInvokerUtils'
-import { samSyncUrl, samInitDocUrl } from '../constants'
+import { samSyncUrl, samInitDocUrl, samUpgradeUrl } from '../constants'
 import { getAwsConsoleUrl } from '../awsConsole'
 import { openUrl } from '../utilities/vsCodeUtils'
+import { showOnce } from '../utilities/messages'
 
 const localize = nls.loadMessageBundle()
 
@@ -60,6 +61,7 @@ export interface SyncParams {
 }
 
 export const prefixNewBucketName = (name: string) => `newbucket:${name}`
+export const prefixNewRepoName = (name: string) => `newrepo:${name}`
 
 function createBucketPrompter(client: DefaultS3Client) {
     const recentBucket = getRecentResponse(client.regionCode, 'bucketName')
@@ -143,11 +145,11 @@ function createEcrPrompter(client: DefaultEcrClient) {
 
     return createQuickPick(items, {
         title: 'Select an ECR Repository',
-        placeholder: 'Select a repository (or enter repository URI)',
+        placeholder: 'Select a repository (or enter a name to create one)',
         buttons: createCommonButtons(samSyncUrl, consoleUrl),
         filterBoxInputSettings: {
-            label: 'Existing repository URI',
-            transform: v => v,
+            label: 'Create a New Repository',
+            transform: v => prefixNewRepoName(v),
         },
         noItemsFoundItem: {
             label: localize(
@@ -272,6 +274,21 @@ async function ensureBucket(resp: Pick<SyncParams, 'region' | 'bucketName'>) {
     }
 }
 
+async function ensureRepo(resp: Pick<SyncParams, 'region' | 'ecrRepoUri'>) {
+    const newRepoName = resp.ecrRepoUri?.match(/^newrepo:(.*)/)?.[1]
+    if (newRepoName === undefined) {
+        return resp.ecrRepoUri
+    }
+
+    try {
+        const repo = await new DefaultEcrClient(resp.region).createRepository(newRepoName)
+
+        return repo.repository?.repositoryUri
+    } catch (err) {
+        throw ToolkitError.chain(err, `Failed to create new ECR repository "${newRepoName}"`)
+    }
+}
+
 async function injectCredentials(conn: IamConnection, env = process.env) {
     const creds = await conn.getCredentials()
     return { ...env, ...asEnvironmentVariables(creds) }
@@ -282,7 +299,8 @@ async function saveAndBindArgs(args: SyncParams): Promise<{ readonly boundArgs:
         codeOnly: args.deployType === 'code',
         templatePath: args.template.uri.fsPath,
         bucketName: await ensureBucket(args),
-        ...selectFrom(args, 'stackName', 'ecrRepoUri', 'region', 'skipDependencyLayer'),
+        ecrRepoUri: await ensureRepo(args),
+        ...selectFrom(args, 'stackName', 'region', 'skipDependencyLayer'),
     }
 
     await Promise.all([
@@ -305,20 +323,21 @@ async function saveAndBindArgs(args: SyncParams): Promise<{ readonly boundArgs:
     return { boundArgs }
 }
 
-async function getSamCliPath() {
+async function getSamCliPathAndVersion() {
     const { path: samCliPath } = await SamCliSettings.instance.getOrDetectSamCli()
     if (samCliPath === undefined) {
         throw new ToolkitError('SAM CLI could not be found', { code: 'MissingExecutable' })
     }
 
     const info = await new SamCliInfoInvocation(samCliPath).execute()
+    const parsedVersion = parse(info.version)
     telemetry.record({ version: info.version })
 
-    if (parse(info.version)?.compare('1.53.0') === -1) {
+    if (parsedVersion?.compare('1.53.0') === -1) {
         throw new ToolkitError('SAM CLI version 1.53.0 or higher is required', { code: 'VersionTooLow' })
     }
 
-    return samCliPath
+    return { path: samCliPath, parsedVersion }
 }
 
 let oldTerminal: ProcessTerminal | undefined
@@ -380,7 +399,7 @@ async function loadLegacyParameterOverrides(template: TemplateItem) {
 export async function runSamSync(args: SyncParams) {
     telemetry.record({ lambdaPackageType: args.ecrRepoUri !== undefined ? 'Image' : 'Zip' })
 
-    const samCliPath = await getSamCliPath()
+    const { path: samCliPath, parsedVersion } = await getSamCliPathAndVersion()
     const { boundArgs } = await saveAndBindArgs(args)
     const overrides = await loadLegacyParameterOverrides(args.template)
     if (overrides !== undefined) {
@@ -390,6 +409,23 @@ export async function runSamSync(args: SyncParams) {
         boundArgs.push('--parameter-overrides', ...overrides)
     }
 
+    // '--no-watch' was not added until https://github.com/aws/aws-sam-cli/releases/tag/v1.77.0
+    // Forcing every user to upgrade will be a headache for what is otherwise a minor problem
+    if ((parsedVersion?.compare('1.77.0') ?? -1) >= 0) {
+        boundArgs.push('--no-watch')
+    }
+
+    if ((parsedVersion?.compare('1.78.0') ?? 1) < 0) {
+        showOnce('sam.sync.updateMessage', async () => {
+            const openDocsItem = 'Open Upgrade Documentation'
+            const message = `Your current version of SAM CLI (${parsedVersion?.version}) does not include performance improvements for "sam sync". Update to 1.78.0 or higher for faster executions.`
+            const resp = await vscode.window.showInformationMessage(message, openDocsItem)
+            if (resp === openDocsItem) {
+                await openUrl(samUpgradeUrl)
+            }
+        })
+    }
+
     const sam = new ChildProcess(samCliPath, ['sync', ...boundArgs], {
         spawnOptions: await addTelemetryEnvVar({
             cwd: args.projectRoot.fsPath,
@@ -516,14 +552,6 @@ export function registerSync() {
         (arg?: unknown) => telemetry.sam_sync.run(() => runSync('infra', arg))
     )
 
-    Commands.register(
-        {
-            id: 'aws.samcli.syncCode',
-            autoconnect: true,
-        },
-        (arg?: unknown) => telemetry.sam_sync.run(() => runSync('code', arg))
-    )
-
     const settings = SamCliSettings.instance
     settings.onDidChange(({ key }) => {
         if (key === 'legacyDeploy') {

src/shared/utilities/messages.ts

@@ -13,6 +13,7 @@ import { sleep } from './timeoutUtils'
 import { Timeout } from './timeoutUtils'
 import { addCodiconToString } from './textUtilities'
 import { getIcon, codicon } from '../icons'
+import globals from '../extensionGlobals'
 
 export const messages = {
     editCredentials(icon: boolean) {
@@ -215,3 +216,18 @@ export async function copyToClipboard(data: string, label?: string, env: Env = v
     vscode.window.setStatusBarMessage(addCodiconToString('clippy', message), 5000)
     getLogger().verbose('copied %s to clipboard: %O', label ?? '', data)
 }
+
+export async function showOnce<T>(
+    key: string,
+    fn: () => Promise<T>,
+    memento = globals.context.globalState
+): Promise<T | undefined> {
+    if (memento.get(key)) {
+        return
+    }
+
+    const result = fn()
+    await memento.update(key, true)
+
+    return result
+}

src/test/ecr/commands/createRepository.test.ts

@@ -30,6 +30,8 @@ describe('createRepositoryCommand', function () {
 
         const stub = sandbox.stub(ecr, 'createRepository').callsFake(async name => {
             assert.strictEqual(name, repoName)
+
+            return {} as any
         })
 
         getTestWindow().onDidShowInputBox(input => {