introduce tx-state-history-helper and diff-based history

2 files changed, 31 insertions, 5 deletions

diff --git a/test/unit/tx-controller-test.js b/test/unit/tx-controller-test.js
index 57d7deccd..c84a374ae 100644
--- a/test/unit/tx-controller-test.js
+++ b/test/unit/tx-controller-test.js
@@ -47,7 +47,7 @@ describe('Transaction Controller', function () {
         metamaskNetworkId: currentNetworkId,
         txParams,
       }
-      txController._saveTxList([txMeta])
+      txController.addTx(txMeta)
       stub = sinon.stub(txController, 'addUnapprovedTransaction').returns(Promise.resolve(txMeta))
     })
 
@@ -279,9 +279,12 @@ describe('Transaction Controller', function () {
     it('replaces the tx with the same id', function () {
       txController.addTx({ id: '1', status: 'unapproved', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
       txController.addTx({ id: '2', status: 'confirmed', metamaskNetworkId: currentNetworkId, txParams: {} }, noop)
-      txController.updateTx({ id: '1', status: 'blah', hash: 'foo', metamaskNetworkId: currentNetworkId, txParams: {} })
-      var result = txController.getTx('1')
-      assert.equal(result.hash, 'foo')
+      const tx1 = txController.getTx('1')
+      tx1.status = 'blah'
+      tx1.hash = 'foo'
+      txController.updateTx(tx1)
+      const savedResult = txController.getTx('1')
+      assert.equal(savedResult.hash, 'foo')
     })
 
     it('updates gas price', function () {
@@ -297,9 +300,9 @@ describe('Transaction Controller', function () {
         },
       }
 
-      const updatedMeta = clone(txMeta)
 
       txController.addTx(txMeta)
+      const updatedMeta = txController.getTx('1')
       updatedMeta.txParams.gasPrice = desiredGasPrice
       txController.updateTx(updatedMeta)
       var result = txController.getTx('1')
diff --git a/test/unit/tx-state-history-helper.js b/test/unit/tx-state-history-helper.js
new file mode 100644
index 000000000..2ac91c39f
--- /dev/null
+++ b/test/unit/tx-state-history-helper.js
@@ -0,0 +1,23 @@
+const assert = require('assert')
+const txStateHistoryHelper = require('../../app/scripts/lib/tx-state-history-helper')
+const testVault = require('../data/v17-long-history.json')
+
+
+describe('history-differ', function () {
+  it('migrates history to diffs and can recover original values', function () {
+    testVault.data.TransactionController.transactions.forEach((tx, index) => {
+      const newHistory = txStateHistoryHelper.migrateFromSnapshotsToDiffs(tx.history)
+      newHistory.forEach((newEntry, index) => {
+        if (index === 0) {
+          assert.equal(Array.isArray(newEntry), false, 'initial history item IS NOT a json patch obj')
+        } else {
+          assert.equal(Array.isArray(newEntry), true, 'non-initial history entry IS a json patch obj')
+        }
+        const oldEntry = tx.history[index]
+        const historySubset = newHistory.slice(0, index + 1)
+        const reconstructedValue = txStateHistoryHelper.replayHistory(historySubset)
+        assert.deepEqual(oldEntry, reconstructedValue, 'was able to reconstruct old entry from diffs')
+      })
+    })
+  })
+})