Add option for MatrixClient.initRustCrypto() to disable tracing.

[Srayash]

Checklist

• Tests written for new code (and old code if feasible).
• New or updated public/exported symbols have accurate TSDoc documentation.
• Linter and other CI checks pass.
• Sign-off given on the changes (see CONTRIBUTING.md).

Fixes

fixes #4177

Description

This PR introduces an optional parameter, tracingEnabled, to the initRustCrypto function, allowing users to enable or disable tracing in the Rust crypto SDK.

Now, the tracing feature can be toggled:

Enabled: tracingEnabled: true - Tracing will capture debug-level logs.
Disabled: tracingEnabled: false - No tracing will occur, leading to cleaner log output and improved performance.

Signed-off-by: Srayash [email protected]

[andybalaam]

The change looks ok to me, but I want to defer to the other reviewers as to whether this the right way to do this.

[andybalaam]

This error from the build looks genuine though:

src/rust-crypto/index.ts:108:65 - error TS2339: Property 'Off' does not exist on type 'typeof LoggerLevel'.

108 new RustSdkCryptoJs.Tracing(RustSdkCryptoJs.LoggerLevel.Off).turnOn();
~~~

[andybalaam]

Changes needed to fix the build

[Srayash]

hey @andybalaam the error can be fixed in two ways:

• Using LoggerLevel.Error to minimize logs.
• skip .turnOn() when tracing is disabled or modify rust enum in matrix-rust-sdk-crypto-wasm/src/tracing.rs to include an off level.

[Srayash]

Changes needed to fix the build

Hi @andybalaam ,

I have made the requested changes by skipping .turnOn() when tracing is disabled

Please let me know if further adjustments are needed or if everything looks good now.

Thanks!

[andybalaam]

I have made the requested changes by skipping .turnOn() when tracing is disabled

Sounds to me like the right change.

Please let me know if further adjustments are needed or if everything looks good now.

I just kicked off the tests but I am strongly guessing they will fail after your latest change.

[andybalaam]

Tests fail because they test for the old behaviour before the recent change.

[richvdh]

disabling logging altogether seems like a very bad idea. How will you diagnose any issues that occur?

[richvdh]

the problem with this is that incorrectly gives the impression that tracing can be enabled or disabled at the level of an individual instance of RustCrypto.

For example: if I call initRustCrypto({tracingEnabled: true}), and then later, for a different MatrixClient instance, call initRustCrypto({tracingEnabled: false}), tracing will be enabled for the second instance despite tracngEnabled being set to false.

What we really need is to do the work in matrix-sdk-crypto-wasm to connect the logging from the rust tracing system to logger, so that it can be correctly enabled or disabled via the js-sdk's logging API.