fix: add migration script

app/scripts/migrations/134.test.ts

@@ -0,0 +1,56 @@
+import { migrate, version } from './134';
+
+const oldVersion = 133;
+
+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 });
+  });
+
+  it('Does nothing if `usedNetworks` is not in the AppStateController state', async () => {
+    const oldState = {
+      AppStateController: {
+        timeoutMinutes: 0,
+      },
+    };
+
+    const transformedState = await migrate({
+      meta: { version: oldVersion },
+      data: oldState,
+    });
+
+    expect(transformedState.data).toStrictEqual(oldState);
+  });
+
+  it('Removes `usedNetworks` from the AppStateController state', async () => {
+    const oldState: {
+      AppStateController: {
+        timeoutMinutes: number;
+        usedNetworks?: Record<string, boolean>;
+      };
+    } = {
+      AppStateController: {
+        timeoutMinutes: 0,
+        usedNetworks: {
+          '0x1': true,
+          '0x5': true,
+          '0x539': true,
+        },
+      },
+    };
+    const transformedState = await migrate({
+      meta: { version: oldVersion },
+      data: oldState,
+    });
+
+    delete oldState.AppStateController.usedNetworks;
+    expect(transformedState.data).toStrictEqual(oldState);
+  });
+});

app/scripts/migrations/134.ts

@@ -0,0 +1,41 @@
+import { hasProperty, isObject } from '@metamask/utils';
+import { cloneDeep } from 'lodash';
+
+type VersionedData = {
+  meta: { version: number };
+  data: Record<string, unknown>;
+};
+
+export const version = 134;
+
+/**
+ * This migration removes `providerConfig` from the network controller state.
+ *
+ * @param originalVersionedData - Versioned MetaMask extension state, exactly what we persist to dist.
+ * @param originalVersionedData.meta - State metadata.
+ * @param originalVersionedData.meta.version - The current state version.
+ * @param originalVersionedData.data - The persisted MetaMask state, keyed by controller.
+ * @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>,
+): Record<string, unknown> {
+  if (
+    hasProperty(state, 'AppStateController') &&
+    isObject(state.AppStateController) &&
+    hasProperty(state.AppStateController, 'usedNetworks')
+  ) {
+    console.log('Removing usedNetworks from AppStateController');
+    delete state.AppStateController.usedNetworks;
+  }
+  return state;
+}

app/scripts/migrations/index.js

@@ -154,6 +154,7 @@ const migrations = [
   require('./131'),
   require('./132'),
   require('./133'),
+  require('./134'),
 ];
 
 export default migrations;