Firefox for desktop - list fixed bugs in Mercurial

It generates lists of fixed bugs related to Firefox for desktop in Mozilla Mercurial pushlogs

As of 2015-11-26. See the latest version.

// ==UserScript==
// @name        Firefox for desktop - list fixed bugs in Mercurial
// @namespace   darkred
// @authors     darkred, johnp
// @description It generates lists of fixed bugs related to Firefox for desktop in Mozilla Mercurial pushlogs
// @version     5.4
// @require     https://code.jquery.com/jquery-2.1.4.min.js
// @require     https://code.jquery.com/ui/1.11.4/jquery-ui.min.js
// @require     https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.24.3/js/jquery.tablesorter.min.js
// @require     https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.10.6/moment-with-locales.min.js
// @require     https://cdnjs.cloudflare.com/ajax/libs/moment-timezone/0.4.1/moment-timezone-with-data.min.js
// @require     https://cdnjs.cloudflare.com/ajax/libs/jstimezonedetect/1.0.6/jstz.min.js
// @require     https://cdnjs.cloudflare.com/ajax/libs/datejs/1.0/date.min.js
// @require     https://cdnjs.cloudflare.com/ajax/libs/keypress/2.1.3/keypress.min.js
// @include     /^https?:\/\/hg\.mozilla\.org.*pushloghtml.*/
// @grant       GM_xmlhttpRequest
// @grant       GM_addStyle
// @grant       GM_getResourceText
// ==/UserScript==




// CSS rules in order to show 'up' and 'down' arrows in each table header
var stylesheet = '                                                                                                              \
<style>                                                                                                                         \
thead th {                                                                                                                      \
    background-repeat: no-repeat;                                                                                               \
    background-position: right center;                                                                                          \
}                                                                                                                               \
thead th.up {                                                                                                                   \
    padding-right: 20px;                                                                                                        \
    background-image: url(data:image/gif;base64,R0lGODlhFQAEAIAAACMtMP///yH5BAEAAAEALAAAAAAVAAQAAAINjI8Bya2wnINUMopZAQA7);      \
}                                                                                                                               \
thead th.down {                                                                                                                 \
    padding-right: 20px;                                                                                                        \
    background-image: url(data:image/gif;base64,R0lGODlhFQAEAIAAACMtMP///yH5BAEAAAEALAAAAAAVAAQAAAINjB+gC+jP2ptn0WskLQA7);      \
}                                                                                                                               \
}                                                                                                                               \
</style>';

$('head').append(stylesheet);



// in order to highlight hovered table row
GM_addStyle("#tbl tr:hover{ background:#F6E6C6 !important;}");

// in order the table headers to be larger and bold
GM_addStyle('#tbl th {text-align: -moz-center !important; font-size: larger; font-weight: bold; }');

// in order to remove unnecessairy space between rows
GM_addStyle('#dialog > div > table > tbody {line-height: 14px;}');


GM_addStyle('#tbl > thead > tr > th {border-bottom: solid 1px};}');


GM_addStyle('#tbl td:nth-child(1) {text-align: -moz-right;}');

// in order the 'product/component' to be aligned to the right
GM_addStyle('#tbl td:nth-child(2) {text-align: -moz-right;}');






var silent = false;
var debug = false;

time('MozillaMercurial');

String.prototype.escapeHTML = function() {
var tagsToReplace = {
      '&': '&amp;',
        '<': '&lt;',
        '>': '&gt;'
    };
    return this.replace(/[&<>]/g, function(tag) {
        return tagsToReplace[tag] || tag;
    });
};

// theme for the jQuery dialog
$("head").append(
    '<link ' +
    'href="//ajax.googleapis.com/ajax/libs/jqueryui/1.11.4/themes/redmond/jquery-ui.min.css" ' +
    // 'href="//ajax.googleapis.com/ajax/libs/jqueryui/1.11.4/themes/smoothness/jquery-ui.min.css" ' +                 // uncomment this (and comment #19)  in order to change theme
    'rel="stylesheet" type="text/css">'
);


var regex = /^https:\/\/bugzilla\.mozilla\.org\/show_bug\.cgi\?id=(.*)$/;
var base_url = "https://bugzilla.mozilla.org/rest/bug?include_fields=id,summary,status,resolution,product,component,op_sys,platform,whiteboard,last_change_time&id=";
var bugIds = [];
var bugsComplete = [];

var table = document.getElementsByTagName("table")[0];
var links = table.getElementsByTagName("a");
var len = links.length;
for (let i = 0; i < len; i++) {
  let n = links[i].href.match(regex);
  if (n !== null && n.length > 0) {
    let id = parseInt(n[1]);
    if (bugIds.indexOf(id) === -1) {
      bugIds.push(id);
    }
  }
}

var numBugs = bugIds.length;
var counter = 0;

var rest_url = base_url + bugIds.join();
time("MozillaMercurial-REST");







$.getJSON(rest_url, function(data) {
  timeEnd("MozillaMercurial-REST");
  $.each(data.bugs, function(index) {
    let bug = data.bugs[index];
    // process bug (let "shorthands" just to simplify things during refactoring)
    let status = bug.status;
    if (bug.resolution !== "") status += " " + bug.resolution;
    let product = bug.product;
    let component = bug.component;
    let platform = bug.platform;
    if (platform == 'Unspecified') {
      platform = 'Uns';
    }
    if (bug.op_sys !== "" && bug.op_sys !== "Unspecified") {
      platform += '/' + bug.op_sys;
    }
    let whiteboard = bug.whiteboard === "" ? "[]" : bug.whiteboard;
    // todo: message???






    var changetime;
    var localTimezone = getLocalTimezone();

    if (bug.last_change_time !== '') {
        var temp = toRelativeTime(bug.last_change_time, localTimezone);
        if (temp.match(/(an?)\ .*/)) {
            changetime = temp.replace(/an?/, 1);
        } else {
            changetime = temp;
        }
        // changetime
    } else {
        changetime = '';
    }



    // 2015-11-09T14:40:41Z
     function toRelativeTime(time, zone) {
       var format2 = ('YYYY-MM-DD HH:mm:ss Z');
       return moment(time, format2).tz(zone).fromNow();
     }


    function getLocalTimezone(){
        var tz = jstz.determine();    // Determines the time zone of the browser client
        return tz.name();             // Returns the name of the time zone eg "Europe/Berlin"
    }






     log('----------------------------------------------------------------------------------------------------------------------------------');
     log((index + 1) + "/" + numBugs); // Progression counter
     log('BugNo: ' + bug.id + '\nTitle: ' + bug.summary + '\nStatus: ' + status + '\nProduct: ' + product + '\nComponent: ' + component + '\nPlatform: ' + platform + '\nWhiteboard: ' + whiteboard);

    if (isRelevant(bug)) {
      // add html code for this bug
      bugsComplete.push('<tr><td><a href="'
                        + 'https://bugzilla.mozilla.org/show_bug.cgi?id='+ bug.id + '">#'
                        + bug.id
                        + '</a></td>'
                        + '<td nowrap>(' + product + ': ' + component + ') </td>'
                        + '<td>'+bug.summary.escapeHTML() + ' [' + platform + ']' + whiteboard.escapeHTML() + '</td>'
                        + '<td>' + changetime + '</td></tr>');  // previously had a <br> at the end;
    }
    counter++; // increase counter
    // remove processed bug from bugIds
    let i = bugIds.indexOf(bug.id);
    if (i !== -1) bugIds[i] = null;
  });
  log("==============\nReceived " + counter + " of " + numBugs + " bugs.");




  // process remaining bugs one-by-one
  var requests = [];
  time("MozillaMercurial-missing");
  $.each(bugIds, function(index) {
    let id = bugIds[index];
    if (id !== null) {
      time("Requesting missing bug " + id);
      let promise = $.getJSON("https://bugzilla.mozilla.org/rest/bug/" + id,
                function(json) {
        // I've not end up here yet, so cry if we do
        console.error("Request succeeded unexpectedly!");
        console.error("Please submit this information to the script authors:");
        timeEnd("Requesting missing bug " + id);
        console.log(json);
        let bug = json.bugs[0];
        console.log(bug);
        // TODO: display as much information as possible
      });
      // Actually, we usually get an error
      promise.error(function(req, status, error) {
        timeEnd("Requesting missing bug " + id);
        if (error == "Authorization Required") {
          // log("Bug " + id + " requires authorization!");
          log("https://bugzilla.mozilla.org/show_bug.cgi?id=" + id + " requires authorization!");
          let text = " requires authorization!<br>";

          bugsComplete.push('<a href="'
                        + 'https://bugzilla.mozilla.org/show_bug.cgi?id='+ id + '">#'
                        + id + '</a>' + text);
        } else {
          console.error("Unexpected error encountered (Bug" + id + "): " + status + " " + error);
        }
      });
      requests.push(promise);
    }
  });
  // wait for all requests to be settled, then join them together
  // Source: https://stackoverflow.com/questions/19177087/deferred-how-to-detect-when-every-promise-has-been-executed
  $.when.apply($, $.map(requests, function(p) {
                return p.then(null, function() {
                  return $.Deferred().resolveWith(this, arguments);
                });
              })).always(function() {
    timeEnd("MozillaMercurial-missing");
    // Variable that will contain all values of the bugsComplete array, and will be displayed in the 'dialog' below
    var docu = '';
    docu = bugsComplete.join('');
    docu = ' <table id="tbl" style="width:100%">'+
             '<thead>' +
             '<tr><th>BugNo</th>' +
             '<th>Product/Component</th>' +
             '<th>Summary</th>' +
             '<th>Modified__</th></tr>' +
             '</thead>' +
             '<tbody>' + docu + '</tbody></table>';




    var div = document.createElement('div');
    $('div.page_footer').append(div);
    div.id = 'dialog';
    docu = '<div id="dialog_content" title="Relevant Bugs">' + docu + '</div>';
    div.innerHTML = docu;
    $("#dialog").hide();

    $(function() {
      $("#dialog").dialog({
        title: 'List of fixed bugs of Firefox for desktop (' + bugsComplete.length + ')',
        width: '1350px'
      });
    });






// THE CUSTOM PARSER MUST BE PUT BEFORE '$('#tbl').tablesorter ( {'' or else it wont work !!!!
// add parser through the tablesorter addParser method  (for the "Last modified" column)
$.tablesorter.addParser({
    // set a unique id
    id: 'dates',
    is: function(s) {
        return false;                                // return false so this parser is not auto detected
    },
    format: function(s) {
      // format your data for normalization
      if (s !== ''){
        var number1, number2;

        // format your data for normalization
        number1 = Number((/(.{1,2})\ .*/).exec(s)[1]);


        if (s.match(/A few seconds ago/)) { number2 = 0;}
        else if (s.match(/(.*)seconds?.*/)) { number2 = 1;}
        else if (s.match(/(.*)minutes?.*/)) {number2 = 60;}
        else if (s.match(/(.*)hours?.*/)) { number2 = 3600;}
        else if (s.match(/(.*)days?.*/)) { number2 = 86400;}
        else if (s.match(/(.*)months?.*/)) { number2 = 30 * 86400;}
        else if (s.match(/(.*)years?.*/)) {number2 = 365 * 30 * 86400;}
        return number1 * number2;

      }
    },
    // set type, either numeric or text
    type: 'numeric'
});



// make table sortable
$('#tbl').tablesorter({
  cssAsc: 'up',
  cssDesc: 'down',
  // sortList : [[1,0],[2,0]],      // initial sort (by column 1 'Product/Component' and then by column 2 'Summary')
  sortList: [[3, 0],[1, 0],[2, 0]], // in order the table to be sorted by default by column 3 'Modified', then by column 1 'Product/Component' and then by column 2 'Summary'
  headers: {3: {sorter: 'dates'}},
  initialized: function() {               // comment out lines 325-334 to disable having separators between groups of the same timestamps
      var mytable = document.getElementById('tbl');
      for (var i = 2, j = mytable.rows.length + 1; i < j; i++) {
          if (mytable.rows[i].cells[3].innerHTML != mytable.rows[i - 1].cells[3].innerHTML) {
              for (var k = 0; k < 4; k++) {
                  mytable.rows[i - 1].cells[k].style.borderBottom = '1px black dotted';
              }
          }
      }
  }



});






    log('ALL IS DONE');
    timeEnd("MozillaMercurial");





});

});


// bind keypress of ` so that when pressed, the separators between groups of the same timestamps to be removed, in order to sort manually
var listener = new window.keypress.Listener();
listener.simple_combo("`", function() {
  console.log("You pressed `");
  var mytable = document.getElementById('tbl');
  for (var i = 2, j = mytable.rows.length+1; i < j; i++) {
          for (var k = 0; k < 4; k++) {
              mytable.rows[i-1].cells[k].style.borderBottom = 'none';
          }
  }
});





function isRelevant(bug) {
    if (!bug.id) return false;
    if (bug.status && bug.status != 'RESOLVED' && bug.status != 'VERIFIED') {
        log('    IRRELEVANT because of it\'s Status --> ' + bug.status);
        return false;
    }
    if (bug.component && bug.product && bug.component == 'Build Config' && (bug.product == 'Toolkit' || bug.product == 'Firefox')) {
        log('    IRRELEVANT because of it\'s Product --> ' + bug.product + 'having component --> ' + bug.component);
        return false;
    }
    if (bug.product && bug.product != 'Add-on SDK'      &&
                       bug.product != 'Cloud Services'  &&
                       bug.product != 'Core'            &&
                       bug.product != 'Firefox'         &&
                       bug.product != 'Hello (Loop)'    &&
                       bug.product != 'Toolkit') {
        log('    IRRELEVANT because of it\'s Product --> ' + bug.product);
        return false;
    }
    if (bug.component && bug.component == 'AutoConfig'                 ||
                         bug.component == 'Build Config'               ||
                         bug.component == 'DMD'                        ||
                         bug.component == 'Embedding: GRE Core'        ||
                         bug.component == 'Embedding: Mac'             ||
                         bug.component == 'Embedding: MFC Embed'       ||
                         bug.component == 'Embedding: Packaging'       ||
                         bug.component == 'Hardware Abstraction Layer' ||
                         bug.component == 'mach'                       ||
                         bug.component == 'Nanojit'                    ||
                         bug.component == 'QuickLaunch'                ||
                         bug.component == 'Widget: Gonk') {
        log('    IRRELEVANT because of it\'s Component --> ' + bug.component);
        return false;
    }

    log('    OK  ' + 'https://bugzilla.mozilla.org/show_bug.cgi?id=' + bug.id);
    return true;
}




function log(str) {
  if (!silent) {
    console.log(str);
  }
}

function time(str) {
  if (debug) {
    console.time(str);
  }
}

function timeEnd(str) {
  if (debug) {
    console.timeEnd(str);
  }
}

// $(function() {
$("#dialog").dialog({
        modal: false,
        title: "Draggable, sizeable dialog",
        position: {
            my: "top",
            at: "top",
            of: document,
            collision: "none"
        },
        width: "auto",
        //minWidth: 400,
        // minHeight: 200,
        zIndex: 3666
    })
    .dialog("widget").draggable("option", "containment", "none");

//-- Fix crazy bug in FF! ...
$("#dialog").parent().css({
    position: "fixed",
    top: 0,
    left: "4em",
    width: "75ex"
});