Merge pull request #1221 from neet/prettify-test-assertions

chore: Use equality tester to simplify assertions

Author: neet

test-utils/async-next-tick.ts

@@ -1,37 +1,17 @@
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-/* eslint-disable @typescript-eslint/no-namespace */
-export interface CustomMatchers<R = unknown> {
-  toContainId(id: string): R;
-}
+import { expect } from "@jest/globals";
+
+// https://jestjs.io/docs/expect#expectaddequalitytesterstesters
+function idChecker(a: unknown, b: unknown) {
+  const hasAId = typeof a === "object" && a !== null && "id" in a;
+  const hasBId = typeof b === "object" && b !== null && "id" in b;
 
-declare global {
-  namespace jest {
-    interface Expect extends CustomMatchers {}
-    interface Matchers<R> extends CustomMatchers<R> {}
-    interface InverseAsymmetricMatchers extends CustomMatchers {}
+  if (hasAId && hasBId) {
+    return a.id === b.id;
+  } else if (hasAId === hasBId) {
+    return;
+  } else {
+    return false;
   }
 }
 
-expect.extend({
-  toContainId<T extends { id: string }>(received?: T, expected?: string) {
-    if (!Array.isArray(received)) {
-      return { pass: false, message: () => "Expected an array" };
-    }
-
-    if (received.length === 0) {
-      return {
-        pass: false,
-        message: () => "Expected an array with at least one element",
-      };
-    }
-
-    const pass = received.some((entity) => entity.id === expected);
-
-    return {
-      pass,
-      message: () => {
-        return `List does not contain ${expected}`;
-      },
-    };
-  },
-});
+expect.addEqualityTesters([idChecker]);

test-utils/jest-extend-expect.ts

@@ -4,7 +4,10 @@ import "./jest-extend-expect";
 import { createRestAPIClient } from "../src";
 import { SessionPoolImpl } from "./pools";
 
-jest.retryTimes(3);
+if (process.env.CI) {
+  jest.retryTimes(3);
+}
+
 jest.setTimeout(1000 * 60);
 
 globalThis.admin = createRestAPIClient({

test-utils/jest-setup-after-env.ts

@@ -54,7 +54,7 @@ export class SessionPoolImpl implements Pool<Session> {
     if (token == undefined) {
       // eslint-disable-next-line no-console
       console.warn(
-        `Session ${session.id} (${session.acct}) is already released`,
+        `Session ${session.id} (${session.account.acct}) is already released`,
       );
       return;
     }

test-utils/pools/session-pool.ts

@@ -6,7 +6,7 @@ import {
 
 export interface Session {
   readonly id: string;
-  readonly acct: string;
+  readonly account: mastodon.v1.Account;
   readonly rest: mastodon.rest.Client;
   readonly ws: mastodon.streaming.Client;
   readonly [Symbol.asyncDispose]: () => Promise<void>;
@@ -32,7 +32,7 @@ export const createSession = async (
 
   return Object.freeze({
     id: account.id,
-    acct: account.acct,
+    account,
     rest,
     ws,
     [Symbol.asyncDispose]: dispose,

test-utils/session.ts

@@ -220,7 +220,7 @@ describe("account", () => {
       .$select(bob.id)
       .followers.list();
 
-    expect(followers).toContainId(alice.id);
+    expect(followers).toContainEqual(alice.account);
     await alice.rest.v1.accounts.$select(bob.id).unfollow();
   });
 
@@ -233,7 +233,7 @@ describe("account", () => {
       .$select(alice.id)
       .following.list();
 
-    expect(accounts).toContainId(bob.id);
+    expect(accounts).toContainEqual(bob.account);
     await alice.rest.v1.accounts.$select(bob.id).unfollow();
   });
 
@@ -244,7 +244,7 @@ describe("account", () => {
       .$select(status.account.id)
       .statuses.list();
 
-    expect(statuses).toContainId(status.id);
+    expect(statuses).toContainEqual(status);
   });
 
   it("searches", async () => {
@@ -253,7 +253,7 @@ describe("account", () => {
     const accounts = await client.rest.v1.accounts.search.list({
       q: me.username,
     });
-    expect(accounts).toContainId(me.id);
+    expect(accounts).toContainEqual(me);
   });
 
   it("lists lists", async () => {
@@ -266,10 +266,8 @@ describe("account", () => {
       await alice.rest.v1.lists.$select(list.id).accounts.create({
         accountIds: [bob.id],
       });
-      const accounts = await alice.rest.v1.accounts
-        .$select(bob.id)
-        .lists.list();
-      expect(accounts).toContainId(list.id);
+      const lists = await alice.rest.v1.accounts.$select(bob.id).lists.list();
+      expect(lists).toContainEqual(list);
     } finally {
       await alice.rest.v1.lists.$select(list.id).remove();
     }
@@ -284,7 +282,7 @@ describe("account", () => {
     const tags = await client.rest.v1.accounts
       .$select(client.id)
       .featuredTags.list();
-    expect(tags).toContainId(featuredTag.id);
+    expect(tags).toContainEqual(featuredTag);
 
     await client.rest.v1.featuredTags.$select(featuredTag.id).remove();
   });
@@ -308,7 +306,7 @@ describe("account", () => {
   it("lookup", async () => {
     await using client = await sessions.acquire();
     const account = await client.rest.v1.accounts.lookup({
-      acct: client.acct,
+      acct: client.account.acct,
     });
     expect(account.id).toBe(client.id);
   });

tests/rest/v1/accounts.spec.ts

@@ -14,11 +14,11 @@ describe("canonical-email-blocks", () => {
       const result = await admin.v1.admin.canonicalEmailBlocks.test({
         email: "[email protected]",
       });
-      expect(result).toContainId(canonicalEmailBlock.id);
+      expect(result).toContainEqual(canonicalEmailBlock);
 
       const canonicalEmailBlocks =
         await admin.v1.admin.canonicalEmailBlocks.list();
-      expect(canonicalEmailBlocks).toContainId(canonicalEmailBlock.id);
+      expect(canonicalEmailBlocks).toContainEqual(canonicalEmailBlock);
     } finally {
       await admin.v1.admin.canonicalEmailBlocks
         .$select(canonicalEmailBlock.id)

tests/rest/v1/admin/canonical-email-blocks.spec.ts

@@ -11,7 +11,7 @@ it("handles domain allows", async () => {
     expect(domainAllow.domain).toMatch(/example.domain.to.allow.com/);
 
     const list = await admin.v1.admin.domainAllows.list();
-    expect(list).toContainId(domainAllow.id);
+    expect(list).toContainEqual(domainAllow);
   } finally {
     await admin.v1.admin.domainAllows.$select(domainAllow.id).remove();
   }

tests/rest/v1/admin/domain-allows.spec.ts

@@ -18,7 +18,7 @@ it("handles domain blocks", async () => {
     expect(domainBlock.rejectMedia).toBe(false);
 
     const list = await admin.v1.admin.domainBlocks.list();
-    expect(list).toContainId(domainBlock.id);
+    expect(list).toContainEqual(domainBlock);
   } finally {
     await admin.v1.admin.domainBlocks.$select(domainBlock.id).remove();
   }

tests/rest/v1/admin/domain-blocks.spec.ts

@@ -11,7 +11,7 @@ it("handle email domain block", async () => {
     expect(emailDomainBlock.domain).toMatch(/example.domain.to.block.com/);
 
     const list = await admin.v1.admin.emailDomainBlocks.list();
-    expect(list).toContainId(emailDomainBlock.id);
+    expect(list).toContainEqual(emailDomainBlock);
   } finally {
     await admin.v1.admin.emailDomainBlocks
       .$select(emailDomainBlock.id)