matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-07 23:02:56 +03:00
Code Activity

Use js-sdk logger in rust sdk (#4918)

Browse Source
This commit is contained in:
Richard van der Hoff
2025-07-25 10:57:25 +01:00
committed by GitHub
parent 61e07633df
commit 812d0aaef6
3 changed files with 17 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spec/unit/rust-crypto/rust-crypto.spec.ts
View File

@@ -130,8 +130,8 @@ describe("initRustCrypto", () => {
storePassphrase: "storePassphrase", storePassphrase: "storePassphrase",
}); });
expect(StoreHandle.open).toHaveBeenCalledWith("storePrefix", "storePassphrase"); expect(StoreHandle.open).toHaveBeenCalledWith("storePrefix", "storePassphrase", logger);
expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore); expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore, logger);
}); });
it("passes through the store params (key)", async () => { it("passes through the store params (key)", async () => {
@@ -154,8 +154,8 @@ describe("initRustCrypto", () => {
storeKey: storeKey, storeKey: storeKey,
}); });
expect(StoreHandle.openWithKey).toHaveBeenCalledWith("storePrefix", storeKey); expect(StoreHandle.openWithKey).toHaveBeenCalledWith("storePrefix", storeKey, logger);
expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore); expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore, logger);
}); });
it("suppresses the storePassphrase and storeKey if storePrefix is unset", async () => { it("suppresses the storePassphrase and storeKey if storePrefix is unset", async () => {
@@ -178,8 +178,8 @@ describe("initRustCrypto", () => {
storePassphrase: "storePassphrase", storePassphrase: "storePassphrase",
}); });
expect(StoreHandle.open).toHaveBeenCalledWith(); expect(StoreHandle.open).toHaveBeenCalledWith(null, null, logger);
expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore); expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore, logger);
}); });
it("Should get secrets from inbox on start", async () => { it("Should get secrets from inbox on start", async () => {
@@ -278,6 +278,7 @@ describe("initRustCrypto", () => {
expect.any(BaseMigrationData), expect.any(BaseMigrationData),
new Uint8Array(Buffer.from(PICKLE_KEY)), new Uint8Array(Buffer.from(PICKLE_KEY)),
mockStore, mockStore,
logger,
); );
const data = mocked(Migration.migrateBaseData).mock.calls[0][0]; const data = mocked(Migration.migrateBaseData).mock.calls[0][0];
expect(data.pickledAccount).toEqual("not a real account"); expect(data.pickledAccount).toEqual("not a real account");
@@ -294,6 +295,7 @@ describe("initRustCrypto", () => {
expect.any(Array), expect.any(Array),
new Uint8Array(Buffer.from(PICKLE_KEY)), new Uint8Array(Buffer.from(PICKLE_KEY)),
mockStore, mockStore,
logger,
); );
// First call should have 50 entries; second should have 10 // First call should have 50 entries; second should have 10
const sessions1: PickledSession[] = mocked(Migration.migrateOlmSessions).mock.calls[0][0]; const sessions1: PickledSession[] = mocked(Migration.migrateOlmSessions).mock.calls[0][0];
@@ -316,6 +318,7 @@ describe("initRustCrypto", () => {
expect.any(Array), expect.any(Array),
new Uint8Array(Buffer.from(PICKLE_KEY)), new Uint8Array(Buffer.from(PICKLE_KEY)),
mockStore, mockStore,
logger,
); );
// First call should have 50 entries; second should have 10 // First call should have 50 entries; second should have 10
const megolmSessions1: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock const megolmSessions1: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock
@@ -424,6 +427,7 @@ describe("initRustCrypto", () => {
expect.any(Array), expect.any(Array),
new Uint8Array(Buffer.from(PICKLE_KEY)), new Uint8Array(Buffer.from(PICKLE_KEY)),
mockStore, mockStore,
logger,
); );
const megolmSessions: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock const megolmSessions: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock
.calls[0][0]; .calls[0][0];

10
src/rust-crypto/index.ts
View File

@@ -98,19 +98,16 @@ export async function initRustCrypto(args: {
logger.debug("Initialising Rust crypto-sdk WASM artifact"); logger.debug("Initialising Rust crypto-sdk WASM artifact");
await RustSdkCryptoJs.initAsync(); await RustSdkCryptoJs.initAsync();
// enable tracing in the rust-sdk
new RustSdkCryptoJs.Tracing(RustSdkCryptoJs.LoggerLevel.Debug).turnOn();
logger.debug("Opening Rust CryptoStore"); logger.debug("Opening Rust CryptoStore");
let storeHandle; let storeHandle;
if (args.storePrefix) { if (args.storePrefix) {
if (args.storeKey) { if (args.storeKey) {
storeHandle = await StoreHandle.openWithKey(args.storePrefix, args.storeKey); storeHandle = await StoreHandle.openWithKey(args.storePrefix, args.storeKey, logger);
} else { } else {
storeHandle = await StoreHandle.open(args.storePrefix, args.storePassphrase); storeHandle = await StoreHandle.open(args.storePrefix, args.storePassphrase, logger);
} }
} else { } else {
storeHandle = await StoreHandle.open(); storeHandle = await StoreHandle.open(null, null, logger);
} }
if (args.legacyCryptoStore) { if (args.legacyCryptoStore) {
@@ -155,6 +152,7 @@ async function initOlmMachine(
new RustSdkCryptoJs.UserId(userId), new RustSdkCryptoJs.UserId(userId),
new RustSdkCryptoJs.DeviceId(deviceId), new RustSdkCryptoJs.DeviceId(deviceId),
storeHandle, storeHandle,
logger,
); );
// A final migration step, now that we have an OlmMachine. // A final migration step, now that we have an OlmMachine.

9
src/rust-crypto/libolm_migration.ts
View File

@@ -80,9 +80,6 @@ export async function migrateFromLegacyCrypto(args: {
// initialise the rust matrix-sdk-crypto-wasm, if it hasn't already been done // initialise the rust matrix-sdk-crypto-wasm, if it hasn't already been done
await RustSdkCryptoJs.initAsync(); await RustSdkCryptoJs.initAsync();
// enable tracing in the rust-sdk
new RustSdkCryptoJs.Tracing(RustSdkCryptoJs.LoggerLevel.Debug).turnOn();
if (!(await legacyStore.containsData())) { if (!(await legacyStore.containsData())) {
// This store was never used. Nothing to migrate. // This store was never used. Nothing to migrate.
return; return;
@@ -230,7 +227,7 @@ async function migrateBaseData(
pickleKey, pickleKey,
"user_signing", "user_signing",
); );
await RustSdkCryptoJs.Migration.migrateBaseData(migrationData, pickleKey, storeHandle); await RustSdkCryptoJs.Migration.migrateBaseData(migrationData, pickleKey, storeHandle, logger);
} }
async function countOlmSessions(logger: Logger, legacyStore: CryptoStore): Promise<number> { async function countOlmSessions(logger: Logger, legacyStore: CryptoStore): Promise<number> {
@@ -269,7 +266,7 @@ async function migrateOlmSessions(
migrationData.push(pickledSession); migrationData.push(pickledSession);
} }
await RustSdkCryptoJs.Migration.migrateOlmSessions(migrationData, pickleKey, storeHandle); await RustSdkCryptoJs.Migration.migrateOlmSessions(migrationData, pickleKey, storeHandle, logger);
await legacyStore.deleteEndToEndSessionsBatch(batch); await legacyStore.deleteEndToEndSessionsBatch(batch);
onBatchDone(batch.length); onBatchDone(batch.length);
} }
@@ -343,7 +340,7 @@ async function migrateMegolmSessions(
migrationData.push(pickledSession); migrationData.push(pickledSession);
} }
await RustSdkCryptoJs.Migration.migrateMegolmSessions(migrationData, pickleKey, storeHandle); await RustSdkCryptoJs.Migration.migrateMegolmSessions(migrationData, pickleKey, storeHandle, logger);
await legacyStore.deleteEndToEndInboundGroupSessionsBatch(batch); await legacyStore.deleteEndToEndInboundGroupSessionsBatch(batch);
onBatchDone(batch.length); onBatchDone(batch.length);
} }