Fixing emulator timeout issues (#7092)

joehan · mathu97 · commit eeadf5641a4b · 2024-05-06T14:04:08.000Z
* Fixing emulator timeout issues

* Joe learns how to spell waiting
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+- Increased the timeout for waiting for emulators to start to 60s. (#7091)
diff --git a/src/emulator/dataconnectEmulator.ts b/src/emulator/dataconnectEmulator.ts
@@ -69,6 +69,7 @@ export class DataConnectEmulator implements EmulatorInstance {
       host,
       port,
       pid: getPID(Emulators.DATACONNECT),
+      timeout: 10_000,
     };
   }
   getName(): Emulators {
diff --git a/src/emulator/portUtils.ts b/src/emulator/portUtils.ts
@@ -160,11 +160,14 @@ export async function checkListenable(
 }
 
 /**
- * Wait for a port to be available on the given host. Checks every 250ms for up to 5s.
+ * Wait for a port to be available on the given host. Checks every 250ms for up to timeout (default 60s).
  */
-export async function waitForPortUsed(port: number, host: string): Promise<void> {
+export async function waitForPortUsed(
+  port: number,
+  host: string,
+  timeout: number = 60_000,
+): Promise<void> {
   const interval = 200;
-  const timeout = 5_000;
   try {
     await tcpport.waitUntilUsedOnHost(port, host, interval, timeout);
   } catch (e: any) {
diff --git a/src/emulator/registry.ts b/src/emulator/registry.ts
@@ -35,7 +35,7 @@ export class EmulatorRegistry {
     // No need to wait for the Extensions emulator to close its port, since it runs on the Functions emulator.
     if (instance.getName() !== Emulators.EXTENSIONS) {
       const info = instance.getInfo();
-      await portUtils.waitForPortUsed(info.port, connectableHostname(info.host));
+      await portUtils.waitForPortUsed(info.port, connectableHostname(info.host), info.timeout);
     }
   }
 
diff --git a/src/emulator/types.ts b/src/emulator/types.ts
@@ -138,12 +138,15 @@ export interface EmulatorInfo {
   pid?: number;
   reservedPorts?: number[];
 
-  /** All addresses that an emulator listens on. */
+  // All addresses that an emulator listens on.
   listen?: ListenSpec[];
 
-  /** The primary IP address that the emulator listens on. */
+  // The primary IP address that the emulator listens on.
   host: string;
   port: number;
+
+  // How long to wait for the emulator to start before erroring out.
+  timeout?: number;
 }
 
 export interface DownloadableEmulatorCommand {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+- Increased the timeout for waiting for emulators to start to 60s. (#7091)`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ export class DataConnectEmulator implements EmulatorInstance {`
`69`	`69`	`host,`
`70`	`70`	`port,`
`71`	`71`	`pid: getPID(Emulators.DATACONNECT),`
	`72`	`+ timeout: 10_000,`
`72`	`73`	`};`
`73`	`74`	`}`
`74`	`75`	`getName(): Emulators {`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ export class EmulatorRegistry {`
`35`	`35`	`// No need to wait for the Extensions emulator to close its port, since it runs on the Functions emulator.`
`36`	`36`	`if (instance.getName() !== Emulators.EXTENSIONS) {`
`37`	`37`	`const info = instance.getInfo();`
`38`		`- await portUtils.waitForPortUsed(info.port, connectableHostname(info.host));`
	`38`	`+ await portUtils.waitForPortUsed(info.port, connectableHostname(info.host), info.timeout);`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`