Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PM-16917] Remove jest-extended dependency #12798

Merged
merged 11 commits into from
Jan 15, 2025
2 changes: 1 addition & 1 deletion .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,10 @@
"eslint-plugin-storybook",
"eslint-plugin-tailwindcss",
"husky",
"jest-extended",
"jest-junit",
"jest-mock-extended",
"jest-preset-angular",
"jest-diff",
Hinton marked this conversation as resolved.
Show resolved Hide resolved
"lint-staged",
"ts-jest"
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ describe("VaultHeaderV2Component", () => {
it("defaults the initial state to true", (done) => {
// The initial value of the `state$` variable above is undefined
component["initialDisclosureVisibility$"].subscribe((initialVisibility) => {
expect(initialVisibility).toBeTrue();
expect(initialVisibility).toBe(true);
done();
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,31 +179,31 @@ describe("ViewV2Component", () => {

flush(); // Resolve all promises

expect(doAutofill).toHaveBeenCalledOnce();
expect(doAutofill).toHaveBeenCalledTimes(1);
}));

it('invokes `copy` when action="copy-username"', fakeAsync(() => {
params$.next({ action: COPY_USERNAME_ID });

flush(); // Resolve all promises

expect(copy).toHaveBeenCalledOnce();
expect(copy).toHaveBeenCalledTimes(1);
}));

it('invokes `copy` when action="copy-password"', fakeAsync(() => {
params$.next({ action: COPY_PASSWORD_ID });

flush(); // Resolve all promises

expect(copy).toHaveBeenCalledOnce();
expect(copy).toHaveBeenCalledTimes(1);
}));

it('invokes `copy` when action="copy-totp"', fakeAsync(() => {
params$.next({ action: COPY_VERIFICATION_CODE_ID });

flush(); // Resolve all promises

expect(copy).toHaveBeenCalledOnce();
expect(copy).toHaveBeenCalledTimes(1);
}));

it("closes the popout after a load action", fakeAsync(() => {
Expand All @@ -218,9 +218,9 @@ describe("ViewV2Component", () => {

flush(); // Resolve all promises

expect(doAutofill).toHaveBeenCalledOnce();
expect(doAutofill).toHaveBeenCalledTimes(1);
expect(focusSpy).toHaveBeenCalledWith(99);
expect(closeSpy).toHaveBeenCalledOnce();
expect(closeSpy).toHaveBeenCalledTimes(1);
}));
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -488,15 +488,15 @@ describe("VaultPopupListFiltersService", () => {
state$.next(true);

service.filterVisibilityState$.subscribe((filterVisibility) => {
expect(filterVisibility).toBeTrue();
expect(filterVisibility).toBe(true);
done();
});
});

it("updates stored filter state", async () => {
await service.updateFilterVisibility(false);

expect(update).toHaveBeenCalledOnce();
expect(update).toHaveBeenCalledTimes(1);
// Get callback passed to `update`
const updateCallback = update.mock.calls[0][0];
expect(updateCallback()).toBe(false);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ describe("DefaultvNextCollectionService", () => {

// Assert emitted values
expect(result.length).toBe(2);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{
id: collection1.id,
name: "DEC_NAME_" + collection1.id,
Expand Down Expand Up @@ -167,7 +167,7 @@ describe("DefaultvNextCollectionService", () => {
const result = await firstValueFrom(collectionService.encryptedCollections$(userId));

expect(result.length).toBe(2);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{
id: collection1.id,
name: makeEncString("ENC_NAME_" + collection1.id),
Expand Down Expand Up @@ -205,7 +205,7 @@ describe("DefaultvNextCollectionService", () => {

const result = await firstValueFrom(collectionService.encryptedCollections$(userId));
expect(result.length).toBe(3);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{
id: collection1.id,
name: makeEncString("UPDATED_ENC_NAME_" + collection1.id),
Expand All @@ -230,7 +230,7 @@ describe("DefaultvNextCollectionService", () => {

const result = await firstValueFrom(collectionService.encryptedCollections$(userId));
expect(result.length).toBe(1);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{
id: collection1.id,
name: makeEncString("ENC_NAME_" + collection1.id),
Expand All @@ -253,7 +253,7 @@ describe("DefaultvNextCollectionService", () => {

const result = await firstValueFrom(collectionService.encryptedCollections$(userId));
expect(result.length).toBe(1);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{
id: newCollection3.id,
name: makeEncString("ENC_NAME_" + newCollection3.id),
Expand Down
4 changes: 4 additions & 0 deletions libs/admin-console/test.setup.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { webcrypto } from "crypto";

import { addCustomMatchers } from "@bitwarden/common/spec";
import "jest-preset-angular/setup-jest";

addCustomMatchers();

Object.defineProperty(window, "CSS", { value: null });
Object.defineProperty(window, "getComputedStyle", {
value: () => {
Expand Down
2 changes: 1 addition & 1 deletion libs/admin-console/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"@bitwarden/key-management": ["../key-management/src"]
}
},
"include": ["src", "spec"],
"include": ["src", "spec", "../../libs/common/custom-matchers.d.ts"],
Hinton marked this conversation as resolved.
Show resolved Hide resolved
"exclude": ["node_modules", "dist"]
}
12 changes: 7 additions & 5 deletions libs/common/spec/matchers/index.ts
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
import * as matchers from "jest-extended";

import { toBeFulfilled, toBeResolved, toBeRejected } from "./promise-fulfilled";
import { toAlmostEqual } from "./to-almost-equal";
import { toContainPartialObjects } from "./to-contain-partial-objects";
import { toEqualBuffer } from "./to-equal-buffer";

export * from "./to-equal-buffer";
export * from "./to-almost-equal";
export * from "./promise-fulfilled";

// add all jest-extended matchers
expect.extend(matchers);

export function addCustomMatchers() {
expect.extend({
toEqualBuffer: toEqualBuffer,
toAlmostEqual: toAlmostEqual,
toBeFulfilled: toBeFulfilled,
toBeResolved: toBeResolved,
toBeRejected: toBeRejected,
toContainPartialObjects,
});
}

Expand Down Expand Up @@ -59,4 +56,9 @@ export interface CustomMatchers<R = unknown> {
* @returns CustomMatcherResult indicating whether or not the test passed
*/
toBeRejected(withinMs?: number): Promise<R>;
/**
* Matches if the received array contains all the expected objects using partial matching (expect.objectContaining).
* @param expected An array of partial objects that should be contained in the received array.
*/
toContainPartialObjects<T>(expected: Array<T>): R;
}
77 changes: 77 additions & 0 deletions libs/common/spec/matchers/to-contain-partial-objects.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
describe("toContainPartialObjects", () => {
describe("matches", () => {
it("if the array only contains the partial objects", () => {
const actual = [
{
id: 1,
name: "foo",
},
{
id: 2,
name: "bar",
},
];

const expected = [{ id: 1 }, { id: 2 }];

expect(actual).toContainPartialObjects(expected);
});

it("if the array contains the partial objects and other objects", () => {
const actual = [
{
id: 1,
name: "foo",
},
{
id: 2,
name: "bar",
},
{
id: 3,
name: "baz",
},
];

const expected = [{ id: 1 }, { id: 2 }];

expect(actual).toContainPartialObjects(expected);
});
});

describe("doesn't match", () => {
it("if the array does not contain any partial objects", () => {
const actual = [
{
id: 1,
name: "foo",
},
{
id: 2,
name: "bar",
},
];

const expected = [{ id: 1, name: "Foo" }];

expect(actual).not.toContainPartialObjects(expected);
});

it("if the array contains some but not all partial objects", () => {
const actual = [
{
id: 1,
name: "foo",
},
{
id: 2,
name: "bar",
},
];

const expected = [{ id: 2 }, { id: 3 }];

expect(actual).not.toContainPartialObjects(expected);
});
});
});
31 changes: 31 additions & 0 deletions libs/common/spec/matchers/to-contain-partial-objects.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { EOL } from "os";

import { diff } from "jest-diff";

export const toContainPartialObjects: jest.CustomMatcher = function (
received: Array<any>,
expected: Array<any>,
) {
const matched = this.equals(
received,
expect.arrayContaining(expected.map((e) => expect.objectContaining(e))),
audreyality marked this conversation as resolved.
Show resolved Hide resolved
);

if (matched) {
return {
message: () =>
"Expected the received array NOT to include partial matches for all expected objects." +
EOL +
diff(expected, received),
pass: true,
};
}

return {
message: () =>
"Expected the received array to contain partial matches for all expected objects." +
EOL +
diff(expected, received),
pass: false,
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ describe("KeyServiceLegacyEncryptorProvider", () => {

singleUserId$.complete();

expect(completed).toBeTrue();
expect(completed).toBe(true);
});

it("completes when `userKey$` emits a falsy value after emitting a truthy value", () => {
Expand All @@ -199,7 +199,7 @@ describe("KeyServiceLegacyEncryptorProvider", () => {

userKey$.next(null);

expect(completed).toBeTrue();
expect(completed).toBe(true);
});

it("completes once `dependencies.singleUserId$` emits and `userKey$` completes", () => {
Expand All @@ -214,7 +214,7 @@ describe("KeyServiceLegacyEncryptorProvider", () => {

userKey$.complete();

expect(completed).toBeTrue();
expect(completed).toBe(true);
});
});

Expand Down Expand Up @@ -445,7 +445,7 @@ describe("KeyServiceLegacyEncryptorProvider", () => {

singleOrganizationId$.complete();

expect(completed).toBeTrue();
expect(completed).toBe(true);
});

it("completes when `orgKeys$` emits a falsy value after emitting a truthy value", () => {
Expand All @@ -466,7 +466,7 @@ describe("KeyServiceLegacyEncryptorProvider", () => {
orgKey$.next(OrgRecords);
orgKey$.next(null);

expect(completed).toBeTrue();
expect(completed).toBe(true);
});

it("completes once `dependencies.singleOrganizationId$` emits and `userKey$` completes", () => {
Expand All @@ -486,7 +486,7 @@ describe("KeyServiceLegacyEncryptorProvider", () => {

orgKey$.complete();

expect(completed).toBeTrue();
expect(completed).toBe(true);
});
});
});
2 changes: 1 addition & 1 deletion libs/common/src/tools/rx.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ describe("errorOnChange", () => {

source$.complete();

expect(complete).toBeTrue();
expect(complete).toBe(true);
});

it("errors when the input changes", async () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ describe("Folder Service", () => {
const result = await firstValueFrom(folderService.folders$(mockUserId));

expect(result.length).toBe(2);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{ id: "1", name: makeEncString("ENC_STRING_1") },
{ id: "2", name: makeEncString("ENC_STRING_2") },
]);
Expand All @@ -98,7 +98,7 @@ describe("Folder Service", () => {
const result = await firstValueFrom(folderService.folderViews$(mockUserId));

expect(result.length).toBe(3);
expect(result).toIncludeAllPartialMembers([
expect(result).toContainPartialObjects([
{ id: "1", name: "DEC" },
{ id: "2", name: "DEC" },
{ name: "No Folder" },
Expand Down
Loading
Loading