fix: allow device socket and client proxy socket reuse on iOS

Author: DimitarTachev

.vscode/launch.json

@@ -7,15 +7,17 @@
 		{
 			"type": "node",
 			"request": "launch",
-			"cwd": "${workspaceRoot}",
+			"cwd": "/Users/tachev/Work/Test/testJsHw",
 			"sourceMaps": true,
 			// In case you want to debug child processes started from CLI:
 			// "autoAttachChildProcesses": true,
 			"name": "Launch CLI (Node 6+)",
 			"program": "${workspaceRoot}/lib/nativescript-cli.js",
-
 			// example commands
-			"args": [ "create", "cliapp"]
+			"args": [
+				"debug",
+				"ios"
+			]
 			// "args": [ "test", "android", "--justlaunch"]
 			// "args": [ "platform", "add", "[email protected]", "--path", "cliapp"]
 			// "args": [ "platform", "remove", "android", "--path", "cliapp"]
@@ -38,7 +40,6 @@
 			"cwd": "${workspaceRoot}",
 			"sourceMaps": true
 		},
-
 		{
 			"type": "node",
 			"runtimeArgs": [
@@ -51,11 +52,8 @@
 			"sourceMaps": true,
 			// define the arguments that you would like to pass to CLI, for example
 			// "args": [ "build", "android", "--justlaunch" ]
-			"args": [
-
-			]
+			"args": []
 		},
-
 		{
 			// in case you want to debug a single test, modify it's code to be `it.only(...` instead of `it(...`
 			"type": "node",
@@ -68,7 +66,6 @@
 			"cwd": "${workspaceRoot}",
 			"sourceMaps": true
 		},
-
 		{
 			"type": "node",
 			"request": "attach",
@@ -77,7 +74,6 @@
 			"port": 9897,
 			"sourceMaps": true
 		},
-
 		{
 			"type": "node",
 			"request": "attach",
@@ -87,6 +83,5 @@
 			"port": 9855,
 			"sourceMaps": true
 		}
-
 	]
 }

lib/bootstrap.ts

@@ -14,6 +14,7 @@ $injector.require("androidPluginBuildService", "./services/android-plugin-build-
 $injector.require("iOSEntitlementsService", "./services/ios-entitlements-service");
 $injector.require("iOSProjectService", "./services/ios-project-service");
 $injector.require("iOSProvisionService", "./services/ios-provision-service");
+$injector.require("iOSDeviceSocketService", "./services/ios-device-socket-service");
 $injector.require("xCConfigService", "./services/xcconfig-service");
 
 $injector.require("cocoapodsService", "./services/cocoapods-service");

lib/commands/debug.ts

@@ -3,11 +3,13 @@ import { isInteractive } from "../common/helpers";
 import { cache } from "../common/decorators";
 import { DebugCommandErrors } from "../constants";
 import { ValidatePlatformCommandBase } from "./command-base";
+import { LiveSyncCommandHelper } from "../helpers/livesync-command-helper";
 
 export class DebugPlatformCommand extends ValidatePlatformCommandBase implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
 	constructor(private platform: string,
+		private $bundleValidatorHelper: IBundleValidatorHelper,
 		private $debugService: IDebugService,
 		protected $devicesService: Mobile.IDevicesService,
 		$platformService: IPlatformService,
@@ -21,7 +23,7 @@ export class DebugPlatformCommand extends ValidatePlatformCommandBase implements
 		private $prompter: IPrompter,
 		private $liveSyncCommandHelper: ILiveSyncCommandHelper,
 		private $androidBundleValidatorHelper: IAndroidBundleValidatorHelper) {
-			super($options, $platformsData, $platformService, $projectData);
+		super($options, $platformsData, $platformService, $projectData);
 	}
 
 	public async execute(args: string[]): Promise<void> {
@@ -36,7 +38,7 @@ export class DebugPlatformCommand extends ValidatePlatformCommandBase implements
 
 		const selectedDeviceForDebug = await this.getDeviceForDebug();
 
-		const debugData = this.$debugDataService.createDebugData(this.$projectData, {device: selectedDeviceForDebug.deviceInfo.identifier});
+		const debugData = this.$debugDataService.createDebugData(this.$projectData, { device: selectedDeviceForDebug.deviceInfo.identifier });
 
 		if (this.$options.start) {
 			await this.$liveSyncService.printDebugInformation(await this.$debugService.debug(debugData, debugOptions));
@@ -118,7 +120,10 @@ export class DebugPlatformCommand extends ValidatePlatformCommandBase implements
 			this.$errors.fail("--release flag is not applicable to this command");
 		}
 
-		const result = await super.canExecuteCommandBase(this.platform, { validateOptions: true, notConfiguredEnvOptions: { hideCloudBuildOption: true }});
+		const minSupportedWebpackVersion = this.$options.hmr ? LiveSyncCommandHelper.MIN_SUPPORTED_WEBPACK_VERSION_WITH_HMR : null;
+		this.$bundleValidatorHelper.validate(minSupportedWebpackVersion);
+
+		const result = await super.canExecuteCommandBase(this.platform, { validateOptions: true, notConfiguredEnvOptions: { hideCloudBuildOption: true, hideSyncToPreviewAppOption: true } });
 		return result;
 	}
 }
@@ -209,7 +214,7 @@ export class DebugAndroidCommand implements ICommand {
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $injector: IInjector,
 		private $projectData: IProjectData) {
-			this.$projectData.initializeProjectData();
+		this.$projectData.initializeProjectData();
 	}
 
 	public execute(args: string[]): Promise<void> {

lib/common/definitions/mobile.d.ts

@@ -115,6 +115,11 @@ declare module Mobile {
 		openDeviceLogStream(options?: IiOSLogStreamOptions): Promise<void>;
 	}
 
+	interface IiOSDeviceSocketsService {
+		getSocket(deviceId: string): any;
+		addSocket(deviceId: string, socket: any): void;
+	}
+
 	interface IAndroidDevice extends IDevice {
 		adb: Mobile.IDeviceAndroidDebugBridge;
 		init(): Promise<void>;
@@ -125,7 +130,7 @@ declare module Mobile {
 		getDeviceHashService(appIdentifier: string): Mobile.IAndroidDeviceHashService;
 	}
 
-	interface IiOSSimulator extends IDevice { }
+	// interface IiOSSimulator extends IDevice { }
 
 	/**
 	 * Describes log stream options

lib/common/mobile/ios/device/ios-device.ts

@@ -8,8 +8,17 @@ export class IOSDevice implements Mobile.IiOSDevice {
 	public applicationManager: Mobile.IDeviceApplicationManager;
 	public fileSystem: Mobile.IDeviceFileSystem;
 	public deviceInfo: Mobile.IDeviceInfo;
+	private socket: net.Socket;
+
+	// private static sockets: { [id: string]: net.Socket; } = {};
+
+	// get socket(): net.Socket {
+	// 	return IOSDevice.sockets[this.deviceInfo.identifier];
+	// }
+	// set socket(newSocket: net.Socket) {
+	// 	IOSDevice.sockets[this.deviceInfo.identifier] = newSocket;
+	// }
 
-	private _socket: net.Socket;
 	private _deviceLogHandler: (...args: any[]) => void;
 
 	constructor(private deviceActionInfo: IOSDeviceLib.IDeviceActionInfo,
@@ -19,6 +28,7 @@ export class IOSDevice implements Mobile.IiOSDevice {
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $iOSDeviceProductNameMapper: Mobile.IiOSDeviceProductNameMapper,
 		private $iosDeviceOperations: IIOSDeviceOperations,
+		private $logger: ILogger,
 		private $mobileHelper: Mobile.IMobileHelper) {
 
 		this.applicationManager = this.$injector.resolve(applicationManagerPath.IOSApplicationManager, { device: this, devicePointer: this.deviceActionInfo });
@@ -74,15 +84,20 @@ export class IOSDevice implements Mobile.IiOSDevice {
 
 	// This function works only on OSX
 	public async connectToPort(port: number): Promise<net.Socket> {
+		console.log("connectToPort");
 		const deviceId = this.deviceInfo.identifier;
 		const deviceResponse = _.first((await this.$iosDeviceOperations.connectToPort([{ deviceId: deviceId, port: port }]))[deviceId]);
 
-		const socket = new net.Socket();
-		socket.connect(deviceResponse.port, deviceResponse.host);
-		this._socket = socket;
+		const _socket = new net.Socket();
+		_socket.connect(deviceResponse.port, deviceResponse.host);
+		this.socket = _socket;
+		_socket.on("close", () => {
+			this.socket = null;
+			this.$logger.info("iOS Device socket closed!");
+		});
 
 		this.$processService.attachToProcessExitSignals(this, this.destroySocket);
-		return this._socket;
+		return this.socket;
 	}
 
 	private getActiveArchitecture(productType: string): string {
@@ -108,9 +123,9 @@ export class IOSDevice implements Mobile.IiOSDevice {
 	}
 
 	private destroySocket() {
-		if (this._socket) {
-			this._socket.destroy();
-			this._socket = null;
+		if (this.socket) {
+			this.socket.destroy();
+			this.socket = null;
 		}
 	}
 }

lib/common/mobile/ios/simulator/ios-emulator-services.ts

@@ -85,7 +85,7 @@ class IosEmulatorServices implements Mobile.IiOSSimulatorService {
 
 		const output = await this.tryGetiOSSimDevices();
 		if (output.devices && output.devices.length) {
-			devices =  _(output.devices)
+			devices = _(output.devices)
 				.map(simDevice => this.convertSimDeviceToDeviceInfo(simDevice))
 				.sortBy(deviceInfo => deviceInfo.version)
 				.value();
@@ -102,7 +102,7 @@ class IosEmulatorServices implements Mobile.IiOSSimulatorService {
 		return [];
 	}
 
-	private async tryGetiOSSimDevices(): Promise<{devices: Mobile.IiSimDevice[], error: string}> {
+	private async tryGetiOSSimDevices(): Promise<{ devices: Mobile.IiSimDevice[], error: string }> {
 		let devices: Mobile.IiSimDevice[] = [];
 		let error: string = null;
 

lib/common/mobile/ios/simulator/ios-simulator-device.ts

@@ -1,17 +1,41 @@
 import * as applicationManagerPath from "./ios-simulator-application-manager";
 import * as fileSystemPath from "./ios-simulator-file-system";
 import * as constants from "../../../constants";
+import * as net from "net";
 import { cache } from "../../../decorators";
 
-export class IOSSimulator implements Mobile.IiOSSimulator {
+export class IOSSimulator implements Mobile.IiOSDevice {
 	private _applicationManager: Mobile.IDeviceApplicationManager;
 	private _fileSystem: Mobile.IDeviceFileSystem;
+	private socket: net.Socket;
+
+	// private static sockets: { [id: string]: net.Socket; } = {};
+
+	// get socket(): net.Socket {
+	// 	return IOSSimulator.sockets[this.deviceInfo.identifier];
+	// }
+	// set socket(newSocket: net.Socket) {
+	// 	IOSSimulator.sockets[this.deviceInfo.identifier] = newSocket;
+	// }
 
 	constructor(private simulator: Mobile.IiSimDevice,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $injector: IInjector,
 		private $iOSSimResolver: Mobile.IiOSSimResolver,
-		private $iOSSimulatorLogProvider: Mobile.IiOSSimulatorLogProvider) { }
+		private $iOSEmulatorServices: Mobile.IiOSSimulatorService,
+		private $iOSSimulatorLogProvider: Mobile.IiOSSimulatorLogProvider,
+		private $logger: ILogger) { }
+
+	public async connectToPort(port: number): Promise<net.Socket> {
+		console.log("connectToPort");
+		this.socket = await this.$iOSEmulatorServices.connectToPort({ port });
+		this.socket.on("close", () => {
+			this.socket = null;
+			this.$logger.info("iOS Simulator socket closed!");
+		});
+
+		return this.socket;
+	}
 
 	public get deviceInfo(): Mobile.IDeviceInfo {
 		return {

lib/common/test/unit-tests/mobile/ios-simulator-discovery.ts

@@ -58,20 +58,20 @@ describe("ios-simulator-discovery", () => {
 	let defaultRunningSimulator: any;
 	let expectedDeviceInfo: Mobile.IDeviceInfo = null;
 
-	const detectNewSimulatorAttached = async (runningSimulator: any): Promise<Mobile.IiOSSimulator> => {
-		return new Promise<Mobile.IiOSSimulator>(async (resolve, reject) => {
+	const detectNewSimulatorAttached = async (runningSimulator: any): Promise<Mobile.IiOSDevice> => {
+		return new Promise<Mobile.IiOSDevice>(async (resolve, reject) => {
 			currentlyRunningSimulators.push(_.cloneDeep(runningSimulator));
-			iOSSimulatorDiscovery.once(DeviceDiscoveryEventNames.DEVICE_FOUND, (device: Mobile.IDevice) => {
+			iOSSimulatorDiscovery.once(DeviceDiscoveryEventNames.DEVICE_FOUND, (device: Mobile.IiOSDevice) => {
 				resolve(device);
 			});
 			await iOSSimulatorDiscovery.startLookingForDevices();
 		});
 	};
 
-	const detectSimulatorDetached = async (simulatorId: string): Promise<Mobile.IiOSSimulator> => {
+	const detectSimulatorDetached = async (simulatorId: string): Promise<Mobile.IiOSDevice> => {
 		_.remove(currentlyRunningSimulators, simulator => simulator.id === simulatorId);
-		return new Promise<Mobile.IDevice>(async (resolve, reject) => {
-			iOSSimulatorDiscovery.once(DeviceDiscoveryEventNames.DEVICE_LOST, (device: Mobile.IDevice) => {
+		return new Promise<Mobile.IiOSDevice>(async (resolve, reject) => {
+			iOSSimulatorDiscovery.once(DeviceDiscoveryEventNames.DEVICE_LOST, (device: Mobile.IiOSDevice) => {
 				resolve(device);
 			});
 			await iOSSimulatorDiscovery.startLookingForDevices();

lib/declarations.d.ts

@@ -732,8 +732,13 @@ interface IAndroidToolsInfoValidateInput extends IAndroidToolsInfoOptions {
 }
 
 interface ISocketProxyFactory extends NodeJS.EventEmitter {
-	createTCPSocketProxy(factory: () => Promise<any>): Promise<any>;
-	createWebSocketProxy(factory: () => Promise<any>, deviceIdentifier: string): Promise<any>;
+	getTCPSocketProxy(deviceIdentifier: string): any;
+	addTCPSocketProxy(factory: () => Promise<any>, deviceIdentifier: string): Promise<any>;
+
+	getWebSocketProxy(deviceIdentifier: string): any;
+	addWebSocketProxy(factory: () => Promise<any>, deviceIdentifier: string): Promise<any>;
+
+	removeAllProxies(): void;
 }
 
 interface IiOSNotification extends NodeJS.EventEmitter {