2022-10-10 17:19:01 +02:00
|
|
|
// eslint-disable-next-line no-restricted-imports
|
2022-02-14 14:16:07 +01:00
|
|
|
import { Arg, Substitute, SubstituteOf } from "@fluffy-spoon/substitute";
|
|
|
|
|
2022-06-27 19:38:12 +02:00
|
|
|
import { AbstractStorageService } from "@bitwarden/common/abstractions/storage.service";
|
[AC-1266] Enums filename conventions (#5140)
* refactor: update clientType enum
* refactor: update deviceType filename
* refactor: update encryptedExportType filename
* refactor: update encryptionType filename
* refactor: update eventType filename
* refactor: update fieldType filename
* refactor: update fileUploadType filename
* refactor: update hashPurpose filename
* refactor: update htmlStorageLocation filename
* refactor: update kdfType filename
* refactor: update keySuffixOptions filename
* refactor: update linkedIdType filename
* refactor: update logLevelType filename
* refactor: update nativeMessagingVersion filename
* refactor: update notificationType filename
* refactor: update productType filename
* refactor: update secureNoteType filename
* refactor: update stateVersion filename
* refactor: update storageLocation filename
* refactor: update themeType filename
* refactor: update uriMatchType filename
* fix: update kdfType classes missed in initial pass, refs AC-1266
* fix: missing import update for device-type
* refactor: add barrel file for enums and update pathed import statements, refs AC-1266
* fix: incorrect import statements for web, refs AC-1266
* fix: missed import statement updates (browser), refs AC-1266
* fix: missed import statement changes (cli), refs AC-1266
* fix: missed import statement changes (desktop), refs AC-1266
* fix: prettier, refs AC-1266
* refactor: (libs) update relative paths to use barrel file, refs AC-1266
* fix: missed find/replace import statements for SecureNoteType, refs AC-1266
* refactor: apply .enum suffix to enums folder and modify leftover relative paths, refs AC-1266
* fix: find/replace errors for native-messaging-version, refs AC-1266
2023-04-05 05:42:21 +02:00
|
|
|
import { StateVersion } from "@bitwarden/common/enums";
|
2022-06-14 17:10:53 +02:00
|
|
|
import { StateFactory } from "@bitwarden/common/factories/stateFactory";
|
|
|
|
import { Account } from "@bitwarden/common/models/domain/account";
|
2022-10-14 18:25:50 +02:00
|
|
|
import { GlobalState } from "@bitwarden/common/models/domain/global-state";
|
2022-06-14 17:10:53 +02:00
|
|
|
import { StateMigrationService } from "@bitwarden/common/services/stateMigration.service";
|
2022-02-14 14:16:07 +01:00
|
|
|
|
|
|
|
const userId = "USER_ID";
|
|
|
|
|
2022-07-12 23:08:07 +02:00
|
|
|
// Note: each test calls the private migration method for that migration,
|
|
|
|
// so that we don't accidentally run all following migrations as well
|
|
|
|
|
2022-02-14 14:16:07 +01:00
|
|
|
describe("State Migration Service", () => {
|
2022-06-27 19:38:12 +02:00
|
|
|
let storageService: SubstituteOf<AbstractStorageService>;
|
|
|
|
let secureStorageService: SubstituteOf<AbstractStorageService>;
|
2022-02-14 14:16:07 +01:00
|
|
|
let stateFactory: SubstituteOf<StateFactory>;
|
|
|
|
|
|
|
|
let stateMigrationService: StateMigrationService;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
2022-06-27 19:38:12 +02:00
|
|
|
storageService = Substitute.for<AbstractStorageService>();
|
|
|
|
secureStorageService = Substitute.for<AbstractStorageService>();
|
2022-02-14 14:16:07 +01:00
|
|
|
stateFactory = Substitute.for<StateFactory>();
|
|
|
|
|
|
|
|
stateMigrationService = new StateMigrationService(
|
|
|
|
storageService,
|
|
|
|
secureStorageService,
|
|
|
|
stateFactory
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
2022-06-27 19:38:12 +02:00
|
|
|
describe("StateVersion 3 to 4 migration", () => {
|
2022-02-14 14:16:07 +01:00
|
|
|
beforeEach(() => {
|
|
|
|
const globalVersion3: Partial<GlobalState> = {
|
|
|
|
stateVersion: StateVersion.Three,
|
|
|
|
};
|
|
|
|
|
|
|
|
storageService.get("global", Arg.any()).resolves(globalVersion3);
|
|
|
|
storageService.get("authenticatedAccounts", Arg.any()).resolves([userId]);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("clears everBeenUnlocked", async () => {
|
|
|
|
const accountVersion3: Account = {
|
|
|
|
profile: {
|
|
|
|
apiKeyClientId: null,
|
|
|
|
convertAccountToKeyConnector: null,
|
|
|
|
email: "EMAIL",
|
|
|
|
emailVerified: true,
|
|
|
|
everBeenUnlocked: true,
|
|
|
|
hasPremiumPersonally: false,
|
|
|
|
kdfIterations: 100000,
|
|
|
|
kdfType: 0,
|
|
|
|
keyHash: "KEY_HASH",
|
|
|
|
lastSync: "LAST_SYNC",
|
|
|
|
userId: userId,
|
|
|
|
usesKeyConnector: false,
|
2023-04-17 16:35:37 +02:00
|
|
|
forcePasswordResetReason: null,
|
2022-02-14 14:16:07 +01:00
|
|
|
},
|
|
|
|
};
|
|
|
|
|
|
|
|
const expectedAccountVersion4: Account = {
|
|
|
|
profile: {
|
|
|
|
...accountVersion3.profile,
|
|
|
|
},
|
|
|
|
};
|
|
|
|
delete expectedAccountVersion4.profile.everBeenUnlocked;
|
|
|
|
|
|
|
|
storageService.get(userId, Arg.any()).resolves(accountVersion3);
|
|
|
|
|
2022-07-12 23:08:07 +02:00
|
|
|
await (stateMigrationService as any).migrateStateFrom3To4();
|
2022-02-14 14:16:07 +01:00
|
|
|
|
|
|
|
storageService.received(1).save(userId, expectedAccountVersion4, Arg.any());
|
|
|
|
});
|
|
|
|
|
|
|
|
it("updates StateVersion number", async () => {
|
2022-07-12 23:08:07 +02:00
|
|
|
await (stateMigrationService as any).migrateStateFrom3To4();
|
2022-02-14 14:16:07 +01:00
|
|
|
|
|
|
|
storageService.received(1).save(
|
|
|
|
"global",
|
|
|
|
Arg.is((globals: GlobalState) => globals.stateVersion === StateVersion.Four),
|
|
|
|
Arg.any()
|
|
|
|
);
|
|
|
|
});
|
|
|
|
});
|
2022-07-12 23:08:07 +02:00
|
|
|
|
|
|
|
describe("StateVersion 4 to 5 migration", () => {
|
|
|
|
it("migrates organization keys to new format", async () => {
|
|
|
|
const accountVersion4 = new Account({
|
|
|
|
keys: {
|
|
|
|
organizationKeys: {
|
|
|
|
encrypted: {
|
|
|
|
orgOneId: "orgOneEncKey",
|
|
|
|
orgTwoId: "orgTwoEncKey",
|
|
|
|
orgThreeId: "orgThreeEncKey",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
} as any);
|
|
|
|
|
|
|
|
const expectedAccount = new Account({
|
|
|
|
keys: {
|
|
|
|
organizationKeys: {
|
|
|
|
encrypted: {
|
|
|
|
orgOneId: {
|
|
|
|
type: "organization",
|
|
|
|
key: "orgOneEncKey",
|
|
|
|
},
|
|
|
|
orgTwoId: {
|
|
|
|
type: "organization",
|
|
|
|
key: "orgTwoEncKey",
|
|
|
|
},
|
|
|
|
orgThreeId: {
|
|
|
|
type: "organization",
|
|
|
|
key: "orgThreeEncKey",
|
|
|
|
},
|
|
|
|
},
|
2022-09-22 14:51:14 +02:00
|
|
|
} as any,
|
|
|
|
} as any,
|
2022-07-12 23:08:07 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
const migratedAccount = await (stateMigrationService as any).migrateAccountFrom4To5(
|
|
|
|
accountVersion4
|
|
|
|
);
|
|
|
|
|
|
|
|
expect(migratedAccount).toEqual(expectedAccount);
|
|
|
|
});
|
|
|
|
});
|
2022-08-03 23:09:36 +02:00
|
|
|
|
|
|
|
describe("StateVersion 5 to 6 migration", () => {
|
|
|
|
it("deletes account.keys.legacyEtmKey value", async () => {
|
|
|
|
const accountVersion5 = new Account({
|
|
|
|
keys: {
|
|
|
|
legacyEtmKey: "legacy key",
|
|
|
|
},
|
|
|
|
} as any);
|
|
|
|
|
|
|
|
const migratedAccount = await (stateMigrationService as any).migrateAccountFrom5To6(
|
|
|
|
accountVersion5
|
|
|
|
);
|
|
|
|
|
|
|
|
expect(migratedAccount.keys.legacyEtmKey).toBeUndefined();
|
|
|
|
});
|
|
|
|
});
|
2022-02-14 14:16:07 +01:00
|
|
|
});
|