adding basic reactions to discord messages

d2m/actions/add-reaction.js

@@ -0,0 +1,36 @@
+// @ts-check
+
+const assert = require("assert")
+
+const passthrough = require("../../passthrough")
+const { discord, sync, db } = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("./register-user")} */
+const registerUser = sync.require("./register-user")
+/** @type {import("../actions/create-room")} */
+const createRoom = sync.require("../actions/create-room")
+
+/**
+ * @param {import("discord-api-types/v10").GatewayMessageReactionAddDispatchData} data
+ */
+async function addReaction(data) {
+   const user = data.member?.user
+   assert.ok(user && user.username)
+   // TODO: should add my own sent messages to event_message so they can be reacted to?
+   const parentID = db.prepare("SELECT event_id FROM event_message WHERE message_id = ? AND part = 0").pluck().get(data.message_id) // 0 = primary
+   if (!parentID) return // TODO: how to handle reactions for unbridged messages? is there anything I can do?
+   assert.equal(typeof parentID, "string")
+	const roomID = await createRoom.ensureRoom(data.channel_id)
+	const senderMxid = await registerUser.ensureSimJoined(user, roomID)
+	const eventID = api.sendEvent(roomID, "m.reaction", {
+      "m.relates_to": {
+         rel_type: "m.annotation",
+         event_id: parentID,
+         key: data.emoji.name
+      }
+   }, senderMxid)
+	return eventID
+}
+
+module.exports.addReaction = addReaction

d2m/actions/register-user.js

@@ -24,16 +24,25 @@ async function createSim(user) {
 	const mxid = "@" + localpart + ":cadence.moe"
 
 	// Save chosen name in the database forever
+	// Making this database change right away so that in a concurrent registration, the 2nd registration will already have generated a different localpart because it can see this row when it generates
 	db.prepare("INSERT INTO sim (discord_id, sim_name, localpart, mxid) VALUES (?, ?, ?, ?)").run(user.id, simName, localpart, mxid)
 
 	// Register matrix user with that name
-	await api.register(localpart)
+	try {
+		await api.register(localpart)
+	} catch (e) {
+		// If user creation fails, manually undo the database change. Still isn't perfect, but should help.
+		// (A transaction would be preferable, but I don't think it's safe to leave transaction open across event loop ticks.)
+		db.prepare("DELETE FROM sim WHERE discord_id = ?").run(user.id)
+		throw e
+	}
 	return mxid
 }
 
 /**
  * Ensure a sim is registered for the user.
  * If there is already a sim, use that one. If there isn't one yet, register a new sim.
+ * @param {import("discord-api-types/v10").APIUser} user
  * @returns mxid
  */
 async function ensureSim(user) {
@@ -49,6 +58,7 @@ async function ensureSim(user) {
 
 /**
  * Ensure a sim is registered for the user and is joined to the room.
+ * @param {import("discord-api-types/v10").APIUser} user
  * @returns mxid
  */
 async function ensureSimJoined(user, roomID) {

d2m/actions/send-message.js

@@ -1,8 +1,5 @@
 // @ts-check
 
-const fetch = require("node-fetch").default
-const reg = require("../../matrix/read-registration.js")
-
 const passthrough = require("../../passthrough")
 const { discord, sync, db } = passthrough
 /** @type {import("../converters/message-to-event")} */
@@ -24,7 +21,8 @@ async function sendMessage(message) {
 	if (!message.webhook_id) {
 		senderMxid = await registerUser.ensureSimJoined(message.author, roomID)
 	}
-	const eventID = api.sendEvent(roomID, "m.room.message", event, senderMxid)
+	const eventID = await api.sendEvent(roomID, "m.room.message", event, senderMxid)
+	db.prepare("INSERT INTO event_message (event_id, message_id, part) VALUES (?, ?, ?)").run(eventID, message.id, 0) // 0 is primary, 1 is supporting
 	return eventID
 }
 

d2m/converters/user-to-mxid.js

@@ -44,6 +44,7 @@ function* generateLocalpartAlternatives(preferences) {
 
 /**
  * Whole process for checking the database and generating the right sim name.
+ * It is very important this is not an async function: once the name has been chosen, the calling function should be able to immediately claim that name into the database in the same event loop tick.
  * @param {import("discord-api-types/v10").APIUser} user
  * @returns {string}
  */

d2m/converters/user-to-mxid.test.js

@@ -31,3 +31,7 @@ test("user2name: adds number suffix if name is unavailable (new username format)
 test("user2name: uses ID if name becomes too short", t => {
    t.equal(userToSimName({username: "f***", discriminator: "0001", id: "9"}), "9")
 })
+
+test("user2name: uses ID when name has only disallowed characters", t => {
+   t.equal(userToSimName({username: "!@#$%^&*", discriminator: "0001", id: "9"}), "9")
+})

d2m/discord-packets.js

@@ -6,15 +6,16 @@ const DiscordTypes = require("discord-api-types/v10")
 const passthrough = require("../passthrough")
 const { sync } = passthrough
 
-/** @type {typeof import("./event-dispatcher")} */
-const eventDispatcher = sync.require("./event-dispatcher")
-
 const utils = {
 	/**
 	 * @param {import("./discord-client")} client
 	 * @param {import("cloudstorm").IGatewayMessage} message
 	 */
 	onPacket(client, message) {
+		// requiring this later so that the client is already constructed by the time event-dispatcher is loaded
+		/** @type {typeof import("./event-dispatcher")} */
+		const eventDispatcher = sync.require("./event-dispatcher")
+
 		if (message.t === "READY") {
 			if (client.ready) return
 			client.ready = true

d2m/event-dispatcher.js

@@ -2,11 +2,10 @@
 
 const {sync} = require("../passthrough")
 
-/** @type {import("./actions/create-space")}) */
-const createSpace = sync.require("./actions/create-space")
-
 /** @type {import("./actions/send-message")}) */
 const sendMessage = sync.require("./actions/send-message")
+/** @type {import("./actions/add-reaction")}) */
+const addReaction = sync.require("./actions/add-reaction")
 
 // Grab Discord events we care about for the bridge, check them, and pass them on
 
@@ -25,7 +24,8 @@ module.exports = {
 	 * @param {import("discord-api-types/v10").GatewayMessageReactionAddDispatchData} data
 	 */
 	onReactionAdd(client, data) {
+		if (data.emoji.id !== null) return // TOOD: image emoji reactions
 		console.log(data)
-		return {}
+		addReaction.addReaction(data)
 	}
 }

matrix/api.js

@@ -28,6 +28,7 @@ function path(p, mxid) {
  * @returns {Promise<import("../types").R.Registered>}
  */
 function register(username) {
+   console.log(`[api] register: ${username}`)
    return mreq.mreq("POST", "/client/v3/register", {
       type: "m.login.application_service",
       username
@@ -38,6 +39,7 @@ function register(username) {
  * @returns {Promise<string>} room ID
  */
 async function createRoom(content) {
+   console.log(`[api] create room:`, content)
    /** @type {import("../types").R.RoomCreated} */
    const root = await mreq.mreq("POST", "/client/v3/createRoom", content)
    return root.room_id
@@ -74,6 +76,7 @@ function getAllState(roomID) {
  * @returns {Promise<string>} event ID
  */
 async function sendState(roomID, type, stateKey, content, mxid) {
+   console.log(`[api] state: ${roomID}: ${type}/${stateKey}`)
    assert.ok(type)
    assert.ok(stateKey)
    /** @type {import("../types").R.EventSent} */
@@ -82,6 +85,7 @@ async function sendState(roomID, type, stateKey, content, mxid) {
 }
 
 async function sendEvent(roomID, type, content, mxid) {
+   console.log(`[api] event to ${roomID} as ${mxid || "default sim"}`)
    /** @type {import("../types").R.EventSent} */
    const root = await mreq.mreq("PUT", path(`/client/v3/rooms/${roomID}/send/${type}/${makeTxnId.makeTxnId()}`, mxid), content)
    return root.event_id

matrix/mreq.js

@@ -11,11 +11,12 @@ const reg = sync.require("./read-registration.js")
 const baseUrl = "https://matrix.cadence.moe/_matrix"
 
 class MatrixServerError extends Error {
-	constructor(data) {
+	constructor(data, opts) {
 		super(data.error || data.errcode)
 		this.data = data
 		/** @type {string} */
 		this.errcode = data.errcode
+		this.opts = opts
 	}
 }
 
@@ -38,7 +39,7 @@ async function mreq(method, url, body, extra = {}) {
 	const res = await fetch(baseUrl + url, opts)
 	const root = await res.json()
 
-	if (!res.ok || root.errcode) throw new MatrixServerError(root)
+	if (!res.ok || root.errcode) throw new MatrixServerError(root, opts)
 	return root
 }
 

matrix/read-registration.test.js

@@ -0,0 +1,11 @@
+const {test} = require("supertape")
+const assert = require("assert")
+const reg = require("./read-registration")
+
+test("reg: has necessary parameters", t => {
+   const propertiesToCheck = ["sender_localpart", "id", "as_token", "namespace_prefix"]
+   t.deepEqual(
+      propertiesToCheck.filter(p => p in reg),
+      propertiesToCheck
+   )
+})

test/test.js

@@ -12,6 +12,7 @@ const sync = new HeatSync({watchFS: false})
 
 Object.assign(passthrough, { config, sync, db })
 
+require("../matrix/read-registration.test")
 require("../d2m/actions/create-room.test")
 require("../d2m/converters/user-to-mxid.test")
 require("../matrix/api.test")