imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Convert DecryptionFailureTracker-test to typescript (#12368)

Browse source 
* Remove reference to private method

`MatrixEvent.setClearData` is private. Use the test helper instead.

* Remove redundant params to `expect.toBe`

* Convert to typescript
This commit is contained in:
Richard van der Hoff 2024-03-25 19:57:29 +00:00 • committed by GitHub
parent a24aa7e0f7
commit 4702da8038
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 76 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

118
test/DecryptionFailureTracker-test.js → test/DecryptionFailureTracker-test.ts
View file

@ -14,12 +14,15 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
import { mkDecryptionFailureMatrixEvent } from "matrix-js-sdk/src/testing"; import { decryptExistingEvent, mkDecryptionFailureMatrixEvent } from "matrix-js-sdk/src/testing";
import { DecryptionFailureCode } from "matrix-js-sdk/src/crypto-api";
import { DecryptionFailureTracker } from "../src/DecryptionFailureTracker"; import { DecryptionFailureTracker } from "../src/DecryptionFailureTracker";
class MockDecryptionError extends Error { class MockDecryptionError extends Error {
constructor(code) { public readonly code: string;
constructor(code?: string) {
super(); super();
this.code = code || "MOCK_DECRYPTION_ERROR"; this.code = code || "MOCK_DECRYPTION_ERROR";
@ -30,7 +33,7 @@ async function createFailedDecryptionEvent() {
return await mkDecryptionFailureMatrixEvent({ return await mkDecryptionFailureMatrixEvent({
roomId: "!room:id", roomId: "!room:id",
sender: "@alice:example.com", sender: "@alice:example.com",
code: "UNKNOWN_ERROR", code: DecryptionFailureCode.UNKNOWN_ERROR,
msg: ":(", msg: ":(",
}); });
} }
@ -40,8 +43,9 @@ describe("DecryptionFailureTracker", function () {
const failedDecryptionEvent = await createFailedDecryptionEvent(); const failedDecryptionEvent = await createFailedDecryptionEvent();
let count = 0; let count = 0;
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -56,7 +60,8 @@ describe("DecryptionFailureTracker", function () {
// Immediately track the newest failures // Immediately track the newest failures
tracker.trackFailures(); tracker.trackFailures();
expect(count).not.toBe(0, "should track a failure for an event that failed decryption"); // should track a failure for an event that failed decryption
expect(count).not.toBe(0);
}); });
it("tracks a failed decryption with expected raw error for a visible event", async function () { it("tracks a failed decryption with expected raw error for a visible event", async function () {
@ -64,8 +69,9 @@ describe("DecryptionFailureTracker", function () {
let count = 0; let count = 0;
let reportedRawCode = ""; let reportedRawCode = "";
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total, errcode, rawCode) => { (total: number, _errCode: string, rawCode: string) => {
count += total; count += total;
reportedRawCode = rawCode; reportedRawCode = rawCode;
}, },
@ -83,16 +89,20 @@ describe("DecryptionFailureTracker", function () {
// Immediately track the newest failures // Immediately track the newest failures
tracker.trackFailures(); tracker.trackFailures();
expect(count).not.toBe(0, "should track a failure for an event that failed decryption"); // 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"); expect(count).not.toBe(0);
// Should add the rawCode to the event context
expect(reportedRawCode).toBe("INBOUND_SESSION_MISMATCH_ROOM_ID");
}); });
it("tracks a failed decryption for an event that becomes visible later", async function () { it("tracks a failed decryption for an event that becomes visible later", async function () {
const failedDecryptionEvent = await createFailedDecryptionEvent(); const failedDecryptionEvent = await createFailedDecryptionEvent();
let count = 0; let count = 0;
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -107,15 +117,17 @@ describe("DecryptionFailureTracker", function () {
// Immediately track the newest failures // Immediately track the newest failures
tracker.trackFailures(); tracker.trackFailures();
expect(count).not.toBe(0, "should track a failure for an event that failed decryption"); // should track a failure for an event that failed decryption
expect(count).not.toBe(0);
}); });
it("does not track a failed decryption for an event that never becomes visible", async function () { it("does not track a failed decryption for an event that never becomes visible", async function () {
const failedDecryptionEvent = await createFailedDecryptionEvent(); const failedDecryptionEvent = await createFailedDecryptionEvent();
let count = 0; let count = 0;
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -128,14 +140,17 @@ describe("DecryptionFailureTracker", function () {
// Immediately track the newest failures // Immediately track the newest failures
tracker.trackFailures(); tracker.trackFailures();
expect(count).toBe(0, "should not track a failure for an event that never became visible"); // should not track a failure for an event that never became visible
expect(count).toBe(0);
}); });
it("does not track a failed decryption where the event is subsequently successfully decrypted", async () => { it("does not track a failed decryption where the event is subsequently successfully decrypted", async () => {
const decryptedEvent = await createFailedDecryptionEvent(); const decryptedEvent = await createFailedDecryptionEvent();
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => { (_total: number) => {
expect(true).toBe(false, "should not track an event that has since been decrypted correctly"); // should not track an event that has since been decrypted correctly
expect(true).toBe(false);
}, },
() => "UnknownError", () => "UnknownError",
); );
@ -145,8 +160,11 @@ describe("DecryptionFailureTracker", function () {
const err = new MockDecryptionError(); const err = new MockDecryptionError();
tracker.eventDecrypted(decryptedEvent, err); tracker.eventDecrypted(decryptedEvent, err);
// Indicate successful decryption: clear data can be anything where the msgtype is not m.bad.encrypted // Indicate successful decryption.
decryptedEvent.setClearData({}); await decryptExistingEvent(decryptedEvent, {
plainType: "m.room.message",
plainContent: { body: "success" },
});
tracker.eventDecrypted(decryptedEvent, null); tracker.eventDecrypted(decryptedEvent, null);
// Pretend "now" is Infinity // Pretend "now" is Infinity
@ -161,9 +179,11 @@ describe("DecryptionFailureTracker", function () {
"and later becomes visible", "and later becomes visible",
async () => { async () => {
const decryptedEvent = await createFailedDecryptionEvent(); const decryptedEvent = await createFailedDecryptionEvent();
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => { (_total: number) => {
expect(true).toBe(false, "should not track an event that has since been decrypted correctly"); // should not track an event that has since been decrypted correctly
expect(true).toBe(false);
}, },
() => "UnknownError", () => "UnknownError",
); );
@ -171,8 +191,11 @@ describe("DecryptionFailureTracker", function () {
const err = new MockDecryptionError(); const err = new MockDecryptionError();
tracker.eventDecrypted(decryptedEvent, err); tracker.eventDecrypted(decryptedEvent, err);
// Indicate successful decryption: clear data can be anything where the msgtype is not m.bad.encrypted // Indicate successful decryption.
decryptedEvent.setClearData({}); await decryptExistingEvent(decryptedEvent, {
plainType: "m.room.message",
plainContent: { body: "success" },
});
tracker.eventDecrypted(decryptedEvent, null); tracker.eventDecrypted(decryptedEvent, null);
tracker.addVisibleEvent(decryptedEvent); tracker.addVisibleEvent(decryptedEvent);
@ -190,8 +213,9 @@ describe("DecryptionFailureTracker", function () {
const decryptedEvent2 = await createFailedDecryptionEvent(); const decryptedEvent2 = await createFailedDecryptionEvent();
let count = 0; let count = 0;
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -218,15 +242,17 @@ describe("DecryptionFailureTracker", function () {
tracker.trackFailures(); tracker.trackFailures();
tracker.trackFailures(); tracker.trackFailures();
expect(count).toBe(2, count + " failures tracked, should only track a single failure per event"); // should only track a single failure per event
expect(count).toBe(2);
}); });
it("should not track a failure for an event that was tracked previously", async () => { it("should not track a failure for an event that was tracked previously", async () => {
const decryptedEvent = await createFailedDecryptionEvent(); const decryptedEvent = await createFailedDecryptionEvent();
let count = 0; let count = 0;
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -246,7 +272,8 @@ describe("DecryptionFailureTracker", function () {
tracker.trackFailures(); tracker.trackFailures();
expect(count).toBe(1, "should only track a single failure per event"); // should only track a single failure per event
expect(count).toBe(1);
}); });
it.skip("should not track a failure for an event that was tracked in a previous session", async () => { it.skip("should not track a failure for an event that was tracked in a previous session", async () => {
@ -256,8 +283,9 @@ describe("DecryptionFailureTracker", function () {
const decryptedEvent = await createFailedDecryptionEvent(); const decryptedEvent = await createFailedDecryptionEvent();
let count = 0; let count = 0;
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -274,8 +302,9 @@ describe("DecryptionFailureTracker", function () {
tracker.trackFailures(); tracker.trackFailures();
// Simulate the browser refreshing by destroying tracker and creating a new tracker // Simulate the browser refreshing by destroying tracker and creating a new tracker
// @ts-ignore access to private constructor
const secondTracker = new DecryptionFailureTracker( const secondTracker = new DecryptionFailureTracker(
(total) => (count += total), (total: number) => (count += total),
() => "UnknownError", () => "UnknownError",
); );
@ -287,14 +316,17 @@ describe("DecryptionFailureTracker", function () {
secondTracker.checkFailures(Infinity); secondTracker.checkFailures(Infinity);
secondTracker.trackFailures(); secondTracker.trackFailures();
expect(count).toBe(1, count + " failures tracked, should only track a single failure per event"); // should only track a single failure per event
expect(count).toBe(1);
}); });
it("should count different error codes separately for multiple failures with different error codes", async () => { it("should count different error codes separately for multiple failures with different error codes", async () => {
const counts = {}; const counts: Record<string, number> = {};
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total, errorCode) => (counts[errorCode] = (counts[errorCode] || 0) + total), (total: number, errorCode: string) => (counts[errorCode] = (counts[errorCode] || 0) + total),
(error) => (error === "UnknownError" ? "UnknownError" : "OlmKeysNotSentError"), (error: string) => (error === "UnknownError" ? "UnknownError" : "OlmKeysNotSentError"),
); );
const decryptedEvent1 = await createFailedDecryptionEvent(); const decryptedEvent1 = await createFailedDecryptionEvent();
@ -320,14 +352,16 @@ describe("DecryptionFailureTracker", function () {
tracker.trackFailures(); tracker.trackFailures();
//expect(counts['UnknownError']).toBe(1, 'should track one UnknownError'); //expect(counts['UnknownError']).toBe(1, 'should track one UnknownError');
expect(counts["OlmKeysNotSentError"]).toBe(2, "should track two OlmKeysNotSentError"); expect(counts["OlmKeysNotSentError"]).toBe(2);
}); });
it("should aggregate error codes correctly", async () => { it("should aggregate error codes correctly", async () => {
const counts = {}; const counts: Record<string, number> = {};
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total, errorCode) => (counts[errorCode] = (counts[errorCode] || 0) + total), (total: number, errorCode: string) => (counts[errorCode] = (counts[errorCode] || 0) + total),
(errorCode) => "OlmUnspecifiedError", (_errorCode: string) => "OlmUnspecifiedError",
); );
const decryptedEvent1 = await createFailedDecryptionEvent(); const decryptedEvent1 = await createFailedDecryptionEvent();
@ -351,17 +385,16 @@ describe("DecryptionFailureTracker", function () {
tracker.trackFailures(); tracker.trackFailures();
expect(counts["OlmUnspecifiedError"]).toBe( expect(counts["OlmUnspecifiedError"]).toBe(3);
3,
"should track three OlmUnspecifiedError, got " + counts["OlmUnspecifiedError"],
);
}); });
it("should remap error codes correctly", async () => { it("should remap error codes correctly", async () => {
const counts = {}; const counts: Record<string, number> = {};
// @ts-ignore access to private constructor
const tracker = new DecryptionFailureTracker( const tracker = new DecryptionFailureTracker(
(total, errorCode) => (counts[errorCode] = (counts[errorCode] || 0) + total), (total: number, errorCode: string) => (counts[errorCode] = (counts[errorCode] || 0) + total),
(errorCode) => Array.from(errorCode).reverse().join(""), (errorCode: string) => Array.from(errorCode).reverse().join(""),
); );
const decryptedEvent = await createFailedDecryptionEvent(); const decryptedEvent = await createFailedDecryptionEvent();
@ -377,6 +410,7 @@ describe("DecryptionFailureTracker", function () {
tracker.trackFailures(); tracker.trackFailures();
expect(counts["1_EDOC_RORRE"]).toBe(1, "should track remapped error code"); // should track remapped error code
expect(counts["1_EDOC_RORRE"]).toBe(1);
}); });
}); });