1
0
Fork 0
out-of-your-element/src/matrix/kstate.test.js
l1s5 3ed3219bd2 Handle d2m events with empty guild/user avatars (#106)
Should fix the following trace where a `null` value was rendered into the url:

```
Error while processing a MESSAGE_CREATE Discord event:
Error: File download had failure status code 404
    at throwDownloadError (/home/ooye/out-of-your-element/src/matrix/file.js:93:13)
    at Object._actuallyUploadDiscordFileToMxc (/home/ooye/out-of-your-element/src/matrix/file.js:104:16)
    at process.processTicksAndRejections (node:internal/process/task_queues:104:5)
    at async Promise.all (index 0)
    at async kstateUploadMxc (/home/ooye/out-of-your-element/src/matrix/kstate.js:46:2)
    at async Object.kstateToState (/home/ooye/out-of-your-element/src/matrix/kstate.js:54:2)
    at async /home/ooye/out-of-your-element/src/d2m/actions/create-room.js:246:19
    at async postApplyPowerLevels (/home/ooye/out-of-your-element/src/d2m/actions/create-room.js:283:21)
    at async createRoom (/home/ooye/out-of-your-element/src/d2m/actions/create-room.js:239:21)
    at async /home/ooye/out-of-your-element/src/d2m/actions/create-room.js:405:19 {
  downloadURL: 'https://cdn.discordapp.com/icons/<guild_id>/null.png?size=1024'
}
```

Reviewed-on: cadence/out-of-your-element#106
2026-11-11 13:04:52 +00:00

462 lines
9.5 KiB
JavaScript

const assert = require("assert")
const {kstateToState, stateToKState, diffKState, kstateStripConditionals, kstateUploadMxc, kstateToCreationContent} = require("./kstate")
const {test} = require("supertape")
test("kstate strip: strips false conditions", t => {
t.deepEqual(kstateStripConditionals({
a: {$if: false, value: 2},
b: {value: 4}
}), {
b: {value: 4}
})
})
test("kstate strip: keeps true conditions while removing $if", t => {
t.deepEqual(kstateStripConditionals({
a: {$if: true, value: 2},
b: {value: 4}
}), {
a: {value: 2},
b: {value: 4}
})
})
test("kstateUploadMxc: removes keys where $url is null", async t => {
const input = {
"m.room.avatar/": {
url: {$url: null}
}
}
await kstateUploadMxc(input)
t.deepEqual(input, {
"m.room.avatar/": {}
})
})
test("kstateUploadMxc: sets the mxc", async t => {
const input = {
"m.room.avatar/": {
url: {$url: "https://cdn.discordapp.com/guilds/112760669178241024/users/134826546694193153/avatars/38dd359aa12bcd52dd3164126c587f8c.png?size=1024"},
test1: {
test2: {
test3: {$url: "https://cdn.discordapp.com/attachments/176333891320283136/1157854643037163610/Screenshot_20231001_034036.jpg"}
}
}
}
}
await kstateUploadMxc(input)
t.deepEqual(input, {
"m.room.avatar/": {
url: "mxc://cadence.moe/rfemHmAtcprjLEiPiEuzPhpl",
test1: {
test2: {
test3: "mxc://cadence.moe/zAXdQriaJuLZohDDmacwWWDR"
}
}
}
})
})
test("kstateUploadMxc and strip: work together", async t => {
const input = {
"m.room.avatar/yes": {
$if: true,
url: {$url: "https://cdn.discordapp.com/guilds/112760669178241024/users/134826546694193153/avatars/38dd359aa12bcd52dd3164126c587f8c.png?size=1024"}
},
"m.room.avatar/no": {
$if: false,
url: {$url: "https://cdn.discordapp.com/avatars/320067006521147393/5fc4ad85c1ea876709e9a7d3374a78a1.png?size=1024"}
},
}
kstateStripConditionals(input)
await kstateUploadMxc(input)
t.deepEqual(input, {
"m.room.avatar/yes": {
url: "mxc://cadence.moe/rfemHmAtcprjLEiPiEuzPhpl"
}
})
})
test("kstate2state: general", async t => {
t.deepEqual(await kstateToState({
"m.room.create/": {bogus: true},
"m.room.create/outer": {bogus: true},
"m.room.name/": {name: "test name"},
"m.room.member/@cadence:cadence.moe": {membership: "join"},
"uk.half-shot.bridge/org.matrix.appservice-irc://irc/epicord.net/#general": {creator: "@cadence:cadence.moe"}
}), [
{
type: "m.room.name",
state_key: "",
content: {
name: "test name"
}
},
{
type: "m.room.member",
state_key: "@cadence:cadence.moe",
content: {
membership: "join"
}
},
{
type: "uk.half-shot.bridge",
state_key: "org.matrix.appservice-irc://irc/epicord.net/#general",
content: {
creator: "@cadence:cadence.moe"
}
}
])
})
test("state2kstate: general", t => {
t.deepEqual(stateToKState([
{
type: "m.room.create",
state_key: "",
sender: "@example:matrix.org",
content: {
room_version: "12"
}
},
{
type: "m.room.name",
state_key: "",
content: {
name: "test name"
}
},
{
type: "m.room.member",
state_key: "@cadence:cadence.moe",
content: {
membership: "join"
}
},
{
type: "uk.half-shot.bridge",
state_key: "org.matrix.appservice-irc://irc/epicord.net/#general",
content: {
creator: "@cadence:cadence.moe"
}
}
]), {
"m.room.name/": {name: "test name"},
"m.room.member/@cadence:cadence.moe": {membership: "join"},
"uk.half-shot.bridge/org.matrix.appservice-irc://irc/epicord.net/#general": {creator: "@cadence:cadence.moe"},
"m.room.create/": {room_version: "12"},
"m.room.create/outer": {type: "m.room.create", state_key: "", sender: "@example:matrix.org", content: {room_version: "12"}}
})
})
test("diffKState: detects edits", t => {
t.deepEqual(
diffKState({
"m.room.name/": {name: "test name"},
"same/": {a: 2}
}, {
"m.room.name/": {name: "edited name"},
"same/": {a: 2}
}),
{
"m.room.name/": {name: "edited name"}
}
)
})
test("diffKState: detects new properties", t => {
t.deepEqual(
diffKState({
"m.room.name/": {name: "test name"},
}, {
"m.room.name/": {name: "test name"},
"new/": {a: 2}
}),
{
"new/": {a: 2}
}
)
})
test("diffKState: power levels are mixed together", t => {
const original = {
"m.room.create/outer": {
type: "m.room.create",
state_key: "",
sender: "@example:matrix.org",
content: {
room_version: "11"
}
},
"m.room.create/": {
room_version: "11"
},
"m.room.power_levels/": {
"ban": 50,
"events": {
"m.room.name": 100,
"m.room.power_levels": 100
},
"events_default": 0,
"invite": 50,
"kick": 50,
"notifications": {
"room": 20
},
"redact": 50,
"state_default": 50,
"users": {
"@example:localhost": 100
},
"users_default": 0
}
}
const result = diffKState(original, {
"m.room.power_levels/": {
"events": {
"m.room.avatar": 0
},
users: {
"@example:matrix.org": 100
}
}
})
t.deepEqual(result, {
"m.room.power_levels/": {
"ban": 50,
"events": {
"m.room.name": 100,
"m.room.power_levels": 100,
"m.room.avatar": 0
},
"events_default": 0,
"invite": 50,
"kick": 50,
"notifications": {
"room": 20
},
"redact": 50,
"state_default": 50,
"users": {
"@example:localhost": 100,
"@example:matrix.org": 100
},
"users_default": 0
}
})
t.notDeepEqual(original, result)
})
test("diffKState: cannot merge power levels if original power levels are missing", t => {
const original = {}
assert.throws(() =>
diffKState(original, {
"m.room.power_levels/": {
"events": {
"m.room.avatar": 0
}
}
})
, /original power level data is missing/)
t.pass()
})
test("diffKState: kstate keys must contain a slash separator", t => {
assert.throws(() =>
diffKState({
"m.room.name/": {name: "test name"},
}, {
"m.room.name/": {name: "test name"},
"new": {a: 2}
})
, /does not contain a slash separator/)
t.pass()
})
test("diffKState: topic does not change if the topic key has not changed", t => {
t.deepEqual(diffKState({
"m.room.topic/": {
topic: "hello",
"m.topic": {
"m.text": "hello"
}
}
}, {
"m.room.topic/": {
topic: "hello"
}
}),
{})
})
test("diffKState: topic changes if the topic key has changed", t => {
t.deepEqual(diffKState({
"m.room.topic/": {
topic: "hello",
"m.topic": {
"m.text": "hello"
}
}
}, {
"m.room.topic/": {
topic: "hello you"
}
}),
{
"m.room.topic/": {
topic: "hello you"
}
})
})
test("diffKState: room v12 creators cannot be introduced into power levels", t => {
const original = {
"m.room.create/outer": {
type: "m.room.create",
state_key: "",
sender: "@example1:matrix.org",
content: {
additional_creators: ["@example2:matrix.org"],
room_version: "12"
}
},
"m.room.create/": {
room_version: "12"
},
"m.room.power_levels/": {
"ban": 50,
"events": {
"m.room.name": 100,
"m.room.power_levels": 100
},
"events_default": 0,
"invite": 50,
"kick": 50,
"notifications": {
"room": 20
},
"redact": 50,
"state_default": 50,
"users": {
"@example:localhost": 100
},
"users_default": 0
}
}
const result = diffKState(original, {
"m.room.create/": {
bogus: true
},
"m.room.power_levels/": {
events: {
"m.room.avatar": 0
},
users: {
"@example1:matrix.org": 100,
"@example2:matrix.org": 100,
"@example3:matrix.org": 100
}
}
})
t.deepEqual(result, {
"m.room.power_levels/": {
"ban": 50,
"events": {
"m.room.name": 100,
"m.room.power_levels": 100,
"m.room.avatar": 0
},
"events_default": 0,
"invite": 50,
"kick": 50,
"notifications": {
"room": 20
},
"redact": 50,
"state_default": 50,
"users": {
"@example:localhost": 100,
"@example3:matrix.org": 100
},
"users_default": 0
}
})
t.notDeepEqual(original, result)
})
test("diffKState: room v12 creators cannot be introduced into power levels - no diff if no changes", t => {
const original = {
"m.room.create/outer": {
type: "m.room.create",
state_key: "",
sender: "@example1:matrix.org",
content: {
additional_creators: ["@example2:matrix.org"],
room_version: "12"
}
},
"m.room.create/": {
additional_creators: ["@example2:matrix.org"],
room_version: "12"
},
"m.room.power_levels/": {
"ban": 50,
"events": {
"m.room.name": 100,
"m.room.power_levels": 100
},
"events_default": 0,
"invite": 50,
"kick": 50,
"notifications": {
"room": 20
},
"redact": 50,
"state_default": 50,
"users": {
"@example:localhost": 100
},
"users_default": 0
}
}
const result = diffKState(original, {
"m.room.power_levels/": {
users: {
"@example1:matrix.org": 100,
"@example2:matrix.org": 100
}
}
})
t.deepEqual(result, {})
t.notDeepEqual(original, result)
})
test("kstateToCreationContent: works", t => {
const original = {
"m.room.create/outer": {
type: "m.room.create",
state_key: "",
sender: "@example1:matrix.org",
content: {
additional_creators: ["@example2:matrix.org"],
room_version: "12",
type: "m.space"
}
},
"m.room.create/": {
additional_creators: ["@example2:matrix.org"],
room_version: "12",
type: "m.space"
}
}
t.deepEqual(kstateToCreationContent(original), {
additional_creators: ["@example2:matrix.org"],
room_version: "12",
type: "m.space"
})
})
test("kstateToCreationContent: works if empty", t => {
t.deepEqual(kstateToCreationContent({}), {})
})