Skip to content

make sure setDefaultKeyId resolves even if no change is made #5485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andybalaam merged 1 commit into from
Aug 17, 2026
+40 −57
Merged

make sure setDefaultKeyId resolves even if no change is made #5485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 32 additions & 26 deletions spec/unit/secret-storage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
limitations under the License.
*/

import fetchMock from "@fetch-mock/vitest";
import { type Mocked } from "vitest";

import {
Expand All @@ -29,7 +30,9 @@
} from "../../src/secret-storage";
import { secureRandomString } from "../../src/randomstring";
import { type SecretInfo } from "../../src/secret-storage.ts";
import { type AccountDataEvents, ClientEvent, MatrixEvent, TypedEventEmitter } from "../../src";
import { type AccountDataEvents, createClient, TypedEventEmitter } from "../../src";
import { SyncResponder } from "../test-utils/SyncResponder.ts";
import { mockInitialApiRequests } from "../test-utils/mockEndpoints.ts";

declare module "../../src/@types/event" {
interface SecretStorageAccountDataEvents {
Expand Down Expand Up @@ -287,50 +290,53 @@
describe("setDefaultKeyId", function () {
let secretStorage: ServerSideSecretStorage;
let accountDataAdapter: Mocked<AccountDataClient>;
let accountDataPromise: PromiseWithResolvers<void>;
beforeEach(() => {
accountDataAdapter = mockAccountDataClient();
accountDataPromise = Promise.withResolvers();
accountDataAdapter.setAccountData.mockImplementation(() => {
accountDataPromise.resolve();
return Promise.resolve({});
});

secretStorage = new ServerSideSecretStorageImpl(accountDataAdapter, {});
});

it("should set the default key id", async function () {
const setDefaultPromise = secretStorage.setDefaultKeyId("keyId");
await accountDataPromise.promise;
await secretStorage.setDefaultKeyId("keyId");

expect(accountDataAdapter.setAccountData).toHaveBeenCalledWith("m.secret_storage.default_key", {
key: "keyId",
});

accountDataAdapter.emit(
ClientEvent.AccountData,
new MatrixEvent({
type: "m.secret_storage.default_key",
content: { key: "keyId" },
}),
);
await setDefaultPromise;
});

it("should set the default key id with a null key id", async function () {
const setDefaultPromise = secretStorage.setDefaultKeyId(null);
await accountDataPromise.promise;

await secretStorage.setDefaultKeyId(null);
expect(accountDataAdapter.setAccountData).toHaveBeenCalledWith("m.secret_storage.default_key", {});
});

accountDataAdapter.emit(
ClientEvent.AccountData,
new MatrixEvent({
type: "m.secret_storage.default_key",
content: {},
}),
);
await setDefaultPromise;
it("should return even if it makes no change", async function () {
// This test ensures that setDefaultKeyId still resolves, even if
// setAccountData detects that no change needs to be made to the
// account data, and doesn't actually make an HTTP request. For
// this reason, we need to use the real implementation of the secret
// storage, rather than the mock implementation.
vi.useFakeTimers();
const baseUrl = "https://matrix.example";
const userId = "@alice:matrix.example";
const syncResponder = new SyncResponder(baseUrl);
mockInitialApiRequests(baseUrl, userId);
const client = createClient({ baseUrl, userId });
await client.startClient();

// The existing default key is `null`.
syncResponder.sendOrQueueSyncResponse({
account_data: { events: [{ type: "m.secret_storage.default_key", content: null }] },
});
await vi.advanceTimersByTimeAsync(1);

// We set the default key to `null`.
await secretStorage.setDefaultKeyId(null);

// We should not have made an HTTP call.
expect(fetchMock.callHistory.calls(/account_data/).length).toEqual(0);

Check warning on line 339 in spec/unit/secret-storage.spec.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer "expect(fetchMock.callHistory.calls(/account_data/)).toHaveLength(0)" over this generic assertion for better reporting; it works on any object with a numeric length property. 


See more on https://sonarcloud.io/project/issues?id=matrix-js-sdk&issues=AaACRF2IUsSXpj_-xLXx&open=AaACRF2IUsSXpj_-xLXx&pullRequest=5485
});
});

Expand Down
39 changes: 8 additions & 31 deletions src/secret-storage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ limitations under the License.
*/

import { type TypedEventEmitter } from "./models/typed-event-emitter.ts";
import { ClientEvent, type ClientEventHandlerMap } from "./client.ts";
import { type MatrixEvent } from "./models/event.ts";
import { type ClientEvent, type ClientEventHandlerMap } from "./client.ts";
import { secureRandomString } from "./randomstring.ts";
import { logger } from "./logger.ts";
import encryptAESSecretStorageItem from "./utils/encryptAESSecretStorageItem.ts";
Expand Down Expand Up @@ -370,35 +369,13 @@ export class ServerSideSecretStorageImpl implements ServerSideSecretStorage {
/**
* Implementation of {@link ServerSideSecretStorage#setDefaultKeyId}.
*/
public setDefaultKeyId(keyId: string | null): Promise<void> {
return new Promise<void>((resolve, reject) => {
const listener = (ev: MatrixEvent): void => {
if (ev.getType() !== "m.secret_storage.default_key") {
// Different account data item
return;
}

// If keyId === null, the content should be an empty object.
// Otherwise, the `key` in the content object should match keyId.
const content = ev.getContent();
const isSameKey = keyId === null ? Object.keys(content).length === 0 : content.key === keyId;
if (isSameKey) {
this.accountDataAdapter.removeListener(ClientEvent.AccountData, listener);
resolve();
}
};
this.accountDataAdapter.on(ClientEvent.AccountData, listener);

// The spec [1] says that the value of the account data entry should be an object with a `key` property.
// It doesn't specify how to delete the default key; we do it by setting the account data to an empty object.
//
// [1]: https://spec.matrix.org/v1.13/client-server-api/#key-storage
const newValue: Record<string, never> | { key: string } = keyId === null ? {} : { key: keyId };
this.accountDataAdapter.setAccountData("m.secret_storage.default_key", newValue).catch((e) => {
this.accountDataAdapter.removeListener(ClientEvent.AccountData, listener);
reject(e);
});
});
public async setDefaultKeyId(keyId: string | null): Promise<void> {
// The spec [1] says that the value of the account data entry should be an object with a `key` property.
// It doesn't specify how to delete the default key; we do it by setting the account data to an empty object.
//
// [1]: https://spec.matrix.org/v1.13/client-server-api/#key-storage
const newValue: Record<string, never> | { key: string } = keyId === null ? {} : { key: keyId };
await this.accountDataAdapter.setAccountData("m.secret_storage.default_key", newValue);
}

/**
Expand Down
Loading