Code Coverage for /src/src/Logger/ParsoidLogger.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		n/a	0 / 0	26.32% covered (danger)	26.32%	5 / 19	CRAP	0.00% covered (danger)	0.00%	0 / 143
Parsoid\LocationData				0.00% covered (danger)	0.00%	0 / 1	42	0.00% covered (danger)	0.00%	0 / 7
anonymousFunction:27#196				0.00% covered (danger)	0.00%	0 / 1	6	0.00% covered (danger)	0.00%	0 / 3
Parsoid\ParsoidLogData				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 3
Parsoid\ParsoidLogger				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 3
anonymousFunction:55#369				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 1
anonymousFunction:56#378					n/a	0 / 0	1		n/a	0 / 0
anonymousFunction:59#413				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 1
anonymousFunction:60#422					n/a	0 / 0	1		n/a	0 / 0
anonymousFunction:63#457				0.00% covered (danger)	0.00%	0 / 1	156	0.00% covered (danger)	0.00%	0 / 34
anonymousFunction:66#490					n/a	0 / 0	1		n/a	0 / 0
anonymousFunction:75#683				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2
anonymousFunction:88#791				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2
Parsoid\buildTraceOrDebugFlag				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 4
anonymousFunction:119#1086					n/a	0 / 0	1		n/a	0 / 0
anonymousFunction:120#1131					n/a	0 / 0	1		n/a	0 / 0
anonymousFunction:124#1179				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2
anonymousFunction:130#1227				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 8
anonymousFunction:140#1298				0.00% covered (danger)	0.00%	0 / 1	6	0.00% covered (danger)	0.00%	0 / 6
anonymousFunction:184#1560				0.00% covered (danger)	0.00%	0 / 1	56	0.00% covered (danger)	0.00%	0 / 30

1	<?php // lint >= 99.9
2	// phpcs:ignoreFile
3	// phpcs:disable Generic.Files.LineLength.TooLong
4	/* REMOVE THIS COMMENT AFTER PORTING */
5	/** @module */
6
7	namespace Parsoid;
8
9	use Parsoid\coreutil as coreutil;
10	$JSUtils = require( '../utils/jsutils.js' )::JSUtils;
11	$Logger = require( './Logger.js' )::Logger;
12	$LogData = require( './LogData.js' )::LogData;
13	$Promise = require( '../utils/promise.js' );
14
15
16	/**
17	* @class
18	*/
19	function LocationData( $wiki, $title, $meta, $reqId, $userAgent ) {
20	$this->wiki = $wiki;
21	$this->title = $title;
22	$this->oldId = ( $meta && $meta->revision && $meta->revision->revid ) ?
23	$meta->revision->revid : null;
24	$this->reqId = $reqId \|\| null;
25	$this->userAgent = $userAgent \|\| null;
26	}
27	LocationData::prototype::toString = function () {
28	$query = ( $this->oldId ) ? '?oldid=' . $this->oldId : '';
29	return "[{$this->wiki}/{$this->title}{$query}]";
30	};
31
32
33	/**
34	* @class
35	* @extends module:logger/LogData~LogData
36	*/
37	function ParsoidLogData( $logType, $logObject, $locationData ) {
38	$this->locationData = $locationData;
39	call_user_func( 'LogData', $logType, $logObject );
40	}
41	coreutil::inherits( $ParsoidLogData, $LogData );
42
43
44	/**
45	* @class
46	* @extends module:logger/Logger~Logger
47	* @param {MWParserEnvironment} env
48	*/
49	function ParsoidLogger( $env ) {
50	$this->env = $env;
51	call_user_func_array( 'Logger', [] );
52	}
53	coreutil::inherits( $ParsoidLogger, $Logger );
54
55	ParsoidLogger::prototype::getDefaultBackend = function () {
56	return function ( $logData ) {return $this->_defaultBackend( $logData ); };
57	};
58
59	ParsoidLogger::prototype::getDefaultTracerBackend = function () {
60	return function ( $logData ) {return $this->_defaultTracerBackend( $logData ); };
61	};
62
63	ParsoidLogger::prototype::registerLoggingBackends = function ( $defaultLogLevels, $parsoidConfig, $lintLogger ) use ( &$JSUtils ) {
64	// Register a default backend based on default logTypes.
65	// DEFAULT: Combine all regexp-escaped default logTypes into a single regexp.
66	$fixLogType = function ( $logType ) use ( &$JSUtils ) { return JSUtils::escapeRegExp( $logType ) . '(\/\|$)'; };
67	$defaultRE = new RegExp( implode( '\|', array_map( ( $defaultLogLevels \|\| [] ), $fixLogType ) ) );
68	$loggerBackend = null;
69	if ( gettype( $parsoidConfig->loggerBackend ) === 'function' ) {
70	$loggerBackend = $parsoidConfig->loggerBackend;
71	} elseif ( $parsoidConfig->loggerBackend && $parsoidConfig->loggerBackend->name ) {
72	$parts = explode( '/', $parsoidConfig->loggerBackend->name );
73	// use a leading colon to indicate a parsoid-local logger.
74	$ClassObj = require( preg_replace( '/^:/', './', array_shift( $parts ), 1 ) );
75	$parts->forEach( function ( $k ) {
76	$ClassObj = ClassObj[ $k ];
77	}
78	);
79	$loggerBackend = new ClassObj( $parsoidConfig->loggerBackend->options )->
80	getLogger();
81	} else {
82	$loggerBackend = $this->getDefaultBackend();
83	}
84	$this->registerBackend( $defaultRE, $loggerBackend );
85
86	// Register sampling
87	if ( is_array( $parsoidConfig->loggerSampling ) ) {
88	$parsoidConfig->loggerSampling->forEach( function ( $s ) {
89	$this->registerSampling( $s[ 0 ], $s[ 1 ] );
90	}, $this
91	);
92	}
93
94	// TRACE / DEBUG: Make trace / debug regexp with appropriate postfixes,
95	// depending on the command-line options passed in.
96	function buildTraceOrDebugFlag( $parsoidFlags, $logType ) {
97	$escapedFlags = array_map( Array::from( $parsoidFlags ), JSUtils::escapeRegExp );
98	$combinedFlag = $logType . '/(' . implode( '\|', $escapedFlags ) . ')(\/\|$)';
99	return new RegExp( $combinedFlag );
100	}
101
102	// Register separate backend for tracing / debugging events.
103	// Tracing and debugging use the same backend for now.
104	$tracerBackend = ( gettype( $parsoidConfig->tracerBackend ) === 'function' ) ?
105	$parsoidConfig->tracerBackend : $this->getDefaultTracerBackend();
106	if ( $parsoidConfig->traceFlags ) {
107	$this->registerBackend( buildTraceOrDebugFlag( $parsoidConfig->traceFlags, 'trace' ),
108	$tracerBackend
109	);
110	}
111	if ( $parsoidConfig->debug ) {
112	$this->registerBackend( /* RegExp / '/^debug(\/.)?/', $tracerBackend );
113	} elseif ( $parsoidConfig->debugFlags ) {
114	$this->registerBackend( buildTraceOrDebugFlag( $parsoidConfig->debugFlags, 'debug' ),
115	$tracerBackend
116	);
117	}
118	if ( $lintLogger && $parsoidConfig->linting ) {
119	$this->registerBackend( /* RegExp / '/^lint(\/.)?/', function ( $logData ) use ( &$lintLogger ) {return $lintLogger->linterBackend( $logData ); } );
120	$this->registerBackend( /* RegExp / '/^end(\/.)/', function ( $logData ) use ( &$lintLogger ) {return $lintLogger->logLintOutput( $logData ); } );
121	}
122	};
123
124	ParsoidLogger::prototype::_createLogData = function ( $logType, $logObject ) {
125	return new ParsoidLogData( $logType, $logObject, $this->locationData() );
126	};
127
128	// Set up a location message function in Logdata
129	// so all logging backends can output location message
130	ParsoidLogger::prototype::locationData = function () {
131	return new LocationData(
132	$this->env->conf->wiki->iwp,
133	$this->env->page->name,
134	$this->env->page->meta,
135	$this->env->reqId,
136	$this->env->userAgent
137	);
138	};
139
140	ParsoidLogger::prototype::_defaultBackend = /* async */function ( $logData ) { // eslint-disable-line require-yield
141	// The default logging backend provided by Logger.js is not useful to us.
142	// Parsoid needs to be able to emit page location to logs.
143	try {
144	$console->warn( '[%s]%s %s', $logData->logType, $logData->locationData->toString(), $logData->fullMsg() );
145	} catch ( Exception $e ) {
146	$console->error( 'Error in ParsoidLogger._defaultBackend: %s', $e );
147	}
148	}
149
150
151
152
153
154
155
156	;
157
158	$prettyLogTypeMap = [
159	'debug' => '[DEBUG]',
160	'trace/pre-peg' => '[pre-peg]',
161	'trace/peg' => '[peg]',
162	'trace/pre' => '[PRE]',
163	'debug/pre' => '[PRE-DBG]',
164	'trace/p-wrap' => '[P]',
165	'trace/html' => '[HTML]',
166	'debug/html' => '[HTML-DBG]',
167	'trace/sanitizer' => '[SANITY]',
168	'trace/tsp' => '[TSP]',
169	'trace/dsr' => '[DSR]',
170	'trace/list' => '[LIST]',
171	'trace/quote' => '[QUOTE]',
172	'trace/sync:1' => '[S1]',
173	'trace/async:2' => '[A2]',
174	'trace/sync:3' => '[S3]',
175	'trace/wts' => '[WTS]',
176	'debug/wts/sep' => '[SEP]',
177	'trace/selser' => '[SELSER]',
178	'trace/domdiff' => '[DOM-DIFF]',
179	'trace/wt-escape' => '[wt-esc]',
180	'trace/batcher' => '[batcher]',
181	'trace/apirequest' => '[ApiRequest]'
182	];
183
184	ParsoidLogger::prototype::_defaultTracerBackend = /* async */function ( $logData ) use ( &$prettyLogTypeMap ) { // eslint-disable-line require-yield
185	try {
186	$msg = '';
187	$typeColumnWidth = 15;
188	$logType = $logData->logType;
189	$firstArg = ( is_array( $logData->logObject ) ) ? $logData->logObject[ 0 ] : null;
190
191	// Assume first numeric arg is always the pipeline id
192	// Assume first numeric arg is always the pipeline id
193	if ( gettype( $firstArg ) === 'number' ) {
194	$msg = $firstArg . '-';
195	array_shift( $logData->logObject );
196	}
197
198	// indent by number of slashes
199	// indent by number of slashes
200	$match = preg_match_all( '/\//', $logType, $FIXME );
201	$level = ( $match ) ? count( $match ) - 1 : 0;
202	$indent = ' '->repeat( $level );
203	$msg += $indent;
204
205	$prettyLogType = $prettyLogTypeMap[ $logType ];
206	if ( $prettyLogType ) {
207	$msg += $prettyLogType;
208	} else {
209	// XXX: could shorten or strip trace/ logType prefix in a pure
210	// trace logger
211	$msg += $logType;
212
213	// More space for these log types
214	// More space for these log types
215	$typeColumnWidth = 30;
216	}
217
218	// Fixed-width type column so that the messages align
219	// Fixed-width type column so that the messages align
220	$msg = substr( $msg, 0, $typeColumnWidth );
221	$msg += ' '->repeat( $typeColumnWidth - count( $msg ) );
222	$msg += '\| ' . $indent . $logData->msg();
223
224	if ( $msg ) {
225	$console->warn( $msg );
226	}
227	} catch ( Exception $e ) {
228	$console->error( 'Error in ParsoidLogger._defaultTracerBackend: ' . $e );
229	}
230	}
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272	;
273
274	if ( gettype( $module ) === 'object' ) {
275	$module->exports->ParsoidLogger = $ParsoidLogger;
276	$module->exports->ParsoidLogData = $ParsoidLogData;
277	}