bitwarden/browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser synced 2025-12-16 08:13:42 +00:00
Code Issues Releases Wiki Activity

PM-5274 Migrate Collection Service State (#7732)

Browse Source 
* update collection service to use new state provider framework, remove stateservice from collection service, update collections state provider with migrate file and unit test
This commit is contained in:
Jason Ng
2024-02-14 17:03:03 -05:00
committed by GitHub
parent d8b74b78da
commit 3edf098aaf
23 changed files with 426 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
libs/common/src/state-migrations/migrate.ts
View File

@@ -15,6 +15,7 @@ import { EnablePasskeysMigrator } from "./migrations/17-move-enable-passkeys-to-
import { AutofillSettingsKeyMigrator } from "./migrations/18-move-autofill-settings-to-state-providers";
import { RequirePasswordOnStartMigrator } from "./migrations/19-migrate-require-password-on-start";
import { PrivateKeyMigrator } from "./migrations/20-move-private-key-to-state-providers";
import { CollectionMigrator } from "./migrations/21-move-collections-state-to-state-provider";
import { FixPremiumMigrator } from "./migrations/3-fix-premium";
import { RemoveEverBeenUnlockedMigrator } from "./migrations/4-remove-ever-been-unlocked";
import { AddKeyTypeToOrgKeysMigrator } from "./migrations/5-add-key-type-to-org-keys";
@@ -25,7 +26,7 @@ import { MoveBrowserSettingsToGlobal } from "./migrations/9-move-browser-setting
import { MinVersionMigrator } from "./migrations/min-version";
export const MIN_VERSION = 2;
export const CURRENT_VERSION = 20;
export const CURRENT_VERSION = 21;
export type MinVersion = typeof MIN_VERSION;
export function createMigrationBuilder() {
@@ -48,7 +49,8 @@ export function createMigrationBuilder() {
.with(EnablePasskeysMigrator, 16, 17)
.with(AutofillSettingsKeyMigrator, 17, 18)
.with(RequirePasswordOnStartMigrator, 18, 19)
.with(PrivateKeyMigrator, 19, CURRENT_VERSION);
.with(PrivateKeyMigrator, 19, 20)
.with(CollectionMigrator, 20, CURRENT_VERSION);
}
export async function currentVersion(

196
libs/common/src/state-migrations/migrations/21-move-collections-state-to-state-provider.spec.ts Normal file
View File

@@ -0,0 +1,196 @@
import { MockProxy, any } from "jest-mock-extended";
import { MigrationHelper } from "../migration-helper";
import { mockMigrationHelper } from "../migration-helper.spec";
import { CollectionMigrator } from "./21-move-collections-state-to-state-provider";
function exampleJSON() {
return {
global: {
otherStuff: "otherStuff1",
},
authenticatedAccounts: ["user-1", "user-2"],
"user-1": {
data: {
collections: {
encrypted: {
"877fef70-be32-439e-8678-b0d80125653d": {
id: "877fef70-be32-439e-8678-b0d80125653d",
organizationId: "fe1ff6ef-d2d4-49f3-9c07-b0c7013998f9",
name: "2.MD9OMDsvYiU1CTSUxjHorw==|uFc4cZhnmQmK2LFCWbyeZg==|syk2d9JESeplxInLvP36BK5RhqS1c/i+ZQp5NR7EUA4=",
externalId: "",
readOnly: false,
manage: true,
hidePasswords: false,
},
"0d3fee82-3f81-434c-aed0-b0c200ee6c7a": {
id: "0d3fee82-3f81-434c-aed0-b0c200ee6c7a",
organizationId: "5f277723-6391-4b5c-add9-b0c200ee6967",
name: "2.GxnXkIbBCGFr57F6lT7+Ow==|3ctMg95FKquG3l+qfv8BgvaCbYzMmuhnukCEHXhUukE=|cJRZWq05xjPBayUgx6P6gsbtNVLi8exQwo8F1SfqQQ4=",
externalId: "",
readOnly: false,
manage: false,
hidePasswords: false,
},
},
},
otherStuff: "otherStuff2",
},
otherStuff: "otherStuff3",
},
"user-2": {
data: {
otherStuff: "otherStuff4",
},
otherStuff: "otherStuff5",
},
};
}
function rollbackJSON() {
return {
"user_user-1_collection_collections": {
"877fef70-be32-439e-8678-b0d80125653d": {
id: "877fef70-be32-439e-8678-b0d80125653d",
organizationId: "fe1ff6ef-d2d4-49f3-9c07-b0c7013998f9",
name: "2.MD9OMDsvYiU1CTSUxjHorw==|uFc4cZhnmQmK2LFCWbyeZg==|syk2d9JESeplxInLvP36BK5RhqS1c/i+ZQp5NR7EUA4=",
externalId: "",
readOnly: false,
manage: true,
hidePasswords: false,
},
"0d3fee82-3f81-434c-aed0-b0c200ee6c7a": {
id: "0d3fee82-3f81-434c-aed0-b0c200ee6c7a",
organizationId: "5f277723-6391-4b5c-add9-b0c200ee6967",
name: "2.GxnXkIbBCGFr57F6lT7+Ow==|3ctMg95FKquG3l+qfv8BgvaCbYzMmuhnukCEHXhUukE=|cJRZWq05xjPBayUgx6P6gsbtNVLi8exQwo8F1SfqQQ4=",
externalId: "",
readOnly: false,
manage: false,
hidePasswords: false,
},
},
"user_user-2_collection_data": null as any,
global: {
otherStuff: "otherStuff1",
},
authenticatedAccounts: ["user-1", "user-2"],
"user-1": {
data: {
otherStuff: "otherStuff2",
},
otherStuff: "otherStuff3",
},
"user-2": {
data: {
otherStuff: "otherStuff4",
},
otherStuff: "otherStuff5",
},
};
}
describe("CollectionMigrator", () => {
let helper: MockProxy<MigrationHelper>;
let sut: CollectionMigrator;
const keyDefinitionLike = {
key: "collections",
stateDefinition: {
name: "collection",
},
};
describe("migrate", () => {
beforeEach(() => {
helper = mockMigrationHelper(exampleJSON(), 20);
sut = new CollectionMigrator(20, 21);
});
it("should remove collections from all accounts", async () => {
await sut.migrate(helper);
expect(helper.set).toHaveBeenCalledWith("user-1", {
data: {
otherStuff: "otherStuff2",
},
otherStuff: "otherStuff3",
});
});
it("should set collections value for each account", async () => {
await sut.migrate(helper);
expect(helper.setToUser).toHaveBeenCalledWith("user-1", keyDefinitionLike, {
"877fef70-be32-439e-8678-b0d80125653d": {
id: "877fef70-be32-439e-8678-b0d80125653d",
organizationId: "fe1ff6ef-d2d4-49f3-9c07-b0c7013998f9",
name: "2.MD9OMDsvYiU1CTSUxjHorw==|uFc4cZhnmQmK2LFCWbyeZg==|syk2d9JESeplxInLvP36BK5RhqS1c/i+ZQp5NR7EUA4=",
externalId: "",
readOnly: false,
manage: true,
hidePasswords: false,
},
"0d3fee82-3f81-434c-aed0-b0c200ee6c7a": {
id: "0d3fee82-3f81-434c-aed0-b0c200ee6c7a",
organizationId: "5f277723-6391-4b5c-add9-b0c200ee6967",
name: "2.GxnXkIbBCGFr57F6lT7+Ow==|3ctMg95FKquG3l+qfv8BgvaCbYzMmuhnukCEHXhUukE=|cJRZWq05xjPBayUgx6P6gsbtNVLi8exQwo8F1SfqQQ4=",
externalId: "",
readOnly: false,
manage: false,
hidePasswords: false,
},
});
});
});
describe("rollback", () => {
beforeEach(() => {
helper = mockMigrationHelper(rollbackJSON(), 21);
sut = new CollectionMigrator(20, 21);
});
it.each(["user-1", "user-2"])("should null out new values", async (userId) => {
await sut.rollback(helper);
expect(helper.setToUser).toHaveBeenCalledWith(userId, keyDefinitionLike, null);
});
it("should add collection values back to accounts", async () => {
await sut.rollback(helper);
expect(helper.set).toHaveBeenCalled();
expect(helper.set).toHaveBeenCalledWith("user-1", {
data: {
collections: {
encrypted: {
"877fef70-be32-439e-8678-b0d80125653d": {
id: "877fef70-be32-439e-8678-b0d80125653d",
organizationId: "fe1ff6ef-d2d4-49f3-9c07-b0c7013998f9",
name: "2.MD9OMDsvYiU1CTSUxjHorw==|uFc4cZhnmQmK2LFCWbyeZg==|syk2d9JESeplxInLvP36BK5RhqS1c/i+ZQp5NR7EUA4=",
externalId: "",
readOnly: false,
manage: true,
hidePasswords: false,
},
"0d3fee82-3f81-434c-aed0-b0c200ee6c7a": {
id: "0d3fee82-3f81-434c-aed0-b0c200ee6c7a",
organizationId: "5f277723-6391-4b5c-add9-b0c200ee6967",
name: "2.GxnXkIbBCGFr57F6lT7+Ow==|3ctMg95FKquG3l+qfv8BgvaCbYzMmuhnukCEHXhUukE=|cJRZWq05xjPBayUgx6P6gsbtNVLi8exQwo8F1SfqQQ4=",
externalId: "",
readOnly: false,
manage: false,
hidePasswords: false,
},
},
},
otherStuff: "otherStuff2",
},
otherStuff: "otherStuff3",
});
});
it("should not try to restore values to missing accounts", async () => {
await sut.rollback(helper);
expect(helper.set).not.toHaveBeenCalledWith("user-3", any());
});
});
});

63
libs/common/src/state-migrations/migrations/21-move-collections-state-to-state-provider.ts Normal file
View File

@@ -0,0 +1,63 @@
import { KeyDefinitionLike, MigrationHelper } from "../migration-helper";
import { Migrator } from "../migrator";
type CollectionDataType = {
id: string;
organizationId: string;
name: string;
externalId: string;
readOnly: boolean;
manage: boolean;
hidePasswords: boolean;
};
type ExpectedAccountType = {
data?: {
collections?: {
encrypted?: Record<string, CollectionDataType>;
};
};
};
const USER_ENCRYPTED_COLLECTIONS: KeyDefinitionLike = {
key: "collections",
stateDefinition: {
name: "collection",
},
};
export class CollectionMigrator extends Migrator<20, 21> {
async migrate(helper: MigrationHelper): Promise<void> {
const accounts = await helper.getAccounts<ExpectedAccountType>();
async function migrateAccount(userId: string, account: ExpectedAccountType): Promise<void> {
const value = account?.data?.collections?.encrypted;
if (value != null) {
await helper.setToUser(userId, USER_ENCRYPTED_COLLECTIONS, value);
delete account.data.collections;
await helper.set(userId, account);
}
}
await Promise.all([...accounts.map(({ userId, account }) => migrateAccount(userId, account))]);
}
async rollback(helper: MigrationHelper): Promise<void> {
const accounts = await helper.getAccounts<ExpectedAccountType>();
async function rollbackAccount(userId: string, account: ExpectedAccountType): Promise<void> {
const value = await helper.getFromUser(userId, USER_ENCRYPTED_COLLECTIONS);
if (account) {
account.data = Object.assign(account.data ?? {}, {
collections: {
encrypted: value,
},
});
await helper.set(userId, account);
}
await helper.setToUser(userId, USER_ENCRYPTED_COLLECTIONS, null);
}
await Promise.all([...accounts.map(({ userId, account }) => rollbackAccount(userId, account))]);
}
}