From 861c1882df165066184895603c19032048839716 Mon Sep 17 00:00:00 2001 From: Ivan Socolsky Date: Tue, 23 Sep 2014 16:01:02 -0300 Subject: [PATCH] Removed unused functions and refactored tests --- js/models/Storage.js | 90 +++++-------------- js/models/WalletFactory.js | 72 +++++++++------ test/test.Storage.js | 178 ++++++++++++++++++------------------- test/test.WalletFactory.js | 29 +++++- 4 files changed, 182 insertions(+), 187 deletions(-) diff --git a/js/models/Storage.js b/js/models/Storage.js index 9b5fb22f1..79c5c117b 100644 --- a/js/models/Storage.js +++ b/js/models/Storage.js @@ -122,16 +122,6 @@ Storage.prototype.setSessionId = function(sessionId, cb) { this.sessionStorage.setItem('sessionId', sessionId, cb); }; -Storage.prototype._key = function(walletId, k) { - return walletId + '::' + k; -}; -// get value by key -Storage.prototype.get = function(walletId, k, cb) { - preconditions.checkArgument(walletId, k, cb); - this._read(this._key(walletId, k), cb); -}; - - Storage.prototype._readHelper = function(walletId, k, cb) { var wk = this._key(walletId, k); this._read(wk, function(v) { @@ -139,33 +129,34 @@ Storage.prototype._readHelper = function(walletId, k, cb) { }); }; -Storage.prototype.readWallet = function(walletId, cb) { +Storage.prototype.readWallet_Old = function(walletId, cb) { var self = this; this.storage.allKeys(function(allKeys) { var obj = {}; var keys = _.filter(allKeys, function(k) { if (k.indexOf(walletId + '::') === 0) return true; }); - if (keys.length === 0) return cb(null); + if (keys.length === 0) return cb(new Error('Wallet ' + walletId + ' not found')); var count = keys.length; _.each(keys, function(k) { self._read(k, function(v) { obj[k.split('::')[1]] = v; - if (--count === 0) return cb(obj); + if (--count === 0) return cb(null, obj); }) }); }); }; -Storage.prototype.readWallet2 = function(walletId, cb) { +Storage.prototype.readWallet = function(walletId, cb) { var self = this; this.storage.allKeys(function(allKeys) { var keys = _.filter(allKeys, function(k) { if ((k === 'wallet::' + walletId) || k.indexOf('wallet::' + walletId) === 0) return true; }); - if (keys.length !== 1) throw new Error('WALLETNOTFOUND'); + if (keys.length === 0) return cb(new Error('Wallet ' + walletId + ' not found')); self._read(keys[0], function(v) { - return cb(v); + if (_.isNull(v)) return cb(new Error('Could not decrypt wallet data')); + return cb(null, v); }) }); }; @@ -189,32 +180,7 @@ Storage.prototype.getMany = function(walletId, keys, cb) { } }; -// set value for key -Storage.prototype.set = function(walletId, k, v, cb) { - preconditions.checkArgument(walletId && k && cb); - - if (_.isUndefined(v)) return cb(); - - this._write(this._key(walletId, k), v, cb); -}; - -// remove value for key -Storage.prototype.remove = function(walletId, k, cb) { - preconditions.checkArgument(walletId && k && cb); - this.removeGlobal(this._key(walletId, k), cb); -}; - -Storage.prototype.setName = function(walletId, name, cb) { - preconditions.checkArgument(walletId && name && cb); - this.setGlobal('nameFor::' + walletId, name, cb); -}; - -Storage.prototype.getName = function(walletId, cb) { - preconditions.checkArgument(walletId && cb); - this.getGlobal('nameFor::' + walletId, cb); -}; - -Storage.prototype.getWalletIds = function(cb) { +Storage.prototype._getWalletIds = function(cb) { preconditions.checkArgument(cb); var walletIds = []; var uniq = {}; @@ -225,7 +191,7 @@ Storage.prototype.getWalletIds = function(cb) { if (split.length == 2) { var walletId = split[0]; - if (!walletId || walletId === 'nameFor' || walletId === 'lock') + if (!walletId || walletId === 'nameFor' || walletId === 'lock' || walletId === 'wallet') continue; if (typeof uniq[walletId] === 'undefined') { @@ -238,7 +204,7 @@ Storage.prototype.getWalletIds = function(cb) { }); }; -Storage.prototype.getWallets = function(cb) { +Storage.prototype.getWallets_Old = function(cb) { preconditions.checkArgument(cb); if (this.wListCache.ts > Date.now()) @@ -247,14 +213,14 @@ Storage.prototype.getWallets = function(cb) { var wallets = []; var self = this; - this.getWalletIds(function(ids) { + this._getWalletIds(function(ids) { var l = ids.length, i = 0; if (!l) return cb([]); _.each(ids, function(id) { - self.getName(id, function(name) { + self.getGlobal('nameFor::' + id, function(name) { wallets.push({ id: id, name: name, @@ -290,8 +256,17 @@ Storage.prototype.getWallets2 = function(cb) { }); }; +Storage.prototype.getWallets = function(cb) { + var self = this; + self.getWallets2(function(wallets1) { + self.getWallets_Old(function(wallets2) { + return cb(wallets1.concat(wallets2)); + }); + }) +}; -Storage.prototype.deleteWallet = function(walletId, cb) { + +Storage.prototype.deleteWallet_Old = function(walletId, cb) { preconditions.checkArgument(walletId); preconditions.checkArgument(cb); var err; @@ -325,7 +300,7 @@ Storage.prototype.deleteWallet = function(walletId, cb) { }); }; -Storage.prototype.deleteWallet2 = function(walletId, cb) { +Storage.prototype.deleteWallet = function(walletId, cb) { preconditions.checkArgument(walletId); preconditions.checkArgument(cb); @@ -350,29 +325,10 @@ Storage.prototype.getLastOpened = function(cb) { this.getGlobal('lastOpened', cb); }; -//obj contains keys to be set Storage.prototype.setFromObj = function(walletId, obj, cb) { preconditions.checkArgument(cb); var self = this; - var l = Object.keys(obj).length, - i = 0; - for (var k in obj) { - self.set(walletId, k, obj[k], function() { - if (++i == l) { - if (obj.opts.name) - self.setName(walletId, obj.opts.name, cb); - else - return cb(); - } - }); - } -}; - -Storage.prototype.setFromObj2 = function(walletId, obj, cb) { - preconditions.checkArgument(cb); - var self = this; - var key = 'wallet::' + walletId + ((obj.opts && obj.opts.name) ? '_' + obj.opts.name : ''); self._write(key, obj, function() { return cb(); diff --git a/js/models/WalletFactory.js b/js/models/WalletFactory.js index b2b62e35b..12f84086e 100644 --- a/js/models/WalletFactory.js +++ b/js/models/WalletFactory.js @@ -146,28 +146,18 @@ WalletFactory.prototype.migrateWallet = function(walletId, passphrase, cb) { var self = this; self.storage.setPassphrase(passphrase); - self.storage.setFromObj = self.storage.setFromObj2; - - var reconfigureStorage = function() { - self.storage.getWallets = self.storage.getWallets2; - self.storage.readWallet = self.storage.readWallet2; - self.storage.deleteWallet = self.storage.deleteWallet2; - self.storage.get = function() { - throw 'DO NOT USE' - }; - self.storage.set = function() { - throw 'DO NOT USE' - }; - }; - - self.read(walletId, null, function(err, wallet) { + self.read_Old(walletId, null, function(err, wallet) { if (err) return cb(err); - wallet.store(); - self.storage.deleteWallet(walletId, function() { - self.storage.removeGlobal('nameFor::' + walletId, function() { - reconfigureStorage(); - return cb(); + wallet.store(function(err) { + if (err) return cb(err); + + self.storage.deleteWallet_Old(walletId, function(err) { + if (err) return cb(err); + + self.storage.removeGlobal('nameFor::' + walletId, function() { + return cb(); + }); }); }); }); @@ -186,9 +176,9 @@ WalletFactory.prototype.read = function(walletId, skipFields, cb) { err; var obj = {}; - console.log('aáaa'); - this.storage.readWallet(walletId, function(ret) { - console.log('bbb'); + this.storage.readWallet(walletId, function(err, ret) { + if (err) return cb(err); + _.each(Wallet.PERSISTED_PROPERTIES, function(p) { obj[p] = ret[p]; }); @@ -212,6 +202,36 @@ WalletFactory.prototype.read = function(walletId, skipFields, cb) { }); }; +WalletFactory.prototype.read_Old = function(walletId, skipFields, cb) { + var self = this, + err; + var obj = {}; + + this.storage.readWallet_Old(walletId, function(err, ret) { + if (err) return cb(err); + + _.each(Wallet.PERSISTED_PROPERTIES, function(p) { + obj[p] = ret[p]; + }); + + if (!_.any(_.values(obj))) + return cb(new Error('Wallet not found')); + + var w, err; + obj.id = walletId; + try { + w = self.fromObj(obj, skipFields); + } catch (e) { + if (e && e.message && e.message.indexOf('MISSOPTS')) { + err = new Error('Could not read: ' + walletId); + } else { + err = e; + } + w = null; + } + return cb(err, w); + }); +}; /** * @desc This method instantiates a wallet. Usefull for stubbing. @@ -368,10 +388,10 @@ WalletFactory.prototype.getWallets = function(cb) { * @return {?} the result of the callback */ WalletFactory.prototype.delete = function(walletId, cb) { - var s = this.storage; - s.deleteWallet(walletId, function(err) { + var self = this; + self.storage.deleteWallet(walletId, function(err) { if (err) return cb(err); - s.setLastOpened(null, function(err) { + self.storage.setLastOpened(null, function(err) { return cb(err); }); }); diff --git a/test/test.Storage.js b/test/test.Storage.js index be1dbafce..97fd90282 100644 --- a/test/test.Storage.js +++ b/test/test.Storage.js @@ -28,7 +28,7 @@ describe('Storage model', function() { it('should fail when encrypting without a password', function() { var s2 = new Storage(require('./mocks/FakeLocalStorage').storageParams); (function() { - s2.set(fakeWallet, timeStamp, 1, function() {}); + s2._write(fakeWallet + timeStamp, 1, function() {}); }).should.throw('NOPASSPHRASE'); }); it('should be able to encrypt and decrypt', function(done) { @@ -40,7 +40,7 @@ describe('Storage model', function() { }); }); it('should be able to set a value', function(done) { - s.set(fakeWallet, timeStamp, 1, function() { + s._write(fakeWallet + timeStamp, 1, function() { done(); }); }); @@ -63,8 +63,8 @@ describe('Storage model', function() { ]; getSetData.forEach(function(obj) { it('should be able to set a value and get it for ' + JSON.stringify(obj), function(done) { - s.set(fakeWallet, timeStamp, obj, function() { - s.get(fakeWallet, timeStamp, function(obj2) { + s._write(fakeWallet + timeStamp, obj, function() { + s._read(fakeWallet + timeStamp, function(obj2) { JSON.stringify(obj2).should.equal(JSON.stringify(obj)); done(); }); @@ -74,7 +74,7 @@ describe('Storage model', function() { describe('#export', function() { it('should export the encrypted wallet', function(done) { - s.set(fakeWallet, timeStamp, 'testval', function() { + s._write(fakeWallet + timeStamp, 'testval', function() { var obj = { test: 'testval' }; @@ -85,28 +85,11 @@ describe('Storage model', function() { }); }); - describe('#remove', function() { - it('should remove an item', function(done) { - s.set('1', "hola", 'juan', function() { - s.get('1', 'hola', function(v) { - v.should.equal('juan'); - s.remove('1', 'hola', function() { - s.get('1', 'hola', function(v) { - should.not.exist(v); - done(); - }); - }); - }) - }) - }); - }); - - - describe('#getWalletIds', function() { + describe('#_getWalletIds', function() { it('should get wallet ids', function(done) { - s.set('1', "hola", 'juan', function() { - s.set('2', "hola", 'juan', function() { - s.getWalletIds(function(v) { + s._write('1::hola', 'juan', function() { + s._write('2::hola', 'juan', function() { + s._getWalletIds(function(v) { v.should.deep.equal(['1', '2']); done(); }); @@ -115,17 +98,6 @@ describe('Storage model', function() { }); }); - describe('#getName #setName', function() { - it('should get/set names', function(done) { - s.setName(1, 'hola', function() { - s.getName(1, function(v) { - v.should.equal('hola'); - done(); - }); - }); - }); - }); - describe('#getLastOpened #setLastOpened', function() { it('should get/set last opened', function() { s.setLastOpened('hey', function() { @@ -150,13 +122,13 @@ describe('Storage model', function() { }); } - describe('#getWallets', function() { - it('should retreive wallets from storage', function(done) { - s.set('1', "hola", 'juan', function() { - s.set('2', "hola", 'juan', function() { - s.setName(1, 'hola', function() { + describe('#getWallets_Old', function() { + it('should retrieve wallets from storage', function(done) { + s._write('1::hola', 'juan', function() { + s._write('2::hola', 'juan', function() { + s.setGlobal('nameFor::1', 'hola', function() { - s.getWallets(function(ws) { + s.getWallets_Old(function(ws) { ws[0].should.deep.equal({ id: '1', name: 'hola', @@ -171,19 +143,19 @@ describe('Storage model', function() { }); }); }); - it('should retreive wallets from storage (with delay)', function(done) { - s.set('1', "hola", 'juan', function() { - s.set('2', "hola", 'juan', function() { - s.setName(1, 'hola', function() { + it('should retrieve wallets from storage (with delay)', function(done) { + s._write('1::hola', 'juan', function() { + s._write('2::hola', 'juan', function() { + s.setGlobal('nameFor::1', 'hola', function() { - var orig = s.getName.bind(s); - s.getName = function(wid, cb) { + var orig = s.getGlobal.bind(s); + s.getGlobal = function(k, cb) { setTimeout(function() { - orig(wid, cb); + orig(k, cb); }, 1); }; - s.getWallets(function(ws) { + s.getWallets_Old(function(ws) { ws[0].should.deep.equal({ id: '1', name: 'hola', @@ -201,7 +173,7 @@ describe('Storage model', function() { }); describe('#getWallets2', function() { - it('should retreive wallets from storage', function(done) { + it('should retrieve wallets from storage', function(done) { var w1 = { name: 'juan', opts: { @@ -211,8 +183,8 @@ describe('Storage model', function() { var w2 = { name: 'pepe' }; - s.setFromObj2('1', w1, function() { - s.setFromObj2('2', w2, function() { + s.setFromObj('1', w1, function() { + s.setFromObj('2', w2, function() { s.getWallets2(function(ws) { ws[0].should.deep.equal({ id: '1', @@ -229,11 +201,51 @@ describe('Storage model', function() { }); }); - describe('#deleteWallet', function() { + + describe('#getWallets', function() { + it('should retrieve wallets from storage both new and old format', function(done) { + var w1 = { + name: 'juan', + opts: { + name: 'wallet1' + } + }; + var w2 = { + name: 'pepe' + }; + + s.setFromObj('1', w1, function() { + s.setFromObj('2', w2, function() { + s._write('3::name', 'matias', function() { + s.setGlobal('nameFor::3', 'wallet3', function() { + s.getWallets(function(ws) { + ws.length.should.equal(3); + ws[0].should.deep.equal({ + id: '1', + name: 'wallet1', + }); + ws[1].should.deep.equal({ + id: '2', + name: undefined + }); + ws[2].should.deep.equal({ + id: '3', + name: 'wallet3', + }); + done(); + }); + }); + }) + }); + }); + }); + }); + + describe('#deleteWallet_Old', function() { it('should fail to delete a unexisting wallet', function(done) { - s.set('1', "hola", 'juan', function() { - s.set('2', "hola", 'juan', function() { - s.deleteWallet('3', function(err) { + s._write('1::hola', 'juan', function() { + s._write('2::hola', 'juan', function() { + s.deleteWallet_Old('3', function(err) { err.toString().should.include('WNOTFOUND'); done(); }); @@ -242,11 +254,11 @@ describe('Storage model', function() { }); it('should delete a wallet', function(done) { - s.set('1', "hola", 'juan', function() { - s.set('2', "hola", 'juan', function() { - s.deleteWallet('1', function(err) { + s._write('1::hola', 'juan', function() { + s._write('2::hola', 'juan', function() { + s.deleteWallet_Old('1', function(err) { should.not.exist(err); - s.getWallets(function(ws) { + s.getWallets_Old(function(ws) { ws.length.should.equal(1); ws[0].should.deep.equal({ id: '2', @@ -260,7 +272,7 @@ describe('Storage model', function() { }); }); - describe('#deleteWallet2', function() { + describe('#deleteWallet', function() { it('should fail to delete a unexisting wallet', function(done) { var w1 = { name: 'juan', @@ -272,9 +284,9 @@ describe('Storage model', function() { name: 'pepe' }; - s.setFromObj2('1', w1, function() { - s.setFromObj2('2', w2, function() { - s.deleteWallet2('3', function(err) { + s.setFromObj('1', w1, function() { + s.setFromObj('2', w2, function() { + s.deleteWallet('3', function(err) { err.toString().should.include('WNOTFOUND'); done(); }); @@ -293,9 +305,9 @@ describe('Storage model', function() { name: 'pepe' }; - s.setFromObj2('1', w1, function() { - s.setFromObj2('2', w2, function() { - s.deleteWallet2('1', function(err) { + s.setFromObj('1', w1, function() { + s.setFromObj('2', w2, function() { + s.deleteWallet('1', function(err) { should.not.exist(err); s.getWallets2(function(ws) { ws.length.should.equal(1); @@ -308,7 +320,7 @@ describe('Storage model', function() { }); }); - describe('#readWallet', function() { + describe('#readWallet_Old', function() { it('should read wallet', function(done) { var data = { 'id1::a': 'x', @@ -319,7 +331,8 @@ describe('Storage model', function() { sinon.stub(s, '_read', function(k, cb) { return cb(data[k]); }); - s.readWallet('id1', function(w) { + s.readWallet_Old('id1', function(err, w) { + should.not.exist(err); w.should.exist; w.hasOwnProperty('a').should.be.true; w.hasOwnProperty('b').should.be.true; @@ -332,7 +345,7 @@ describe('Storage model', function() { }); }); - describe('#readWallet2', function() { + describe('#readWallet', function() { it('should read wallet', function(done) { var data = { 'wallet::id1_wallet1': { @@ -347,7 +360,8 @@ describe('Storage model', function() { sinon.stub(s, '_read', function(k, cb) { return cb(data[k]); }); - s.readWallet2('id1', function(w) { + s.readWallet('id1', function(err, w) { + should.not.exist(err); w.should.exist; w.hasOwnProperty('a').should.be.true; w.hasOwnProperty('b').should.be.true; @@ -361,24 +375,8 @@ describe('Storage model', function() { }); describe('#setFromObj', function() { - it('set localstorage from an object', function(done) { - s.setFromObj('id1', { - 'key': 'val', - 'opts': { - 'name': 'nameid1' - }, - }, function() { - s.get('id1', 'key', function(v) { - v.should.equal('val'); - done(); - }); - }); - }); - }); - - describe('#setFromObj2', function() { it('should store from an object as single key', function(done) { - s.setFromObj2('id1', { + s.setFromObj('id1', { 'key': 'val', 'opts': { 'name': 'nameid1' diff --git a/test/test.WalletFactory.js b/test/test.WalletFactory.js index 71f8bac10..b20511800 100644 --- a/test/test.WalletFactory.js +++ b/test/test.WalletFactory.js @@ -40,7 +40,6 @@ describe('WalletFactory model', function() { wf.storage.setLastOpened = sinon.stub().yields(null); - var w = sinon.stub(); w.store = sinon.stub().yields(null); @@ -246,7 +245,7 @@ describe('WalletFactory model', function() { describe('#read', function() { it('should fail to read unexisting wallet', function(done) { - wf.storage.readWallet = sinon.stub().yields({}); + wf.storage.readWallet = sinon.stub().yields(null, {}); wf.read('id', [], function(err, w) { should.not.exist(w); @@ -258,7 +257,7 @@ describe('WalletFactory model', function() { }); }); it('should fail to read broken wallet', function(done) { - wf.storage.readWallet = sinon.stub().yields({ + wf.storage.readWallet = sinon.stub().yields(null, { 'opts': 1 }); wf.read('id', [], function(err, w) { @@ -272,7 +271,7 @@ describe('WalletFactory model', function() { }); it('should read existing wallet', function(done) { var wf = new WalletFactory(config, '0.0.1'); - wf.storage.readWallet = sinon.stub().yields({ + wf.storage.readWallet = sinon.stub().yields(null, { 'opts': 1 }); wf.fromObj = sinon.stub().returns('ok'); @@ -298,6 +297,7 @@ describe('WalletFactory model', function() { var s1 = sinon.stub(); s1.store = sinon.stub().yields(null); wf.read = sinon.stub().yields(null, s1); + wf.migrateWallet = sinon.stub().yields(null); wf.storage.setLastOpened = sinon.stub().yields(null); wf.open('dummy', 'xxx', function(err, w) { @@ -314,6 +314,7 @@ describe('WalletFactory model', function() { var s1 = sinon.stub(); s1.store = sinon.stub().yields(null); wf.read = sinon.stub().yields(null, s1); + wf.migrateWallet = sinon.stub().yields(null); wf.storage.setLastOpened = sinon.stub().yields(null); wf.open('dummy', 'xxx', function(err, w) { @@ -331,6 +332,7 @@ describe('WalletFactory model', function() { var s1 = sinon.stub(); s1.store = sinon.stub().yields(null); wf.read = sinon.stub().yields(null, s1); + wf.migrateWallet = sinon.stub().yields(null); wf.storage.setLastOpened = sinon.stub().yields(null); wf.open('dummy', 'xxx', function(err, w) { @@ -346,6 +348,7 @@ describe('WalletFactory model', function() { var s1 = sinon.stub(); s1.store = sinon.stub().yields(null); wf.read = sinon.stub().yields(null, s1); + wf.migrateWallet = sinon.stub().yields(null); wf.storage.setLastOpened = sinon.stub().yields(null); wf.open('dummy', 'xxx', function(err, w) { @@ -354,6 +357,24 @@ describe('WalletFactory model', function() { done(); }); }); + it('should call #migrateWallet', function(done) { + var wf = new WalletFactory(config, '0.0.1'); + wf.storage.setPassphrase = sinon.spy(); + + var s1 = sinon.stub(); + s1.store = sinon.stub().yields(null); + wf.read = sinon.stub().yields(null, s1); + wf.migrateWallet = sinon.stub().yields(null); + wf.storage.deleteWallet_Old = sinon.stub().yields(null); + wf.storage.removeGlobal = sinon.stub().yields(null); + wf.storage.setLastOpened = sinon.stub().yields(null); + + wf.open('dummy', 'xxx', function(err, w) { + wf.migrateWallet.calledOnce.should.equal(true); + wf.migrateWallet.getCall(0).args[0].should.equal('dummy'); + done(); + }); + }); }); describe('#create', function() {