Merge pull request #1460 from NativeScript/vladimirov/android-manifest-in-app-resources

Use AndroidManifest from App_Resources as full manifest

Author: rosen-vladimirov

lib/bootstrap.ts

@@ -93,3 +93,4 @@ $injector.require("socketProxyFactory", "./device-sockets/ios/socket-proxy-facto
 $injector.require("iOSNotification", "./device-sockets/ios/notification");
 $injector.require("iOSSocketRequestExecutor", "./device-sockets/ios/socket-request-executor");
 $injector.require("messages", "./messages");
+$injector.require("xmlValidator", "./xml-validator");

lib/declarations.ts

@@ -184,3 +184,22 @@ interface IiOSSocketRequestExecutor {
 	executeLaunchRequest(device: Mobile.IiOSDevice, timeout: number, readyForAttachTimeout: number): IFuture<void>;
 	executeAttachRequest(device: Mobile.IiOSDevice, timeout: number): IFuture<void>;
 }
+
+/**
+ * Describes validation methods for XMLs.
+ */
+interface IXmlValidator {
+	/**
+	 * Checks the passed xml files for errors and if such exists, print them on the stdout.
+	 * @param {string[]} sourceFiles Files to be checked. Only the ones that ends with .xml are filtered.
+	 * @return {IFuture<boolean>} true in case there are no errors in specified files and false in case there's at least one error.
+	 */
+	validateXmlFiles(sourceFiles: string[]): IFuture<boolean>;
+
+	/**
+	 * Checks the passed xml file for errors and returns them as a result.
+	 * @param {string} sourceFile File to be checked.
+	 * @return {IFuture<string>} The errors detected (as a single string) or null in case there are no errors.
+	 */
+	getXmlFileErrors(sourceFile: string): IFuture<string>;
+}

lib/definitions/project.d.ts

@@ -76,6 +76,10 @@ interface IPlatformProjectService {
 	getAppResourcesDestinationDirectoryPath(): IFuture<string>;
 	deploy(deviceIdentifier: string): IFuture<void>;
 	processConfigurationFilesFromAppResources(): IFuture<void>;
+	/**
+	 * Ensures there is configuration file (AndroidManifest.xml, Info.plist) in app/App_Resources.
+	 */
+	ensureConfigurationFileInAppResources(): IFuture<void>;
 }
 
 interface IAndroidProjectPropertiesManager {

lib/services/android-project-service.ts

@@ -31,7 +31,10 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		private $mobileHelper: Mobile.IMobileHelper,
 		private $injector: IInjector,
 		private $pluginVariablesService: IPluginVariablesService,
-		private $deviceAppDataFactory: Mobile.IDeviceAppDataFactory) {
+		private $deviceAppDataFactory: Mobile.IDeviceAppDataFactory,
+		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
+		private $projectTemplatesService: IProjectTemplatesService,
+		private $xmlValidator: IXmlValidator) {
 			super($fs, $projectData, $projectDataService);
 			this._androidProjectPropertiesManagers = Object.create(null);
 	}
@@ -253,7 +256,52 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 	}
 
 	public prepareProject(): IFuture<void> {
-		return Future.fromResult();
+		return (() => {
+			let resDestinationDir = this.getAppResourcesDestinationDirectoryPath().wait();
+			let androidManifestPath = path.join(resDestinationDir, this.platformData.configurationFileName);
+
+			// In case the file is not correct, looks like we are still using the default AndroidManifest.xml from runtime and the current file (in res dir)
+			// should be merged with it.
+			if(this.isAndroidManifestFileCorrect(androidManifestPath).wait()) {
+				// Delete the AndroidManifest.xml file from res directory as the runtime will consider it as addition to the one in src/main and will try to merge them.
+				// However now they are the same file.
+				this.$fs.deleteFile(androidManifestPath).wait();
+			}
+		}).future<void>()();
+	}
+
+	public ensureConfigurationFileInAppResources(): IFuture<void> {
+		return (() => {
+			let originalAndroidManifestFilePath = path.join(this.$projectData.appResourcesDirectoryPath, this.$devicePlatformsConstants.Android, this.platformData.configurationFileName),
+				hasAndroidManifestInAppResources = this.$fs.exists(originalAndroidManifestFilePath).wait(),
+				shouldExtractDefaultManifest = !hasAndroidManifestInAppResources,
+				isAndroidManifestBackedUp = false;
+
+			if(hasAndroidManifestInAppResources) {
+				let isFileCorrect = this.isAndroidManifestFileCorrect(originalAndroidManifestFilePath).wait();
+				if(!isFileCorrect) {
+					shouldExtractDefaultManifest = true;
+					isAndroidManifestBackedUp = true;
+					this.backupOriginalAndroidManifest(originalAndroidManifestFilePath).wait();
+				}
+			}
+
+			// In case we should extract the manifest from default template, but for some reason we cannot, break the execution,
+			// so the original file from Android runtime will be used.
+			if(shouldExtractDefaultManifest && !this.extractAndroidManifestFromDefaultTemplate(originalAndroidManifestFilePath).wait()) {
+				// now revert back
+				this.revertBackupOfOriginalAndroidManifest(originalAndroidManifestFilePath).wait();
+				return;
+			}
+
+			if(isAndroidManifestBackedUp) {
+				this.$logger.warn(`Your ${this.platformData.configurationFileName} in app/App_Resources/Android will be replaced by the default one from hello-world template.`);
+				this.$logger.printMarkdown(`The original file will be moved to \`${this.configurationFileBackupName}\`. Merge it **manually** with the new \`${this.platformData.configurationFileName}\` in your app/App_Resources/Android.`);
+			}
+
+			// Overwrite the AndroidManifest from runtime.
+			this.$fs.copyFile(originalAndroidManifestFilePath, this.platformData.configurationFilePath).wait();
+		}).future<void>()();
 	}
 
 	public prepareAppResources(appResourcesDirectoryPath: string): IFuture<void> {
@@ -275,7 +323,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 	}
 
 	public processConfigurationFilesFromAppResources(): IFuture<void> {
-		return Future.fromResult();
+		return this.ensureConfigurationFileInAppResources();
 	}
 
 	private processResourcesFromPlugin(pluginData: IPluginData, pluginPlatformsFolderPath: string): IFuture<void> {
@@ -462,5 +510,69 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 		}).future<void>()();
 	}
+
+	private isAndroidManifestFileCorrect(pathToAndroidManifest: string): IFuture<boolean> {
+		return ((): boolean => {
+			try {
+				// Check if the AndroidManifest in app/App_Resouces is the correct one
+				// Use a real magic to detect if this is the correct file, by checking some mandatory strings.
+				let fileContent = this.$fs.readText(pathToAndroidManifest).wait(),
+					isFileCorrect = !!(~fileContent.indexOf("android:minSdkVersion") && ~fileContent.indexOf("android:targetSdkVersion")
+									&& ~fileContent.indexOf("uses-permission") && ~fileContent.indexOf("<application")
+									&& ~fileContent.indexOf("<activity") && ~fileContent.indexOf("<intent-filter>")
+									&& ~fileContent.indexOf("android.intent.action.MAIN") && ~fileContent.indexOf("com.tns.ErrorReportActivity")
+									&& ~fileContent.indexOf("android:versionCode")
+									&& !this.$xmlValidator.getXmlFileErrors(pathToAndroidManifest).wait());
+
+				this.$logger.trace(`Existing ${this.platformData.configurationFileName} is ${isFileCorrect ? "" : "NOT "}correct.`);
+				return isFileCorrect;
+			} catch(err) {
+				this.$logger.trace(`Error while checking ${pathToAndroidManifest}: `, err);
+				return false;
+			}
+		}).future<boolean>()();
+	}
+
+	private get configurationFileBackupName(): string {
+		return this.platformData.configurationFileName + ".backup";
+	}
+
+	private backupOriginalAndroidManifest(originalAndroidManifestFilePath: string): IFuture<void> {
+		return (() => {
+			let newPathForOriginalManifest = path.join(path.dirname(originalAndroidManifestFilePath), this.configurationFileBackupName);
+			shell.mv(originalAndroidManifestFilePath, newPathForOriginalManifest);
+		}).future<void>()();
+	}
+
+	private revertBackupOfOriginalAndroidManifest(originalAndroidManifestFilePath: string): IFuture<void> {
+		return (() => {
+			let pathToBackupFile = path.join(path.dirname(originalAndroidManifestFilePath), this.configurationFileBackupName);
+			if(this.$fs.exists(pathToBackupFile).wait()) {
+				this.$logger.trace(`Could not extract ${this.platformData.configurationFileName} from default template. Reverting the change of your app/App_Resources/${this.platformData.configurationFileName}.`);
+				shell.mv(pathToBackupFile, originalAndroidManifestFilePath);
+			}
+		}).future<void>()();
+	}
+
+	private extractAndroidManifestFromDefaultTemplate(originalAndroidManifestFilePath: string): IFuture<boolean> {
+		return ((): boolean => {
+			let defaultTemplatePath = this.$projectTemplatesService.defaultTemplatePath.wait();
+			let templateAndroidManifest = path.join(defaultTemplatePath, constants.APP_RESOURCES_FOLDER_NAME, this.$devicePlatformsConstants.Android, this.platformData.configurationFileName);
+			if (this.$fs.exists(templateAndroidManifest).wait()) {
+				this.$logger.trace(`${originalAndroidManifestFilePath} is missing. Upgrading the source of the project with one from the new project template. Copy ${templateAndroidManifest} to ${originalAndroidManifestFilePath}`);
+				try {
+					this.$fs.copyFile(templateAndroidManifest, originalAndroidManifestFilePath).wait();
+				} catch(e) {
+					this.$logger.trace(`Copying template's ${this.platformData.configurationFileName} failed. `, e);
+					return false;
+				}
+			} else {
+				this.$logger.trace(`${originalAndroidManifestFilePath} is missing but the template ${templateAndroidManifest} is missing too, can not upgrade ${this.platformData.configurationFileName}.`);
+				return false;
+			}
+
+			return true;
+		}).future<boolean>()();
+	}
 }
 $injector.register("androidProjectService", AndroidProjectService);

lib/services/ios-project-service.ts

@@ -400,7 +400,7 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 		}).future<void>()();
 	}
 
-	private mergeInfoPlists(): IFuture<void> {
+	public ensureConfigurationFileInAppResources(): IFuture<void> {
 		return (() => {
 			let projectDir = this.$projectData.projectDir;
 			let infoPlistPath = path.join(projectDir, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME, this.platformData.normalizedPlatformName, this.platformData.configurationFileName);
@@ -422,6 +422,15 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 				}
 			}
 
+		}).future<void>()();
+	}
+
+	private mergeInfoPlists(): IFuture<void> {
+		return (() => {
+			let projectDir = this.$projectData.projectDir;
+			let infoPlistPath = path.join(projectDir, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME, this.platformData.normalizedPlatformName, this.platformData.configurationFileName);
+			this.ensureConfigurationFileInAppResources().wait();
+
 			if (!this.$fs.exists(infoPlistPath).wait()) {
 				this.$logger.trace("Info.plist: No app/App_Resources/iOS/Info.plist found, falling back to pre-1.6.0 Info.plist behavior.");
 				return;

lib/services/platform-service.ts

@@ -8,7 +8,6 @@ import * as helpers from "../common/helpers";
 import * as semver from "semver";
 import * as minimatch from "minimatch";
 import Future = require("fibers/future");
-import {EOL} from "os";
 let clui = require("clui");
 
 export class PlatformService implements IPlatformService {
@@ -34,7 +33,8 @@ export class PlatformService implements IPlatformService {
 		private $pluginsService: IPluginsService,
 		private $projectFilesManager: IProjectFilesManager,
 		private $mobileHelper: Mobile.IMobileHelper,
-		private $hostInfo: IHostInfo) { }
+		private $hostInfo: IHostInfo,
+		private $xmlValidator: IXmlValidator) { }
 
 	public addPlatforms(platforms: string[]): IFuture<void> {
 		return (() => {
@@ -127,6 +127,7 @@ export class PlatformService implements IPlatformService {
 				this.$fs.deleteDirectory(path.join(frameworkDir, "../../")).wait();
 			}
 
+			platformData.platformProjectService.ensureConfigurationFileInAppResources().wait();
 			platformData.platformProjectService.interpolateData().wait();
 			platformData.platformProjectService.afterCreateProject(platformData.projectRoot).wait();
 
@@ -184,35 +185,6 @@ export class PlatformService implements IPlatformService {
 		}).future<boolean>()();
 	}
 
-	private checkXmlFiles(sourceFiles: string[]): IFuture<boolean> {
-		return (() => {
-			let xmlHasErrors = false;
-			let DomParser = require("xmldom").DOMParser;
-			sourceFiles
-				.filter(file => _.endsWith(file, ".xml"))
-				.forEach(file => {
-					let fileContents = this.$fs.readText(file).wait();
-					let hasErrors = false;
-					let errorOutput = "";
-					let domErrorHandler = (level:any, msg:string) => {
-						errorOutput += level + EOL + msg + EOL;
-						hasErrors = true;
-					};
-					let parser = new DomParser({
-						locator:{},
-						errorHandler: domErrorHandler
-					});
-					parser.parseFromString(fileContents, "text/xml");
-					xmlHasErrors = xmlHasErrors || hasErrors;
-					if (hasErrors) {
-						this.$logger.warn(`${file} has syntax errors.`);
-						this.$logger.out(errorOutput);
-					}
-				});
-			return !xmlHasErrors;
-		}).future<boolean>()();
-	}
-
 	@helpers.hook('prepare')
 	private preparePlatformCore(platform: string): IFuture<boolean> {
 		return (() => {
@@ -250,7 +222,7 @@ export class PlatformService implements IPlatformService {
 			}
 
 			// verify .xml files are well-formed
-			this.checkXmlFiles(sourceFiles).wait();
+			this.$xmlValidator.validateXmlFiles(sourceFiles).wait();
 
 			// Remove .ts and .js.map files
 			PlatformService.EXCLUDE_FILES_PATTERN.forEach(pattern => sourceFiles = sourceFiles.filter(file => !minimatch(file, pattern, {nocase: true})));

lib/xml-validator.ts

@@ -0,0 +1,51 @@
+///<reference path=".d.ts"/>
+"use strict";
+
+import { EOL } from "os";
+
+export class XmlValidator implements IXmlValidator {
+	constructor(private $fs: IFileSystem,
+				private $logger: ILogger) { }
+
+	public validateXmlFiles(sourceFiles: string[]): IFuture<boolean> {
+		return (() => {
+			let xmlHasErrors = false;
+			sourceFiles
+				.filter(file => _.endsWith(file, ".xml"))
+				.forEach(file => {
+					let errorOutput = this.getXmlFileErrors(file).wait();
+					let hasErrors = !!errorOutput;
+					xmlHasErrors = xmlHasErrors || hasErrors;
+					if (hasErrors) {
+						this.$logger.warn(`${file} has syntax errors.`);
+						this.$logger.out(errorOutput);
+					}
+				});
+			return !xmlHasErrors;
+		}).future<boolean>()();
+	}
+
+	public getXmlFileErrors(sourceFile: string): IFuture<string> {
+		return ((): string => {
+			let errorOutput = "";
+			let fileContents = this.$fs.readText(sourceFile).wait();
+			let domErrorHandler = (level:any, msg:string) => {
+				errorOutput += level + EOL + msg + EOL;
+			};
+			this.getDomParser(domErrorHandler).parseFromString(fileContents, "text/xml");
+
+			return errorOutput || null;
+		}).future<string>()();
+	}
+
+	private getDomParser(errorHandler: (level:any, msg:string) => void): any {
+		let DomParser = require("xmldom").DOMParser;
+		let parser = new DomParser({
+			locator:{},
+			errorHandler: errorHandler
+		});
+
+		return parser;
+	}
+}
+$injector.register("xmlValidator", XmlValidator);

test/npm-support.ts

@@ -27,6 +27,7 @@ import {ProjectFilesProvider} from "../lib/providers/project-files-provider";
 import {DeviceAppDataProvider} from "../lib/providers/device-app-data-provider";
 import {MobilePlatformsCapabilities} from "../lib/mobile-platforms-capabilities";
 import {DevicePlatformsConstants} from "../lib/common/mobile/device-platforms-constants";
+import { XmlValidator } from "../lib/xml-validator";
 import Future = require("fibers/future");
 
 import path = require("path");
@@ -75,6 +76,7 @@ function createTestInjector(): IInjector {
 	testInjector.register("deviceAppDataProvider", DeviceAppDataProvider);
 	testInjector.register("mobilePlatformsCapabilities", MobilePlatformsCapabilities);
 	testInjector.register("devicePlatformsConstants", DevicePlatformsConstants);
+	testInjector.register("xmlValidator", XmlValidator);
 
 	return testInjector;
 }

test/platform-commands.ts

@@ -20,6 +20,7 @@ import {ProjectFilesProvider} from "../lib/providers/project-files-provider";
 import {DeviceAppDataProvider} from "../lib/providers/device-app-data-provider";
 import {MobilePlatformsCapabilities} from "../lib/mobile-platforms-capabilities";
 import {DevicePlatformsConstants} from "../lib/common/mobile/device-platforms-constants";
+import { XmlValidator } from "../lib/xml-validator";
 
 let isCommandExecuted = true;
 
@@ -135,6 +136,7 @@ function createTestInjector() {
 	testInjector.register("deviceAppDataProvider", DeviceAppDataProvider);
 	testInjector.register("mobilePlatformsCapabilities", MobilePlatformsCapabilities);
 	testInjector.register("devicePlatformsConstants", DevicePlatformsConstants);
+	testInjector.register("xmlValidator", XmlValidator);
 
 	return testInjector;
 }