sorb/ThreadNet-Web
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

DeviceListener: add logging around key backup upload check (#30291)

Browse Source 
* DeviceListener: add logging around key backup upload check

... in an attempt to diagnose what is going on with
https://github.com/element-hq/element-web/issues/30270

* fix typescript

* fix lint
This commit is contained in:
Richard van der Hoff
2025-07-09 17:31:36 +00:00
committed by GitHub
parent 7f97f46686
commit 26d71530f5
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/DeviceListener.ts
+7 -4
View File
@@ -15,7 +15,7 @@ import {
type SyncState, type SyncState,
ClientStoppedError, ClientStoppedError,
} from "matrix-js-sdk/src/matrix"; } from "matrix-js-sdk/src/matrix";
import { logger as baseLogger, LogSpan } from "matrix-js-sdk/src/logger"; import { logger as baseLogger, type BaseLogger, LogSpan } from "matrix-js-sdk/src/logger";
import { CryptoEvent, type KeyBackupInfo } from "matrix-js-sdk/src/crypto-api"; import { CryptoEvent, type KeyBackupInfo } from "matrix-js-sdk/src/crypto-api";
import { type CryptoSessionStateChange } from "@matrix-org/analytics-events/types/typescript/CryptoSessionStateChange"; import { type CryptoSessionStateChange } from "@matrix-org/analytics-events/types/typescript/CryptoSessionStateChange";
import { secureRandomString } from "matrix-js-sdk/src/randomstring"; import { secureRandomString } from "matrix-js-sdk/src/randomstring";
@@ -213,6 +213,7 @@ export default class DeviceListener {
}; };
private onKeyBackupStatusChanged = (): void => { private onKeyBackupStatusChanged = (): void => {
logger.info("Backup status changed");
this.cachedKeyBackupUploadActive = undefined; this.cachedKeyBackupUploadActive = undefined;
this.recheck(); this.recheck();
}; };
@@ -313,6 +314,7 @@ export default class DeviceListener {
private async doRecheck(): Promise<void> { private async doRecheck(): Promise<void> {
if (!this.running || !this.client) return; // we have been stopped if (!this.running || !this.client) return; // we have been stopped
const logSpan = new LogSpan(logger, "check_" + secureRandomString(4)); const logSpan = new LogSpan(logger, "check_" + secureRandomString(4));
logSpan.debug("starting recheck...");
const cli = this.client; const cli = this.client;
@@ -355,7 +357,7 @@ export default class DeviceListener {
(await crypto.getDeviceVerificationStatus(cli.getSafeUserId(), cli.deviceId!))?.crossSigningVerified, (await crypto.getDeviceVerificationStatus(cli.getSafeUserId(), cli.deviceId!))?.crossSigningVerified,
); );
const keyBackupUploadActive = await this.isKeyBackupUploadActive(); const keyBackupUploadActive = await this.isKeyBackupUploadActive(logSpan);
const backupDisabled = await this.recheckBackupDisabled(cli); const backupDisabled = await this.recheckBackupDisabled(cli);
// We warn if key backup upload is turned off and we have not explicitly // We warn if key backup upload is turned off and we have not explicitly
@@ -579,7 +581,7 @@ export default class DeviceListener {
* trigger an auto-rageshake). * trigger an auto-rageshake).
*/ */
private checkKeyBackupStatus = async (): Promise<void> => { private checkKeyBackupStatus = async (): Promise<void> => {
if (!(await this.isKeyBackupUploadActive())) { if (!(await this.isKeyBackupUploadActive(logger))) {
dis.dispatch({ action: Action.ReportKeyBackupNotEnabled }); dis.dispatch({ action: Action.ReportKeyBackupNotEnabled });
} }
}; };
@@ -587,7 +589,7 @@ export default class DeviceListener {
/** /**
* Is key backup enabled? Use a cached answer if we have one. * Is key backup enabled? Use a cached answer if we have one.
*/ */
private isKeyBackupUploadActive = async (): Promise<boolean> => { private isKeyBackupUploadActive = async (logger: BaseLogger): Promise<boolean> => {
if (!this.client) { if (!this.client) {
// To preserve existing behaviour, if there is no client, we // To preserve existing behaviour, if there is no client, we
// pretend key backup upload is on. // pretend key backup upload is on.
@@ -611,6 +613,7 @@ export default class DeviceListener {
// Fetch the answer and cache it // Fetch the answer and cache it
const activeKeyBackupVersion = await crypto.getActiveSessionBackupVersion(); const activeKeyBackupVersion = await crypto.getActiveSessionBackupVersion();
this.cachedKeyBackupUploadActive = !!activeKeyBackupVersion; this.cachedKeyBackupUploadActive = !!activeKeyBackupVersion;
logger.debug(`Key backup upload is ${this.cachedKeyBackupUploadActive ? "active" : "inactive"}`);
return this.cachedKeyBackupUploadActive; return this.cachedKeyBackupUploadActive;
}; };