chore: merge 7.16.0 into 7.17.0

README.md

@@ -27,22 +27,18 @@ The code is built using React-Native and running code locally requires a Mac or
 - Install [Yarn v1](https://yarnpkg.com/en/docs/install)
 
   One way to install Yarn v1 is by using brew:
-
   ```bash
   brew install yarn@1.22.19
   ```
 
   To check you've installed the right version:
-
   ```bash
   yarn --version
   ```
 
 - Install the shared [React Native dependencies](https://reactnative.dev/docs/environment-setup#installing-dependencies) (`React Native CLI`, _not_ `Expo CLI`)
 
-
 - Install [cocoapods](https://guides.cocoapods.org/using/getting-started.html) by running:
-
   ```bash
   sudo gem install cocoapods -v 1.12.1
   ```

app/store/migrations/028.test.js

@@ -0,0 +1,117 @@
+import migrate, { controllerList } from './028';
+
+jest.mock('@metamask/utils', () => ({
+  hasProperty: jest.fn(),
+  isObject: jest.fn(),
+}));
+
+jest.mock('@sentry/react-native', () => ({
+  captureException: jest.fn(),
+}));
+
+jest.mock('../../util/general', () => ({
+  deepJSONParse: jest.fn(),
+}));
+
+jest.mock('redux-persist-filesystem-storage', () => ({
+  setItem: jest.fn(),
+  getItem: jest.fn(),
+  removeItem: jest.fn(),
+  getAllKeys: jest.fn(),
+  clear: jest.fn(),
+}));
+
+describe('Migration #28', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  jest.mock('@sentry/react-native', () => ({
+    captureException: jest.fn(),
+  }));
+
+  it('should return state unchanged if it is not an object', async () => {
+    const state = 'invalid_state';
+    const result = await migrate(state);
+
+    expect(result).toEqual(state);
+    expect(
+      require('@sentry/react-native').captureException,
+    ).toHaveBeenCalledWith(expect.any(Error));
+    expect(
+      require('@sentry/react-native').captureException,
+    ).toHaveBeenCalledTimes(1);
+    expect(require('@metamask/utils').isObject).toHaveBeenCalledTimes(1);
+  });
+
+  it('should return state unchanged if engine already exists in state', async () => {
+    const state = { engine: {} };
+    const result = await migrate(state);
+
+    expect(result).toEqual(state);
+    expect(
+      require('redux-persist-filesystem-storage').getItem,
+    ).not.toHaveBeenCalled();
+    expect(require('@metamask/utils').isObject).toHaveBeenCalledTimes(1);
+  });
+
+  it('should properly migrate state', async () => {
+    const persistedData = { someData: 'example' };
+    const getItemMock = jest
+      .fn()
+      .mockResolvedValue(JSON.stringify(persistedData));
+    const setItemMock = jest.fn().mockResolvedValue(undefined);
+    const removeItemMock = jest.fn().mockResolvedValue(undefined);
+    const deepJSONParseMock = jest.fn().mockReturnValue(persistedData);
+    const hasPropertyMock = jest.fn().mockReturnValue(false);
+
+    require('@metamask/utils').isObject.mockReturnValue(true);
+    require('../../util/general').deepJSONParse = deepJSONParseMock;
+    require('redux-persist-filesystem-storage').getItem = getItemMock;
+    require('redux-persist-filesystem-storage').setItem = setItemMock;
+    require('redux-persist-filesystem-storage').removeItem = removeItemMock;
+    require('@metamask/utils').hasProperty = hasPropertyMock;
+
+    const state = {};
+    const result = await migrate(state);
+    // eslint-disable-next-line
+    const mockValue = `{\"engine\":{\"backgroundState\":{\"AccountTrackerController\":{\"someData\":\"example\"},\"AddressBookController\":{\"someData\":\"example\"},\"AssetsContractController\":{\"someData\":\"example\"},\"NftController\":{\"someData\":\"example\"},\"TokensController\":{\"someData\":\"example\"},\"TokenDetectionController\":{\"someData\":\"example\"},\"NftDetectionController\":{\"someData\":\"example\"},\"KeyringController\":{\"someData\":\"example\"},\"NetworkController\":{\"someData\":\"example\"},\"PhishingController\":{\"someData\":\"example\"},\"PreferencesController\":{\"someData\":\"example\"},\"TokenBalancesController\":{\"someData\":\"example\"},\"TokenRatesController\":{\"someData\":\"example\"},\"TransactionController\":{\"someData\":\"example\"},\"SwapsController\":{\"someData\":\"example\"},\"TokenListController\":{\"someData\":\"example\"},\"CurrencyRateController\":{\"someData\":\"example\"},\"GasFeeController\":{\"someData\":\"example\"},\"ApprovalController\":{\"someData\":\"example\"},\"SnapController\":{\"someData\":\"example\"},\"subjectMetadataController\":{\"someData\":\"example\"},\"PermissionController\":{\"someData\":\"example\"},\"LoggingController\":{\"someData\":\"example\"},\"PPOMController\":{\"someData\":\"example\"}}}}`;
+
+    const mockEngine = {
+      AccountTrackerController: { someData: 'example' },
+      AddressBookController: { someData: 'example' },
+      AssetsContractController: { someData: 'example' },
+      NftController: { someData: 'example' },
+      TokensController: { someData: 'example' },
+      TokenDetectionController: { someData: 'example' },
+      NftDetectionController: { someData: 'example' },
+      KeyringController: { someData: 'example' },
+      NetworkController: { someData: 'example' },
+      PhishingController: { someData: 'example' },
+      PreferencesController: { someData: 'example' },
+      TokenBalancesController: { someData: 'example' },
+      TokenRatesController: { someData: 'example' },
+      TransactionController: { someData: 'example' },
+      SwapsController: { someData: 'example' },
+      TokenListController: { someData: 'example' },
+      CurrencyRateController: { someData: 'example' },
+      GasFeeController: { someData: 'example' },
+      ApprovalController: { someData: 'example' },
+      SnapController: { someData: 'example' },
+      subjectMetadataController: { someData: 'example' },
+      PermissionController: { someData: 'example' },
+      LoggingController: { someData: 'example' },
+      PPOMController: { someData: 'example' },
+    };
+
+    expect(deepJSONParseMock).toHaveBeenCalledTimes(controllerList.length);
+    expect(hasPropertyMock).toHaveBeenCalledTimes(controllerList.length);
+    expect(getItemMock).toHaveBeenCalledTimes(controllerList.length);
+    expect(setItemMock).toHaveBeenCalledWith('persist:root', mockValue, true);
+    expect(removeItemMock).toHaveBeenCalledTimes(controllerList.length);
+    expect(result).toEqual({ engine: { backgroundState: mockEngine } });
+    expect(
+      require('@sentry/react-native').captureException,
+    ).not.toHaveBeenCalled();
+  });
+});