✨ Added logging to n8n (#1381)

* Added logging to n8n

This commit adds logging to n8n using the Winston library.

For now, this commit only allows logging to console (default behavior)
or file (need to pass in config via environment variables).

Other logging methods can be further implemented using hooks. These were
skipped for now as it would require adding more dependencies.

Logging level is notice by default, meaning no additional messages would
be displayed at the moment. Logging level can be set to info or debug as
well to enrich the generated logs.

The ILogger interface was added to the workflow project as it would make
it available for all other projects but the implementation was done on
the cli project.

* Lint fixes and logging level naming. Also fixed the way we use the logger as it was not working previously

* Improvements to logging framework

Using appropriate single quotes
Improving the way the logger is declared

* Improved naming for Log Types

* Removed logger global variable, replacing it by a proxy

* Add logging to CLI commands

* Remove unused GenericHelpers

* Changed back some messages to console instead of logger and added npm
shortcuts for worker and webhook

* Fix typos

* Adding basic file rotation to logs as suggested by @mutdmour

* Fixed linting issues

* Correcting comment to correctly reflect space usage

* Added settings for log files rotation

* Correcting config type from String to Number

* Changed default file settings to number

To reflect previous changes to the type

* Changed the way log messages are added to be called statically. Also minor naming improvements

* Applying latest corrections sent by @ivov

* ⚡ Some logging improvements

* Saving logs to a folder inside n8n home instead of root

* Fixed broken tests and linting

* Changed some log messages to improve formatting

* Adding quotes to names  on log messages

* Added execution and session IDs to logs. Also removed unnecessary line breaks

* ⚡ Added file caller to log messages (#1657)

This is done using callsites library which already existed
in the project as another library's dependency. So in fact
it does not add any new dependency.

* Adding logs to help debug Salesforce node

* ⚡ Add function name to logs and add more logs

* ⚡ Improve some error messages

* ⚡ Improve some more log messages

* ⚡ Rename logging env variables to match others

Co-authored-by: dali <servfrdali@yahoo.fr>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>

packages/cli/commands/export/workflow.ts

@@ -9,9 +9,16 @@ import {
 
 import {
 	Db,
-	GenericHelpers,
 } from '../../src';
 
+import { 
+	getLogger,
+} from '../../src/Logger';
+
+import {
+	LoggerProxy,
+} from 'n8n-workflow';
+
 import * as fs from 'fs';
 import * as path from 'path';
 
@@ -49,6 +56,9 @@ export class ExportWorkflowsCommand extends Command {
 	};
 
 	async run() {
+		const logger = getLogger();
+		LoggerProxy.init(logger);
+
 		const { flags } = this.parse(ExportWorkflowsCommand);
 
 		if (flags.backup) {
@@ -58,41 +68,42 @@ export class ExportWorkflowsCommand extends Command {
 		}
 
 		if (!flags.all && !flags.id) {
-			GenericHelpers.logOutput(`Either option "--all" or "--id" have to be set!`);
+			console.info(`Either option "--all" or "--id" have to be set!`);
 			return;
 		}
 
 		if (flags.all && flags.id) {
-			GenericHelpers.logOutput(`You should either use "--all" or "--id" but never both!`);
+			console.info(`You should either use "--all" or "--id" but never both!`);
 			return;
 		}
 
 		if (flags.separate) {
 			try {
 				if (!flags.output) {
-					GenericHelpers.logOutput(`You must inform an output directory via --output when using --separate`);
+					console.info(`You must inform an output directory via --output when using --separate`);
 					return;
 				}
 
 				if (fs.existsSync(flags.output)) {
 					if (!fs.lstatSync(flags.output).isDirectory()) {
-						GenericHelpers.logOutput(`The paramenter --output must be a directory`);
+						console.info(`The paramenter --output must be a directory`);
 						return;
 					}
 				} else {
 					fs.mkdirSync(flags.output, { recursive: true });
 				}
 			} catch (e) {
-				console.error('\nFILESYSTEM ERROR');
-				console.log('====================================');
-				console.error(e.message);
-				console.error(e.stack);
+				console.error('Aborting execution as a filesystem error has been encountered while creating the output directory. See log messages for details.');
+				logger.error('\nFILESYSTEM ERROR');
+				logger.info('====================================');
+				logger.error(e.message);
+				logger.error(e.stack);
 				this.exit(1);
 			}
 		} else if (flags.output) {
 			if (fs.existsSync(flags.output)) {
 				if (fs.lstatSync(flags.output).isDirectory()) {
-					GenericHelpers.logOutput(`The paramenter --output must be a writeble file`);
+					console.info(`The paramenter --output must be a writeble file`);
 					return;
 				}
 			}
@@ -119,18 +130,21 @@ export class ExportWorkflowsCommand extends Command {
 					const filename = (flags.output!.endsWith(path.sep) ? flags.output! : flags.output + path.sep) + workflows[i].id + '.json';
 					fs.writeFileSync(filename, fileContents);
 				}
-				console.log('Successfully exported', i, 'workflows.');
+				console.info(`Successfully exported ${i} workflows.`);
 			} else {
 				const fileContents = JSON.stringify(workflows, null, flags.pretty ? 2 : undefined);
 				if (flags.output) {
 					fs.writeFileSync(flags.output!, fileContents);
-					console.log('Successfully exported', workflows.length, workflows.length === 1 ? 'workflow.' : 'workflows.');
+					console.info(`Successfully exported ${workflows.length} ${workflows.length === 1 ? 'workflow.' : 'workflows.'}`);
 				} else {
-					console.log(fileContents);
+					console.info(fileContents);
 				}
 			}
+			// Force exit as process won't exit using MySQL or Postgres.
+			process.exit(0);
 		} catch (error) {
-			this.error(error.message);
+			console.error('Error exporting workflows. See log messages for details.');
+			logger.error(error.message);
 			this.exit(1);
 		}
 	}