fix: copy env specific data from ccb on env checkout (#7512)

Author: jhockett

packages/amplify-category-function/src/provider-utils/awscloudformation/index.ts

@@ -1,4 +1,14 @@
-import { $TSAny, $TSContext, JSONUtilities, open, PathConstants, pathManager, stateManager } from 'amplify-cli-core';
+import {
+  $TSAny,
+  $TSContext,
+  JSONUtilities,
+  open,
+  PathConstants,
+  pathManager,
+  readCFNTemplate,
+  stateManager,
+  writeCFNTemplate,
+} from 'amplify-cli-core';
 import { FunctionParameters, FunctionTemplate, FunctionTriggerParameters, LambdaLayer } from 'amplify-function-plugin-interface';
 import * as fs from 'fs-extra';
 import _ from 'lodash';
@@ -381,6 +391,22 @@ export async function updateConfigOnEnvInit(context: $TSContext, resourceName: s
     if (currentCloudVersionHash) {
       _.set(amplifyMeta, [categoryName, resourceName, versionHash], currentCloudVersionHash);
     }
+
+    // Since the CFN template and parameters.json are updated on each new layer version which are specific to each env, we need to update
+    // the files accordingly to ensure the correct status is shown after env checkout. The restore flag already handles this scenario.
+    if (context.input.command === 'env' && context.input?.subCommands.includes('checkout') && !context.exeInfo?.inputParams?.restore) {
+      const currentParametersJson =
+        stateManager.getCurrentResourceParametersJson(projectPath, categoryName, resourceName, { throwIfNotExist: false }) || undefined;
+      if (currentParametersJson) {
+        const backendParametersJson = stateManager.getResourceParametersJson(projectPath, categoryName, resourceName);
+        backendParametersJson.description = currentParametersJson.description;
+        stateManager.setResourceParametersJson(projectPath, categoryName, resourceName, backendParametersJson);
+      }
+
+      const currentCfnTemplatePath = pathManager.getCurrentCfnTemplatePath(projectPath, categoryName, resourceName);
+      const { cfnTemplate: currentCfnTemplate } = await readCFNTemplate(currentCfnTemplatePath);
+      await writeCFNTemplate(currentCfnTemplate, pathManager.getResourceCfnTemplatePath(projectPath, categoryName, resourceName));
+    }
   }
 }
 

packages/amplify-cli-core/src/state-manager/pathManager.ts

@@ -39,6 +39,8 @@ export const PathConstants = {
   CLIJSONFileName: 'cli.json',
   CLIJSONFileNameGlob: 'cli*.json',
   CLIJsonWithEnvironmentFileName: (env: string) => `cli.${env}.json`,
+
+  CfnFileName: (resourceName: string) => `${resourceName}-awscloudformation-template.json`,
 };
 
 export class PathManager {
@@ -78,6 +80,12 @@ export class PathManager {
   getCurrentCloudBackendDirPath = (projectPath?: string): string =>
     this.constructPath(projectPath, [PathConstants.AmplifyDirName, PathConstants.CurrentCloudBackendDirName]);
 
+  getCurrentResourceParametersJsonPath = (projectPath: string | undefined, categoryName: string, resourceName: string): string =>
+    path.join(this.getCurrentCloudBackendDirPath(projectPath), categoryName, resourceName, PathConstants.ParametersJsonFileName);
+
+  getCurrentCfnTemplatePath = (projectPath: string | undefined, categoryName: string, resourceName: string): string =>
+    path.join(this.getCurrentCloudBackendDirPath(projectPath), categoryName, resourceName, PathConstants.CfnFileName(resourceName));
+
   getAmplifyRcFilePath = (projectPath?: string): string => this.constructPath(projectPath, [PathConstants.AmplifyRcFileName]);
 
   getGitIgnoreFilePath = (projectPath?: string): string => this.constructPath(projectPath, [PathConstants.GitIgnoreFileName]);
@@ -112,6 +120,9 @@ export class PathManager {
   getResourceParametersFilePath = (projectPath: string | undefined, category: string, resourceName: string): string =>
     path.join(this.getResourceDirectoryPath(projectPath, category, resourceName), PathConstants.ParametersJsonFileName);
 
+  getResourceCfnTemplatePath = (projectPath: string | undefined, category: string, resourceName: string): string =>
+    path.join(this.getResourceDirectoryPath(projectPath, category, resourceName), PathConstants.CfnFileName(resourceName));
+
   getReadMeFilePath = (projectPath?: string): string =>
     this.constructPath(projectPath, [PathConstants.AmplifyDirName, PathConstants.ReadMeFileName]);
 

packages/amplify-cli-core/src/state-manager/stateManager.ts

@@ -133,6 +133,21 @@ export class StateManager {
     return this.getData<$TSAny>(filePath, mergedOptions);
   };
 
+  getCurrentResourceParametersJson = (
+    projectPath: string | undefined,
+    category: string,
+    resourceName: string,
+    options?: GetOptions<$TSAny>,
+  ): $TSAny => {
+    const filePath = pathManager.getCurrentResourceParametersJsonPath(projectPath, category, resourceName);
+    const mergedOptions = {
+      throwIfNotExist: true,
+      ...options,
+    };
+
+    return this.getData<$TSAny>(filePath, mergedOptions);
+  };
+
   getAmplifyAdminConfigEntry = (appId: string, options?: GetOptions<$TSAny>) => {
     const mergedOptions = {
       throwIfNotExist: false,

packages/amplify-e2e-tests/src/__tests__/layer.test.ts

@@ -1,29 +1,30 @@
 import {
-  addLayer,
   addFunction,
+  addLayer,
   addOptData,
   amplifyPull,
   amplifyPushAuth,
   amplifyPushLayer,
+  amplifyStatus,
   createNewProjectDir,
   deleteProject,
   deleteProjectDir,
-  initJSProjectWithProfile,
   getAppId,
+  getCurrentLayerArnFromMeta,
+  getProjectConfig,
   getProjectMeta,
+  initJSProjectWithProfile,
   LayerPermission,
   LayerPermissionChoice,
   LayerPermissionName,
   LayerRuntime,
   removeLayer,
+  removeLayerVersion,
   updateLayer,
   updateOptData,
   validateLayerDir,
   validateLayerMetadata,
   validatePushedVersion,
-  getCurrentLayerArnFromMeta,
-  getProjectConfig,
-  removeLayerVersion,
 } from 'amplify-e2e-core';
 import { v4 as uuid } from 'uuid';
 import { addEnvironment, checkoutEnvironment, listEnvironment } from '../environment/env';
@@ -71,7 +72,7 @@ describe('amplify add lambda layer', () => {
     expect(validateLayerDir(projRoot, settings, settings.runtimes)).toBe(false);
   });
 
-  it('init a project add 4 layers and delete first 3 of them and push and verify', async () => {
+  it('init a project, add layer, push 4 layer versions and delete first 3 of them, then push and verify', async () => {
     const [shortId] = uuid().split('-');
     const layerName = `simplelayer${shortId}`;
     const runtime: LayerRuntime = 'nodejs';
@@ -236,11 +237,13 @@ describe('amplify add lambda layer', () => {
     await amplifyPushLayer(projRoot, {
       acceptSuggestedLayerVersionConfigurations: true,
     });
+    await amplifyStatus(projRoot, 'No Change');
     layerTestArns.push(getCurrentLayerArnFromMeta(projRoot, settings));
     validatePushedVersion(projRoot, settings, expectedPerms);
     await validateLayerMetadata(projRoot, settings, getProjectMeta(projRoot), newEnvName, layerTestArns);
 
     await checkoutEnvironment(projRoot, { envName });
+    await amplifyStatus(projRoot, 'No Change');
     validatePushedVersion(projRoot, settings, expectedPerms);
     await validateLayerMetadata(projRoot, settings, getProjectMeta(projRoot), envName, integtestArns);
   });
@@ -309,6 +312,7 @@ describe('amplify add lambda layer - with amplify console app', () => {
     }
 
     await amplifyPull(projRoot, {});
+    await amplifyStatus(projRoot, 'No Change');
 
     validatePushedVersion(projRoot, settings, expectedPerms);
   });