Issue 4919 - Make getBackupFiles in lib/filterStorage.js asynchronous

lib/filterStorage.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 687 matching lines @@
     let subscriptions = this.subscriptions.filter(
       s => !(s instanceof ExternalSubscription)
     );
     if (!explicitFile)
       this._saving = true;
 
     checkBackupRequired(writeFilters, removeLastBackup);
   },
 
   /**
-   * Returns the list of existing backup files.
-   * @return {nsIFile[]}
+   * @typedef FileInfo
+   * @type {object}
+   * @property {nsIFile} file
+   * @property {number} lastModified
+   */
+
+  /**
+   * Returns a promise resolving in a list of existing backup files.
+   * @return {Promise.<FileInfo[]>}
    */
   getBackupFiles()
   {
-    let result = [];
+    let backups = [];
 
     let [, part1, part2] = /^(.*)(\.\w+)$/.exec(
       FilterStorage.sourceFile.leafName
     ) || [null, FilterStorage.sourceFile.leafName, ""];
-    for (let i = 1; ; i++)
+
+    function checkBackupFile(index)
     {
-      let file = FilterStorage.sourceFile.clone();
-      file.leafName = part1 + "-backup" + i + part2;
-      if (file.exists())
-        result.push(file);
-      else
-        break;
+      return new Promise((resolve, reject) =>
+      {
+        let file = FilterStorage.sourceFile.clone();
+        file.leafName = part1 + "-backup" + index + part2;
+
+        IO.statFile(file, (error, result) =>
+        {
+          if (!error && result.exists)
+          {
+            backups.push({
+              file,
+              lastModified: result.lastModified
+            });
+            resolve(checkBackupFile(index + 1));

[kzar, 2017/03/29 11:51:33]

The recursion here is slightly hairy but I can't think of a better alternative
either. I considered Promise.all but since we don't know how many files to check
in advance I guess that wouldn't work.

+          }
+          else
+            resolve(backups);
+        });
+      });
     }
-    return result;
+
+    return checkBackupFile(1);
   }
 };
 
 /**
  * Joins subscription's filters to the subscription without any notifications.
  * @param {Subscription} subscription
  *   filter subscription that should be connected to its filters
  */
 function addSubscriptionFilters(subscription)
 {
@@ skipping 127 matching lines @@
       Subscription.knownSubscriptions = origKnownSubscriptions;
     }
 
     // Allow events to be processed every now and then.
     // Note: IO.readFromFile() will deal with the potential reentrance here.
     this.linesProcessed++;
     if (this.linesProcessed % 1000 == 0)
       return Utils.yield();
   }
 };