mirror of
https://github.com/bitwarden/browser
synced 2025-12-15 07:43:35 +00:00
7d47f1496c
* Added missing get$ method on SendService * Added distinctUntilChanged to the get$ method and added more tests * Added more validations and tests to get$ * Added some more test cases to get$ * Refactored test cases from get$
538 lines
16 KiB
TypeScript
538 lines
16 KiB
TypeScript
import { any, mock, MockProxy } from "jest-mock-extended";
|
|
import { BehaviorSubject, firstValueFrom } from "rxjs";
|
|
|
|
import { CryptoFunctionService } from "../../../platform/abstractions/crypto-function.service";
|
|
import { CryptoService } from "../../../platform/abstractions/crypto.service";
|
|
import { EncryptService } from "../../../platform/abstractions/encrypt.service";
|
|
import { I18nService } from "../../../platform/abstractions/i18n.service";
|
|
import { StateService } from "../../../platform/abstractions/state.service";
|
|
import { EncString } from "../../../platform/models/domain/enc-string";
|
|
import { SymmetricCryptoKey } from "../../../platform/models/domain/symmetric-crypto-key";
|
|
import { ContainerService } from "../../../platform/services/container.service";
|
|
import { UserKey } from "../../../types/key";
|
|
import { SendType } from "../enums/send-type";
|
|
import { SendFileApi } from "../models/api/send-file.api";
|
|
import { SendTextApi } from "../models/api/send-text.api";
|
|
import { SendFileData } from "../models/data/send-file.data";
|
|
import { SendTextData } from "../models/data/send-text.data";
|
|
import { SendData } from "../models/data/send.data";
|
|
import { Send } from "../models/domain/send";
|
|
import { SendView } from "../models/view/send.view";
|
|
|
|
import { SendService } from "./send.service";
|
|
|
|
describe("SendService", () => {
|
|
const cryptoService = mock<CryptoService>();
|
|
const i18nService = mock<I18nService>();
|
|
const cryptoFunctionService = mock<CryptoFunctionService>();
|
|
const encryptService = mock<EncryptService>();
|
|
|
|
let sendService: SendService;
|
|
|
|
let stateService: MockProxy<StateService>;
|
|
let activeAccount: BehaviorSubject<string>;
|
|
let activeAccountUnlocked: BehaviorSubject<boolean>;
|
|
|
|
beforeEach(() => {
|
|
activeAccount = new BehaviorSubject("123");
|
|
activeAccountUnlocked = new BehaviorSubject(true);
|
|
|
|
stateService = mock<StateService>();
|
|
stateService.activeAccount$ = activeAccount;
|
|
stateService.activeAccountUnlocked$ = activeAccountUnlocked;
|
|
(window as any).bitwardenContainerService = new ContainerService(cryptoService, encryptService);
|
|
|
|
stateService.getEncryptedSends.calledWith(any()).mockResolvedValue({
|
|
"1": sendData("1", "Test Send"),
|
|
});
|
|
|
|
stateService.getDecryptedSends
|
|
.calledWith(any())
|
|
.mockResolvedValue([sendView("1", "Test Send")]);
|
|
|
|
sendService = new SendService(cryptoService, i18nService, cryptoFunctionService, stateService);
|
|
});
|
|
|
|
afterEach(() => {
|
|
activeAccount.complete();
|
|
activeAccountUnlocked.complete();
|
|
});
|
|
|
|
describe("get", () => {
|
|
it("exists", async () => {
|
|
const result = sendService.get("1");
|
|
|
|
expect(result).toEqual(send("1", "Test Send"));
|
|
});
|
|
|
|
it("does not exist", async () => {
|
|
const result = sendService.get("2");
|
|
|
|
expect(result).toBe(undefined);
|
|
});
|
|
});
|
|
|
|
describe("get$", () => {
|
|
it("exists", async () => {
|
|
const result = await firstValueFrom(sendService.get$("1"));
|
|
|
|
expect(result).toEqual(send("1", "Test Send"));
|
|
});
|
|
|
|
it("does not exist", async () => {
|
|
const result = await firstValueFrom(sendService.get$("2"));
|
|
|
|
expect(result).toBe(undefined);
|
|
});
|
|
|
|
it("updated observable", async () => {
|
|
const singleSendObservable = sendService.get$("1");
|
|
const result = await firstValueFrom(singleSendObservable);
|
|
expect(result).toEqual(send("1", "Test Send"));
|
|
|
|
await sendService.replace({
|
|
"1": sendData("1", "Test Send Updated"),
|
|
});
|
|
|
|
const result2 = await firstValueFrom(singleSendObservable);
|
|
expect(result2).toEqual(send("1", "Test Send Updated"));
|
|
});
|
|
|
|
it("reports a change when name changes on a new send", async () => {
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
const sendDataObject = sendData("1", "Test Send 2");
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("reports a change when notes changes on a new send", async () => {
|
|
const sendDataObject = createSendData() as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
sendDataObject.notes = "New notes";
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("reports a change when Text changes on a new send", async () => {
|
|
const sendDataObject = createSendData() as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
sendDataObject.text.text = "new text";
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("reports a change when Text is set as null on a new send", async () => {
|
|
const sendDataObject = createSendData() as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
sendDataObject.text = null;
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("Doesn't reports a change when File changes on a new send", async () => {
|
|
const sendDataObject = createSendData({
|
|
type: SendType.File,
|
|
file: new SendFileData(new SendFileApi({ FileName: "name of file" })),
|
|
}) as SendData;
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
sendDataObject.file = new SendFileData(new SendFileApi({ FileName: "updated name of file" }));
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(false);
|
|
});
|
|
|
|
it("reports a change when key changes on a new send", async () => {
|
|
const sendDataObject = createSendData() as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
sendDataObject.key = "newKey";
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("reports a change when revisionDate changes on a new send", async () => {
|
|
const sendDataObject = createSendData() as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
sendDataObject.revisionDate = "2025-04-05";
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("reports a change when a property is set as null on a new send", async () => {
|
|
const sendDataObject = createSendData() as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
sendDataObject.name = null;
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("does not reports a change when text's text is set as null on a new send and old send and reports a change then new send sets a text", async () => {
|
|
const sendDataObject = createSendData({
|
|
text: new SendTextData(new SendTextApi({ Text: null })),
|
|
}) as SendData;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(false);
|
|
|
|
sendDataObject.text.text = "Asdf";
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
|
|
it("do not reports a change when nothing changes on the observed send", async () => {
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
|
|
const sendDataObject = sendData("1", "Test Send");
|
|
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
await sendService.replace({
|
|
"1": sendDataObject,
|
|
"2": sendData("3", "Test Send 3"),
|
|
});
|
|
|
|
expect(changed).toEqual(false);
|
|
});
|
|
|
|
it("reports a change when the observed send is deleted", async () => {
|
|
let changed = false;
|
|
sendService.get$("1").subscribe(() => {
|
|
changed = true;
|
|
});
|
|
//it is immediately called when subscribed, we need to reset the value
|
|
changed = false;
|
|
|
|
await sendService.replace({
|
|
"2": sendData("2", "Test Send 2"),
|
|
});
|
|
|
|
expect(changed).toEqual(true);
|
|
});
|
|
});
|
|
|
|
it("getAll", async () => {
|
|
const sends = await sendService.getAll();
|
|
const send1 = sends[0];
|
|
|
|
expect(sends).toHaveLength(1);
|
|
expect(send1).toEqual(send("1", "Test Send"));
|
|
});
|
|
|
|
describe("getFromState", () => {
|
|
it("exists", async () => {
|
|
const result = await sendService.getFromState("1");
|
|
|
|
expect(result).toEqual(send("1", "Test Send"));
|
|
});
|
|
it("does not exist", async () => {
|
|
const result = await sendService.getFromState("2");
|
|
|
|
expect(result).toBe(null);
|
|
});
|
|
});
|
|
|
|
it("getAllDecryptedFromState", async () => {
|
|
await sendService.getAllDecryptedFromState();
|
|
|
|
expect(stateService.getDecryptedSends).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
describe("getRotatedKeys", () => {
|
|
let encryptedKey: EncString;
|
|
beforeEach(() => {
|
|
cryptoService.decryptToBytes.mockResolvedValue(new Uint8Array(32));
|
|
encryptedKey = new EncString("Re-encrypted Send Key");
|
|
cryptoService.encrypt.mockResolvedValue(encryptedKey);
|
|
});
|
|
|
|
it("returns re-encrypted user sends", async () => {
|
|
const newUserKey = new SymmetricCryptoKey(new Uint8Array(32)) as UserKey;
|
|
const result = await sendService.getRotatedKeys(newUserKey);
|
|
|
|
expect(result).toMatchObject([{ id: "1", key: "Re-encrypted Send Key" }]);
|
|
});
|
|
|
|
it("returns null if there are no sends", async () => {
|
|
// FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
|
|
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
|
sendService.replace(null);
|
|
|
|
const newUserKey = new SymmetricCryptoKey(new Uint8Array(32)) as UserKey;
|
|
const result = await sendService.getRotatedKeys(newUserKey);
|
|
|
|
expect(result).toEqual([]);
|
|
});
|
|
|
|
it("throws if the new user key is null", async () => {
|
|
await expect(sendService.getRotatedKeys(null)).rejects.toThrowError(
|
|
"New user key is required for rotation.",
|
|
);
|
|
});
|
|
});
|
|
|
|
// InternalSendService
|
|
|
|
it("upsert", async () => {
|
|
await sendService.upsert(sendData("2", "Test 2"));
|
|
|
|
expect(await firstValueFrom(sendService.sends$)).toEqual([
|
|
send("1", "Test Send"),
|
|
send("2", "Test 2"),
|
|
]);
|
|
});
|
|
|
|
it("replace", async () => {
|
|
await sendService.replace({ "2": sendData("2", "test 2") });
|
|
|
|
expect(await firstValueFrom(sendService.sends$)).toEqual([send("2", "test 2")]);
|
|
});
|
|
|
|
it("clear", async () => {
|
|
await sendService.clear();
|
|
|
|
expect(await firstValueFrom(sendService.sends$)).toEqual([]);
|
|
});
|
|
|
|
describe("delete", () => {
|
|
it("exists", async () => {
|
|
await sendService.delete("1");
|
|
|
|
expect(stateService.getEncryptedSends).toHaveBeenCalledTimes(2);
|
|
expect(stateService.setEncryptedSends).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it("does not exist", async () => {
|
|
// FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
|
|
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
|
sendService.delete("1");
|
|
|
|
expect(stateService.getEncryptedSends).toHaveBeenCalledTimes(2);
|
|
});
|
|
});
|
|
|
|
// Send object helper functions
|
|
|
|
function sendData(id: string, name: string) {
|
|
const data = new SendData({} as any);
|
|
data.id = id;
|
|
data.name = name;
|
|
data.disabled = false;
|
|
data.accessCount = 2;
|
|
data.accessId = "1";
|
|
data.revisionDate = null;
|
|
data.expirationDate = null;
|
|
data.deletionDate = null;
|
|
data.notes = "Notes!!";
|
|
data.key = null;
|
|
return data;
|
|
}
|
|
|
|
const defaultSendData: Partial<SendData> = {
|
|
id: "1",
|
|
name: "Test Send",
|
|
accessId: "123",
|
|
type: SendType.Text,
|
|
notes: "notes!",
|
|
file: null,
|
|
text: new SendTextData(new SendTextApi({ Text: "send text" })),
|
|
key: "key",
|
|
maxAccessCount: 12,
|
|
accessCount: 2,
|
|
revisionDate: "2024-09-04",
|
|
expirationDate: "2024-09-04",
|
|
deletionDate: "2024-09-04",
|
|
password: "password",
|
|
disabled: false,
|
|
hideEmail: false,
|
|
};
|
|
|
|
function createSendData(value: Partial<SendData> = {}) {
|
|
const testSend: any = {};
|
|
for (const prop in defaultSendData) {
|
|
testSend[prop] = value[prop as keyof SendData] ?? defaultSendData[prop as keyof SendData];
|
|
}
|
|
return testSend;
|
|
}
|
|
|
|
function sendView(id: string, name: string) {
|
|
const data = new SendView({} as any);
|
|
data.id = id;
|
|
data.name = name;
|
|
data.disabled = false;
|
|
data.accessCount = 2;
|
|
data.accessId = "1";
|
|
data.revisionDate = null;
|
|
data.expirationDate = null;
|
|
data.deletionDate = null;
|
|
data.notes = "Notes!!";
|
|
data.key = null;
|
|
return data;
|
|
}
|
|
|
|
function send(id: string, name: string) {
|
|
const data = new Send({} as any);
|
|
data.id = id;
|
|
data.name = new EncString(name);
|
|
data.disabled = false;
|
|
data.accessCount = 2;
|
|
data.accessId = "1";
|
|
data.revisionDate = null;
|
|
data.expirationDate = null;
|
|
data.deletionDate = null;
|
|
data.notes = new EncString("Notes!!");
|
|
data.key = null;
|
|
return data;
|
|
}
|
|
});
|