fix: fix pr comments

DimitarTachev · DimitarTachev · commit 2135c65e7176 · 2019-01-10T16:14:40.000+02:00
diff --git a/lib/common/bootstrap.ts b/lib/common/bootstrap.ts
@@ -122,4 +122,4 @@ $injector.require("qr", "./services/qr");
 $injector.require("printPluginsService", "./services/plugins/print-plugins-service");
 $injector.require("npmPluginsService", "./services/plugins/npm-plugins-service");
 
-$injector.require("lockfile", "./services/lockfile");
+$injector.require(["lockfile", "lockService"], "./services/lock-service");
diff --git a/lib/common/mobile/ios/device/ios-device.ts b/lib/common/mobile/ios/device/ios-device.ts
@@ -17,7 +17,7 @@ export class IOSDevice extends IOSDeviceBase {
 		protected $errors: IErrors,
 		private $injector: IInjector,
 		protected $iOSDebuggerPortService: IIOSDebuggerPortService,
-		protected $lockfile: ILockFile,
+		protected $lockService: ILockService,
 		private $iOSSocketRequestExecutor: IiOSSocketRequestExecutor,
 		protected $processService: IProcessService,
 		private $deviceLogProvider: Mobile.IDeviceLogProvider,
diff --git a/lib/common/mobile/ios/ios-device-base.ts b/lib/common/mobile/ios/ios-device-base.ts
@@ -5,7 +5,7 @@ export abstract class IOSDeviceBase implements Mobile.IiOSDevice {
 	protected abstract $errors: IErrors;
 	protected abstract $iOSDebuggerPortService: IIOSDebuggerPortService;
 	protected abstract $processService: IProcessService;
-	protected abstract $lockfile: ILockFile;
+	protected abstract $lockService: ILockService;
 	abstract deviceInfo: Mobile.IDeviceInfo;
 	abstract applicationManager: Mobile.IDeviceApplicationManager;
 	abstract fileSystem: Mobile.IDeviceFileSystem;
@@ -25,7 +25,7 @@ export abstract class IOSDeviceBase implements Mobile.IiOSDevice {
 	}
 
 	public async getSocket(appId: string): Promise<net.Socket> {
-		return this.$lockfile.executeActionWithLock(async () => {
+		return this.$lockService.executeActionWithLock(async () => {
 			if (this.cachedSockets[appId]) {
 				return this.cachedSockets[appId];
 			}
diff --git a/lib/common/mobile/ios/simulator/ios-simulator-device.ts b/lib/common/mobile/ios/simulator/ios-simulator-device.ts
@@ -14,7 +14,7 @@ export class IOSSimulator extends IOSDeviceBase implements Mobile.IiOSDevice {
 	constructor(private simulator: Mobile.IiSimDevice,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		protected $errors: IErrors,
-		protected $lockfile: ILockFile,
+		protected $lockService: ILockService,
 		private $injector: IInjector,
 		protected $iOSDebuggerPortService: IIOSDebuggerPortService,
 		private $iOSSimResolver: Mobile.IiOSSimResolver,
diff --git a/lib/common/services/lock-service.ts b/lib/common/services/lock-service.ts
@@ -2,7 +2,7 @@ import * as lockfile from "lockfile";
 import * as path from "path";
 import { cache } from "../decorators";
 
-export class LockFile implements ILockFile {
+export class LockService implements ILockService {
 	private currentlyLockedFiles: string[] = [];
 
 	@cache()
@@ -14,10 +14,10 @@ export class LockFile implements ILockFile {
 		return path.join(this.$settingsService.getProfileDir(), relativeLockFilePath);
 	}
 
-	private get defaultLockParams(): ILockFileOptions {
+	private get defaultLockParams(): ILockOptions {
 		// We'll retry 100 times and time between retries is 100ms, i.e. full wait in case we are unable to get lock will be 10 seconds.
 		// In case lock is older than the `stale` value, consider it stale and try to get a new lock.
-		const lockParams: ILockFileOptions = {
+		const lockParams: ILockOptions = {
 			retryWait: 100,
 			retries: 100,
 			stale: 30 * 1000,
@@ -37,8 +37,19 @@ export class LockFile implements ILockFile {
 		});
 	}
 
-	public lock(lockFilePath?: string, lockFileOpts?: ILockFileOptions): Promise<string> {
-		const { filePath, fileOpts } = this.getLockFileSettings(lockFilePath, lockFileOpts);
+	public async executeActionWithLock<T>(action: () => Promise<T>, lockFilePath?: string, lockOpts?: ILockOptions): Promise<T> {
+		const resolvedLockFilePath = await this.lock(lockFilePath, lockOpts);
+
+		try {
+			const result = await action();
+			return result;
+		} finally {
+			this.unlock(resolvedLockFilePath);
+		}
+	}
+
+	private lock(lockFilePath?: string, lockOpts?: ILockOptions): Promise<string> {
+		const { filePath, fileOpts } = this.getLockFileSettings(lockFilePath, lockOpts);
 		this.currentlyLockedFiles.push(filePath);
 
 		// Prevent ENOENT error when the dir, where lock should be created, does not exist.
@@ -51,30 +62,13 @@ export class LockFile implements ILockFile {
 		});
 	}
 
-	public async executeActionWithLock<T>(action: () => Promise<T>, lockFilePath?: string, lockFileOpts?: ILockFileOptions): Promise<T> {
-		const resolvedLockFilePath = await this.lock(lockFilePath, lockFileOpts);
-
-		try {
-			const result = await action();
-			return result;
-		} finally {
-			this.unlock(resolvedLockFilePath);
-		}
-	}
-
-	public unlock(lockFilePath?: string): void {
+	private unlock(lockFilePath?: string): void {
 		const { filePath } = this.getLockFileSettings(lockFilePath);
 		_.remove(this.currentlyLockedFiles, e => e === lockFilePath);
 		lockfile.unlockSync(filePath);
 	}
 
-	public check(lockFilePath?: string, lockFileOpts?: ILockFileOptions): boolean {
-		const { filePath, fileOpts } = this.getLockFileSettings(lockFilePath, lockFileOpts);
-
-		return lockfile.checkSync(filePath, fileOpts);
-	}
-
-	private getLockFileSettings(filePath?: string, fileOpts?: ILockFileOptions): { filePath: string, fileOpts: ILockFileOptions } {
+	private getLockFileSettings(filePath?: string, fileOpts?: ILockOptions): { filePath: string, fileOpts: ILockOptions } {
 		if (filePath && !path.isAbsolute(filePath)) {
 			filePath = this.getAbsoluteLockFilePath(filePath);
 		}
@@ -89,4 +83,6 @@ export class LockFile implements ILockFile {
 	}
 }
 
-$injector.register("lockfile", LockFile);
+$injector.register("lockService", LockService);
+// backwards compatibility
+$injector.register("lockfile", LockService);
diff --git a/lib/common/services/user-settings-service.ts b/lib/common/services/user-settings-service.ts
@@ -10,7 +10,7 @@ export class UserSettingsServiceBase implements IUserSettingsService {
 
 	constructor(userSettingsFilePath: string,
 		protected $fs: IFileSystem,
-		protected $lockfile: ILockFile,
+		protected $lockService: ILockService,
 		private $logger: ILogger) {
 		this.userSettingsFilePath = userSettingsFilePath;
 	}
@@ -21,7 +21,7 @@ export class UserSettingsServiceBase implements IUserSettingsService {
 			return this.userSettingsData ? this.userSettingsData[settingName] : null;
 		};
 
-		return this.$lockfile.executeActionWithLock<T>(action, this.lockFilePath);
+		return this.$lockService.executeActionWithLock<T>(action, this.lockFilePath);
 	}
 
 	public async saveSetting<T>(key: string, value: T): Promise<void> {
@@ -39,7 +39,7 @@ export class UserSettingsServiceBase implements IUserSettingsService {
 			await this.saveSettings();
 		};
 
-		return this.$lockfile.executeActionWithLock<void>(action, this.lockFilePath);
+		return this.$lockService.executeActionWithLock<void>(action, this.lockFilePath);
 	}
 
 	public saveSettings(data?: any): Promise<void> {
@@ -56,7 +56,7 @@ export class UserSettingsServiceBase implements IUserSettingsService {
 			this.$fs.writeJson(this.userSettingsFilePath, this.userSettingsData);
 		};
 
-		return this.$lockfile.executeActionWithLock<void>(action, this.lockFilePath);
+		return this.$lockService.executeActionWithLock<void>(action, this.lockFilePath);
 	}
 
 	// TODO: Remove Promise, reason: writeFile - blocked as other implementation of the interface has async operation.
diff --git a/lib/common/test/unit-tests/mobile/ios-simulator-discovery.ts b/lib/common/test/unit-tests/mobile/ios-simulator-discovery.ts
@@ -4,7 +4,7 @@ import { Yok } from "../../../yok";
 import { assert } from "chai";
 import { DeviceDiscoveryEventNames, CONNECTED_STATUS } from "../../../constants";
 import { DevicePlatformsConstants } from "../../../mobile/device-platforms-constants";
-import { ErrorsStub, CommonLoggerStub, HooksServiceStub, LockFileStub } from "../stubs";
+import { ErrorsStub, CommonLoggerStub, HooksServiceStub, LockServiceStub } from "../stubs";
 import { FileSystemStub } from "../../../../../test/stubs";
 
 let currentlyRunningSimulators: Mobile.IiSimDevice[];
@@ -16,7 +16,7 @@ function createTestInjector(): IInjector {
 	injector.register("injector", injector);
 	injector.register("errors", ErrorsStub);
 	injector.register("iOSDebuggerPortService", {});
-	injector.register("lockfile", LockFileStub);
+	injector.register("lockService", LockServiceStub);
 	injector.register("iOSSimResolver", {
 		iOSSim: {
 			getRunningSimulators: async () => currentlyRunningSimulators
diff --git a/lib/common/test/unit-tests/stubs.ts b/lib/common/test/unit-tests/stubs.ts
@@ -3,8 +3,8 @@
 import * as util from "util";
 import { EventEmitter } from "events";
 
-export class LockFileStub implements ILockFile {
-	public async executeActionWithLock<T>(action: () => Promise<T>, lockFilePath?: string, lockFileOpts?: ILockFileOptions): Promise<T> {
+export class LockServiceStub implements ILockService {
+	public async executeActionWithLock<T>(action: () => Promise<T>, lockFilePath?: string, lockOpts?: ILockOptions): Promise<T> {
 		const result = await action();
 		return result;
 	}
diff --git a/lib/declarations.d.ts b/lib/declarations.d.ts
@@ -745,17 +745,11 @@ interface IAppDebugSocketProxyFactory extends NodeJS.EventEmitter {
 }
 
 interface IiOSNotification extends NodeJS.EventEmitter {
-	getWaitForDebug(projectId: string): string;
 	getAttachRequest(projectId: string, deviceId: string): string;
-	getAppLaunching(projectId: string): string;
 	getReadyForAttach(projectId: string): string;
-	getAttachAvailabilityQuery(projectId: string): string;
-	getAlreadyConnected(projectId: string): string;
-	getAttachAvailable(projectId: string): string;
 }
 
 interface IiOSSocketRequestExecutor {
-	executeLaunchRequest(device: Mobile.IiOSDevice, timeout: number, readyForAttachTimeout: number, projectId: string, debugOptions: IDebugOptions): Promise<void>;
 	executeAttachRequest(device: Mobile.IiOSDevice, timeout: number, projectId: string): Promise<void>;
 }
 
diff --git a/lib/definitions/debug.d.ts b/lib/definitions/debug.d.ts
@@ -96,10 +96,6 @@ interface IDebugOptions {
 	 * The sdk version of the emulator.
 	 */
 	sdk?: string;
-	/**
-	 * Defines if the handshake(AppLaunching notification) between CLI and runtime should be executed. The handshake is not needed when CLI retries to attach to the debugger.
-	 */
-	skipHandshake?: boolean;
 	/**
 	 * Forces the debugger attach event to be emitted.
 	 */
diff --git a/lib/definitions/lock-service.d.ts b/lib/definitions/lock-service.d.ts
@@ -0,0 +1,19 @@
+import * as lockfile from "lockfile";
+
+declare global {
+    interface ILockOptions extends lockfile.Options { }
+
+    /**
+     * Describes methods that can be used to use file locking.
+     */
+    interface ILockService {
+        /**
+         * @param action The code to be locked.
+         * @param {string} lockFilePath Path to lock file that has to be created. Defaults to `<profile dir>/lockfile.lock`
+         * @param {ILockOptions} lockOpts Options used for creating the lock file.
+         * @returns {Promise<T>}
+         */
+        executeActionWithLock<T>(action: () => Promise<T>, lockFilePath?: string, lockOpts?: ILockOptions): Promise<T>
+        // TODO: expose as decorator
+    }
+}
diff --git a/lib/definitions/lockfile.d.ts b/lib/definitions/lockfile.d.ts
diff --git a/lib/device-sockets/ios/notification.ts b/lib/device-sockets/ios/notification.ts
@@ -2,17 +2,8 @@ import { EventEmitter } from "events";
 import { ATTACH_REQUEST_EVENT_NAME } from "../../common/constants";
 
 export class IOSNotification extends EventEmitter implements IiOSNotification {
-	private static WAIT_FOR_DEBUG_NOTIFICATION_NAME = "WaitForDebugger";
 	private static ATTACH_REQUEST_NOTIFICATION_NAME = "AttachRequest";
-	private static APP_LAUNCHING_NOTIFICATION_NAME = "AppLaunching";
 	private static READY_FOR_ATTACH_NOTIFICATION_NAME = "ReadyForAttach";
-	private static ATTACH_AVAILABILITY_QUERY_NOTIFICATION_NAME = "AttachAvailabilityQuery";
-	private static ALREADY_CONNECTED_NOTIFICATION_NAME = "AlreadyConnected";
-	private static ATTACH_AVAILABLE_NOTIFICATION_NAME = "AttachAvailable";
-
-	public getWaitForDebug(projectId: string) {
-		return this.formatNotification(IOSNotification.WAIT_FOR_DEBUG_NOTIFICATION_NAME, projectId);
-	}
 
 	public getAttachRequest(appId: string, deviceId: string): string {
 		// It could be too early to emit this event, but we rely that if you construct attach request,
@@ -21,26 +12,10 @@ export class IOSNotification extends EventEmitter implements IiOSNotification {
 		return this.formatNotification(IOSNotification.ATTACH_REQUEST_NOTIFICATION_NAME, appId);
 	}
 
-	public getAppLaunching(projectId: string): string {
-		return this.formatNotification(IOSNotification.APP_LAUNCHING_NOTIFICATION_NAME, projectId);
-	}
-
 	public getReadyForAttach(projectId: string): string {
 		return this.formatNotification(IOSNotification.READY_FOR_ATTACH_NOTIFICATION_NAME, projectId);
 	}
 
-	public getAttachAvailabilityQuery(projectId: string) {
-		return this.formatNotification(IOSNotification.ATTACH_AVAILABILITY_QUERY_NOTIFICATION_NAME, projectId);
-	}
-
-	public getAlreadyConnected(projectId: string) {
-		return this.formatNotification(IOSNotification.ALREADY_CONNECTED_NOTIFICATION_NAME, projectId);
-	}
-
-	public getAttachAvailable(projectId: string) {
-		return this.formatNotification(IOSNotification.ATTACH_AVAILABLE_NOTIFICATION_NAME, projectId);
-	}
-
 	private formatNotification(notification: string, projectId: string) {
 		return `${projectId}:NativeScript.Debug.${notification}`;
 	}
diff --git a/lib/device-sockets/ios/socket-request-executor.ts b/lib/device-sockets/ios/socket-request-executor.ts
@@ -3,8 +3,7 @@ import * as constants from "../../common/constants";
 export class IOSSocketRequestExecutor implements IiOSSocketRequestExecutor {
 	constructor(private $errors: IErrors,
 		private $iOSNotification: IiOSNotification,
-		private $iOSNotificationService: IiOSNotificationService,
-		private $logger: ILogger) { }
+		private $iOSNotificationService: IiOSNotificationService) { }
 
 	public async executeAttachRequest(device: Mobile.IiOSDevice, timeout: number, projectId: string): Promise<void> {
 		const deviceIdentifier = device.deviceInfo.identifier;
@@ -19,33 +18,6 @@ export class IOSSocketRequestExecutor implements IiOSSocketRequestExecutor {
 			this.$errors.failWithoutHelp(`The application ${projectId} does not appear to be running on ${deviceIdentifier} or is not built with debugging enabled. Try starting the application manually.`);
 		}
 	}
-
-	public async executeLaunchRequest(device: Mobile.IiOSDevice, timeout: number, readyForAttachTimeout: number, projectId: string, debugOptions: IDebugOptions): Promise<void> {
-		const deviceIdentifier = device.deviceInfo.identifier;
-
-		try {
-			if (!debugOptions.skipHandshake) {
-				await this.executeHandshake(deviceIdentifier, projectId, timeout);
-			}
-
-			if (debugOptions.debugBrk) {
-				await this.$iOSNotificationService.postNotification(deviceIdentifier, this.$iOSNotification.getWaitForDebug(projectId));
-			}
-
-			await this.executeAttachRequest(device, readyForAttachTimeout, projectId);
-		} catch (e) {
-			this.$logger.trace("Launch request error: ", e);
-			this.$errors.failWithoutHelp("Error while waiting for response from NativeScript runtime.");
-		}
-	}
-
-	private async executeHandshake(deviceIdentifier: string, projectId: string, timeout: number): Promise<void> {
-		// This notification will be send only once by the runtime during application start.
-		// In case app is already running, we'll fail here as we'll not receive it.
-		const appLaunchingNotification = this.$iOSNotification.getAppLaunching(projectId);
-		const appLaunchingSocket = await this.$iOSNotificationService.postNotification(deviceIdentifier, appLaunchingNotification, constants.IOS_OBSERVE_NOTIFICATION_COMMAND_TYPE);
-		await this.$iOSNotificationService.awaitNotification(deviceIdentifier, +appLaunchingSocket, timeout);
-	}
 }
 
 $injector.register("iOSSocketRequestExecutor", IOSSocketRequestExecutor);
diff --git a/lib/services/livesync/livesync-service.ts b/lib/services/livesync/livesync-service.ts
@@ -329,7 +329,6 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		} catch (err) {
 			this.$logger.trace("Couldn't attach debugger, will modify options and try again.", err);
 			attachDebuggerOptions.debugOptions.start = false;
-			attachDebuggerOptions.debugOptions.skipHandshake = true;
 			try {
 				debugInformation = await this.attachDebugger(attachDebuggerOptions);
 			} catch (innerErr) {
diff --git a/lib/services/user-settings-service.ts b/lib/services/user-settings-service.ts
@@ -4,10 +4,10 @@ import * as userSettingsServiceBaseLib from "../common/services/user-settings-se
 export class UserSettingsService extends userSettingsServiceBaseLib.UserSettingsServiceBase {
 	constructor($fs: IFileSystem,
 		$settingsService: ISettingsService,
-		$lockfile: ILockFile,
+		$lockService: ILockService,
 		$logger: ILogger) {
 		const userSettingsFilePath = path.join($settingsService.getProfileDir(), "user-settings.json");
-		super(userSettingsFilePath, $fs, $lockfile, $logger);
+		super(userSettingsFilePath, $fs, $lockService, $logger);
 	}
 
 	public async loadUserSettingsFile(): Promise<void> {
diff --git a/test/stubs.ts b/test/stubs.ts
@@ -564,19 +564,6 @@ export class HooksServiceStub implements IHooksService {
 	hookArgsName = "hookArgs";
 }
 
-export class LockFile {
-
-	async check(): Promise<boolean> {
-		return false;
-	}
-
-	async lock(): Promise<void> {
-	}
-
-	async unlock(): Promise<void> {
-	}
-}
-
 export class PrompterStub implements IPrompter {
 	private strings: IDictionary<string> = {};
 	private passwords: IDictionary<string> = {};

Original file line number	Diff line number	Diff line change
`@@ -745,17 +745,11 @@ interface IAppDebugSocketProxyFactory extends NodeJS.EventEmitter {`
`745`	`745`	`}`
`746`	`746`
`747`	`747`	`interface IiOSNotification extends NodeJS.EventEmitter {`
`748`		`- getWaitForDebug(projectId: string): string;`
`749`	`748`	`getAttachRequest(projectId: string, deviceId: string): string;`
`750`		`- getAppLaunching(projectId: string): string;`
`751`	`749`	`getReadyForAttach(projectId: string): string;`
`752`		`- getAttachAvailabilityQuery(projectId: string): string;`
`753`		`- getAlreadyConnected(projectId: string): string;`
`754`		`- getAttachAvailable(projectId: string): string;`
`755`	`750`	`}`
`756`	`751`
`757`	`752`	`interface IiOSSocketRequestExecutor {`
`758`		`- executeLaunchRequest(device: Mobile.IiOSDevice, timeout: number, readyForAttachTimeout: number, projectId: string, debugOptions: IDebugOptions): Promise<void>;`
`759`	`753`	`executeAttachRequest(device: Mobile.IiOSDevice, timeout: number, projectId: string): Promise<void>;`
`760`	`754`	`}`
`761`	`755`