mirror of
https://github.com/bitwarden/browser.git
synced 2024-10-09 05:57:40 +02:00
1ff7bdd014
* Create MigrationRunner - Create MigrationRunner Service for running migrations in StateService - Create web override so that migrations also run against `localStorage` * Fix Web StateService * Fix WebMigrationRunner * Fix CLI * Fix ElectronStateService * Update Comment * More Common Scenarios
87 lines
2.9 KiB
TypeScript
87 lines
2.9 KiB
TypeScript
import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
|
|
import { AbstractStorageService } from "@bitwarden/common/platform/abstractions/storage.service";
|
|
import { Utils } from "@bitwarden/common/platform/misc/utils";
|
|
import { MigrationBuilderService } from "@bitwarden/common/platform/services/migration-builder.service";
|
|
import { MigrationRunner } from "@bitwarden/common/platform/services/migration-runner";
|
|
import { MigrationHelper } from "@bitwarden/common/state-migrations/migration-helper";
|
|
|
|
import { WindowStorageService } from "./window-storage.service";
|
|
|
|
export class WebMigrationRunner extends MigrationRunner {
|
|
constructor(
|
|
diskStorage: AbstractStorageService,
|
|
logService: LogService,
|
|
migrationBuilderService: MigrationBuilderService,
|
|
private diskLocalStorage: WindowStorageService,
|
|
) {
|
|
super(diskStorage, logService, migrationBuilderService);
|
|
}
|
|
|
|
override async run(): Promise<void> {
|
|
// Run the default migration against session storage
|
|
await super.run();
|
|
|
|
// run web disk local specific migrations
|
|
const migrationBuilder = this.migrationBuilderService.build();
|
|
|
|
let stateVersion = await this.diskLocalStorage.get<number | null>("stateVersion");
|
|
if (stateVersion == null) {
|
|
// Web has never stored a state version in disk local before
|
|
// TODO: Is this a good number?
|
|
stateVersion = 12;
|
|
}
|
|
|
|
// Run migrations again specifically for web `localStorage`.
|
|
const helper = new WebMigrationHelper(stateVersion, this.diskLocalStorage, this.logService);
|
|
|
|
await migrationBuilder.migrate(helper);
|
|
}
|
|
}
|
|
|
|
class WebMigrationHelper extends MigrationHelper {
|
|
private readonly diskLocalStorageService: WindowStorageService;
|
|
|
|
constructor(
|
|
currentVersion: number,
|
|
storageService: WindowStorageService,
|
|
logService: LogService,
|
|
) {
|
|
super(currentVersion, storageService, logService);
|
|
this.diskLocalStorageService = storageService;
|
|
}
|
|
|
|
override async getAccounts<ExpectedAccountType>(): Promise<
|
|
{ userId: string; account: ExpectedAccountType }[]
|
|
> {
|
|
// Get all the keys of things stored in `localStorage`
|
|
const keys = this.diskLocalStorageService.getKeys();
|
|
|
|
const accounts: { userId: string; account: ExpectedAccountType }[] = [];
|
|
|
|
for (const key of keys) {
|
|
// Is this is likely a userid
|
|
if (!Utils.isGuid(key)) {
|
|
continue;
|
|
}
|
|
|
|
const accountCandidate = await this.diskLocalStorageService.get(key);
|
|
|
|
// If there isn't data at that key location, don't bother
|
|
if (accountCandidate == null) {
|
|
continue;
|
|
}
|
|
|
|
// The legacy account object was always an object, if
|
|
// it is some other primitive, it's like a false positive.
|
|
if (typeof accountCandidate !== "object") {
|
|
continue;
|
|
}
|
|
|
|
accounts.push({ userId: key, account: accountCandidate as ExpectedAccountType });
|
|
}
|
|
|
|
// TODO: Cache this for future calls?
|
|
return accounts;
|
|
}
|
|
}
|