update start spinner api to accept the id instead of generating a new (#2532)

Author: Amplifiyer

.changeset/hip-pens-walk.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/cli-core': patch
+---
+
+update start spinner api to accept the id instead of generating a new

packages/cli-core/API.md

@@ -94,7 +94,7 @@ export class Printer {
     log: (message: string, level?: LogLevel) => void;
     print: (message: string) => void;
     printNewLine: () => void;
-    startSpinner: (message: string, options?: {
+    startSpinner: (id: string, message: string, options?: {
         timeoutSeconds: number;
     }) => string;
     stopSpinner: (id: string) => void;

packages/cli-core/src/printer/printer.test.ts

@@ -2,11 +2,12 @@ import { after, before, beforeEach, describe, it, mock } from 'node:test';
 import assert from 'assert';
 import { LogLevel, Printer } from './printer.js';
 import tty from 'node:tty';
+import { randomUUID } from 'node:crypto';
 
 void describe('Printer', () => {
   const mockedWrite = mock.method(process.stdout, 'write');
   let originalWrite: typeof process.stdout.write;
-
+  let spinnerId = '';
   const mockedTTYWrite = mock.fn();
   const ttyStream: tty.WriteStream = {
     cursorTo: mock.fn(),
@@ -27,6 +28,7 @@ void describe('Printer', () => {
   });
 
   beforeEach(() => {
+    spinnerId = randomUUID();
     mockedTTYWrite.mock.resetCalls();
     mockedWrite.mock.resetCalls();
   });
@@ -146,7 +148,7 @@ void describe('Printer', () => {
       50,
       true
     );
-    const spinnerId = printer.startSpinner(message);
+    printer.startSpinner(spinnerId, message);
 
     // Wait for 190 ms
     await new Promise((resolve) => setTimeout(resolve, 190));
@@ -180,7 +182,7 @@ void describe('Printer', () => {
       50,
       false // simulate non-tty
     );
-    const spinnerId = printer.startSpinner(message);
+    printer.startSpinner(spinnerId, message);
 
     // Wait for 190 ms such that tty would have caused multiple prints
     await new Promise((resolve) => setTimeout(resolve, 190));
@@ -214,7 +216,9 @@ void describe('Printer', () => {
       50,
       true
     );
-    const spinnerId = printer.startSpinner(message, { timeoutSeconds: 0.1 });
+    printer.startSpinner(spinnerId, message, {
+      timeoutSeconds: 0.1,
+    });
     assert.ok(printer.isSpinnerRunning(spinnerId));
     // Wait for 110 ms for the spinner to timeout
     await new Promise((resolve) => setTimeout(resolve, 110));
@@ -232,7 +236,9 @@ void describe('Printer', () => {
       50,
       true
     );
-    const spinnerId = printer.startSpinner(message, { timeoutSeconds: 0.1 });
+    printer.startSpinner(spinnerId, message, {
+      timeoutSeconds: 0.1,
+    });
     assert.ok(printer.isSpinnerRunning(spinnerId));
     // Wait for 70 ms so the spinner doesn't timeout
     await new Promise((resolve) => setTimeout(resolve, 70));
@@ -271,7 +277,7 @@ void describe('Printer', () => {
       50,
       true
     );
-    const spinnerId = printer.startSpinner(message);
+    printer.startSpinner(spinnerId, message);
     printer.updateSpinner(spinnerId, {
       prefixText: 'this is some prefix text',
     });

packages/cli-core/src/printer/printer.ts

@@ -1,7 +1,6 @@
 import { WriteStream } from 'node:tty';
 import { EOL } from 'os';
 import ora, { Ora, oraPromise } from 'ora';
-import { randomUUID } from 'node:crypto';
 
 export type RecordValue = string | number | string[] | Date;
 
@@ -94,10 +93,10 @@ export class Printer {
    * @returns the id of the spinner
    */
   startSpinner = (
+    id: string,
     message: string,
     options: { timeoutSeconds: number } = { timeoutSeconds: 60 }
   ): string => {
-    const id = randomUUID();
     this.currentSpinners[id] = {
       instance: ora({
         text: message,