fix: async persist env params on success (#11367)

packages/amplify-cli-core/src/index.ts

@@ -32,4 +32,3 @@ export * from './errors/amplify-error';
 export * from './errors/amplify-fault';
 export * from './errors/amplify-exception';
 export * from './errors/project-not-initialized-error';
-/* eslint-enable */

packages/amplify-cli/src/__tests__/commands/status.test.ts

@@ -36,7 +36,7 @@ describe('amplify status:', () => {
   const { run } = require('../../commands/status');
   const runStatusCmd = run;
   const statusPluginInfo = `${process.cwd()}/../amplify-console-hosting`;
-  const mockPath = './';
+  const mockPath = './help';
 
   afterAll(() => {
     jest.clearAllMocks();
@@ -53,6 +53,7 @@ describe('amplify status:', () => {
         showGlobalSandboxModeWarning: jest.fn(),
         showHelpfulProviderLinks: jest.fn(),
         getCategoryPluginInfo: jest.fn().mockReturnValue({ packageLocation: mockPath }),
+        pathManager: pathManagerMock,
       },
       parameters: {
         input: {
@@ -75,6 +76,7 @@ describe('amplify status:', () => {
         showGlobalSandboxModeWarning: jest.fn(),
         showHelpfulProviderLinks: jest.fn(),
         getCategoryPluginInfo: jest.fn().mockReturnValue({ packageLocation: statusPluginInfo }),
+        pathManager: pathManagerMock,
       },
       input: {
         command: 'status',
@@ -94,6 +96,7 @@ describe('amplify status:', () => {
         showGlobalSandboxModeWarning: jest.fn(),
         showHelpfulProviderLinks: jest.fn(),
         getCategoryPluginInfo: jest.fn().mockReturnValue({ packageLocation: statusPluginInfo }),
+        pathManager: pathManagerMock,
       },
       input: {
         command: 'status',
@@ -116,6 +119,7 @@ describe('amplify status:', () => {
         showGlobalSandboxModeWarning: jest.fn(),
         showHelpfulProviderLinks: jest.fn(),
         getCategoryPluginInfo: jest.fn().mockReturnValue({ packageLocation: statusPluginInfo }),
+        pathManager: pathManagerMock,
       },
       input: {
         command: 'status',
@@ -134,6 +138,7 @@ describe('amplify status:', () => {
         showGlobalSandboxModeWarning: jest.fn(),
         showHelpfulProviderLinks: jest.fn(),
         getCategoryPluginInfo: jest.fn().mockReturnValue({ packageLocation: statusPluginInfo }),
+        pathManager: pathManagerMock,
       },
       input: {
         command: 'status',

packages/amplify-cli/src/index.ts

@@ -16,6 +16,7 @@ import { EventEmitter } from 'events';
 import * as fs from 'fs-extra';
 import * as path from 'path';
 import { printer, prompter } from 'amplify-prompts';
+import { saveAll as saveAllEnvParams } from '@aws-amplify/amplify-environment-parameters';
 import { logInput } from './conditional-local-logging-init';
 import { attachUsageData, constructContext } from './context-manager';
 import { displayBannerMessages } from './display-banner-messages';
@@ -195,6 +196,8 @@ export const run = async (startTime: number): Promise<void> => {
     // Checks for available update, defaults to a 1 day interval for notification
     notify({ defer: true, isGlobal: true });
   }
+
+  await saveAllEnvParams();
 };
 
 const ensureFilePermissions = (filePath: string): void => {

packages/amplify-environment-parameters/src/__tests__/environment-parameter-manager.test.ts

@@ -1,6 +1,5 @@
-/* eslint-disable spellcheck/spell-checker */
 import { pathManager, stateManager } from 'amplify-cli-core';
-import { IEnvironmentParameterManager } from '../environment-parameter-manager';
+import { IEnvironmentParameterManager, saveAll } from '../environment-parameter-manager';
 
 jest.mock('amplify-cli-core');
 const stateManagerMock = stateManager as jest.Mocked<typeof stateManager>;
@@ -34,20 +33,8 @@ beforeEach(() => {
 
 describe('init', () => {
   it('loads params and registers save on exit listener', async () => {
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    const processEventListeners: Record<string | symbol, Function[]> = {};
-    jest.spyOn(process, 'on').mockImplementation((event, func) => {
-      if (Array.isArray(processEventListeners[event])) {
-        processEventListeners[event].push(func);
-      } else {
-        processEventListeners[event] = [func];
-      }
-      return process;
-    });
     await ensureEnvParamManager();
-    // it's important that the save callback is registered on exit instead of beforeExit
-    // because if save fails, beforeExit will be called again
-    processEventListeners.exit.forEach(fn => fn(0));
+    await saveAll();
     expect(stateManagerMock.setTeamProviderInfo).toHaveBeenCalledWith(undefined, stubTPI);
   });
 });

packages/amplify-environment-parameters/src/environment-parameter-manager.ts

@@ -35,6 +35,16 @@ export const getEnvParamManager = (envName: string = stateManager.getLocalEnvInf
   });
 };
 
+/**
+ * Execute the save method of all currently initialized IEnvironmentParameterManager instances
+ */
+export const saveAll = async (): Promise<void> => {
+  for (const envParamManager of Object.values(envParamManagerMap)) {
+    // save methods must be executed in sequence to avoid race conditions writing to the tpi file
+    await envParamManager.save();
+  }
+};
+
 /**
  * Class for interfacing with environment-specific parameters
  */
@@ -53,8 +63,6 @@ class EnvironmentParameterManager implements IEnvironmentParameterManager {
         this.getResourceParamManager(category, resource).setAllParams(parameters);
       });
     });
-
-    process.on('exit', () => this.save());
   }
 
   removeResourceParamManager(category: string, resource: string): void {
@@ -78,7 +86,7 @@ class EnvironmentParameterManager implements IEnvironmentParameterManager {
     return !!this.resourceParamManagers[getResourceKey(category, resource)];
   }
 
-  save(): void {
+  async save(): Promise<void> {
     if (!pathManager.findProjectRoot()) {
       // assume that the project is deleted if we cannot find a project root
       return;