fix: Make sure session id is set before cleaning up socket handlers (#2604)

Author: mykola-mokhnach

lib/driver.js

@@ -981,8 +981,8 @@ export class XCUITestDriver extends BaseDriver {
     this.logEvent('resetComplete');
   }
 
-  async deleteSession() {
-    await removeAllSessionWebSocketHandlers(this.server, this.sessionId);
+  async deleteSession(sessionId) {
+    await removeAllSessionWebSocketHandlers.bind(this)();
 
     for (const recorder of _.compact([
       this._recentScreenRecorder,
@@ -1058,7 +1058,7 @@ export class XCUITestDriver extends BaseDriver {
 
     this.resetIos();
 
-    await super.deleteSession();
+    await super.deleteSession(sessionId);
   }
 
   async stop() {

lib/utils.js

@@ -404,18 +404,17 @@ async function encodeBase64OrUpload(localPath, remotePath = null, uploadOptions
  * Stops and removes all web socket handlers that are listening
  * in scope of the current session.
  *
- * @param {Object} server - The instance of NodeJs HTTP server,
- * which hosts Appium
- * @param {string|null} sessionId - The id of the current session
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
  */
-async function removeAllSessionWebSocketHandlers(server, sessionId) {
-  if (!server || !_.isFunction(server.getWebSocketHandlers)) {
+export async function removeAllSessionWebSocketHandlers() {
+  if (!this.sessionId || !_.isFunction(this.server?.getWebSocketHandlers)) {
     return;
   }
 
-  const activeHandlers = await server.getWebSocketHandlers(sessionId);
+  const activeHandlers = await this.server.getWebSocketHandlers(this.sessionId);
   for (const pathname of _.keys(activeHandlers)) {
-    await server.removeWebSocketHandler(pathname);
+    await this.server.removeWebSocketHandler(pathname);
   }
 }
 
@@ -538,7 +537,6 @@ export {
   printUser,
   getPIDsListeningOnPort,
   encodeBase64OrUpload,
-  removeAllSessionWebSocketHandlers,
   isLocalHost,
   normalizePlatformVersion,
   clearLogs,
@@ -548,4 +546,5 @@ export {
 /**
  * @typedef {import('appium-xcode').XcodeVersion} XcodeVersion
  * @typedef {import('appium-ios-simulator').Simulator} Simulator
+ * @typedef {import('./driver').XCUITestDriver} XCUITestDriver
  */