Add ESLint Jest (matrix-org#10261)

Author: weeman1337

.eslintrc.js

@@ -165,17 +165,43 @@ module.exports = {
         },
         {
             files: ["test/**/*.{ts,tsx}", "cypress/**/*.ts"],
+            extends: ["plugin:matrix-org/jest"],
             rules: {
                 // We don't need super strict typing in test utilities
                 "@typescript-eslint/explicit-function-return-type": "off",
                 "@typescript-eslint/explicit-member-accessibility": "off",
+
+                // Jest/Cypress specific
+
+                // Disabled tests are a reality for now but as soon as all of the xits are
+                // eliminated, we should enforce this.
+                "jest/no-disabled-tests": "off",
+                // TODO: There are many tests with invalid expects that should be fixed,
+                // https://github.com/vector-im/element-web/issues/24709
+                "jest/valid-expect": "off",
+                // TODO: There are many cases to refactor away,
+                // https://github.com/vector-im/element-web/issues/24710
+                "jest/no-conditional-expect": "off",
+                // Also treat "oldBackendOnly" as a test function.
+                // Used in some crypto tests.
+                "jest/no-standalone-expect": [
+                    "error",
+                    {
+                        additionalTestBlockFunctions: ["beforeAll", "beforeEach", "oldBackendOnly"],
+                    },
+                ],
             },
         },
         {
             files: ["cypress/**/*.ts"],
             parserOptions: {
                 project: ["./cypress/tsconfig.json"],
             },
+            rules: {
+                // Cypress "promises" work differently - disable some related rules
+                "jest/valid-expect-in-promise": "off",
+                "jest/no-done-callback": "off",
+            },
         },
     ],
     settings: {

cypress/e2e/sliding-sync/sliding-sync.ts

@@ -356,7 +356,7 @@ describe("Sliding Sync", () => {
     });
 
     // Regression test for https://github.com/vector-im/element-web/issues/21462
-    it("should not cancel replies when permalinks are clicked ", () => {
+    it("should not cancel replies when permalinks are clicked", () => {
         cy.get<string>("@roomId").then((roomId) => {
             // we require a first message as you cannot click the permalink text with the avatar in the way
             return cy

cypress/e2e/spotlight/spotlight.spec.ts

@@ -24,7 +24,7 @@ import Timeoutable = Cypress.Timeoutable;
 import Withinable = Cypress.Withinable;
 import Shadow = Cypress.Shadow;
 
-export enum Filter {
+enum Filter {
     People = "people",
     PublicRooms = "public_rooms",
 }
@@ -297,27 +297,28 @@ describe("Spotlight", () => {
 
     // TODO: We currently can’t test finding rooms on other homeservers/other protocols
     // We obviously don’t have federation or bridges in cypress tests
-    /*
-    const room3Name = "Matrix HQ";
-    const room3Id = "#matrix:matrix.org";
-
-    it("should find unknown public rooms on other homeservers", () => {
-        cy.openSpotlightDialog().within(() => {
-            cy.spotlightFilter(Filter.PublicRooms);
-            cy.spotlightSearch().clear().type(room3Name);
-            cy.get("[aria-haspopup=true][role=button]").click();
-        }).then(() => {
-            cy.contains(".mx_GenericDropdownMenu_Option--header", "matrix.org")
-                .next("[role=menuitemradio]")
-                .click();
-            cy.wait(3_600_000);
-        }).then(() => cy.spotlightDialog().within(() => {
-            cy.spotlightResults().should("have.length", 1);
-            cy.spotlightResults().eq(0).should("contain", room3Name);
-            cy.spotlightResults().eq(0).should("contain", room3Id);
-        }));
+    it.skip("should find unknown public rooms on other homeservers", () => {
+        cy.openSpotlightDialog()
+            .within(() => {
+                cy.spotlightFilter(Filter.PublicRooms);
+                cy.spotlightSearch().clear().type(room3Name);
+                cy.get("[aria-haspopup=true][role=button]").click();
+            })
+            .then(() => {
+                cy.contains(".mx_GenericDropdownMenu_Option--header", "matrix.org")
+                    .next("[role=menuitemradio]")
+                    .click();
+                cy.wait(3_600_000);
+            })
+            .then(() =>
+                cy.spotlightDialog().within(() => {
+                    cy.spotlightResults().should("have.length", 1);
+                    cy.spotlightResults().eq(0).should("contain", room3Name);
+                    cy.spotlightResults().eq(0).should("contain", room3Id);
+                }),
+            );
     });
-    */
+
     it("should find known people", () => {
         cy.openSpotlightDialog()
             .within(() => {

package.json

@@ -194,6 +194,7 @@
         "eslint-config-prettier": "^8.5.0",
         "eslint-plugin-deprecate": "^0.7.0",
         "eslint-plugin-import": "^2.25.4",
+        "eslint-plugin-jest": "^27.2.1",
         "eslint-plugin-jsx-a11y": "^6.5.1",
         "eslint-plugin-matrix-org": "1.0.0",
         "eslint-plugin-react": "^7.28.0",

test/ContentMessages-test.ts

@@ -327,6 +327,6 @@ describe("uploadFile", () => {
         const prom = uploadFile(client, "!roomId:server", file);
         mocked(client.uploadContent).mock.calls[0][1]!.abortController!.abort();
         deferred.resolve({ content_uri: "mxc://foo/bar" });
-        await expect(prom).rejects.toThrowError(UploadCanceledError);
+        await expect(prom).rejects.toThrow(UploadCanceledError);
     });
 });

test/DecryptionFailureTracker-test.js

@@ -38,7 +38,7 @@ function createFailedDecryptionEvent() {
 }
 
 describe("DecryptionFailureTracker", function () {
-    it("tracks a failed decryption for a visible event", function (done) {
+    it("tracks a failed decryption for a visible event", function () {
         const failedDecryptionEvent = createFailedDecryptionEvent();
 
         let count = 0;
@@ -59,11 +59,9 @@ describe("DecryptionFailureTracker", function () {
         tracker.trackFailures();
 
         expect(count).not.toBe(0, "should track a failure for an event that failed decryption");
-
-        done();
     });
 
-    it("tracks a failed decryption with expected raw error for a visible event", function (done) {
+    it("tracks a failed decryption with expected raw error for a visible event", function () {
         const failedDecryptionEvent = createFailedDecryptionEvent();
 
         let count = 0;
@@ -89,11 +87,9 @@ describe("DecryptionFailureTracker", function () {
 
         expect(count).not.toBe(0, "should track a failure for an event that failed decryption");
         expect(reportedRawCode).toBe("INBOUND_SESSION_MISMATCH_ROOM_ID", "Should add the rawCode to the event context");
-
-        done();
     });
 
-    it("tracks a failed decryption for an event that becomes visible later", function (done) {
+    it("tracks a failed decryption for an event that becomes visible later", function () {
         const failedDecryptionEvent = createFailedDecryptionEvent();
 
         let count = 0;
@@ -114,11 +110,9 @@ describe("DecryptionFailureTracker", function () {
         tracker.trackFailures();
 
         expect(count).not.toBe(0, "should track a failure for an event that failed decryption");
-
-        done();
     });
 
-    it("does not track a failed decryption for an event that never becomes visible", function (done) {
+    it("does not track a failed decryption for an event that never becomes visible", function () {
         const failedDecryptionEvent = createFailedDecryptionEvent();
 
         let count = 0;
@@ -137,11 +131,9 @@ describe("DecryptionFailureTracker", function () {
         tracker.trackFailures();
 
         expect(count).toBe(0, "should not track a failure for an event that never became visible");
-
-        done();
     });
 
-    it("does not track a failed decryption where the event is subsequently successfully decrypted", (done) => {
+    it("does not track a failed decryption where the event is subsequently successfully decrypted", () => {
         const decryptedEvent = createFailedDecryptionEvent();
         const tracker = new DecryptionFailureTracker(
             (total) => {
@@ -164,13 +156,12 @@ describe("DecryptionFailureTracker", function () {
 
         // Immediately track the newest failures
         tracker.trackFailures();
-        done();
     });
 
     it(
         "does not track a failed decryption where the event is subsequently successfully decrypted " +
             "and later becomes visible",
-        (done) => {
+        () => {
             const decryptedEvent = createFailedDecryptionEvent();
             const tracker = new DecryptionFailureTracker(
                 (total) => {
@@ -193,11 +184,10 @@ describe("DecryptionFailureTracker", function () {
 
             // Immediately track the newest failures
             tracker.trackFailures();
-            done();
         },
     );
 
-    it("only tracks a single failure per event, despite multiple failed decryptions for multiple events", (done) => {
+    it("only tracks a single failure per event, despite multiple failed decryptions for multiple events", () => {
         const decryptedEvent = createFailedDecryptionEvent();
         const decryptedEvent2 = createFailedDecryptionEvent();
 
@@ -231,11 +221,9 @@ describe("DecryptionFailureTracker", function () {
         tracker.trackFailures();
 
         expect(count).toBe(2, count + " failures tracked, should only track a single failure per event");
-
-        done();
     });
 
-    it("should not track a failure for an event that was tracked previously", (done) => {
+    it("should not track a failure for an event that was tracked previously", () => {
         const decryptedEvent = createFailedDecryptionEvent();
 
         let count = 0;
@@ -261,11 +249,9 @@ describe("DecryptionFailureTracker", function () {
         tracker.trackFailures();
 
         expect(count).toBe(1, "should only track a single failure per event");
-
-        done();
     });
 
-    xit("should not track a failure for an event that was tracked in a previous session", (done) => {
+    it.skip("should not track a failure for an event that was tracked in a previous session", () => {
         // This test uses localStorage, clear it beforehand
         localStorage.clear();
 
@@ -304,8 +290,6 @@ describe("DecryptionFailureTracker", function () {
         secondTracker.trackFailures();
 
         expect(count).toBe(1, count + " failures tracked, should only track a single failure per event");
-
-        done();
     });
 
     it("should count different error codes separately for multiple failures with different error codes", () => {

test/Notifier-test.ts

@@ -302,7 +302,7 @@ describe("Notifier", () => {
             );
         });
 
-        it("should display the expected notification for a broadcast chunk with sequence = 1", () => {
+        it("should display the expected notification for a broadcast chunk with sequence = 2", () => {
             const audioEvent = mkAudioEvent({ sequence: 2 });
             Notifier.displayPopupNotification(audioEvent, testRoom);
             expect(MockPlatform.displayNotification).not.toHaveBeenCalled();

test/PosthogAnalytics-test.ts

@@ -35,7 +35,7 @@ const getFakePosthog = (): PostHog =>
         register: jest.fn(),
     } as unknown as PostHog);
 
-export interface ITestEvent extends IPosthogEvent {
+interface ITestEvent extends IPosthogEvent {
     eventName: "JestTestEvents";
     foo?: string;
 }

test/RoomNotifs-test.ts

@@ -218,7 +218,7 @@ describe("RoomNotifs test", () => {
             expect(getUnreadNotificationCount(room, NotificationCountType.Highlight, THREAD_ID)).toBe(0);
         });
 
-        it("counts notifications type", () => {
+        it("counts thread notifications type", () => {
             room.setThreadUnreadNotificationCount(THREAD_ID, NotificationCountType.Total, 2);
             room.setThreadUnreadNotificationCount(THREAD_ID, NotificationCountType.Highlight, 1);
 

test/ScalarAuthClient-test.ts

@@ -58,7 +58,7 @@ describe("ScalarAuthClient", function () {
 
         await sac.connect();
 
-        expect(sac.exchangeForScalarToken).toBeCalledWith(tokenObject);
+        expect(sac.exchangeForScalarToken).toHaveBeenCalledWith(tokenObject);
         expect(sac.hasCredentials).toBeTruthy();
         // @ts-ignore private property
         expect(sac.scalarToken).toEqual("wokentoken");