Fix ios streaming for real device (#1232)

* fix ios streaming for real device * bump version
AppiumTestDistribution · Jul 8, 2024 · af0ff02 · af0ff02
1 parent 43fce98
commit af0ff02
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 37 deletions.
diff --git a/dashboard-frontend b/dashboard-frontend
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "appium-device-farm",
-  "version": "9.0.0",
+  "version": "9.0.1",
   "description": "An appium 2.0 plugin that manages and create driver session on available devices",
   "main": "./lib/src/main.js",
   "scripts": {

diff --git a/src/iProxy.ts b/src/iProxy.ts
@@ -190,35 +190,7 @@ class DeviceConnectionsFactory {
           for (const key of this._releaseProxiedConnections(connectionsOnPort)) {
             delete this._connectionsMapping[key];
           }
-          const timer = new timing.Timer().start();
-          try {
-            await waitForCondition(
-              async () => {
-                try {
-                  if ((await checkPortStatus(port, LOCALHOST)) !== 'open') {
-                    log.info(
-                      `Port #${port} has been successfully released after ` +
-                        `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
-                    );
-                    isPortBusy = false;
-                    return true;
-                  }
-                } catch (ign) {
-                  /* empty */
-                }
-                return false;
-              },
-              {
-                waitMs: PORT_CLOSE_TIMEOUT,
-                intervalMs: 300,
-              },
-            );
-          } catch (ign) {
-            log.warn(
-              `Did not know how to release port #${port} in ` +
-                `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
-            );
-          }
+          isPortBusy = await this.waitForPortTobeReleased(port, isPortBusy);
         }
       }
 
@@ -249,7 +221,41 @@ class DeviceConnectionsFactory {
     log.info(`Successfully requested the connection for ${currentKey}`);
   }
 
-  releaseConnection(udid = null, port = null) {
+  private async waitForPortTobeReleased(port: any, isPortBusy: boolean) {
+    const timer = new timing.Timer().start();
+    try {
+      await waitForCondition(
+        async () => {
+          try {
+            if ((await checkPortStatus(port, LOCALHOST)) !== 'open') {
+              log.info(
+                `Port #${port} has been successfully released after ` +
+                  `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
+              );
+              isPortBusy = false;
+              return true;
+            }
+          } catch (ign) {
+            /* empty */
+          }
+          return false;
+        },
+        {
+          waitMs: PORT_CLOSE_TIMEOUT,
+          intervalMs: 300,
+        },
+      );
+    } catch (ign) {
+      log.warn(
+        `Did not know how to release port #${port} in ` +
+          `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
+      );
+    }
+    return isPortBusy;
+  }
+
+  async releaseConnection(udid: any, port: any) {
+    const isPortBusy = (await checkPortStatus(port, LOCALHOST)) === 'open';
     if (!udid && !port) {
       log.warn(
         'Neither device UDID nor local port is set. ' +
@@ -269,6 +275,7 @@ class DeviceConnectionsFactory {
     for (const key of keys) {
       delete this._connectionsMapping[key];
     }
+    await this.waitForPortTobeReleased(port, isPortBusy);
     log.debug(`Cached connections count: ${_.size(this._connectionsMapping)}`);
   }
 }

diff --git a/src/modules b/src/modules
diff --git a/src/plugin.ts b/src/plugin.ts
@@ -340,15 +340,15 @@ class DevicePlugin extends BasePlugin {
           : SessionType.LOCAL;
 
       await EventBus.fire(new BeforeSessionCreatedEvent({ device, sessionType: sessionType }));
-
-      session = await next();
       if (device.platform === 'ios' && device.realDevice) {
         log.info(`📱 Forwarding ios port to real device ${device.udid} for manual interaction`);
         await DEVICE_CONNECTIONS_FACTORY.requestConnection(device.udid, device.mjpegServerPort, {
           usePortForwarding: true,
           devicePort: device.mjpegServerPort,
         });
       }
+      session = await next();
+
       debugLog(`📱 Session response: ${JSON.stringify(session)}`);
     }
 
@@ -576,6 +576,9 @@ class DevicePlugin extends BasePlugin {
     log.info(`📱 Unblocking the device that is blocked for session ${sessionId}`);
     const res = await next();
     await EventBus.fire(new AfterSessionDeletedEvent({ sessionId: sessionId, device: device }));
+    if (device?.platform === 'ios' && device.realDevice) {
+      await DEVICE_CONNECTIONS_FACTORY.releaseConnection(device.udid, device.mjpegServerPort);
+    }
     return res;
   }
 }