fix(definitions): align conflicting service typings and declare conformance

Five services were injected as an interface that nothing checked them
against. Two of the interfaces disagreed with the implementation:
checkForAvailableSimulators returns the simulators it found rather than
void, and DeployController.deploy takes the deploy descriptor set rather
than the run one. Both declarations now match the code they describe.

The implements clauses make the compiler verify what was previously
assumed. IOptionsTracker also needed importing, since lib/declarations
is a module and its interfaces are not global.

Author: edusperoni

lib/common/definitions/mobile.d.ts

@@ -532,7 +532,7 @@ declare global {
 		}
 
 		interface IiOSSimulatorDiscovery extends IDeviceDiscovery {
-			checkForAvailableSimulators(): Promise<void>;
+			checkForAvailableSimulators(): Promise<IDeviceInfo[]>;
 		}
 
 		interface IAndroidDeviceDiscovery extends IDeviceDiscovery {

lib/common/mobile/mobile-core/ios-simulator-discovery.ts

@@ -6,7 +6,10 @@ import { IInjector } from "../../definitions/yok";
 import { injector } from "../../yok";
 import * as _ from "lodash";
 
-export class IOSSimulatorDiscovery extends DeviceDiscovery {
+export class IOSSimulatorDiscovery
+	extends DeviceDiscovery
+	implements Mobile.IiOSSimulatorDiscovery
+{
 	private cachedSimulators: Mobile.IiSimDevice[] = [];
 	private availableSimulators: IDictionary<Mobile.IDeviceInfo> = {};
 
@@ -15,13 +18,13 @@ export class IOSSimulatorDiscovery extends DeviceDiscovery {
 		private $iOSSimResolver: Mobile.IiOSSimResolver,
 		private $mobileHelper: Mobile.IMobileHelper,
 		private $hostInfo: IHostInfo,
-		private $iOSEmulatorServices: Mobile.IiOSSimulatorService
+		private $iOSEmulatorServices: Mobile.IiOSSimulatorService,
 	) {
 		super();
 	}
 
 	public async startLookingForDevices(
-		options?: Mobile.IDeviceLookingOptions
+		options?: Mobile.IDeviceLookingOptions,
 	): Promise<void> {
 		if (
 			options &&
@@ -36,7 +39,8 @@ export class IOSSimulatorDiscovery extends DeviceDiscovery {
 
 	private async checkForDevices(): Promise<void> {
 		if (this.$hostInfo.isDarwin) {
-			const currentSimulators: Mobile.IiSimDevice[] = await this.$iOSSimResolver.iOSSim.getRunningSimulators();
+			const currentSimulators: Mobile.IiSimDevice[] =
+				await this.$iOSSimResolver.iOSSim.getRunningSimulators();
 
 			// Remove old simulators
 			_(this.cachedSimulators)
@@ -47,8 +51,8 @@ export class IOSSimulatorDiscovery extends DeviceDiscovery {
 							simulator &&
 							s &&
 							simulator.id === s.id &&
-							simulator.state === s.state
-					)
+							simulator.state === s.state,
+					),
 				)
 				.each((s) => this.deleteAndRemoveDevice(s));
 
@@ -61,8 +65,8 @@ export class IOSSimulatorDiscovery extends DeviceDiscovery {
 							simulator &&
 							s &&
 							simulator.id === s.id &&
-							simulator.state === s.state
-					)
+							simulator.state === s.state,
+					),
 				)
 				.each((s) => this.createAndAddDevice(s));
 		}
@@ -83,7 +87,7 @@ export class IOSSimulatorDiscovery extends DeviceDiscovery {
 			if (
 				!_.find(
 					this.availableSimulators,
-					(s) => s.imageIdentifier === simulator.imageIdentifier
+					(s) => s.imageIdentifier === simulator.imageIdentifier,
 				)
 			) {
 				lostSimulators.push(simulator);
@@ -110,7 +114,7 @@ export class IOSSimulatorDiscovery extends DeviceDiscovery {
 	private createAndAddDevice(simulator: Mobile.IiSimDevice): void {
 		this.cachedSimulators.push(_.cloneDeep(simulator));
 		this.addDevice(
-			this.$injector.resolve(IOSSimulator, { simulator: simulator })
+			this.$injector.resolve(IOSSimulator, { simulator: simulator }),
 		);
 	}
 

lib/controllers/deploy-controller.ts

@@ -1,11 +1,11 @@
 import * as _ from "lodash";
 import { injector } from "../common/yok";
 
-export class DeployController {
+export class DeployController implements IDeployController {
 	constructor(
 		private $deviceInstallAppService: IDeviceInstallAppService,
 		private $devicesService: Mobile.IDevicesService,
-		private $prepareController: IPrepareController
+		private $prepareController: IPrepareController,
 	) {}
 
 	public async deploy(data: IDeployData): Promise<void> {
@@ -14,7 +14,7 @@ export class DeployController {
 		const executeAction = async (device: Mobile.IDevice) => {
 			const deviceDescriptor = _.find(
 				deviceDescriptors,
-				(dd) => dd.identifier === device.deviceInfo.identifier
+				(dd) => dd.identifier === device.deviceInfo.identifier,
 			);
 			const prepareData = {
 				...deviceDescriptor.buildData,
@@ -27,7 +27,7 @@ export class DeployController {
 			await this.$deviceInstallAppService.installOnDevice(
 				device,
 				{ ...deviceDescriptor.buildData, buildForDevice: !device.isEmulator },
-				packageFilePath
+				packageFilePath,
 			);
 		};
 
@@ -37,8 +37,8 @@ export class DeployController {
 				_.some(
 					deviceDescriptors,
 					(deviceDescriptor) =>
-						deviceDescriptor.identifier === device.deviceInfo.identifier
-				)
+						deviceDescriptor.identifier === device.deviceInfo.identifier,
+				),
 		);
 	}
 }

lib/controllers/prepare-controller.ts

@@ -52,7 +52,10 @@ interface IPlatformWatcherData {
 	};
 }
 
-export class PrepareController extends EventEmitter {
+export class PrepareController
+	extends EventEmitter
+	implements IPrepareController
+{
 	private watchersData: IDictionary<IDictionary<IPlatformWatcherData>> = {};
 	private isInitialPrepareReady = false;
 	private persistedData: IFilesChangeEventData[] = [];

lib/definitions/deploy.d.ts

@@ -1,3 +1,3 @@
 interface IDeployController {
-	deploy(data: IRunData): Promise<void>;
+	deploy(data: IDeployData): Promise<void>;
 }

lib/helpers/options-track-helper.ts

@@ -1,6 +1,6 @@
 import * as path from "path";
 import { TrackActionNames } from "../constants";
-import { IOptions } from "../declarations";
+import { IOptions, IOptionsTracker } from "../declarations";
 import {
 	IAnalyticsService,
 	IDictionary,
@@ -10,7 +10,7 @@ import { OptionType } from "../common/enums";
 import * as _ from "lodash";
 import { injector } from "../common/yok";
 
-export class OptionsTracker {
+export class OptionsTracker implements IOptionsTracker {
 	public static PASSWORD_DETECTION_STRING = "password";
 	public static PRIVATE_REPLACE_VALUE = "private";
 	public static PATH_REPLACE_VALUE = "_localpath";

lib/services/device/device-install-app-service.ts

@@ -14,7 +14,7 @@ import {
 import { IAnalyticsService, IFileSystem } from "../../common/declarations";
 import { injector } from "../../common/yok";
 
-export class DeviceInstallAppService {
+export class DeviceInstallAppService implements IDeviceInstallAppService {
 	constructor(
 		private $analyticsService: IAnalyticsService,
 		private $buildArtifactsService: IBuildArtifactsService,
@@ -23,25 +23,25 @@ export class DeviceInstallAppService {
 		private $logger: ILogger,
 		private $mobileHelper: Mobile.IMobileHelper,
 		private $projectDataService: IProjectDataService,
-		private $platformsDataService: IPlatformsDataService
+		private $platformsDataService: IPlatformsDataService,
 	) {}
 
 	public async installOnDevice(
 		device: Mobile.IDevice,
 		buildData: IBuildData,
-		packageFile?: string
+		packageFile?: string,
 	): Promise<void> {
 		this.$logger.info(
-			`Installing on device ${device.deviceInfo.identifier}...`
+			`Installing on device ${device.deviceInfo.identifier}...`,
 		);
 
 		const platform = device.deviceInfo.platform.toLowerCase();
 		const projectData = this.$projectDataService.getProjectData(
-			buildData.projectDir
+			buildData.projectDir,
 		);
 		const platformData = this.$platformsDataService.getPlatformData(
 			platform,
-			projectData
+			projectData,
 		);
 
 		await this.$analyticsService.trackEventActionInGoogleAnalytics({
@@ -53,13 +53,13 @@ export class DeviceInstallAppService {
 		if (!packageFile) {
 			packageFile = await this.$buildArtifactsService.getLatestAppPackagePath(
 				platformData,
-				buildData
+				buildData,
 			);
 		}
 
 		await platformData.platformProjectService.cleanDeviceTempFolder(
 			device.deviceInfo.identifier,
-			projectData
+			projectData,
 		);
 
 		const appIdentifier = projectData.projectIdentifiers[platform];
@@ -69,7 +69,7 @@ export class DeviceInstallAppService {
 		await device.applicationManager.reinstallApplication(
 			appIdentifier,
 			packageFile,
-			buildData
+			buildData,
 		);
 
 		await this.updateHashesOnDevice({
@@ -83,19 +83,19 @@ export class DeviceInstallAppService {
 			await this.$buildInfoFileService.saveDeviceBuildInfo(
 				device,
 				projectData,
-				outputFilePath
+				outputFilePath,
 			);
 		}
 
 		this.$logger.info(
-			`Successfully installed on device with identifier '${device.deviceInfo.identifier}'.`
+			`Successfully installed on device with identifier '${device.deviceInfo.identifier}'.`,
 		);
 	}
 
 	public async installOnDeviceIfNeeded(
 		device: Mobile.IDevice,
 		buildData: IBuildData,
-		packageFile?: string
+		packageFile?: string,
 	): Promise<void> {
 		const shouldInstall = await this.shouldInstall(device, buildData);
 		if (shouldInstall) {
@@ -105,31 +105,29 @@ export class DeviceInstallAppService {
 
 	public async shouldInstall(
 		device: Mobile.IDevice,
-		buildData: IBuildData
+		buildData: IBuildData,
 	): Promise<boolean> {
 		const projectData = this.$projectDataService.getProjectData(
-			buildData.projectDir
+			buildData.projectDir,
 		);
 		const platformData = this.$platformsDataService.getPlatformData(
 			device.deviceInfo.platform,
-			projectData
+			projectData,
 		);
 		const platform = device.deviceInfo.platform;
 		if (
 			!(await device.applicationManager.isApplicationInstalled(
-				projectData.projectIdentifiers[platform.toLowerCase()]
+				projectData.projectIdentifiers[platform.toLowerCase()],
 			))
 		) {
 			return true;
 		}
 
-		const deviceBuildInfo: IBuildInfo = await this.$buildInfoFileService.getDeviceBuildInfo(
-			device,
-			projectData
-		);
+		const deviceBuildInfo: IBuildInfo =
+			await this.$buildInfoFileService.getDeviceBuildInfo(device, projectData);
 		const localBuildInfo = this.$buildInfoFileService.getLocalBuildInfo(
 			platformData,
-			{ ...buildData, buildForDevice: !device.isEmulator }
+			{ ...buildData, buildForDevice: !device.isEmulator },
 		);
 
 		return (