mirror of
https://github.com/bitwarden/browser
synced 2026-03-02 03:21:19 +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>
85 lines
2.9 KiB
TypeScript
85 lines
2.9 KiB
TypeScript
import { MockProxy, mock } from "jest-mock-extended";
|
|
|
|
// eslint-disable-next-line import/no-restricted-paths -- Needed to print log messages
|
|
import { LogService } from "../platform/abstractions/log.service";
|
|
// eslint-disable-next-line import/no-restricted-paths -- Needed to interface with storage locations
|
|
import { AbstractStorageService } from "../platform/abstractions/storage.service";
|
|
|
|
import { MigrationHelper } from "./migration-helper";
|
|
|
|
const exampleJSON = {
|
|
authenticatedAccounts: [
|
|
"c493ed01-4e08-4e88-abc7-332f380ca760",
|
|
"23e61a5f-2ece-4f5e-b499-f0bc489482a9",
|
|
],
|
|
"c493ed01-4e08-4e88-abc7-332f380ca760": {
|
|
otherStuff: "otherStuff1",
|
|
},
|
|
"23e61a5f-2ece-4f5e-b499-f0bc489482a9": {
|
|
otherStuff: "otherStuff2",
|
|
},
|
|
};
|
|
|
|
describe("RemoveLegacyEtmKeyMigrator", () => {
|
|
let storage: MockProxy<AbstractStorageService>;
|
|
let logService: MockProxy<LogService>;
|
|
let sut: MigrationHelper;
|
|
|
|
beforeEach(() => {
|
|
logService = mock();
|
|
storage = mock();
|
|
storage.get.mockImplementation((key) => (exampleJSON as any)[key]);
|
|
|
|
sut = new MigrationHelper(0, storage, logService);
|
|
});
|
|
|
|
describe("get", () => {
|
|
it("should delegate to storage.get", async () => {
|
|
await sut.get("key");
|
|
expect(storage.get).toHaveBeenCalledWith("key");
|
|
});
|
|
});
|
|
|
|
describe("set", () => {
|
|
it("should delegate to storage.save", async () => {
|
|
await sut.set("key", "value");
|
|
expect(storage.save).toHaveBeenCalledWith("key", "value");
|
|
});
|
|
});
|
|
|
|
describe("getAccounts", () => {
|
|
it("should return all accounts", async () => {
|
|
const accounts = await sut.getAccounts();
|
|
expect(accounts).toEqual([
|
|
{ userId: "c493ed01-4e08-4e88-abc7-332f380ca760", account: { otherStuff: "otherStuff1" } },
|
|
{ userId: "23e61a5f-2ece-4f5e-b499-f0bc489482a9", account: { otherStuff: "otherStuff2" } },
|
|
]);
|
|
});
|
|
|
|
it("should handle missing authenticatedAccounts", async () => {
|
|
storage.get.mockImplementation((key) =>
|
|
key === "authenticatedAccounts" ? undefined : (exampleJSON as any)[key]
|
|
);
|
|
const accounts = await sut.getAccounts();
|
|
expect(accounts).toEqual([]);
|
|
});
|
|
});
|
|
});
|
|
|
|
/** Helper to create well-mocked migration helpers in migration tests */
|
|
export function mockMigrationHelper(storageJson: any): MockProxy<MigrationHelper> {
|
|
const logService: MockProxy<LogService> = mock();
|
|
const storage: MockProxy<AbstractStorageService> = mock();
|
|
storage.get.mockImplementation((key) => (storageJson as any)[key]);
|
|
storage.save.mockImplementation(async (key, value) => {
|
|
(storageJson as any)[key] = value;
|
|
});
|
|
const helper = new MigrationHelper(0, storage, logService);
|
|
|
|
const mockHelper = mock<MigrationHelper>();
|
|
mockHelper.get.mockImplementation((key) => helper.get(key));
|
|
mockHelper.set.mockImplementation((key, value) => helper.set(key, value));
|
|
mockHelper.getAccounts.mockImplementation(() => helper.getAccounts());
|
|
return mockHelper;
|
|
}
|