Report verification and recovery state to posthog (#12516)
* Report verification and recovery state to posthog * Fix CryptoApi import * Fix js-sdk import * Review: Use DeviceVerificationStatus instead of CrossSigningStatus * Review: Clean condition to check secrets in 4S * review: Fix redundent !!
This commit is contained in:
Valere
GitHub
parent
f712b809e2
commit
a29cabe45a
4 changed files with 450 additions and 5 deletions
|
|
@ -27,6 +27,8 @@ import {
|
|||
import { logger } from "matrix-js-sdk/src/logger";
|
||||
import { CryptoEvent } from "matrix-js-sdk/src/crypto";
|
||||
import { IKeyBackupInfo } from "matrix-js-sdk/src/crypto/keybackup";
|
||||
import { CryptoSessionStateChange } from "@matrix-org/analytics-events/types/typescript/CryptoSessionStateChange";
|
||||
import { CrossSigningStatus, KeyBackupInfo } from "matrix-js-sdk/src/crypto-api";
|
||||
|
||||
import DeviceListener from "../src/DeviceListener";
|
||||
import { MatrixClientPeg } from "../src/MatrixClientPeg";
|
||||
|
|
@ -41,6 +43,7 @@ import { SettingLevel } from "../src/settings/SettingLevel";
|
|||
import { getMockClientWithEventEmitter, mockPlatformPeg } from "./test-utils";
|
||||
import { UIFeature } from "../src/settings/UIFeature";
|
||||
import { isBulkUnverifiedDeviceReminderSnoozed } from "../src/utils/device/snoozeBulkUnverifiedDeviceReminder";
|
||||
import { PosthogAnalytics } from "../src/PosthogAnalytics";
|
||||
|
||||
// don't litter test console with logs
|
||||
jest.mock("matrix-js-sdk/src/logger");
|
||||
|
|
@ -93,6 +96,16 @@ describe("DeviceListener", () => {
|
|||
isSecretStorageReady: jest.fn().mockResolvedValue(true),
|
||||
userHasCrossSigningKeys: jest.fn(),
|
||||
getActiveSessionBackupVersion: jest.fn(),
|
||||
getCrossSigningStatus: jest.fn().mockReturnValue({
|
||||
publicKeysOnDevice: true,
|
||||
privateKeysInSecretStorage: true,
|
||||
privateKeysCachedLocally: {
|
||||
masterKey: true,
|
||||
selfSigningKey: true,
|
||||
userSigningKey: true,
|
||||
},
|
||||
}),
|
||||
getSessionBackupPrivateKey: jest.fn(),
|
||||
} as unknown as Mocked<CryptoApi>;
|
||||
mockClient = getMockClientWithEventEmitter({
|
||||
isGuest: jest.fn(),
|
||||
|
|
@ -110,6 +123,10 @@ describe("DeviceListener", () => {
|
|||
getAccountData: jest.fn(),
|
||||
deleteAccountData: jest.fn(),
|
||||
getCrypto: jest.fn().mockReturnValue(mockCrypto),
|
||||
secretStorage: {
|
||||
isStored: jest.fn().mockReturnValue(null),
|
||||
getDefaultKeyId: jest.fn().mockReturnValue("00"),
|
||||
},
|
||||
});
|
||||
jest.spyOn(MatrixClientPeg, "get").mockReturnValue(mockClient);
|
||||
jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
|
||||
|
|
@ -552,5 +569,362 @@ describe("DeviceListener", () => {
|
|||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("Report verification and recovery state to Analytics", () => {
|
||||
let setPropertySpy: jest.SpyInstance;
|
||||
let trackEventSpy: jest.SpyInstance;
|
||||
|
||||
beforeEach(() => {
|
||||
setPropertySpy = jest.spyOn(PosthogAnalytics.instance, "setProperty");
|
||||
trackEventSpy = jest.spyOn(PosthogAnalytics.instance, "trackEvent");
|
||||
});
|
||||
|
||||
describe("Report crypto verification state to analytics", () => {
|
||||
type VerificationTestCases = [string, Partial<DeviceVerificationStatus>, "Verified" | "NotVerified"];
|
||||
|
||||
const testCases: VerificationTestCases[] = [
|
||||
[
|
||||
"Identity trusted and device is signed by owner",
|
||||
{
|
||||
signedByOwner: true,
|
||||
crossSigningVerified: true,
|
||||
},
|
||||
"Verified",
|
||||
],
|
||||
[
|
||||
"Identity is trusted, but device is not signed",
|
||||
{
|
||||
signedByOwner: false,
|
||||
crossSigningVerified: true,
|
||||
},
|
||||
"NotVerified",
|
||||
],
|
||||
[
|
||||
"Identity is not trusted, device not signed",
|
||||
{
|
||||
signedByOwner: false,
|
||||
crossSigningVerified: false,
|
||||
},
|
||||
"NotVerified",
|
||||
],
|
||||
[
|
||||
"Identity is not trusted, and device signed",
|
||||
{
|
||||
signedByOwner: true,
|
||||
crossSigningVerified: false,
|
||||
},
|
||||
"NotVerified",
|
||||
],
|
||||
];
|
||||
|
||||
beforeEach(() => {
|
||||
mockClient.secretStorage.getDefaultKeyId.mockResolvedValue(null);
|
||||
mockCrypto.isSecretStorageReady.mockResolvedValue(false);
|
||||
});
|
||||
|
||||
it.each(testCases)("Does report session verification state when %s", async (_, status, expected) => {
|
||||
mockCrypto!.getDeviceVerificationStatus.mockResolvedValue(status as DeviceVerificationStatus);
|
||||
await createAndStart();
|
||||
|
||||
// Should have updated user properties
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("verificationState", expected);
|
||||
|
||||
// Should have reported a status change event
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: expected,
|
||||
recoveryState: "Disabled",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
});
|
||||
|
||||
it("should not report a status event if no changes", async () => {
|
||||
mockCrypto!.getDeviceVerificationStatus.mockResolvedValue({
|
||||
signedByOwner: true,
|
||||
crossSigningVerified: true,
|
||||
} as unknown as DeviceVerificationStatus);
|
||||
|
||||
await createAndStart();
|
||||
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: "Verified",
|
||||
recoveryState: "Disabled",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledTimes(1);
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
|
||||
// simulate a recheck
|
||||
mockClient.emit(CryptoEvent.DevicesUpdated, [userId], false);
|
||||
await flushPromises();
|
||||
expect(trackEventSpy).toHaveBeenCalledTimes(1);
|
||||
|
||||
// Now simulate a change
|
||||
mockCrypto!.getDeviceVerificationStatus.mockResolvedValue({
|
||||
signedByOwner: false,
|
||||
crossSigningVerified: true,
|
||||
} as unknown as DeviceVerificationStatus);
|
||||
|
||||
// simulate a recheck
|
||||
mockClient.emit(CryptoEvent.DevicesUpdated, [userId], false);
|
||||
await flushPromises();
|
||||
expect(trackEventSpy).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("Report crypto recovery state to analytics", () => {
|
||||
beforeEach(() => {
|
||||
// During all these tests we want verification state to be verified.
|
||||
mockCrypto!.getDeviceVerificationStatus.mockResolvedValue({
|
||||
signedByOwner: true,
|
||||
crossSigningVerified: true,
|
||||
} as unknown as DeviceVerificationStatus);
|
||||
});
|
||||
|
||||
describe("When Room Key Backup is not enabled", () => {
|
||||
beforeEach(() => {
|
||||
// no backup
|
||||
mockClient.getKeyBackupVersion.mockResolvedValue(null);
|
||||
});
|
||||
|
||||
it("Should report recovery state as Enabled", async () => {
|
||||
// 4S is enabled
|
||||
mockClient.secretStorage.getDefaultKeyId.mockResolvedValue("00");
|
||||
|
||||
// Session trusted and cross signing secrets in 4S and stored locally
|
||||
mockCrypto!.getCrossSigningStatus.mockResolvedValue({
|
||||
publicKeysOnDevice: true,
|
||||
privateKeysInSecretStorage: true,
|
||||
privateKeysCachedLocally: {
|
||||
masterKey: true,
|
||||
selfSigningKey: true,
|
||||
userSigningKey: true,
|
||||
},
|
||||
});
|
||||
|
||||
await createAndStart();
|
||||
|
||||
// Should have updated user properties
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("verificationState", "Verified");
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("recoveryState", "Enabled");
|
||||
|
||||
// Should have reported a status change event
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: "Verified",
|
||||
recoveryState: "Enabled",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
});
|
||||
|
||||
it("Should report recovery state as Incomplete if secrets not cached locally", async () => {
|
||||
// 4S is enabled
|
||||
mockClient.secretStorage.getDefaultKeyId.mockResolvedValue("00");
|
||||
|
||||
// Session trusted and cross signing secrets in 4S and stored locally
|
||||
mockCrypto!.getCrossSigningStatus.mockResolvedValue({
|
||||
publicKeysOnDevice: true,
|
||||
privateKeysInSecretStorage: true,
|
||||
privateKeysCachedLocally: {
|
||||
masterKey: false,
|
||||
selfSigningKey: true,
|
||||
userSigningKey: true,
|
||||
},
|
||||
});
|
||||
|
||||
// no backup
|
||||
mockClient.getKeyBackupVersion.mockResolvedValue(null);
|
||||
|
||||
await createAndStart();
|
||||
|
||||
// Should have updated user properties
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("verificationState", "Verified");
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("recoveryState", "Incomplete");
|
||||
|
||||
// Should have reported a status change event
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: "Verified",
|
||||
recoveryState: "Incomplete",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
});
|
||||
|
||||
const baseState: CrossSigningStatus = {
|
||||
publicKeysOnDevice: true,
|
||||
privateKeysInSecretStorage: true,
|
||||
privateKeysCachedLocally: {
|
||||
masterKey: true,
|
||||
selfSigningKey: true,
|
||||
userSigningKey: true,
|
||||
},
|
||||
};
|
||||
type MissingSecretsInCacheTestCases = [string, CrossSigningStatus];
|
||||
|
||||
const partialTestCases: MissingSecretsInCacheTestCases[] = [
|
||||
[
|
||||
"MSK not cached",
|
||||
{
|
||||
...baseState,
|
||||
privateKeysCachedLocally: { ...baseState.privateKeysCachedLocally, masterKey: false },
|
||||
},
|
||||
],
|
||||
[
|
||||
"SSK not cached",
|
||||
{
|
||||
...baseState,
|
||||
privateKeysCachedLocally: {
|
||||
...baseState.privateKeysCachedLocally,
|
||||
selfSigningKey: false,
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
"USK not cached",
|
||||
{
|
||||
...baseState,
|
||||
privateKeysCachedLocally: {
|
||||
...baseState.privateKeysCachedLocally,
|
||||
userSigningKey: false,
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
"MSK/USK not cached",
|
||||
{
|
||||
...baseState,
|
||||
privateKeysCachedLocally: {
|
||||
...baseState.privateKeysCachedLocally,
|
||||
masterKey: false,
|
||||
userSigningKey: false,
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
"MSK/SSK not cached",
|
||||
{
|
||||
...baseState,
|
||||
privateKeysCachedLocally: {
|
||||
...baseState.privateKeysCachedLocally,
|
||||
masterKey: false,
|
||||
selfSigningKey: false,
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
"USK/SSK not cached",
|
||||
{
|
||||
...baseState,
|
||||
privateKeysCachedLocally: {
|
||||
...baseState.privateKeysCachedLocally,
|
||||
userSigningKey: false,
|
||||
selfSigningKey: false,
|
||||
},
|
||||
},
|
||||
],
|
||||
];
|
||||
|
||||
it.each(partialTestCases)(
|
||||
"Should report recovery state as Incomplete when %s",
|
||||
async (_, status) => {
|
||||
mockClient.secretStorage.getDefaultKeyId.mockResolvedValue("00");
|
||||
|
||||
// Session trusted and cross signing secrets in 4S and stored locally
|
||||
mockCrypto!.getCrossSigningStatus.mockResolvedValue(status);
|
||||
|
||||
await createAndStart();
|
||||
|
||||
// Should have updated user properties
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("verificationState", "Verified");
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("recoveryState", "Incomplete");
|
||||
|
||||
// Should have reported a status change event
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: "Verified",
|
||||
recoveryState: "Incomplete",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
},
|
||||
);
|
||||
|
||||
it("Should report recovery state as Incomplete when some secrets are not in 4S", async () => {
|
||||
mockClient.secretStorage.getDefaultKeyId.mockResolvedValue("00");
|
||||
|
||||
// Some missing secret in 4S
|
||||
mockCrypto.isSecretStorageReady.mockResolvedValue(false);
|
||||
|
||||
// Session trusted and secrets known locally.
|
||||
mockCrypto!.getCrossSigningStatus.mockResolvedValue({
|
||||
publicKeysOnDevice: true,
|
||||
privateKeysCachedLocally: {
|
||||
masterKey: true,
|
||||
selfSigningKey: true,
|
||||
userSigningKey: true,
|
||||
},
|
||||
} as unknown as CrossSigningStatus);
|
||||
|
||||
await createAndStart();
|
||||
|
||||
// Should have updated user properties
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("verificationState", "Verified");
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("recoveryState", "Incomplete");
|
||||
|
||||
// Should have reported a status change event
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: "Verified",
|
||||
recoveryState: "Incomplete",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
});
|
||||
});
|
||||
|
||||
describe("When Room Key Backup is enabled", () => {
|
||||
beforeEach(() => {
|
||||
// backup enabled - just need a mock object
|
||||
mockClient.getKeyBackupVersion.mockResolvedValue({} as KeyBackupInfo);
|
||||
});
|
||||
|
||||
const testCases = [
|
||||
["as Incomplete if backup key not cached locally", false],
|
||||
["as Enabled if backup key is cached locally", true],
|
||||
];
|
||||
it.each(testCases)("Should report recovery state as %s", async (_, isCached) => {
|
||||
// 4S is enabled
|
||||
mockClient.secretStorage.getDefaultKeyId.mockResolvedValue("00");
|
||||
|
||||
// Session trusted and cross signing secrets in 4S and stored locally
|
||||
mockCrypto!.getCrossSigningStatus.mockResolvedValue({
|
||||
publicKeysOnDevice: true,
|
||||
privateKeysInSecretStorage: true,
|
||||
privateKeysCachedLocally: {
|
||||
masterKey: true,
|
||||
selfSigningKey: true,
|
||||
userSigningKey: true,
|
||||
},
|
||||
});
|
||||
|
||||
mockCrypto.getSessionBackupPrivateKey.mockResolvedValue(isCached ? new Uint8Array() : null);
|
||||
|
||||
await createAndStart();
|
||||
|
||||
expect(setPropertySpy).toHaveBeenCalledWith("verificationState", "Verified");
|
||||
expect(setPropertySpy).toHaveBeenCalledWith(
|
||||
"recoveryState",
|
||||
isCached ? "Enabled" : "Incomplete",
|
||||
);
|
||||
|
||||
// Should have reported a status change event
|
||||
const expectedTrackedEvent: CryptoSessionStateChange = {
|
||||
eventName: "CryptoSessionState",
|
||||
verificationState: "Verified",
|
||||
recoveryState: isCached ? "Enabled" : "Incomplete",
|
||||
};
|
||||
expect(trackEventSpy).toHaveBeenCalledWith(expectedTrackedEvent);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue