mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-24 02:58:09 +01:00
ac01c5c89a
* Specify type before parameter name
Various JSDoc `@param` entries were specified as `name {type}` rather
than `{type} name`.
A couple of `@return` entries have been given types as well.
* Use JSDoc optional syntax rather than Closure syntax
* Use @returns rather than @return
* Use consistent built-in type capitalization
Primitive types are lower-case, and Object is upper-case.
* Separate param/return description with a dash
75 lines
2.0 KiB
JavaScript
75 lines
2.0 KiB
JavaScript
import jsonDiffer from 'fast-json-patch'
|
|
import clone from 'clone'
|
|
|
|
/** @module*/
|
|
export default {
|
|
generateHistoryEntry,
|
|
replayHistory,
|
|
snapshotFromTxMeta,
|
|
migrateFromSnapshotsToDiffs,
|
|
}
|
|
|
|
/**
|
|
converts non-initial history entries into diffs
|
|
@param {array} longHistory
|
|
@returns {array}
|
|
*/
|
|
function migrateFromSnapshotsToDiffs (longHistory) {
|
|
return (
|
|
longHistory
|
|
// convert non-initial history entries into diffs
|
|
.map((entry, index) => {
|
|
if (index === 0) {
|
|
return entry
|
|
}
|
|
return generateHistoryEntry(longHistory[index - 1], entry)
|
|
})
|
|
)
|
|
}
|
|
|
|
/**
|
|
Generates an array of history objects sense the previous state.
|
|
The object has the keys
|
|
op (the operation performed),
|
|
path (the key and if a nested object then each key will be seperated with a `/`)
|
|
value
|
|
with the first entry having the note and a timestamp when the change took place
|
|
@param {Object} previousState - the previous state of the object
|
|
@param {Object} newState - the update object
|
|
@param {string} [note] - a optional note for the state change
|
|
@returns {array}
|
|
*/
|
|
function generateHistoryEntry (previousState, newState, note) {
|
|
const entry = jsonDiffer.compare(previousState, newState)
|
|
// Add a note to the first op, since it breaks if we append it to the entry
|
|
if (entry[0]) {
|
|
if (note) {
|
|
entry[0].note = note
|
|
}
|
|
|
|
entry[0].timestamp = Date.now()
|
|
}
|
|
return entry
|
|
}
|
|
|
|
/**
|
|
Recovers previous txMeta state obj
|
|
@returns {Object}
|
|
*/
|
|
function replayHistory (_shortHistory) {
|
|
const shortHistory = clone(_shortHistory)
|
|
return shortHistory.reduce((val, entry) => jsonDiffer.applyPatch(val, entry).newDocument)
|
|
}
|
|
|
|
/**
|
|
@param {Object} txMeta
|
|
@returns {Object} - a clone object of the txMeta with out history
|
|
*/
|
|
function snapshotFromTxMeta (txMeta) {
|
|
// create txMeta snapshot for history
|
|
const snapshot = clone(txMeta)
|
|
// dont include previous history in this snapshot
|
|
delete snapshot.history
|
|
return snapshot
|
|
}
|