Merge branch 'main' into fix/remove-supported-chains-check-ppom

Author: vinistevam

app/scripts/migrations/144.test.ts

@@ -0,0 +1,87 @@
+import { migrate, version } from './144';
+
+const oldVersion = 143;
+
+const DEFAULT_CURRENCY = 'usd';
+const VALID_CURRENCY = 'eur';
+const INVALID_CURRENCY = 'INVALID_CURRENCY';
+
+describe(`migration #${version}`, () => {
+  it('updates the version metadata', async () => {
+    const oldStorage = {
+      meta: { version: oldVersion },
+      data: {},
+    };
+    const newStorage = await migrate(oldStorage);
+    expect(newStorage.meta).toStrictEqual({ version });
+  });
+
+  describe(`migration #${version}`, () => {
+    it('does nothing if CurrencyController is missing', async () => {
+      const oldStorage = {
+        meta: { version: oldVersion },
+        data: {},
+      };
+      const newStorage = await migrate(oldStorage);
+      expect(newStorage.data).toStrictEqual({});
+    });
+
+    it('does nothing if CurrencyController is not an object', async () => {
+      const oldStorage = {
+        meta: { version: oldVersion },
+        data: {
+          CurrencyController: 'invalidData',
+        },
+      };
+      const newStorage = await migrate(oldStorage);
+      expect(newStorage.data).toStrictEqual(oldStorage.data);
+    });
+
+    it('sets currentCurrency to "USD" if it is missing', async () => {
+      const oldStorage = {
+        meta: { version: oldVersion },
+        data: {
+          CurrencyController: {},
+        },
+      };
+      const expectedData = {
+        CurrencyController: {
+          currentCurrency: DEFAULT_CURRENCY,
+        },
+      };
+      const newStorage = await migrate(oldStorage);
+      expect(newStorage.data).toStrictEqual(expectedData);
+    });
+
+    it('sets currentCurrency to "USD" if it is invalid', async () => {
+      const oldStorage = {
+        meta: { version: oldVersion },
+        data: {
+          CurrencyController: {
+            currentCurrency: INVALID_CURRENCY,
+          },
+        },
+      };
+      const expectedData = {
+        CurrencyController: {
+          currentCurrency: DEFAULT_CURRENCY,
+        },
+      };
+      const newStorage = await migrate(oldStorage);
+      expect(newStorage.data).toStrictEqual(expectedData);
+    });
+
+    it('does nothing if currentCurrency is valid', async () => {
+      const oldStorage = {
+        meta: { version: oldVersion },
+        data: {
+          CurrencyController: {
+            currentCurrency: VALID_CURRENCY,
+          },
+        },
+      };
+      const newStorage = await migrate(oldStorage);
+      expect(newStorage.data).toStrictEqual(oldStorage.data);
+    });
+  });
+});

app/scripts/migrations/144.ts

@@ -0,0 +1,71 @@
+import { hasProperty } from '@metamask/utils';
+import { cloneDeep, isObject } from 'lodash';
+import { PRICE_API_CURRENCIES } from '../../../shared/constants/price-api-currencies';
+
+type VersionedData = {
+  meta: { version: number };
+  data: Record<string, unknown>;
+};
+
+type CurrencyController = {
+  currentCurrency?: string;
+};
+
+export const version = 144;
+const DEFAULT_CURRENCY = 'usd';
+
+/**
+ * This migration ensures that the `currentCurrency` in `CurrencyController`
+ * is set to a valid available currency. If it's missing or invalid, it defaults to "USD".
+ *
+ * @param originalVersionedData - The original MetaMask extension state.
+ * @returns Updated versioned MetaMask extension state.
+ */
+export async function migrate(
+  originalVersionedData: VersionedData,
+): Promise<VersionedData> {
+  const versionedData = cloneDeep(originalVersionedData);
+  versionedData.meta.version = version;
+  transformState(versionedData.data);
+  return versionedData;
+}
+
+function transformState(state: Record<string, unknown>) {
+  if (!hasProperty(state, 'CurrencyController')) {
+    global.sentry?.captureException?.(
+      new Error(`Migration ${version}: Missing CurrencyController in state`),
+    );
+    return;
+  }
+
+  const currencyController = state.CurrencyController as CurrencyController;
+
+  if (!isObject(currencyController)) {
+    global.sentry?.captureException?.(
+      new Error(
+        `Migration ${version}: Invalid CurrencyController state type '${typeof currencyController}'`,
+      ),
+    );
+    return;
+  }
+
+  const { currentCurrency } = currencyController;
+
+  if (!currentCurrency) {
+    global.sentry?.captureException?.(
+      new Error(
+        `Migration ${version}: Missing currentCurrency in CurrencyController, defaulting to ${DEFAULT_CURRENCY}`,
+      ),
+    );
+    currencyController.currentCurrency = DEFAULT_CURRENCY;
+    return;
+  }
+
+  const isValidCurrency = PRICE_API_CURRENCIES.some(
+    (currency) => currency === currentCurrency,
+  );
+
+  if (!isValidCurrency) {
+    currencyController.currentCurrency = DEFAULT_CURRENCY;
+  }
+}

app/scripts/migrations/index.js

@@ -168,6 +168,7 @@ const migrations = [
   require('./141'),
   require('./142'),
   require('./143'),
+  require('./144'),
 ];
 
 export default migrations;

shared/constants/price-api-currencies.ts

@@ -0,0 +1,46 @@
+export const PRICE_API_CURRENCIES = [
+  'aud',
+  'hkd',
+  'sgd',
+  'idr',
+  'inr',
+  'nzd',
+  'php',
+  'btc',
+  'cad',
+  'eur',
+  'gbp',
+  'jpy',
+  'ltc',
+  'rub',
+  'uah',
+  'usd',
+  'xlm',
+  'xrp',
+  'sek',
+  'aed',
+  'ars',
+  'bch',
+  'bnb',
+  'brl',
+  'clp',
+  'cny',
+  'czk',
+  'dkk',
+  'chf',
+  'dot',
+  'eos',
+  'eth',
+  'gel',
+  'huf',
+  'ils',
+  'krw',
+  'mxn',
+  'myr',
+  'ngn',
+  'nok',
+  'pln',
+  'thb',
+  'try',
+  'zar',
+];