fix: multi select race conditions (#12356)

Author: sobolk

packages/amplify-e2e-core/src/categories/api.ts

@@ -531,17 +531,14 @@ function protectAPI(settings: RestAPISettings, chain: ExecutionContext) {
         .sendKeyDown()
         .sendCarriageReturn() // Authenticated and Guest users
         .wait('What permissions do you want to grant to Authenticated users')
-        .sendCtrlA() // CRUD permissions for authenticated users
-        .sendCarriageReturn()
+        .selectAll() // CRUD permissions for authenticated users
         .wait('What permissions do you want to grant to Guest users')
-        .sendCtrlA() // CRUD permissions for guest users
-        .sendCarriageReturn();
+        .selectAll(); // CRUD permissions for guest users
     } else {
       chain
         .sendCarriageReturn() // Authenticated users only
         .wait('What permissions do you want to grant to Authenticated users')
-        .sendCtrlA() // CRUD permissions
-        .sendCarriageReturn();
+        .selectAll(); // CRUD permissions
     }
   } else {
     chain.sendNo();

packages/amplify-e2e-core/src/categories/auth.ts

@@ -389,17 +389,15 @@ export function updateAuthSignInSignOutUrl(cwd: string, settings: any): Promise<
       .send(KEY_DOWN_ARROW)
       .sendCarriageReturn()
       .wait('Which redirect signin URIs do you want to edit?')
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait(`Update ${settings.signinUrl}`)
       .sendCarriageReturn()
       .send(settings.updatesigninUrl)
       .sendCarriageReturn()
       .wait('Do you want to add redirect signin URIs?')
       .sendConfirmNo()
       .wait('Which redirect signout URIs do you want to edit?')
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait(`Update ${settings.signoutUrl}`)
       .send(settings.updatesignoutUrl)
       .sendCarriageReturn()

packages/amplify-e2e-core/src/categories/custom.ts

@@ -24,10 +24,10 @@ export const addCFNCustomResource = async (cwd: string, settings: any, testingWi
     .wait('Do you want to access Amplify generated resources in your custom CloudFormation file?')
     .sendYes();
   if (settings.promptForCategorySelection) {
-    chain.wait('Select the categories you want this custom resource to have access to').sendCtrlA().sendCarriageReturn();
+    chain.wait('Select the categories you want this custom resource to have access to').selectAll();
   }
   if (settings.promptForCustomResourcesSelection) {
-    chain.wait('Select the one you would like your custom resource to access').sendCtrlA().sendCarriageReturn();
+    chain.wait('Select the one you would like your custom resource to access').selectAll();
   }
   await chain.wait('Do you want to edit the CloudFormation stack now?').sendNo().sendEof().runAsync();
 };

packages/amplify-e2e-core/src/categories/geo.ts

@@ -97,11 +97,10 @@ export function addGeofenceCollectionWithDefault(cwd: string, groupNames: string
     .wait('Provide a name for the Geofence Collection:')
     .sendLine(config.resourceName)
     .wait('Select one or more cognito groups to give access:')
-    .sendCtrlA()
-    .sendCarriageReturn();
+    .selectAll();
 
   for (const groupName of groupNames) {
-    chain.wait(`What kind of access do you want for ${groupName} users? Select ALL that apply:`).sendCtrlA().sendCarriageReturn();
+    chain.wait(`What kind of access do you want for ${groupName} users? Select ALL that apply:`).selectAll();
   }
 
   if (config.isAdditional === true) {

packages/amplify-e2e-core/src/categories/storage.ts

@@ -414,8 +414,7 @@ export function addS3AndAuthWithAuthOnlyAccess(cwd: string): Promise<void> {
       .wait('Who should have access')
       .sendCarriageReturn() // Auth users only
       .wait('What kind of access do you want for Authenticated users?')
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait('Do you want to add a Lambda Trigger for your S3 Bucket')
       .sendConfirmNo()
       .sendEof()
@@ -442,11 +441,9 @@ export function addS3WithGuestAccess(cwd: string): Promise<void> {
       .sendKeyDown()
       .sendCarriageReturn() // Auth and guest users
       .wait('What kind of access do you want for Authenticated users?')
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait('What kind of access do you want for Guest users?')
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait('Do you want to add a Lambda Trigger for your S3 Bucket')
       .sendConfirmNo()
       .sendEof()
@@ -474,14 +471,11 @@ export function addS3WithGroupAccess(cwd: string, settings: any): Promise<void>
       .sendKeyDown()
       .sendCarriageReturn() // Individual groups
       .wait('Select groups')
-      .sendCtrlA() // select all groups
-      .sendCarriageReturn()
+      .selectAll() // select all groups
       .wait(`What kind of access do you want for ${settings?.userGroup1 ?? 'Admins'} users`) // for <UserGroup1> users?
-      .sendCtrlA() // Select all permissions
-      .sendCarriageReturn()
+      .selectAll() // Select all permissions
       .wait(`What kind of access do you want for ${settings?.userGroup2 ?? 'Users'} users`) // for <UserGroup2> users?
-      .sendCtrlA() // Select all permissions
-      .sendCarriageReturn()
+      .selectAll() // Select all permissions
       .wait('Do you want to add a Lambda Trigger for your S3 Bucket')
       .sendConfirmNo()
       .sendEof()
@@ -668,11 +662,9 @@ export function addS3Storage(projectDir: string): Promise<void> {
       .send(' ') //Auth and guest
       .sendCarriageReturn()
       .wait('What kind of access do you want for Authenticated users?') //Auth
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait('What kind of access do you want for Guest users?') //Guest
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait('Do you want to add a Lambda Trigger for your S3 Bucket?')
       .sendConfirmNo()
       .run((err: Error) => {
@@ -698,8 +690,7 @@ export function addS3StorageWithAuthOnly(projectDir: string): Promise<void> {
       .wait('Who should have access:')
       .sendCarriageReturn() //Auth users only
       .wait('What kind of access do you want for Authenticated users?') //Auth
-      .sendCtrlA()
-      .sendCarriageReturn()
+      .selectAll()
       .wait('Do you want to add a Lambda Trigger for your S3 Bucket?')
       .sendConfirmNo()
       .run((err: Error) => {
@@ -746,9 +737,9 @@ export function addS3StorageWithSettings(projectDir: string, settings: AddStorag
 
     chain.wait('Who should have access:').sendKeyDown().send(' ').sendCarriageReturn();
 
-    chain.wait('What kind of access do you want for Authenticated users?').sendCtrlA().sendCarriageReturn();
+    chain.wait('What kind of access do you want for Authenticated users?').selectAll();
 
-    chain.wait('What kind of access do you want for Guest users?').sendCtrlA().sendCarriageReturn();
+    chain.wait('What kind of access do you want for Guest users?').selectAll();
 
     chain.wait('Do you want to add a Lambda Trigger for your S3 Bucket?').sendConfirmNo();
 

packages/amplify-e2e-core/src/utils/nexpect.ts

@@ -90,6 +90,7 @@ export type ExecutionContext = {
   sendNo: () => ExecutionContext;
   sendCtrlC: () => ExecutionContext;
   sendCtrlA: () => ExecutionContext;
+  selectAll: () => ExecutionContext;
   sendEof: () => ExecutionContext;
   delay: (milliseconds: number) => ExecutionContext;
   /**
@@ -340,6 +341,15 @@ function chain(context: Context): ExecutionContext {
       context.queue.push(_send);
       return chain(context);
     },
+    selectAll(): ExecutionContext {
+      /*
+        Delays are added because multi-select re-renders when making transitions.
+        Sending Ctrl+A or confirmation while prompter state settles might not be reflected on the CLI side.
+        Delays are arbitrary. The alternative of tracking prompt transitions would be much more complicated
+        given variety of rendering styles, but should be pursued if this solution stops working.
+      */
+      return this.delay(1000).sendCtrlA().delay(1000).sendCarriageReturn();
+    },
     sendEof(): ExecutionContext {
       const _sendEof: ExecutionStep = {
         fn: () => {
@@ -357,12 +367,17 @@ function chain(context: Context): ExecutionContext {
     delay(milliseconds: number): ExecutionContext {
       const _delay: ExecutionStep = {
         fn: () => {
-          const startCallback = Date.now();
-
-          while (Date.now() - startCallback < milliseconds) {
-            // empty
-          }
-
+          /*
+            Code below is workaround for lack of synchronous sleep() in JS.
+            It has nothing to do with atomicity nor with buffers. It's just using these
+            built-in APIs to wait synchronously. I.e. it waits number of milliseconds for
+            byte transition in the buffer that never happens.
+            This replaced active spin-lock that was here before
+            and was burning 100% CPU while waiting that led to spawned CLI starvation.
+            If this way of delaying becomes insufficient then this module should
+            be refactored and implement fully asynchronous input handlers.
+          */
+          Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds);
           return true;
         },
         shift: true,