chore(migrations): remove null "seedWords" from state

Author: davidmurdoch

app/scripts/migrations/190.test.ts

@@ -0,0 +1,72 @@
+import { cloneDeep } from 'lodash';
+import { migrate, version } from './190';
+
+const VERSION = version;
+const OLD_VERSION = VERSION - 1;
+
+describe(`migration #${VERSION}`, () => {
+  it('removes seedWords when value is null', async () => {
+    const oldStorage = {
+      meta: { version: OLD_VERSION },
+      data: {
+        seedWords: null,
+        PreferencesController: {
+          showTestNetworks: true,
+        },
+      },
+    };
+
+    const versionedData = cloneDeep(oldStorage);
+    const changedKeys = new Set<string>();
+
+    await migrate(versionedData, changedKeys);
+
+    expect(versionedData.meta.version).toBe(VERSION);
+    expect('seedWords' in versionedData.data).toBe(false);
+    expect(versionedData.data).toStrictEqual({
+      PreferencesController: {
+        showTestNetworks: true,
+      },
+    });
+    expect(changedKeys).toStrictEqual(new Set(['seedWords']));
+  });
+
+  it('keeps seedWords when value is not null', async () => {
+    const oldStorage = {
+      meta: { version: OLD_VERSION },
+      data: {
+        seedWords: 'mock-seed-phrase',
+      },
+    };
+
+    const versionedData = cloneDeep(oldStorage);
+    const changedKeys = new Set<string>();
+
+    await migrate(versionedData, changedKeys);
+
+    expect(versionedData.meta.version).toBe(VERSION);
+    expect(versionedData.data).toStrictEqual(oldStorage.data);
+    expect(changedKeys.size).toBe(0);
+  });
+
+  it('handles state when seedWords property does not exist', async () => {
+    const oldStorage = {
+      meta: { version: OLD_VERSION },
+      data: {
+        PreferencesController: {
+          showTestNetworks: true,
+        },
+      },
+    };
+
+    const versionedData = cloneDeep(oldStorage);
+    const changedKeys = new Set<string>();
+
+    await migrate(versionedData, changedKeys);
+
+    expect(versionedData.meta.version).toBe(VERSION);
+    expect('seedWords' in versionedData.data).toBe(false);
+    expect(versionedData.data).toStrictEqual(oldStorage.data);
+    expect(changedKeys.size).toBe(0);
+  });
+});

app/scripts/migrations/190.ts

@@ -0,0 +1,26 @@
+import { hasProperty } from '@metamask/utils';
+import type { Migrate } from './types';
+
+export const version = 190;
+
+/**
+ * Migration that removes `null` seedWords values from the persisted state.
+ *
+ * If the `seedWords` property exists on the data object and its value is
+ * `null`, this migration deletes the property and records `seedWords` in
+ * the set of changed keys.
+ *
+ * @param versionedData - The versioned data object to migrate.
+ * @param changedKeys - A set used to record keys that were modified.
+ */
+export const migrate = (async (versionedData, changedKeys) => {
+  versionedData.meta.version = version;
+
+  if (
+    hasProperty(versionedData.data, 'seedWords') &&
+    versionedData.data.seedWords === null
+  ) {
+    delete versionedData.data.seedWords;
+    changedKeys.add('seedWords');
+  }
+}) satisfies Migrate;

app/scripts/migrations/index.js

@@ -225,6 +225,7 @@ const migrations = [
   require('./187'),
   require('./188'),
   require('./189'),
+  require('./190'),
 ];
 
 export default migrations;

test/e2e/tests/metrics/state-snapshots/errors-before-init-opt-in-ui-state.json

@@ -316,5 +316,5 @@
     "config": "object",
     "firstTimeInfo": "object"
   },
-  "meta": { "version": 189 }
+  "meta": { "version": 190 }
 }