mirror of
https://github.com/bitwarden/browser
synced 2025-12-19 09:43:23 +00:00
3340af8084
* WIP: safer state migrations Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com> * Add min version check and remove old migrations Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com> * Add rollback and version checking * Add state version move migration * Expand tests and improve typing for Migrations * Remove StateMigration Service * Rewrite version 5 and 6 migrations * Add all but initial migration to supported migrations * Handle stateVersion location in migrator update versions * Move to unique migrations directory * Disallow imports outside of state-migrations * Lint and test fixes * Do not run migrations if we cannot determine state * Fix desktop background StateService build * Document Migration builder class * Add debug logging to migrations * Comment on migrator overrides * Use specific property names * `npm run prettier` 🤖 * Insert new migration * Set stateVersion when creating new globals object * PR comments * Fix migrate imports * Move migration building into `migrate` function * Export current version from migration definitions * Move file version concerns to migrator * Update migrate spec to reflect new version requirements * Fix import paths * Prefer unique state data * Remove unnecessary async * Prefer to not use `any` --------- Co-authored-by: Justin Baur <justindbaur@users.noreply.github.com> Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>
33 lines
1.3 KiB
TypeScript
33 lines
1.3 KiB
TypeScript
import { MigrationHelper } from "../migration-helper";
|
|
import { Direction, IRREVERSIBLE, Migrator } from "../migrator";
|
|
|
|
type ExpectedAccountType = { keys?: { legacyEtmKey?: string } };
|
|
|
|
export class RemoveLegacyEtmKeyMigrator extends Migrator<5, 6> {
|
|
async migrate(helper: MigrationHelper): Promise<void> {
|
|
const accounts = await helper.getAccounts<ExpectedAccountType>();
|
|
|
|
async function updateAccount(userId: string, account: ExpectedAccountType) {
|
|
if (account?.keys?.legacyEtmKey) {
|
|
delete account.keys.legacyEtmKey;
|
|
await helper.set(userId, account);
|
|
}
|
|
}
|
|
|
|
await Promise.all(accounts.map(({ userId, account }) => updateAccount(userId, account)));
|
|
}
|
|
|
|
async rollback(helper: MigrationHelper): Promise<void> {
|
|
throw IRREVERSIBLE;
|
|
}
|
|
|
|
// Override is necessary because default implementation assumes `stateVersion` at the root, but for this version
|
|
// it is nested inside a global object.
|
|
override async updateVersion(helper: MigrationHelper, direction: Direction): Promise<void> {
|
|
const endVersion = direction === "up" ? this.toVersion : this.fromVersion;
|
|
helper.currentVersion = endVersion;
|
|
const global: { stateVersion: number } = (await helper.get("global")) || ({} as any);
|
|
await helper.set("global", { ...global, stateVersion: endVersion });
|
|
}
|
|
}
|