Add platform specific app identifier in package.json.

Rename projectId to projectIdentifiers.

projectId is left as getter and setter to avoid breaking change in hooks and CLI extensions

Fix ui tests for platform service and safeguard missing id.

Remove breaking change from debug data.

Use IProjectDefinition from mobile-cli-lib

Fix comments.

Fix comments

chore: send projectDir instead of projectData to PluginVariableService.

chore: fix comments

chore: fix tests

Author: KristianDD

lib/commands/debug.ts

@@ -24,11 +24,10 @@ export class DebugPlatformCommand implements ICommand {
 	public async execute(args: string[]): Promise<void> {
 		const debugOptions = <IDebugOptions>_.cloneDeep(this.$options.argv);
 
-		const debugData = this.$debugDataService.createDebugData(this.$projectData, this.$options);
-
 		await this.$platformService.trackProjectType(this.$projectData);
 		const selectedDeviceForDebug = await this.getDeviceForDebug();
-		debugData.deviceIdentifier = 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));

lib/common

@@ -161,6 +161,16 @@ interface ILiveSyncInfo extends IProjectDir, IEnvOptions, IBundle, IRelease, IOp
 	clean?: boolean;
 }
 
+interface ILiveSyncEventData {
+	deviceIdentifier: string,
+	applicationIdentifier?: string,
+	projectDir: string,
+	syncedFiles?: Object
+	error? : Error,
+	notification?: string,
+	isFullSync?: boolean
+}
+
 interface ILatestAppPackageInstalledSettings extends IDictionary<IDictionary<boolean>> { /* empty */ }
 
 interface IIsEmulator {

lib/definitions/livesync.d.ts

@@ -49,40 +49,39 @@ interface IPluginVariablesService {
 	/**
 	 * Saves plugin variables in project package.json file.
 	 * @param  {IPluginData}		pluginData for the plugin.
-	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @param {string} projectDir: Specifies the directory of the project.
 	 * @return {Promise<void>}
 	 */
-	savePluginVariablesInProjectFile(pluginData: IPluginData, projectData: IProjectData): Promise<void>;
+	savePluginVariablesInProjectFile(pluginData: IPluginData, projectDir: string): Promise<void>;
 
 	/**
 	 * Removes plugin variables from project package.json file.
 	 * @param  {string}		pluginName Name of the plugin.
-	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @param {string} projectDir: Specifies the directory of the project.
 	 * @return {void}
 	 */
-	removePluginVariablesFromProjectFile(pluginName: string, projectData: IProjectData): void;
+	removePluginVariablesFromProjectFile(pluginName: string, projectDir: string): void;
 
 	/**
 	 * Replaces all plugin variables with their corresponding values.
 	 * @param {IPluginData}		pluginData for the plugin.
 	 * @param {pluginConfigurationFilePath}		pluginConfigurationFilePath for the plugin.
-	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @param {string} projectDir: Specifies the directory of the project.
 	 * @return {Promise<void>}
 	 */
-	interpolatePluginVariables(pluginData: IPluginData, pluginConfigurationFilePath: string, projectData: IProjectData): Promise<void>;
+	interpolatePluginVariables(pluginData: IPluginData, pluginConfigurationFilePath: string, projectDir: string): Promise<void>;
 
 	/**
 	 * Replaces {nativescript.id} expression with the application identifier from package.json.
 	 * @param {pluginConfigurationFilePath}	pluginConfigurationFilePath for the plugin.
-	 * @param {IProjectData} projectData DTO with information about the project.
 	 * @return {void}
 	 */
-	interpolateAppIdentifier(pluginConfigurationFilePath: string, projectData: IProjectData): void;
+	interpolateAppIdentifier(pluginConfigurationFilePath: string, projectIdentifier: string): void;
 
 	/**
 	 * Replaces both plugin variables and appIdentifier
 	 */
-	interpolate(pluginData: IPluginData, pluginConfigurationFilePath: string, projectData: IProjectData): Promise<void>;
+	interpolate(pluginData: IPluginData, pluginConfigurationFilePath: string, projectDir: string, projectIdentifier: string): Promise<void>;
 
 	/**
 	 * Returns the

lib/definitions/plugins.d.ts

@@ -69,7 +69,8 @@ interface INsConfig {
 interface IProjectData extends ICreateProjectData {
 	platformsDir: string;
 	projectFilePath: string;
-	projectId?: string;
+	projectId: string;
+	projectIdentifiers?: Mobile.IProjectIdentifier;
 	dependencies: any;
 	devDependencies: IStringDictionary;
 	appDirectoryPath: string;

lib/definitions/project.d.ts

@@ -152,7 +152,14 @@ export class LiveSyncCommandHelper implements ILiveSyncCommandHelper {
 			};
 
 			await this.$platformService.deployPlatform(deployPlatformInfo);
-			await this.$platformService.startApplication(currentPlatform, runPlatformOptions, { appId: this.$projectData.projectId, projectName: this.$projectData.projectName });
+			await this.$platformService.startApplication(
+				currentPlatform,
+				runPlatformOptions,
+				{
+					appId: this.$projectData.projectIdentifiers[currentPlatform.toLowerCase()],
+					projectName: this.$projectData.projectName
+				}
+			);
 			this.$platformService.trackProjectType(this.$projectData);
 		}
 	}

lib/helpers/livesync-command-helper.ts

@@ -2,6 +2,7 @@ import * as constants from "./constants";
 import * as path from "path";
 import { parseJson } from "./common/helpers";
 import { EOL } from "os";
+import { cache } from "./common/decorators";
 
 interface IProjectType {
 	type: string;
@@ -35,7 +36,17 @@ export class ProjectData implements IProjectData {
 	public projectDir: string;
 	public platformsDir: string;
 	public projectFilePath: string;
-	public projectId: string;
+	public projectIdentifiers: Mobile.IProjectIdentifier;
+	get projectId(): string {
+		this.warnProjectId();
+		return this.projectIdentifiers.ios;
+	}
+	//just in case hook/extension modifies it.
+	set projectId(identifier: string) {
+		this.warnProjectId();
+		this.projectIdentifiers.ios = identifier;
+		this.projectIdentifiers.android = identifier;
+	}
 	public projectName: string;
 	public nsConfig: INsConfig;
 	public appDirectoryPath: string;
@@ -108,7 +119,7 @@ export class ProjectData implements IProjectData {
 			this.projectName = this.$projectHelper.sanitizeName(path.basename(projectDir));
 			this.platformsDir = path.join(projectDir, constants.PLATFORMS_DIR_NAME);
 			this.projectFilePath = projectFilePath;
-			this.projectId = nsData.id;
+			this.projectIdentifiers = this.initializeProjectIdentifiers(nsData.id);
 			this.dependencies = packageJsonData.dependencies;
 			this.devDependencies = packageJsonData.devDependencies;
 			this.projectType = this.getProjectType();
@@ -206,6 +217,25 @@ export class ProjectData implements IProjectData {
 		return path.resolve(projectDir, pathToResolve);
 	}
 
+	private initializeProjectIdentifiers(data: string | Mobile.IProjectIdentifier): Mobile.IProjectIdentifier {
+		let identifier: Mobile.IProjectIdentifier;
+		data = data || "";
+
+		if (typeof data === "string") {
+			identifier = {
+				android: data,
+				ios: data
+			};
+		} else {
+			identifier = {
+				android: data.android || "",
+				ios: data.ios || ""
+			};
+		}
+
+		return identifier;
+	}
+
 	private getProjectType(): string {
 		let detectedProjectType = _.find(ProjectData.PROJECT_TYPES, (projectType) => projectType.isDefaultProjectType).type;
 
@@ -220,5 +250,10 @@ export class ProjectData implements IProjectData {
 
 		return detectedProjectType;
 	}
+
+	@cache()
+	private warnProjectId(): void {
+		this.$logger.warnWithLabel("IProjectData.projectId is deprecated. Please use IProjectData.projectIdentifiers[platform].");
+	}
 }
 $injector.register("projectData", ProjectData);

lib/project-data.ts

@@ -130,7 +130,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 	}
 
 	public async validate(projectData: IProjectData): Promise<void> {
-		this.validatePackageName(projectData.projectId);
+		this.validatePackageName(projectData.projectIdentifiers.android);
 		this.validateProjectName(projectData.projectName);
 
 		await this.$platformEnvironmentRequirements.checkEnvironmentRequirements(this.getPlatformData(projectData).normalizedPlatformName);
@@ -256,15 +256,16 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 		try {
 			// will replace applicationId in app/App_Resources/Android/app.gradle if it has not been edited by the user
-			shell.sed('-i', /__PACKAGE__/, projectData.projectId, projectData.appGradlePath);
+			//TODO: For compatibility with old templates. Once all templates are updated should delete.
+			shell.sed('-i', /__PACKAGE__/, projectData.projectIdentifiers.android, projectData.appGradlePath);
 		} catch (e) {
-			this.$logger.warn(`\n${e}.\nCheck if you're using an outdated template and update it.`);
+			this.$logger.trace(`Templates updated and no need for replace in app.gradle.`);
 		}
 	}
 
 	public interpolateConfigurationFile(projectData: IProjectData, platformSpecificData: IPlatformSpecificData): void {
 		const manifestPath = this.getPlatformData(projectData).configurationFilePath;
-		shell.sed('-i', /__PACKAGE__/, projectData.projectId, manifestPath);
+		shell.sed('-i', /__PACKAGE__/, projectData.projectIdentifiers.android, manifestPath);
 		if (this.$androidToolsInfo.getToolsInfo().androidHomeEnvVar) {
 			const sdk = (platformSpecificData && platformSpecificData.sdk) || (this.$androidToolsInfo.getToolsInfo().compileSdkVersion || "").toString();
 			shell.sed('-i', /__APILEVEL__/, sdk, manifestPath);
@@ -273,8 +274,8 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 	private getProjectNameFromId(projectData: IProjectData): string {
 		let id: string;
-		if (projectData && projectData.projectId) {
-			const idParts = projectData.projectId.split(".");
+		if (projectData && projectData.projectIdentifiers && projectData.projectIdentifiers.android) {
+			const idParts = projectData.projectIdentifiers.android.split(".");
 			id = idParts[idParts.length - 1];
 		}
 
@@ -511,7 +512,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 			const filesForInterpolation = this.$fs.enumerateFilesInDirectorySync(resourcesDestinationDirectoryPath, file => this.$fs.getFsStats(file).isDirectory() || path.extname(file) === constants.XML_FILE_EXTENSION) || [];
 			for (const file of filesForInterpolation) {
 				this.$logger.trace(`Interpolate data for plugin file: ${file}`);
-				await this.$pluginVariablesService.interpolate(pluginData, file, projectData);
+				await this.$pluginVariablesService.interpolate(pluginData, file, projectData.projectDir, projectData.projectIdentifiers.android);
 			}
 		}
 
@@ -618,7 +619,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 	public async cleanDeviceTempFolder(deviceIdentifier: string, projectData: IProjectData): Promise<void> {
 		const adb = this.$injector.resolve(DeviceAndroidDebugBridge, { identifier: deviceIdentifier });
-		const deviceRootPath = `/data/local/tmp/${projectData.projectId}`;
+		const deviceRootPath = `/data/local/tmp/${projectData.projectIdentifiers.android}`;
 		await adb.executeShellCommand(["rm", "-rf", deviceRootPath]);
 	}
 

lib/services/android-project-service.ts

@@ -1,7 +1,12 @@
 export class DebugDataService implements IDebugDataService {
+	constructor(
+		private $devicesService: Mobile.IDevicesService
+	) { }
 	public createDebugData(projectData: IProjectData, options: IDeviceIdentifier): IDebugData {
+		const device = this.$devicesService.getDeviceByIdentifier(options.device);
+
 		return {
-			applicationIdentifier: projectData.projectId,
+			applicationIdentifier: projectData.projectIdentifiers[device.deviceInfo.platform.toLowerCase()],
 			projectDir: projectData.projectDir,
 			deviceIdentifier: options.device,
 			projectName: projectData.projectName

lib/services/debug-data-service.ts

@@ -244,7 +244,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		if (options && options.provision) {
 			plistTemplate += `    <key>provisioningProfiles</key>
     <dict>
-        <key>${projectData.projectId}</key>
+        <key>${projectData.projectIdentifiers.ios}</key>
         <string>${options.provision}</string>
     </dict>`;
 		}
@@ -291,7 +291,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		if (options && options.provision) {
 			plistTemplate += `    <key>provisioningProfiles</key>
 <dict>
-	<key>${projectData.projectId}</key>
+	<key>${projectData.projectIdentifiers.ios}</key>
 	<string>${options.provision}</string>
 </dict>`;
 		}
@@ -499,7 +499,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 
 			if (shouldUpdateXcode) {
 				const pickStart = Date.now();
-				const mobileprovision = mobileProvisionData || await this.$iOSProvisionService.pick(provision, projectData.projectId);
+				const mobileprovision = mobileProvisionData || await this.$iOSProvisionService.pick(provision, projectData.projectIdentifiers.ios);
 				const pickEnd = Date.now();
 				this.$logger.trace("Searched and " + (mobileprovision ? "found" : "failed to find ") + " matching provisioning profile. (" + (pickEnd - pickStart) + "ms.)");
 				if (!mobileprovision) {
@@ -764,10 +764,10 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 		await this.$iOSEntitlementsService.merge(projectData);
 		await this.mergeProjectXcconfigFiles(release, projectData);
 		for (const pluginData of await this.getAllInstalledPlugins(projectData)) {
-			await this.$pluginVariablesService.interpolatePluginVariables(pluginData, this.getPlatformData(projectData).configurationFilePath, projectData);
+			await this.$pluginVariablesService.interpolatePluginVariables(pluginData, this.getPlatformData(projectData).configurationFilePath, projectData.projectDir);
 		}
 
-		this.$pluginVariablesService.interpolateAppIdentifier(this.getPlatformData(projectData).configurationFilePath, projectData);
+		this.$pluginVariablesService.interpolateAppIdentifier(this.getPlatformData(projectData).configurationFilePath, projectData.projectIdentifiers.ios);
 	}
 
 	private getInfoPlistPath(projectData: IProjectData): string {
@@ -828,7 +828,7 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 
 		makePatch(infoPlistPath);
 
-		if (projectData.projectId) {
+		if (projectData.projectIdentifiers && projectData.projectIdentifiers.ios) {
 			session.patch({
 				name: "CFBundleIdentifier from package.json nativescript.id",
 				read: () =>
@@ -837,13 +837,13 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 						<plist version="1.0">
 						<dict>
 							<key>CFBundleIdentifier</key>
-							<string>${projectData.projectId}</string>
+							<string>${projectData.projectIdentifiers.ios}</string>
 						</dict>
 						</plist>`
 			});
 		}
 
-		if (!buildOptions.release && projectData.projectId) {
+		if (!buildOptions.release && projectData.projectIdentifiers && projectData.projectIdentifiers.ios) {
 			session.patch({
 				name: "CFBundleURLTypes from package.json nativescript.id",
 				read: () =>
@@ -858,7 +858,7 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 									<string>Editor</string>
 									<key>CFBundleURLSchemes</key>
 									<array>
-										<string>${projectData.projectId.replace(/[^A-Za-z0-9]/g, "")}</string>
+										<string>${projectData.projectIdentifiers.ios.replace(/[^A-Za-z0-9]/g, "")}</string>
 									</array>
 								</dict>
 							</array>