preview-app-livesync-service.ts

import * as path from "path";
import { FilePayload, Device, FilesPayload } from "nativescript-preview-sdk";
import { PreviewSdkEventNames } from "./preview-app-constants";
import { APP_FOLDER_NAME, APP_RESOURCES_FOLDER_NAME, TNS_MODULES_FOLDER_NAME } from "../../../constants";
import { HmrConstants } from "../../../common/constants";
const isTextOrBinary = require('istextorbinary');

interface ISyncFilesOptions {
	filesToSync?: string[];
	filesToRemove?: string[];
	isInitialSync?: boolean;
	skipPrepare?: boolean;
	useHotModuleReload?: boolean;
	deviceId?: string;
}

export class PreviewAppLiveSyncService implements IPreviewAppLiveSyncService {
	private excludedFileExtensions = [".ts", ".sass", ".scss", ".less"];
	private excludedFiles = [".DS_Store"];
	private deviceInitializationPromise: IDictionary<Promise<FilesPayload>> = {};

	constructor(private $fs: IFileSystem,
		private $errors: IErrors,
		private $hooksService: IHooksService,
		private $logger: ILogger,
		private $platformService: IPlatformService,
		private $platformsData: IPlatformsData,
		private $projectDataService: IProjectDataService,
		private $previewSdkService: IPreviewSdkService,
		private $previewAppPluginsService: IPreviewAppPluginsService,
		private $previewDevicesService: IPreviewDevicesService,
		private $projectFilesManager: IProjectFilesManager,
		private $hmrStatusService: IHmrStatusService,
		private $projectFilesProvider: IProjectFilesProvider) { }

	public async initialize(data: IPreviewAppLiveSyncData): Promise<void> {
		await this.$previewSdkService.initialize(async (device: Device) => {
			if (!device) {
				this.$errors.failWithoutHelp("Sending initial preview files without a specified device is not supported.");
			}

			if (this.deviceInitializationPromise[device.id]) {
				return this.deviceInitializationPromise[device.id];
			}

			this.deviceInitializationPromise[device.id] = this.initializePreviewForDevice(data, device);
			try {
				const payloads = await this.deviceInitializationPromise[device.id];
				return payloads;
			} finally {
				this.deviceInitializationPromise[device.id] = null;
			}
		});
	}

	public async syncFiles(data: IPreviewAppLiveSyncData, filesToSync: string[], filesToRemove: string[]): Promise<void> {
		this.showWarningsForNativeFiles(filesToSync);

		const connectedDevices = this.$previewDevicesService.getConnectedDevices();
		for (const device of connectedDevices) {
			await this.$previewAppPluginsService.comparePluginsOnDevice(data, device);
		}

		const platforms = _(connectedDevices)
			.map(device => device.platform)
			.uniq()
			.value();
		for (const platform of platforms) {
			await this.syncFilesForPlatformSafe(data, platform, { filesToSync, filesToRemove, useHotModuleReload: data.appFilesUpdaterOptions.useHotModuleReload });
		}
	}

	public async stopLiveSync(): Promise<void> {
		this.$previewSdkService.stop();
	}

	private async initializePreviewForDevice(data: IPreviewAppLiveSyncData, device: Device): Promise<FilesPayload> {
		const hookArgs = this.getHookArgs(data, device);
		await this.$hooksService.executeBeforeHooks("preview-sync", { hookArgs });
		await this.$previewAppPluginsService.comparePluginsOnDevice(data, device);
		const payloads = await this.syncFilesForPlatformSafe(data, device.platform, { isInitialSync: true, useHotModuleReload: data.appFilesUpdaterOptions.useHotModuleReload });
		return payloads;
	}

	private getHookArgs(data: IPreviewAppLiveSyncData, device: Device) {
		const filesToSyncMap: IDictionary<string[]> = {};
		const hmrData: IDictionary<IPlatformHmrData> = {};
		const promise = Promise.resolve<FilesPayload>(null);
		const result = {
			projectData: this.$projectDataService.getProjectData(data.projectDir),
			hmrData,
			config: {
				env: data.env,
				platform: device.platform,
				appFilesUpdaterOptions: data.appFilesUpdaterOptions,
			},
			externals: this.$previewAppPluginsService.getExternalPlugins(device),
			filesToSyncMap,
			startSyncFilesTimeout: async (platform: string) => await this.onWebpackCompilationComplete(data, hmrData, filesToSyncMap, promise, platform)
		};

		return result;
	}

	private async onWebpackCompilationComplete(data: IPreviewAppLiveSyncData, hmrData: IDictionary<IPlatformHmrData>, filesToSyncMap: IDictionary<string[]>, promise: Promise<FilesPayload>, platform: string) {
		await promise
			.then(async () => {
				const currentHmrData = _.cloneDeep(hmrData);
				const platformHmrData = currentHmrData[platform] || <any>{};
				const filesToSync = _.cloneDeep(filesToSyncMap[platform]);
				// We don't need to prepare when webpack emits changed files. We just need to send a message to pubnub.
				promise = this.syncFilesForPlatformSafe(data, platform, { filesToSync, skipPrepare: true, useHotModuleReload: data.appFilesUpdaterOptions.useHotModuleReload });
				await promise;

				if (data.appFilesUpdaterOptions.useHotModuleReload && platformHmrData.hash) {
					const devices = this.$previewDevicesService.getDevicesForPlatform(platform);

					await Promise.all(_.map(devices, async (previewDevice: Device) => {
						const status = await this.$hmrStatusService.getHmrStatus(previewDevice.id, platformHmrData.hash);
						if (status === HmrConstants.HMR_ERROR_STATUS) {
							await this.syncFilesForPlatformSafe(data, platform, { filesToSync: platformHmrData.fallbackFiles, useHotModuleReload: false, deviceId: previewDevice.id });
						}
					}));
				}
			});
		filesToSyncMap[platform] = [];
	}

	private async syncFilesForPlatformSafe(data: IPreviewAppLiveSyncData, platform: string, opts?: ISyncFilesOptions): Promise<FilesPayload> {
		this.$logger.info(`Start syncing changes for platform ${platform}.`);

		opts = opts || {};
		let payloads = null;

		try {
			const { appFilesUpdaterOptions, env, projectDir } = data;
			const projectData = this.$projectDataService.getProjectData(projectDir);
			const platformData = this.$platformsData.getPlatformData(platform, projectData);

			if (!opts.skipPrepare) {
				await this.preparePlatform(platform, appFilesUpdaterOptions, env, projectData);
			}

			if (opts.isInitialSync) {
				const platformsAppFolderPath = path.join(platformData.appDestinationDirectoryPath, APP_FOLDER_NAME);
				opts.filesToSync = this.$projectFilesManager.getProjectFiles(platformsAppFolderPath);
				payloads = this.getFilesPayload(platformData, projectData, opts);
				this.$logger.info(`Successfully synced changes for platform ${platform}.`);
			} else {
				opts.filesToSync = _.map(opts.filesToSync, file => this.$projectFilesProvider.mapFilePath(file, platformData.normalizedPlatformName, projectData));
				payloads = this.getFilesPayload(platformData, projectData, opts);
				await this.$previewSdkService.applyChanges(payloads);
				this.$logger.info(`Successfully synced ${payloads.files.map(filePayload => filePayload.file.yellow)} for platform ${platform}.`);
			}

			return payloads;
		} catch (err) {
			this.$logger.warn(`Unable to apply changes for platform ${platform}. Error is: ${err}, ${JSON.stringify(err, null, 2)}.`);
		}
	}

	private getFilesPayload(platformData: IPlatformData, projectData: IProjectData, opts?: ISyncFilesOptions): FilesPayload {
		const { filesToSync, filesToRemove, deviceId } = opts;

		const filesToTransfer = filesToSync
			.filter(file => file.indexOf(TNS_MODULES_FOLDER_NAME) === -1)
			.filter(file => file.indexOf(APP_RESOURCES_FOLDER_NAME) === -1)
			.filter(file => !_.includes(this.excludedFiles, path.basename(file)))
			.filter(file => !_.includes(this.excludedFileExtensions, path.extname(file)));

		this.$logger.trace(`Transferring ${filesToTransfer.join("\n")}.`);

		const payloadsToSync = filesToTransfer.map(file => this.createFilePayload(file, platformData, projectData, PreviewSdkEventNames.CHANGE_EVENT_NAME));
		const payloadsToRemove = _.map(filesToRemove, file => this.createFilePayload(file, platformData, projectData, PreviewSdkEventNames.UNLINK_EVENT_NAME));
		const payloads = payloadsToSync.concat(payloadsToRemove);

		const hmrMode = opts.useHotModuleReload ? 1 : 0;
		return { files: payloads, platform: platformData.normalizedPlatformName.toLowerCase(), hmrMode, deviceId };
	}

	private async preparePlatform(platform: string, appFilesUpdaterOptions: IAppFilesUpdaterOptions, env: Object, projectData: IProjectData): Promise<void> {
		const nativePrepare = { skipNativePrepare: true };
		const config = <IPlatformOptions>{};
		const platformTemplate = <string>null;
		const prepareInfo = {
			platform,
			appFilesUpdaterOptions,
			env,
			projectData,
			nativePrepare,
			config,
			platformTemplate,
			skipCopyTnsModules: true,
			skipCopyAppResourcesFiles: true
		};
		await this.$platformService.preparePlatform(prepareInfo);
	}

	private showWarningsForNativeFiles(files: string[]): void {
		_.filter(files, file => file.indexOf(APP_RESOURCES_FOLDER_NAME) > -1)
			.forEach(file => this.$logger.warn(`Unable to apply changes from ${APP_RESOURCES_FOLDER_NAME} folder. You need to build your application in order to make changes in ${APP_RESOURCES_FOLDER_NAME} folder.`));
	}

	private createFilePayload(file: string, platformData: IPlatformData, projectData: IProjectData, event: string): FilePayload {
		const projectFileInfo = this.$projectFilesProvider.getProjectFileInfo(file, platformData.normalizedPlatformName, null);
		const binary = isTextOrBinary.isBinarySync(file);
		let fileContents = "";
		let filePath = "";

		if (event === PreviewSdkEventNames.CHANGE_EVENT_NAME) {
			const relativePath = path.relative(path.join(platformData.appDestinationDirectoryPath, APP_FOLDER_NAME), file);
			filePath = path.join(path.dirname(relativePath), projectFileInfo.onDeviceFileName);

			if (binary) {
				const bitmap = <string>this.$fs.readFile(file);
				const base64 = Buffer.from(bitmap).toString('base64');
				fileContents = base64;
			} else {
				fileContents = this.$fs.readText(path.join(path.dirname(projectFileInfo.filePath), projectFileInfo.onDeviceFileName));
			}
		} else if (event === PreviewSdkEventNames.UNLINK_EVENT_NAME) {
			filePath = path.relative(path.join(projectData.projectDir, APP_FOLDER_NAME), file);
		}

		const filePayload = {
			event,
			file: filePath,
			binary,
			fileContents
		};

		return filePayload;
	}
}
$injector.register("previewAppLiveSyncService", PreviewAppLiveSyncService);