Load existing .mailmap file before generating new one

Author: Julien Gilli

tools/update-authors.js

@@ -53,6 +53,8 @@ var OPTS = processCmdLineArgs();
 var AUTHORS_FILE = OPTS.authorsFile || 'AUTHORS';
 var MAILMAP_FILE = OPTS.mailmapFile || '.mailmap';
 
+var PLATFORM_AGNOSTIC_EOL = /\r|\n|\r\n/;
+
 var authorsMailMap = {};
 
 function usage() {
@@ -92,12 +94,13 @@ function addAuthorToEmailMap(authorName, authorEmail) {
 
   debug('ADDING AUTHOR [' + authorName + '] [' + authorEmail + ']');
 
-  if (authorsMailMap[authorName]) {
-    if (authorsMailMap[authorName].indexOf(authorEmail) === -1) {
-      authorsMailMap[authorName].push(authorEmail);
+  var authorEntry = authorsMailMap[authorName];
+  if (authorEntry && authorEntry.emails) {
+    if (authorEntry.emails.indexOf(authorEmail) === -1) {
+      authorEntry.emails.push(authorEmail);
     }
   } else {
-    authorsMailMap[authorName] = [ authorEmail ];
+    authorsMailMap[authorName] = { emails: [ authorEmail ] };
   }
 }
 
@@ -126,7 +129,7 @@ function generateAuthorsMailMapFile(authorsMailMap, mailmapFilepath, cb) {
     assert(Array.isArray(authorsNames), 'authorsNames must be an array');
 
     var authorName = authorsNames.splice(0, 1);
-    var authorEmails = authorsMailMap[authorName];
+    var authorEntry = authorsMailMap[authorName];
 
     function writeNextAuthorOrDone() {
       process.nextTick(function onNextTick() {
@@ -136,16 +139,19 @@ function generateAuthorsMailMapFile(authorsMailMap, mailmapFilepath, cb) {
           return cb();
       });
     }
-    // Authors with no more than one email address don't need to be added
+    // Unless the entry was already present in the original .mailmap file,
+    // authors with no more than one email address don't need to be added
     // to the .mailmap file, since its purpose is to handle authors with
     // more than one email address.
-    if (!authorEmails || authorEmails.length < 2) {
+    if (!authorEntry || !authorEntry.emails ||
+        (authorEntry.emails.length < 2 && !authorEntry.loadedFromExisting)) {
       debug('Skipping mailmap entry for author [' + authorName + ']');
       return writeNextAuthorOrDone();
     }
 
     debug('Writing mailmap entry for author [' + authorName + ']');
 
+    var authorEmails = authorEntry.emails;
     authorEmails = authorEmails.map(emailFormatter);
 
     var mapAuthorEntry = authorName + ' ' + authorEmails.join(' ');
@@ -182,7 +188,7 @@ var latestAuthorsLineChunk = '';
 function addAuthors(authors) {
   assert(typeof authors === 'string', 'authors must be a string');
 
-  var authors = (latestAuthorsLineChunk + authors).split(os.EOL);
+  var authors = (latestAuthorsLineChunk + authors).split(PLATFORM_AGNOSTIC_EOL);
   latestAuthorsLineChunk = '';
   authors.forEach(function eachAuthor(author) {
     if (author && author.length > 0) {
@@ -202,38 +208,98 @@ function addAuthors(authors) {
   });
 }
 
-var gitLog = child_process.spawn('git', GIT_LOG_COMMAND_ARGS);
+function loadAdditionalAuthorsFromGitLog(cb) {
+  var gitLog = child_process.spawn('git', GIT_LOG_COMMAND_ARGS);
 
-gitLog.on('close', function onGitLogClose(exitCode, signal) {
-  if (exitCode === 0 && signal === null) {
+  gitLog.on('close', function onGitLogClose(exitCode, signal) {
+    if (exitCode === 0 && signal === null) {
 
-    debug('NB AUTHORS:' + Object.keys(authorsMailMap).length);
+      debug('NB AUTHORS:' + Object.keys(authorsMailMap).length);
 
-    generateAuthorsFile(AUTHORS_FILE, function onAuthorsFileGenerated(err) {
-      if (err) {
-        console.error('Error when generating authors file:', err);
-      } else {
-        console.log('Authors file generated successfully!');
-      }
-    });
+      generateAuthorsFile(AUTHORS_FILE, function onAuthorsFileGenerated(err) {
+        if (err) {
+          return cb(new Error('Error when generating authors file:', err));
+        } else {
+          console.log('Authors file generated successfully!');
+        }
+      });
 
-    generateAuthorsMailMapFile(authorsMailMap,
-                               MAILMAP_FILE,
-                               function onMailmapFileGenerated(err) {
-      if (err) {
-        console.error('Error when generating mailmap file:', err);
-      } else {
-        console.log('mailmap file generated successfully!');
-      }
+      generateAuthorsMailMapFile(authorsMailMap,
+                                 MAILMAP_FILE,
+                                 function onMailmapFileGenerated(err) {
+        if (err) {
+          return cb(new Error('Error when generating mailmap file:', err));
+        } else {
+          console.log('mailmap file generated successfully!');
+        }
+      });
+    }
+  });
+
+  gitLog.on('error', function onGitLogError(err) {
+    var errorMsg = util.format('Error when executing command %s: %s', GIT_LOG_COMMAND, err);
+    return cb(new Error(errorMsg));
+  });
+
+  gitLog.stdout.on('data', function onGitLogData(data) {
+    addAuthors(data.toString());
+  });
+}
+
+function addExistingMailmapEntries(mailmapEntries, cb) {
+  assert(typeof mailmapEntries === 'string',
+         'mailmapEntries must be a string');
+  assert(typeof cb === 'function', 'cb must be a function');
+
+   var mailmapLines = mailmapEntries.split(PLATFORM_AGNOSTIC_EOL);
+   mailmapLines.forEach(function(mailmapLine) {
+    debug('Processing existing mailmap line:');
+    debug(mailmapLine);
+
+    var indexFirstEmail = mailmapLine.indexOf('<');
+    var authorName = mailmapLine.substr(0, indexFirstEmail).trim();
+    debug('author name: ' + authorName);
+
+    var authorEmails = [];
+
+    var nextEmailIndex = indexFirstEmail;
+    for (var idx = nextEmailIndex;
+         nextEmailIndex !== -1;
+         idx += mailmapLine.indexOf('<', nextEmailIndex + 1)) {
+      var indexOfEmailEnd = mailmapLine.indexOf('>', nextEmailIndex)
+      var authorEmail = mailmapLine.substr(nextEmailIndex + 1,
+                                           indexOfEmailEnd - (nextEmailIndex + 1))
+      debug('author email: ' + authorEmail);
+      authorEmails.push(authorEmail);
+
+      nextEmailIndex = mailmapLine.indexOf('<', indexOfEmailEnd);
+    }
+
+    if (authorEmails.length > 0) {
+      authorsMailMap[authorName] = {
+        loadedFromExisting: true, emails: authorEmails
+      };
+    }
+   });
+
+   return cb();
+}
+
+function loadExistingMailmapFile(cb) {
+  debug('Loading existing mailmap file');
+
+  fs.readFile(MAILMAP_FILE, function onMailmapFileRead(err, data) {
+    addExistingMailmapEntries(data.toString(), cb);
+  });
+}
+
+loadExistingMailmapFile(function onMailmapFileLoaded(err) {
+  if (err) {
+    console.error('Error when loading existing mailmap file:' ,err);
+  } else {
+    return loadAdditionalAuthorsFromGitLog(function onGitLoneDone(err) {
+      console.error('Error when loading git log data:', err);
     });
   }
 });
 
-gitLog.on('error', function onGitLogError(err) {
-  console.error('Error when executing command %s: %s', GIT_LOG_COMMAND, err);
-  process.exit(1);
-});
-
-gitLog.stdout.on('data', function onGitLogData(data) {
-  addAuthors(data.toString());
-});