mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-27 04:46:10 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
68 lines
1.8 KiB
JavaScript
68 lines
1.8 KiB
JavaScript
import jsonDiffer from 'fast-json-patch'
|
|
import { cloneDeep } from 'lodash'
|
|
|
|
/**
|
|
converts non-initial history entries into diffs
|
|
@param {Array} longHistory
|
|
@returns {Array}
|
|
*/
|
|
export 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 separated 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}
|
|
*/
|
|
export 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}
|
|
*/
|
|
export function replayHistory(_shortHistory) {
|
|
const shortHistory = cloneDeep(_shortHistory)
|
|
return shortHistory.reduce(
|
|
(val, entry) => jsonDiffer.applyPatch(val, entry).newDocument,
|
|
)
|
|
}
|
|
|
|
/**
|
|
* Snapshot {@code txMeta}
|
|
* @param {Object} txMeta - the tx metadata object
|
|
* @returns {Object} a deep clone without history
|
|
*/
|
|
export function snapshotFromTxMeta(txMeta) {
|
|
const shallow = { ...txMeta }
|
|
delete shallow.history
|
|
return cloneDeep(shallow)
|
|
}
|