chore(runway): cherry-pick fix: migration order to cherry pick the phishing controller migration in 7.47 (#16149)

- fix: cp-7.47.0 migration order to cherry pick the phishing controller
migration in 7.47 (#16137)

Author: runway-github[bot]

app/store/migrations/078.test.ts

@@ -0,0 +1,140 @@
+import migrate from './078';
+import { ensureValidState } from './util';
+import { captureException } from '@sentry/react-native';
+
+jest.mock('@sentry/react-native', () => ({
+  captureException: jest.fn(),
+}));
+
+jest.mock('./util', () => ({
+  ensureValidState: jest.fn(),
+}));
+
+const mockedCaptureException = jest.mocked(captureException);
+const mockedEnsureValidState = jest.mocked(ensureValidState);
+
+describe('Migration 078: Reset PhishingController phishingLists', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('returns state unchanged if ensureValidState fails', () => {
+    const state = { some: 'state' };
+
+    mockedEnsureValidState.mockReturnValue(false);
+
+    const migratedState = migrate(state);
+
+    expect(migratedState).toBe(state);
+    expect(mockedCaptureException).not.toHaveBeenCalled();
+  });
+
+  it('captures exception if PhishingController state is invalid', () => {
+    const state = {
+      engine: {
+        backgroundState: {
+          // PhishingController is missing
+        },
+      },
+    };
+
+    mockedEnsureValidState.mockReturnValue(true);
+
+    const migratedState = migrate(state);
+
+    expect(migratedState).toEqual(state);
+    expect(mockedCaptureException).toHaveBeenCalledWith(expect.any(Error));
+    expect(mockedCaptureException.mock.calls[0][0].message).toContain(
+      'Migration 078: Invalid PhishingController state',
+    );
+  });
+
+  it('resets PhishingController phishingLists to empty array and stalelistLastFetched to 0 while preserving other fields', () => {
+    interface TestState {
+      engine: {
+        backgroundState: {
+          PhishingController: {
+            c2DomainBlocklistLastFetched: number;
+            phishingLists: string[];
+            whitelist: string[];
+            hotlistLastFetched: number;
+            stalelistLastFetched: number;
+            extraProperty?: string;
+          };
+          OtherController: {
+            shouldStayUntouched: boolean;
+          };
+        };
+      };
+    }
+
+    const state: TestState = {
+      engine: {
+        backgroundState: {
+          PhishingController: {
+            c2DomainBlocklistLastFetched: 123456789,
+            phishingLists: ['list1', 'list2'],
+            whitelist: ['site1', 'site2'],
+            hotlistLastFetched: 987654321,
+            stalelistLastFetched: 123123123,
+            extraProperty: 'should remain',
+          },
+          OtherController: {
+            shouldStayUntouched: true,
+          },
+        },
+      },
+    };
+
+    mockedEnsureValidState.mockReturnValue(true);
+
+    const migratedState = migrate(state) as typeof state;
+
+    // PhishingLists should be reset to empty array and stalelistLastFetched to 0
+    expect(migratedState.engine.backgroundState.PhishingController.phishingLists).toEqual([]);
+    expect(migratedState.engine.backgroundState.PhishingController.stalelistLastFetched).toBe(0);
+
+    // Other fields should remain unchanged
+    expect(migratedState.engine.backgroundState.PhishingController.c2DomainBlocklistLastFetched).toBe(123456789);
+    expect(migratedState.engine.backgroundState.PhishingController.whitelist).toEqual(['site1', 'site2']);
+    expect(migratedState.engine.backgroundState.PhishingController.hotlistLastFetched).toBe(987654321);
+    expect(migratedState.engine.backgroundState.PhishingController.extraProperty).toBe('should remain');
+
+    // Other controllers should remain untouched
+    expect(migratedState.engine.backgroundState.OtherController).toEqual({
+      shouldStayUntouched: true,
+    });
+
+    expect(mockedCaptureException).not.toHaveBeenCalled();
+  });
+
+  it('handles error during migration', () => {
+    // Create state with a PhishingController that throws when phishingLists is accessed
+    const state = {
+      engine: {
+        backgroundState: {
+          PhishingController: Object.defineProperty({}, 'phishingLists', {
+            get: () => {
+              throw new Error('Test error');
+            },
+            set: () => {
+              throw new Error('Test error');
+            },
+            configurable: true,
+            enumerable: true,
+          }),
+        },
+      },
+    };
+
+    mockedEnsureValidState.mockReturnValue(true);
+
+    const migratedState = migrate(state);
+
+    expect(migratedState).toEqual(state);
+    expect(mockedCaptureException).toHaveBeenCalledWith(expect.any(Error));
+    expect(mockedCaptureException.mock.calls[0][0].message).toContain(
+      'Migration 078: cleaning PhishingController state failed with error',
+    );
+  });
+}); 

app/store/migrations/078.ts

@@ -0,0 +1,50 @@
+import { hasProperty, isObject } from '@metamask/utils';
+import { ensureValidState } from './util';
+import { captureException } from '@sentry/react-native';
+
+/**
+ * Migration 78: Reset PhishingController phishingLists
+ *
+ * This migration resets only the phishingLists array in the PhishingController state
+ * while preserving all other state properties. This allows the app to rebuild the lists
+ * while maintaining user preferences and configuration.
+ */
+const migration = (state: unknown): unknown => {
+  const migrationVersion = 78;
+
+  if (!ensureValidState(state, migrationVersion)) {
+    return state;
+  }
+
+  try {
+    if (
+      !hasProperty(state.engine.backgroundState, 'PhishingController') ||
+      !isObject(state.engine.backgroundState.PhishingController)
+    ) {
+      captureException(
+        new Error(
+          `Migration 078: Invalid PhishingController state: '${JSON.stringify(
+            state.engine.backgroundState.PhishingController,
+          )}'`,
+        ),
+      );
+      return state;
+    }
+
+    // Only reset the phishingLists field to an empty array
+    // while preserving all other fields
+    state.engine.backgroundState.PhishingController.phishingLists = [];
+    state.engine.backgroundState.PhishingController.stalelistLastFetched = 0;
+
+    return state;
+  } catch (error) {
+    captureException(
+      new Error(
+        `Migration 078: cleaning PhishingController state failed with error: ${error}`,
+      ),
+    );
+    return state;
+  }
+};
+
+export default migration;

app/store/migrations/index.ts

@@ -78,7 +78,7 @@ import migration74 from './074';
 import migration75 from './075';
 import migration76 from './076';
 import migration77 from './077';
-import migration82 from './082';
+import migration78 from './078';
 
 // Add migrations above this line
 import { validatePostMigrationState } from '../validateMigration/validateMigration';
@@ -173,7 +173,7 @@ export const migrationList: MigrationsList = {
   75: migration75,
   76: migration76,
   77: migration77,
-  82: migration82,
+  78: migration78,
 };
 
 // Enable both synchronous and asynchronous migrations