MediaWiki:Gadget-BugStatusUpdate.js

/*
 * Bug Status Update Gadget
 *
 * Authors:
 * Written by Rob Moen (robm).
 * Ported to Phabricator by Matthew Flaschen (Mattflaschen (WMF))
 *
 * Description:
 *  Finds and updates bug status templates on a page.
 *  Makes 1 JSONP request to phabricator-bug-status API (maintained by Matthew Flaschen)
 *  (which passes the request to Phabricator's Conduit API)
 * Source: [[mw:User:Robmoen/bugStatusUpdate.js]]
 */

jQuery( function ( $ ) {
	var	$trackedTemplates = $( '#mw-content-text' ).find( '.phab-trackedTemplate' ),
		ids = [],
		target = 'https://tools.wmflabs.org/phabricator-bug-status/queryTasks';

	// Get the Phabricator task id numbers on the page
	// The template should provide a data attribute, for simplicity and probably better performance.  There
	// should also be a class (which is added by this script), so it could quickly be found.  E.g.
	// data-task-number="123" class="phab-taskNumber-123 ..." ...
	// This could then be selected easily, and the number could be accessed with .data( 'taskNumber' ) 
	$trackedTemplates.each( function ( _, trackedTemplate ) {
		var taskNumber = trackedTemplate.dataset.taskNumber;
		if ( taskNumber && /^\d+$/.test( taskNumber ) ) {
			ids.push( parseInt( taskNumber ) );
			trackedTemplate.classList.add( 'phab-taskNumber-' + taskNumber );
		}
	} );

	// Do not query if no ids were found
	if ( !ids.length ) {
		return;
	}

	// Remove duplicates
	ids = ids.filter( function ( value, index, self ) {
		return self.indexOf( value ) === index;
	} );

	// Make jsonp
	$.ajax( {
		url: target,
		dataType: 'jsonp',
		data: { ids: JSON.stringify( ids ) },
		timeout: 5000, // Give up if Tool Labs is being slow today
		success: function ( data ) {

			var		color = {
						"resolved": "green"
					},
					statusProps = {
						'font-weight': 'bold',
						'text-transform': 'uppercase'
					},
					phid, taskInfo, taskNumber;

			for ( phid in data ) {
				taskInfo = data[phid];
				taskNumber = taskInfo.id;

				// Update the corresponding templates
				$trackedTemplates.filter( '.phab-taskNumber-' + taskNumber ).each( function ( _, template ) {
					var	$template = $( template ),
						$title, $status;

					$title = $template.find( '.phab-taskTitle' );
					if ( $title.length ) {
						$title.text( taskInfo.title );
					}

					// Find child, if exists
					$status = $template.find( '.phab-status' );

					// Create the status element if it does not exist
					if ( !$status.length ) {
						$status = $( '<span></span>' )
							.addClass( 'phab-status' )
							.css( statusProps );
						$template.append( '<br>', $status );
					}

					// Update the status element
					// This matches Template:Tracked itself, where only resolved has a color
					// defined for Phabricator (everything else is black).
					$status
						.text( taskInfo.statusName )
						.css( 'color', color[taskInfo.status] || 'black' );
				} );
			}
		}
	} );
} );