Skip to content

Commit

Permalink
Remove extensible events v1 field population on legacy events (#3040)
Browse files Browse the repository at this point in the history
* Remove extensible events v1 field population on legacy events

With extensible events v2, affected events are now gated by a room version, so we don't need this code anymore. 

The proposal has generally moved away from mixing m.room.message with extensible fields as well.

* Run prettier

* Remove unstable identifier from tests too

* Run prettier again
  • Loading branch information
turt2live committed Jan 10, 2023
1 parent 3564a35 commit 185ded4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 49 deletions.
18 changes: 8 additions & 10 deletions spec/integ/matrix-client-methods.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1177,11 +1177,10 @@ describe("MatrixClient", function () {
.when("PUT", "/send")
.check((req) => {
expect(req.data).toStrictEqual({
"msgtype": "m.emote",
"body": "Body",
"formatted_body": "<h1>Body</h1>",
"format": "org.matrix.custom.html",
"org.matrix.msc1767.message": expect.anything(),
msgtype: "m.emote",
body: "Body",
formatted_body: "<h1>Body</h1>",
format: "org.matrix.custom.html",
});
})
.respond(200, { event_id: "$foobar" });
Expand All @@ -1197,11 +1196,10 @@ describe("MatrixClient", function () {
.when("PUT", "/send")
.check((req) => {
expect(req.data).toStrictEqual({
"msgtype": "m.text",
"body": "Body",
"formatted_body": "<h1>Body</h1>",
"format": "org.matrix.custom.html",
"org.matrix.msc1767.message": expect.anything(),
msgtype: "m.text",
body: "Body",
formatted_body: "<h1>Body</h1>",
format: "org.matrix.custom.html",
});
})
.respond(200, { event_id: "$foobar" });
Expand Down
42 changes: 3 additions & 39 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.
* This is an internal module. See {@link MatrixClient} for the public class.
*/

import { EmoteEvent, IPartialEvent, MessageEvent, NoticeEvent, Optional } from "matrix-events-sdk";
import { Optional } from "matrix-events-sdk";

import type { IMegolmSessionData } from "./@types/crypto";
import { ISyncStateData, SyncApi, SyncApiOptions, SyncState } from "./sync";
Expand Down Expand Up @@ -4541,44 +4541,8 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
threadId = null;
}

// Populate all outbound events with Extensible Events metadata to ensure there's a
// reasonably large pool of messages to parse.
let eventType: string = EventType.RoomMessage;
let sendContent: IContent = content as IContent;
const makeContentExtensible = (content: IContent = {}, recurse = true): IPartialEvent<object> | undefined => {
let newEvent: IPartialEvent<IContent> | undefined;

if (content["msgtype"] === MsgType.Text) {
newEvent = MessageEvent.from(content["body"], content["formatted_body"]).serialize();
} else if (content["msgtype"] === MsgType.Emote) {
newEvent = EmoteEvent.from(content["body"], content["formatted_body"]).serialize();
} else if (content["msgtype"] === MsgType.Notice) {
newEvent = NoticeEvent.from(content["body"], content["formatted_body"]).serialize();
}

if (newEvent && content["m.new_content"] && recurse) {
const newContent = makeContentExtensible(content["m.new_content"], false);
if (newContent) {
newEvent.content["m.new_content"] = newContent.content;
}
}

if (newEvent) {
// copy over all other fields we don't know about
for (const [k, v] of Object.entries(content)) {
if (!newEvent.content.hasOwnProperty(k)) {
newEvent.content[k] = v;
}
}
}

return newEvent;
};
const result = makeContentExtensible(sendContent);
if (result) {
eventType = result.type;
sendContent = result.content;
}
const eventType: string = EventType.RoomMessage;
const sendContent: IContent = content as IContent;

return this.sendEvent(roomId, threadId as string | null, eventType, sendContent, txnId);
}
Expand Down

0 comments on commit 185ded4

Please sign in to comment.