Move old keystore migration code to metamask controller

Allows keyring controller to be more generic, less opinionated, and who knows, maybe sooner publishable as its own thing.

app/scripts/keyring-controller.js

@@ -9,7 +9,6 @@ const encryptor = require('browser-passworder')
 
 const normalize = require('./lib/sig-util').normalize
 const messageManager = require('./lib/message-manager')
-const IdStoreMigrator = require('./lib/idStore-migrator')
 const BN = ethUtil.BN
 
 // Keyrings:
@@ -45,11 +44,6 @@ module.exports = class KeyringController extends EventEmitter {
     this._unconfMsgCbs = {}
 
     this.getNetwork = opts.getNetwork
-
-    // TEMPORARY UNTIL FULL DEPRECATION:
-    this.idStoreMigrator = new IdStoreMigrator({
-      configManager: this.configManager,
-    })
   }
 
   // Set Store
@@ -221,10 +215,7 @@ module.exports = class KeyringController extends EventEmitter {
   // Temporarily also migrates any old-style vaults first, as well.
   // (Pre MetaMask 3.0.0)
   submitPassword (password) {
-    return this.migrateOldVaultIfAny(password)
-    .then(() => {
     return this.unlockKeyrings(password)
-    })
     .then((keyrings) => {
       this.keyrings = keyrings
       return this.fullUpdate()
@@ -610,41 +601,6 @@ module.exports = class KeyringController extends EventEmitter {
   // THESE METHODS ARE ONLY USED INTERNALLY TO THE KEYRING-CONTROLLER
   // AND SO MAY BE CHANGED MORE LIBERALLY THAN THE ABOVE METHODS.
 
-  // Migrate Old Vault If Any
-  // @string password
-  //
-  // returns Promise()
-  //
-  // Temporary step used when logging in.
-  // Checks if old style (pre-3.0.0) Metamask Vault exists.
-  // If so, persists that vault in the new vault format
-  // with the provided password, so the other unlock steps
-  // may be completed without interruption.
-  migrateOldVaultIfAny (password) {
-    const shouldMigrate = !!this.configManager.getWallet() && !this.configManager.getVault()
-    if (!shouldMigrate) {
-      return Promise.resolve()
-    }
-
-    return this.idStoreMigrator.migratedVaultForPassword(password)
-    .then((result) => {
-      this.password = password
-
-      if (result && shouldMigrate) {
-        const { serialized, lostAccounts } = result
-        this.configManager.setLostAccounts(lostAccounts)
-        return this.restoreKeyring(serialized)
-        .then(keyring => keyring.getAccounts())
-        .then((accounts) => {
-          this.configManager.setSelectedAccount(accounts[0])
-          return this.persistAllKeyrings()
-        })
-      } else {
-        return Promise.resolve()
-      }
-    })
-  }
-
   // Create First Key Tree
   // returns @Promise
   //

app/scripts/metamask-controller.js

@@ -10,6 +10,7 @@ const ConfigManager = require('./lib/config-manager')
 const extension = require('./lib/extension')
 const autoFaucet = require('./lib/auto-faucet')
 const nodeify = require('./lib/nodeify')
+const IdStoreMigrator = require('./lib/idStore-migrator')
 
 
 module.exports = class MetamaskController {
@@ -44,6 +45,11 @@ module.exports = class MetamaskController {
     this.checkTOSChange()
 
     this.scheduleConversionInterval()
+
+    // TEMPORARY UNTIL FULL DEPRECATION:
+    this.idStoreMigrator = new IdStoreMigrator({
+      configManager: this.configManager,
+    })
   }
 
   getState () {
@@ -61,6 +67,7 @@ module.exports = class MetamaskController {
   getApi () {
     const keyringController = this.keyringController
     const noticeController = this.noticeController
+    const submitPassword = keyringController.submitPassword.bind(keyringController)
 
     return {
       getState: (cb) => { cb(null, this.getState()) },
@@ -81,7 +88,12 @@ module.exports = class MetamaskController {
       placeSeedWords: nodeify(keyringController.placeSeedWords).bind(keyringController),
       clearSeedWordCache: nodeify(keyringController.clearSeedWordCache).bind(keyringController),
       setLocked: nodeify(keyringController.setLocked).bind(keyringController),
-      submitPassword: nodeify(keyringController.submitPassword).bind(keyringController),
+      submitPassword: (password, cb) => {
+        this.migrateOldVaultIfAny()
+        .then(submitPassword)
+        .then((newState) => { cb(null, newState) })
+        .catch((reason) => { cb(reason) })
+      },
       addNewKeyring: nodeify(keyringController.addNewKeyring).bind(keyringController),
       addNewAccount: nodeify(keyringController.addNewAccount).bind(keyringController),
       setSelectedAccount: nodeify(keyringController.setSelectedAccount).bind(keyringController),
@@ -425,4 +437,40 @@ module.exports = class MetamaskController {
       cb(null, this.getState())
     })
   }
+
+  // Migrate Old Vault If Any
+  // @string password
+  //
+  // returns Promise()
+  //
+  // Temporary step used when logging in.
+  // Checks if old style (pre-3.0.0) Metamask Vault exists.
+  // If so, persists that vault in the new vault format
+  // with the provided password, so the other unlock steps
+  // may be completed without interruption.
+  migrateOldVaultIfAny (password) {
+    const shouldMigrate = !!this.configManager.getWallet() && !this.configManager.getVault()
+    if (!shouldMigrate) {
+      return Promise.resolve(password)
+    }
+
+    return this.idStoreMigrator.migratedVaultForPassword(password)
+    .then((result) => {
+      if (result && shouldMigrate) {
+        const { serialized, lostAccounts } = result
+        this.configManager.setLostAccounts(lostAccounts)
+        return this.keyringController.restoreKeyring(serialized)
+        .then(keyring => keyring.getAccounts())
+        .then((accounts) => {
+          this.configManager.setSelectedAccount(accounts[0])
+          return this.keyringController.persistAllKeyrings()
+          .then(() => password)
+        })
+      } else {
+        return Promise.resolve(password)
+      }
+    })
+  }
+
+
 }