Merge pull request #4610 from NativeScript/vladimirov/backwards-compatible

fix: make logger backwards compatible

Author: Dimitar Tachev

lib/common/definitions/logger.d.ts

@@ -25,6 +25,36 @@ declare global {
 		trace(formatStr?: any, ...args: any[]): void;
 		printMarkdown(...args: any[]): void;
 		prepare(item: any): string;
+
+		/**
+		 * DEPRECATED
+		 * Do not use it.
+		 */
+		out(formatStr?: any, ...args: any[]): void;
+
+		/**
+		 * DEPRECATED
+		 * Do not use it.
+		 */
+		write(...args: any[]): void;
+
+		/**
+		 * DEPRECATED
+		 * Do not use it.
+		 */
+		printInfoMessageOnSameLine(message: string): void;
+
+		/**
+		 * DEPRECATED
+		 * Do not use it.
+		 */
+		printMsgWithTimeout(message: string, timeout: number): Promise<void>;
+
+		/**
+		 * DEPRECATED
+		 * Do not use it.
+		 */
+		printOnStderr(formatStr?: any, ...args: any[]): void;
 	}
 
 	interface Log4JSAppenderConfiguration extends Configuration {

lib/common/logger/logger.ts

@@ -81,15 +81,6 @@ export class Logger implements ILogger {
 		this.logMessage(args, LoggerLevel.INFO);
 	}
 
-	/**
-	 * DEPRECATED
-	 * Present only for backwards compatibility as some plugins (nativescript-plugin-firebase)
-	 * use $logger.out in their hooks
-	 */
-	out(...args: any[]): void {
-		this.info(args);
-	}
-
 	debug(...args: any[]): void {
 		const encodedArgs: string[] = this.getPasswordEncodedArguments(args);
 		this.logMessage(encodedArgs, LoggerLevel.DEBUG);
@@ -200,6 +191,37 @@ export class Logger implements ILogger {
 			return argument;
 		});
 	}
+
+	/*******************************************************************************************
+	 * Metods below are deprecated. Delete them in 6.0.0 release:                              *
+	 * Present only for backwards compatibility as some plugins (nativescript-plugin-firebase) *
+	 * use these methods in their hooks                                                          *
+	 *******************************************************************************************/
+
+	out(...args: any[]): void {
+		this.info(args);
+	}
+
+	write(...args: any[]): void {
+		this.info(args, { [LoggerConfigData.skipNewLine]: true });
+	}
+
+	printOnStderr(...args: string[]): void {
+		this.error(args);
+	}
+
+	printInfoMessageOnSameLine(message: string): void {
+		this.info(message, { [LoggerConfigData.skipNewLine]: true });
+	}
+
+	printMsgWithTimeout(message: string, timeout: number): Promise<void> {
+		return new Promise<void>((resolve, reject) => {
+			setTimeout(() => {
+				this.printInfoMessageOnSameLine(message);
+				resolve();
+			}, timeout);
+		});
+	}
 }
 
 $injector.register("logger", Logger);

lib/common/test/unit-tests/stubs.ts

@@ -45,6 +45,12 @@ export class CommonLoggerStub implements ILogger {
 	printMarkdown(message: string): void {
 		this.output += message;
 	}
+
+	out(formatStr?: any, ...args: any[]): void { }
+	write(...args: any[]): void { }
+	printInfoMessageOnSameLine(message: string): void { }
+	async printMsgWithTimeout(message: string, timeout: number): Promise<void> { }
+	printOnStderr(formatStr?: any, ...args: any[]): void { }
 }
 
 export class ErrorsStub implements IErrors {

lib/declarations.d.ts

@@ -570,7 +570,7 @@ interface IOptions extends IRelease, IDeviceIdentifier, IJustLaunch, IAvd, IAvai
 	analyticsLogFile: string;
 	performance: Object;
 	cleanupLogFile: string;
-	workflow: boolean;
+	workflow: any;
 	setupOptions(projectData: IProjectData): void;
 	printMessagesForDeprecatedOptions(logger: ILogger): void;
 }

test/stubs.ts

@@ -34,6 +34,12 @@ export class LoggerStub implements ILogger {
 	}
 
 	printMarkdown(message: string): void { }
+
+	out(formatStr?: any, ...args: any[]): void { }
+	write(...args: any[]): void { }
+	printInfoMessageOnSameLine(message: string): void { }
+	async printMsgWithTimeout(message: string, timeout: number): Promise<void> { }
+	printOnStderr(formatStr?: any, ...args: any[]): void { }
 }
 
 export class FileSystemStub implements IFileSystem {