Allow tns debug with Hot Module Replacement (HMR)

lib/bootstrap.ts

@@ -29,8 +29,8 @@ $injector.require("preparePlatformNativeService", "./services/prepare-platform-n
 
 $injector.require("debugDataService", "./services/debug-data-service");
 $injector.requirePublicClass("debugService", "./services/debug-service");
-$injector.require("iOSDebugService", "./services/ios-debug-service");
-$injector.require("androidDebugService", "./services/android-debug-service");
+$injector.require("iOSDeviceDebugService", "./services/ios-device-debug-service");
+$injector.require("androidDeviceDebugService", "./services/android-device-debug-service");
 
 $injector.require("userSettingsService", "./services/user-settings-service");
 $injector.requirePublic("analyticsSettingsService", "./services/analytics-settings-service");
@@ -146,7 +146,7 @@ $injector.requirePublic("previewQrCodeService", "./services/livesync/playground/
 $injector.requirePublic("sysInfo", "./sys-info");
 
 $injector.require("iOSNotificationService", "./services/ios-notification-service");
-$injector.require("socketProxyFactory", "./device-sockets/ios/socket-proxy-factory");
+$injector.require("appDebugSocketProxyFactory", "./device-sockets/ios/app-debug-socket-proxy-factory");
 $injector.require("iOSNotification", "./device-sockets/ios/notification");
 $injector.require("iOSSocketRequestExecutor", "./device-sockets/ios/socket-request-executor");
 $injector.require("messages", "./common/messages/messages");

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,14 @@ 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 }});
+		if (this.$options.hmr && this.$options.debugBrk) {
+			this.$errors.fail("--debug-brk and --hmr flags cannot be combined");
+		}
+
+		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 +218,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/constants.ts

@@ -156,4 +156,7 @@ export class AndroidVirtualDevice {
 	static GENYMOTION_DEFAULT_STDERR_STRING = "Logging activities to file";
 
 	static UNABLE_TO_START_EMULATOR_MESSAGE = "Cannot run the app in the selected native emulator. Try to restart the adb server by running the `adb kill-server` command in the Command Prompt, or increase the allocated RAM of the virtual device through the Android Virtual Device manager. NativeScript CLI users can try to increase the timeout of the operation by adding the `--timeout` flag.";
+
 }
+
+export const SOCKET_CONNECTION_TIMEOUT_MS = 30000;

lib/common/definitions/mobile.d.ts

@@ -111,8 +111,14 @@ declare module Mobile {
 	}
 
 	interface IiOSDevice extends IDevice {
-		connectToPort(port: number): Promise<any>;
+		getLiveSyncSocket(appId: string): Promise<any>;
+		destroyLiveSyncSocket(appId: string): void;
+
+		getDebugSocket(appId: string): Promise<any>;
+		destroyDebugSocket(appId: string): void;
+
 		openDeviceLogStream(options?: IiOSLogStreamOptions): Promise<void>;
+		destroyAllSockets(): void;
 	}
 
 	interface IAndroidDevice extends IDevice {
@@ -125,8 +131,6 @@ declare module Mobile {
 		getDeviceHashService(appIdentifier: string): Mobile.IAndroidDeviceHashService;
 	}
 
-	interface IiOSSimulator extends IDevice { }
-
 	/**
 	 * Describes log stream options
 	 */

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

@@ -1,38 +1,41 @@
 import * as applicationManagerPath from "./ios-application-manager";
 import * as fileSystemPath from "./ios-device-file-system";
-import * as constants from "../../../constants";
+import * as commonConstants from "../../../constants";
+import * as constants from "../../../../constants";
 import * as net from "net";
 import { cache } from "../../../decorators";
+import * as helpers from "../../../../common/helpers";
+import { IOSDeviceBase } from "../ios-device-base";
 
-export class IOSDevice implements Mobile.IiOSDevice {
+export class IOSDevice extends IOSDeviceBase {
 	public applicationManager: Mobile.IDeviceApplicationManager;
 	public fileSystem: Mobile.IDeviceFileSystem;
 	public deviceInfo: Mobile.IDeviceInfo;
-
-	private _socket: net.Socket;
 	private _deviceLogHandler: (...args: any[]) => void;
 
 	constructor(private deviceActionInfo: IOSDeviceLib.IDeviceActionInfo,
+		protected $errors: IErrors,
 		private $injector: IInjector,
-		private $processService: IProcessService,
+		protected $iOSDebuggerPortService: IIOSDebuggerPortService,
+		private $iOSSocketRequestExecutor: IiOSSocketRequestExecutor,
+		protected $processService: IProcessService,
 		private $deviceLogProvider: Mobile.IDeviceLogProvider,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $iOSDeviceProductNameMapper: Mobile.IiOSDeviceProductNameMapper,
 		private $iosDeviceOperations: IIOSDeviceOperations,
 		private $mobileHelper: Mobile.IMobileHelper) {
-
+		super();
 		this.applicationManager = this.$injector.resolve(applicationManagerPath.IOSApplicationManager, { device: this, devicePointer: this.deviceActionInfo });
 		this.fileSystem = this.$injector.resolve(fileSystemPath.IOSDeviceFileSystem, { device: this, devicePointer: this.deviceActionInfo });
-
 		const productType = deviceActionInfo.productType;
 		const isTablet = this.$mobileHelper.isiOSTablet(productType);
-		const deviceStatus = deviceActionInfo.status || constants.UNREACHABLE_STATUS;
+		const deviceStatus = deviceActionInfo.status || commonConstants.UNREACHABLE_STATUS;
 		this.deviceInfo = {
 			identifier: deviceActionInfo.deviceId,
 			vendor: "Apple",
 			platform: this.$devicePlatformsConstants.iOS,
 			status: deviceStatus,
-			errorHelp: deviceStatus === constants.UNREACHABLE_STATUS ? `Device ${deviceActionInfo.deviceId} is ${constants.UNREACHABLE_STATUS}` : null,
+			errorHelp: deviceStatus === commonConstants.UNREACHABLE_STATUS ? `Device ${deviceActionInfo.deviceId} is ${commonConstants.UNREACHABLE_STATUS}` : null,
 			type: "Device",
 			isTablet: isTablet,
 			displayName: this.$iOSDeviceProductNameMapper.resolveProductName(deviceActionInfo.deviceName) || deviceActionInfo.deviceName,
@@ -47,8 +50,29 @@ export class IOSDevice implements Mobile.IiOSDevice {
 		return false;
 	}
 
-	public getApplicationInfo(applicationIdentifier: string): Promise<Mobile.IApplicationInfo> {
-		return this.applicationManager.getApplicationInfo(applicationIdentifier);
+	@cache()
+	public async openDeviceLogStream(): Promise<void> {
+		if (this.deviceInfo.status !== commonConstants.UNREACHABLE_STATUS) {
+			this._deviceLogHandler = this.actionOnDeviceLog.bind(this);
+			this.$iosDeviceOperations.on(commonConstants.DEVICE_LOG_EVENT_NAME, this._deviceLogHandler);
+			this.$iosDeviceOperations.startDeviceLog(this.deviceInfo.identifier);
+		}
+	}
+
+	protected async getSocketCore(appId: string): Promise<net.Socket> {
+		await this.$iOSSocketRequestExecutor.executeAttachRequest(this, constants.AWAIT_NOTIFICATION_TIMEOUT_SECONDS, appId);
+		const port = await this.getDebuggerPort(appId);
+		const deviceId = this.deviceInfo.identifier;
+		const socket = await helpers.connectEventuallyUntilTimeout(
+			async () => {
+				const deviceResponse = _.first((await this.$iosDeviceOperations.connectToPort([{ deviceId: deviceId, port: port }]))[deviceId]);
+				const _socket = new net.Socket();
+				_socket.connect(deviceResponse.port, deviceResponse.host);
+				return _socket;
+			},
+			commonConstants.SOCKET_CONNECTION_TIMEOUT_MS);
+
+		return socket;
 	}
 
 	private actionOnDeviceLog(response: IOSDeviceLib.IDeviceLogData): void {
@@ -57,34 +81,12 @@ export class IOSDevice implements Mobile.IiOSDevice {
 		}
 	}
 
-	@cache()
-	public async openDeviceLogStream(): Promise<void> {
-		if (this.deviceInfo.status !== constants.UNREACHABLE_STATUS) {
-			this._deviceLogHandler = this.actionOnDeviceLog.bind(this);
-			this.$iosDeviceOperations.on(constants.DEVICE_LOG_EVENT_NAME, this._deviceLogHandler);
-			this.$iosDeviceOperations.startDeviceLog(this.deviceInfo.identifier);
-		}
-	}
-
 	public detach(): void {
 		if (this._deviceLogHandler) {
-			this.$iosDeviceOperations.removeListener(constants.DEVICE_LOG_EVENT_NAME, this._deviceLogHandler);
+			this.$iosDeviceOperations.removeListener(commonConstants.DEVICE_LOG_EVENT_NAME, this._deviceLogHandler);
 		}
 	}
 
-	// This function works only on OSX
-	public async connectToPort(port: number): Promise<net.Socket> {
-		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;
-
-		this.$processService.attachToProcessExitSignals(this, this.destroySocket);
-		return this._socket;
-	}
-
 	private getActiveArchitecture(productType: string): string {
 		let activeArchitecture = "";
 		if (productType) {
@@ -106,13 +108,6 @@ export class IOSDevice implements Mobile.IiOSDevice {
 
 		return activeArchitecture;
 	}
-
-	private destroySocket() {
-		if (this._socket) {
-			this._socket.destroy();
-			this._socket = null;
-		}
-	}
 }
 
 $injector.register("iOSDevice", IOSDevice);

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

@@ -0,0 +1,81 @@
+import * as net from "net";
+
+export abstract class IOSDeviceBase implements Mobile.IiOSDevice {
+	private cachedSockets: IDictionary<net.Socket> = {};
+	protected abstract $errors: IErrors;
+	protected abstract $iOSDebuggerPortService: IIOSDebuggerPortService;
+	protected abstract $processService: IProcessService;
+	abstract deviceInfo: Mobile.IDeviceInfo;
+	abstract applicationManager: Mobile.IDeviceApplicationManager;
+	abstract fileSystem: Mobile.IDeviceFileSystem;
+	abstract isEmulator: boolean;
+	abstract openDeviceLogStream(): Promise<void>;
+
+	public getApplicationInfo(applicationIdentifier: string): Promise<Mobile.IApplicationInfo> {
+		return this.applicationManager.getApplicationInfo(applicationIdentifier);
+	}
+
+	public async getLiveSyncSocket(appId: string): Promise<net.Socket> {
+		return this.getSocket(appId);
+	}
+
+	public async getDebugSocket(appId: string): Promise<net.Socket> {
+		return this.getSocket(appId);
+	}
+
+	public async getSocket(appId: string): Promise<net.Socket> {
+		if (this.cachedSockets[appId]) {
+			return this.cachedSockets[appId];
+		}
+
+		this.cachedSockets[appId] = await this.getSocketCore(appId);
+
+		if (this.cachedSockets[appId]) {
+			this.cachedSockets[appId].on("close", () => {
+				this.destroySocket(appId);
+			});
+
+			this.$processService.attachToProcessExitSignals(this, () => this.destroySocket(appId));
+		}
+
+		return this.cachedSockets[appId];
+	}
+
+	public destroyLiveSyncSocket(appId: string) {
+		this.destroySocket(appId);
+	}
+
+	public destroyDebugSocket(appId: string) {
+		this.destroySocket(appId);
+	}
+
+	protected abstract async getSocketCore(appId: string): Promise<net.Socket>;
+
+	protected async getDebuggerPort(appId: string): Promise<number> {
+		const port = await this.$iOSDebuggerPortService.getPort({ deviceId: this.deviceInfo.identifier, appId });
+		if (!port) {
+			this.$errors.failWithoutHelp("Device socket port cannot be found.");
+		}
+
+		return port;
+	}
+
+	public destroyAllSockets() {
+		for (const appId in this.cachedSockets) {
+			this.destroySocketSafe(this.cachedSockets[appId]);
+		}
+
+		this.cachedSockets = {};
+	}
+
+	private destroySocket(appId: string) {
+		this.destroySocketSafe(this.cachedSockets[appId]);
+		this.cachedSockets[appId] = null;
+	}
+
+	private destroySocketSafe(socket: net.Socket) {
+		if (socket && !socket.destroyed) {
+			socket.destroy();
+		}
+	}
+}

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

@@ -1,10 +1,7 @@
 import * as net from "net";
-import { connectEventuallyUntilTimeout } from "../../../helpers";
 import { APPLE_VENDOR_NAME, DeviceTypes, RUNNING_EMULATOR_STATUS, NOT_RUNNING_EMULATOR_STATUS } from "../../../constants";
 
 class IosEmulatorServices implements Mobile.IiOSSimulatorService {
-	private static DEFAULT_TIMEOUT = 10000;
-
 	constructor(private $logger: ILogger,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		private $iOSSimResolver: Mobile.IiOSSimResolver,
@@ -72,7 +69,7 @@ class IosEmulatorServices implements Mobile.IiOSSimulatorService {
 
 	public async connectToPort(data: Mobile.IConnectToPortData): Promise<net.Socket> {
 		try {
-			const socket = await connectEventuallyUntilTimeout(async () => net.connect(data.port), data.timeout || IosEmulatorServices.DEFAULT_TIMEOUT);
+			const socket = net.connect(data.port);
 			return socket;
 		} catch (e) {
 			this.$logger.debug(e);
@@ -85,7 +82,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 +99,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;