1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-22 18:00:18 +01:00
metamask-extension/app/scripts/migrations/077.js
Dan J Miller 3b0d37c3bf
Fix migration 77 (#20276)
* Handle the case where tokensChainsCache data is undefined in migration 77

* Delete parts of state that should have been removed in migrations 82,84,86 and 88

* Create 077-supplements.md

* Update 077-supplements.md

* Update 077-supplements/*.js code comments

* Fix types and jsdoc

* Type/lint fix

* Cleanup

* Add 'should set data to an empty object if it is null' test case to 077.test.js

* Update app/scripts/migrations/077.test.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Modify deletion criteria so that all decimal chain id proprties are deleted in migration 88 supplement

* Readme.md

* Update app/scripts/migrations/077.test.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Update app/scripts/migrations/077.test.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Update app/scripts/migrations/077.test.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Lint fix

* Only delete decimal chain id keyed-entries in migration 88 supplement if there are hexadecimal keyed entries as well

* Remove redundant test

* Add 'does not delete' cases for nftcontroller related tests in 077.test.js

---------

Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2023-07-31 19:43:51 -02:30

70 lines
2.3 KiB
JavaScript

import { cloneDeep } from 'lodash';
import transformState077For082 from './077-supplements/077-supplement-for-082';
import transformState077For084 from './077-supplements/077-supplement-for-084';
import transformState077For086 from './077-supplements/077-supplement-for-086';
import transformState077For088 from './077-supplements/077-supplement-for-088';
const version = 77;
/**
* Prior to token detection v2 the data property in tokensChainsCache was an array,
* in v2 we changes that to an object. In this migration we are converting the data as array to object.
*/
export default {
version,
async migrate(originalVersionedData) {
const versionedData = cloneDeep(originalVersionedData);
versionedData.meta.version = version;
const state = versionedData.data;
let newState = transformState(state);
newState = transformState077For082(newState);
newState = transformState077For084(newState);
newState = transformState077For086(newState);
newState = transformState077For088(newState);
versionedData.data = newState;
return versionedData;
},
};
function transformState(state) {
const TokenListController = state?.TokenListController || {};
const { tokensChainsCache } = TokenListController;
let dataCache;
let dataObject;
// eslint-disable-next-line
for (const chainId in tokensChainsCache) {
dataCache = tokensChainsCache[chainId].data || {};
dataObject = {};
// if the data is array conver that to object
if (Array.isArray(dataCache)) {
for (const token of dataCache) {
dataObject[token.address] = token;
}
} else if (
Object.keys(dataCache)[0]?.toLowerCase() !==
dataCache[Object.keys(dataCache)[0]]?.address?.toLowerCase()
) {
// for the users who already updated to the recent version
// and the dataCache is already an object keyed with 0,1,2,3 etc
// eslint-disable-next-line
for (const tokenAddress in dataCache) {
dataObject[dataCache[tokenAddress].address] = dataCache[tokenAddress];
}
}
tokensChainsCache[chainId].data =
Object.keys(dataObject).length > 0 ? dataObject : dataCache;
}
TokenListController.tokensChainsCache = tokensChainsCache;
return {
...state,
TokenListController: {
...TokenListController,
},
};
}