Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Try to resolve emails before creating a DM #10164

Merged
merged 6 commits into from
Feb 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
6 changes: 5 additions & 1 deletion src/components/views/dialogs/InviteDialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -469,10 +469,14 @@ export default class InviteDialog extends React.PureComponent<Props, IInviteDial
}

private startDm = async (): Promise<void> => {
this.setState({
busy: true,
});

try {
const cli = MatrixClientPeg.get();
const targets = this.convertFilter();
startDmOnFirstMessage(cli, targets);
await startDmOnFirstMessage(cli, targets);
this.props.onFinished(true);
} catch (err) {
logger.error(err);
Expand Down
16 changes: 13 additions & 3 deletions src/utils/direct-messages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,19 @@ import { findDMRoom } from "./dm/findDMRoom";
import { privateShouldBeEncrypted } from "./rooms";
import { createDmLocalRoom } from "./dm/createDmLocalRoom";
import { startDm } from "./dm/startDm";
import { resolveThreePids } from "./threepids";

export async function startDmOnFirstMessage(client: MatrixClient, targets: Member[]): Promise<Room> {
const existingRoom = findDMRoom(client, targets);
let resolvedTargets = targets;

try {
resolvedTargets = await resolveThreePids(targets, client);
} catch (e) {
logger.warn("Error resolving 3rd-party members", e);
}

const existingRoom = findDMRoom(client, resolvedTargets);

if (existingRoom) {
dis.dispatch<ViewRoomPayload>({
action: Action.ViewRoom,
Expand All @@ -42,12 +52,12 @@ export async function startDmOnFirstMessage(client: MatrixClient, targets: Membe
return existingRoom;
}

const room = await createDmLocalRoom(client, targets);
const room = await createDmLocalRoom(client, resolvedTargets);
dis.dispatch({
action: Action.ViewRoom,
room_id: room.roomId,
joining: false,
targets,
targets: resolvedTargets,
});
return room;
}
Expand Down
106 changes: 106 additions & 0 deletions src/utils/threepids.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
/*
Copyright 2023 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { MatrixClient } from "matrix-js-sdk/src/matrix";

import { DirectoryMember, Member, ThreepidMember } from "./direct-messages";

/**
* Tries to resolve the ThreepidMembers to DirectoryMembers.
*
* @param members - List of members to resolve
* @returns {Promise<Member[]>} Same list with ThreepidMembers replaced by DirectoryMembers if succesfully resolved
*/
export const resolveThreePids = async (members: Member[], client: MatrixClient): Promise<Member[]> => {
const threePidMembers = members.filter((m) => m instanceof ThreepidMember) as ThreepidMember[];

// Nothing to do here
if (threePidMembers.length === 0) return members;

const lookedUpProfiles = await lookupThreePidProfiles(threePidMembers, client);

return members.map((member: Member) => {
if (!(member instanceof ThreepidMember)) return member;

const lookedUpProfile = lookedUpProfiles.find((r) => r.threePidId === member.userId);

// No profile found for this member; use the ThreepidMember.
if (!lookedUpProfile) return member;

return new DirectoryMember({
user_id: lookedUpProfile.mxid,
avatar_url: lookedUpProfile?.profile?.avatar_url,
display_name: lookedUpProfile?.profile?.displayname,
});
});
};

/**
* Tries to look up the ThreepidMembers.
*
* @param threePids - List of 3rd-party members to look up
* @returns List of resolved 3rd-party IDs with their MXIDs
*/
export const lookupThreePids = async (
threePids: ThreepidMember[],
client: MatrixClient,
): Promise<{ threePidId: string; mxid: string }[]> => {
// No identity server configured. Unable to resolve any 3rd party member.
if (!client.identityServer) return [];

// Nothing we can search, return null
if (threePids.length === 0) return [];

const token = await client.identityServer.getAccessToken();
const lookedUp = await client.bulkLookupThreePids(
threePids.map((t) => [t.isEmail ? "email" : "msisdn", t.userId]),
token,
);

return lookedUp.threepids.map((l: [threePidType: string, threePidId: string, mxid: string][]) => ({
threePidId: l[1],
mxid: l[2],
weeman1337 marked this conversation as resolved.
Show resolved Hide resolved
}));
};

/**
* Tries to look up the MXIDs and profiles of the ThreepidMembers.
*
* @param threePids - List of 3rd-prty members to look up
* @returns List of resolved 3rd-party members with their MXIDs and profile (if found)
*/
export const lookupThreePidProfiles = async (
threePids: ThreepidMember[],
client: MatrixClient,
): Promise<{ threePidId: string; mxid: string; profile: null | { avatar_url?: string; displayname?: string } }[]> => {
const lookedUpThreePids = await lookupThreePids(threePids, client);
const promises = lookedUpThreePids.map(async (t) => {
let profile: null | { avatar_url?: string; display_name?: string } = null;

try {
profile = await client.getProfileInfo(t.mxid);
} catch {
// ignore any lookup error
}

return {
threePidId: t.threePidId,
mxid: t.mxid,
profile,
};
});
return Promise.all(promises);
};
1 change: 1 addition & 0 deletions test/test-utils/test-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ export function createTestClient(): MatrixClient {
getPushRules: jest.fn().mockResolvedValue(undefined),
getPushers: jest.fn().mockResolvedValue({ pushers: [] }),
getThreePids: jest.fn().mockResolvedValue({ threepids: [] }),
bulkLookupThreePids: jest.fn().mockResolvedValue({ threepids: [] }),
setPusher: jest.fn().mockResolvedValue(undefined),
setPushRuleEnabled: jest.fn().mockResolvedValue(undefined),
setPushRuleActions: jest.fn().mockResolvedValue(undefined),
Expand Down
40 changes: 37 additions & 3 deletions test/utils/direct-messages-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ limitations under the License.

import { mocked } from "jest-mock";
import { ClientEvent, MatrixClient, Room } from "matrix-js-sdk/src/matrix";
import { logger } from "matrix-js-sdk/src/logger";

import DMRoomMap from "../../src/utils/DMRoomMap";
import { createTestClient } from "../test-utils";
Expand All @@ -28,6 +29,8 @@ import { waitForRoomReadyAndApplyAfterCreateCallbacks } from "../../src/utils/lo
import { findDMRoom } from "../../src/utils/dm/findDMRoom";
import { createDmLocalRoom } from "../../src/utils/dm/createDmLocalRoom";
import { startDm } from "../../src/utils/dm/startDm";
import { Member } from "../../src/utils/direct-messages";
import { resolveThreePids } from "../../src/utils/threepids";

jest.mock("../../src/utils/rooms", () => ({
...(jest.requireActual("../../src/utils/rooms") as object),
Expand Down Expand Up @@ -59,6 +62,12 @@ jest.mock("../../src/utils/dm/startDm", () => ({
startDm: jest.fn(),
}));

jest.mock("../../src/utils/threepids", () => ({
resolveThreePids: jest.fn().mockImplementation(async (members: Member[]) => {
return members;
}),
}));

describe("direct-messages", () => {
const userId1 = "@user1:example.com";
const member1 = new dmModule.DirectoryMember({ user_id: userId1 });
Expand All @@ -69,8 +78,6 @@ describe("direct-messages", () => {
let roomEvents: Room[];

beforeEach(() => {
jest.restoreAllMocks();

mockClient = createTestClient();
jest.spyOn(MatrixClientPeg, "get").mockReturnValue(mockClient);
roomEvents = [];
Expand All @@ -89,10 +96,17 @@ describe("direct-messages", () => {
} as unknown as DMRoomMap;
jest.spyOn(DMRoomMap, "shared").mockReturnValue(dmRoomMap);
jest.spyOn(dis, "dispatch");
jest.spyOn(logger, "warn");

jest.useFakeTimers();
jest.setSystemTime(new Date(2022, 7, 4, 11, 12, 30, 42));
});

afterEach(() => {
jest.restoreAllMocks();
jest.useRealTimers();
});

describe("startDmOnFirstMessage", () => {
describe("if no room exists", () => {
beforeEach(() => {
Expand All @@ -101,14 +115,34 @@ describe("direct-messages", () => {

it("should create a local room and dispatch a view room event", async () => {
mocked(createDmLocalRoom).mockResolvedValue(localRoom);
const room = await dmModule.startDmOnFirstMessage(mockClient, [member1]);
const members = [member1];
const room = await dmModule.startDmOnFirstMessage(mockClient, members);
expect(room).toBe(localRoom);
expect(dis.dispatch).toHaveBeenCalledWith({
action: Action.ViewRoom,
room_id: room.roomId,
joining: false,
targets: [member1],
});

// assert, that startDmOnFirstMessage tries to resolve 3rd-party IDs
expect(resolveThreePids).toHaveBeenCalledWith(members, mockClient);
});

it("should work when resolveThreePids raises an error", async () => {
const error = new Error("error 4711");
mocked(resolveThreePids).mockRejectedValue(error);

mocked(createDmLocalRoom).mockResolvedValue(localRoom);
const members = [member1];
const room = await dmModule.startDmOnFirstMessage(mockClient, members);
expect(room).toBe(localRoom);

// ensure that startDmOnFirstMessage tries to resolve 3rd-party IDs
expect(resolveThreePids).toHaveBeenCalledWith(members, mockClient);

// ensure that the error is logged
expect(logger.warn).toHaveBeenCalledWith("Error resolving 3rd-party members", error);
});
});

Expand Down
Loading