parse sticker reactions (#57)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: KishanBagaria

src/api.ts

@@ -47,9 +47,9 @@ function getDNDState() {
   return new Set(arr)
 }
 export default class AppleiMessage implements PlatformAPI {
-  currentUser: CurrentUser | undefined
+  constructor(public readonly accountID: string) {}
 
-  // private accountID: string
+  currentUser: CurrentUser | undefined
 
   private threadReadStore?: ThreadReadStore
 
@@ -148,7 +148,6 @@ export default class AppleiMessage implements PlatformAPI {
 
   init = async (session: SerializedSession, { dataDirPath }: ClientContext, prefs?: Record<string, any>) => {
     this.session = session || {}
-    // this.accountID = accountID
     const userDataDirPath = path.dirname(dataDirPath)
     this.experiments = await fs.readFile(path.join(userDataDirPath, 'imessage-enabled-experiments'), 'utf-8').catch(() => '')
     if (swiftServer) {
@@ -359,6 +358,7 @@ export default class AppleiMessage implements PlatformAPI {
       texts.error(`imsg/getThreads: couldn't log hashed ids: ${err}`)
     }
     const items = mapThreads(chatRows, {
+      accountID: this.accountID,
       mapMessageArgsMap,
       handleRowsMap,
       chatImagesMap,
@@ -393,7 +393,7 @@ export default class AppleiMessage implements PlatformAPI {
       db.getAttachments(msgRowIDs),
       db.getMessageReactions(msgGUIDs, { type: 'guid', guid: threadID }),
     ])
-    const items = mapMessages(msgRows, attachmentRows, reactionRows, this.currentUser!.id)
+    const items = mapMessages(msgRows, attachmentRows, reactionRows, this.currentUser!.id, this.accountID)
     return {
       // NOTE(types): appease typescript, but we aren't actually using the texts SDK contract
       items: items.map(hashMessage) as Message[],
@@ -411,7 +411,7 @@ export default class AppleiMessage implements PlatformAPI {
       db.getAttachments([msgRow.ROWID]),
       db.getMessageReactions([msgRow.guid], { type: 'guid', guid: threadID }),
     ])
-    const items = mapMessages([msgRow], attachmentRows, reactionRows, this.currentUser!.id)
+    const items = mapMessages([msgRow], attachmentRows, reactionRows, this.currentUser!.id, this.accountID)
     const message = items.find(i => i.id === messageID)
     // NOTE(types): appease typescript, but we aren't actually using the texts SDK contract
     return (message ? hashMessage(message) : message) as Message
@@ -440,7 +440,7 @@ export default class AppleiMessage implements PlatformAPI {
       db.getAttachments(msgRowIDs),
       threadID ? db.getMessageReactions(msgGUIDs, { type: 'guid', guid: threadID }) : [],
     ])
-    const items = mapMessages(msgRows, attachmentRows, reactionRows, this.currentUser!.id)
+    const items = mapMessages(msgRows, attachmentRows, reactionRows, this.currentUser!.id, this.accountID)
     return {
       // NOTE(types): appease typescript, but we aren't actually using the texts SDK contract
       items: items.map(hashMessage) as Message[],
@@ -682,11 +682,13 @@ export default class AppleiMessage implements PlatformAPI {
   }
 
   addReaction = async (hashedThreadID: ThreadID, messageID: MessageID, reactionKey: string) => {
+    if (reactionKey === 'sticker') throw Error("Adding sticker reactions isn't supported")
     const threadID = originalThreadID(hashedThreadID)
     return this.threadPhaser.bracketed(hashedThreadID, this.setReaction(threadID, messageID, reactionKey, true))
   }
 
   removeReaction = async (hashedThreadID: ThreadID, messageID: MessageID, reactionKey: string) => {
+    if (reactionKey === 'sticker') throw Error("Removing sticker reactions isn't supported")
     const threadID = originalThreadID(hashedThreadID)
     return this.threadPhaser.bracketed(hashedThreadID, this.setReaction(threadID, messageID, reactionKey, false))
   }
@@ -886,6 +888,16 @@ export default class AppleiMessage implements PlatformAPI {
         return url.pathToFileURL(filePath).href
       }
 
+      case 'reaction-sticker': {
+        if (!/^\d+$/.test(methodName)) throw new Error("invalid reaction sticker row ID")
+        const reactionRowID = Number(methodName)
+        if (!Number.isSafeInteger(reactionRowID)) throw new Error("invalid reaction sticker row ID")
+        const db = await this.ensureDB()
+        const attachment = (await db.getAttachments([reactionRowID])).find(a => a.filePath)
+        if (!attachment?.filePath) throw new Error("couldn't resolve sticker attachment for reaction row")
+        return url.pathToFileURL(attachment.filePath).href
+      }
+
       default: {
         const filePath = Buffer.from(pathHex, 'hex').toString()
         const buffer = await fs.readFile(filePath)

src/constants.ts

@@ -19,6 +19,7 @@ export const ASSOC_MSG_TYPE = {
   2004: 'reacted_emphasize',
   2005: 'reacted_question',
   2006: 'reacted_emoji',
+  2007: 'reacted_sticker',
 
   3000: 'unreacted_heart',
   3001: 'unreacted_like',
@@ -27,6 +28,7 @@ export const ASSOC_MSG_TYPE = {
   3004: 'unreacted_emphasize',
   3005: 'unreacted_question',
   3006: 'unreacted_emoji',
+  3007: 'unreacted_sticker',
 } as const
 
 export const REACTION_VERB_MAP = {
@@ -37,6 +39,7 @@ export const REACTION_VERB_MAP = {
   reacted_emphasize: 'emphasized',
   reacted_question: 'questioned',
   reacted_emoji: 'reacted to',
+  reacted_sticker: 'reacted with a sticker to',
 
   unreacted_heart: 'removed a heart from',
   unreacted_like: 'removed a like from',
@@ -45,6 +48,7 @@ export const REACTION_VERB_MAP = {
   unreacted_emphasize: 'removed an exclamation from',
   unreacted_question: 'removed a question mark from',
   unreacted_emoji: 'unreacted from',
+  unreacted_sticker: 'removed a sticker from',
 } as const
 
 export const EXPRESSIVE_MSGS = {

src/db-api.ts

@@ -80,7 +80,7 @@ FROM message AS m
 LEFT JOIN message_attachment_join AS maj ON maj.message_id = m.ROWID
 LEFT JOIN attachment AS a ON a.ROWID = maj.attachment_id
 WHERE m.ROWID IN (${new Array(msgIDs.length).fill('?').join(', ')})`,
-  getMessageReactions: (msgGUIDs: string[]) => `SELECT is_from_me, handle_id, associated_message_type, associated_message_guid, ${IS_SEQUOIA_OR_UP ? 'associated_message_emoji,' : ''} h.id AS participantID
+  getMessageReactions: (msgGUIDs: string[]) => `SELECT m.ROWID, is_from_me, handle_id, associated_message_type, associated_message_guid, ${IS_SEQUOIA_OR_UP ? 'associated_message_emoji,' : ''} h.id AS participantID
 FROM message AS m
 LEFT JOIN handle AS h ON m.handle_id = h.ROWID
 LEFT JOIN chat_message_join AS cmj ON cmj.message_id = m.ROWID
@@ -411,7 +411,7 @@ WHERE m.ROWID = ?`, rowID)
   private getMappedMessagesWithoutExtraRows = async (chatGUID: string, pagination?: PaginationArg) => {
     const msgRows = await this.getMessages(chatGUID, pagination)
     if (pagination?.direction !== 'after') msgRows.reverse()
-    const items = mapMessages(msgRows, [], [], this.papi.currentUser!.id)
+    const items = mapMessages(msgRows, [], [], this.papi.currentUser!.id, this.papi.accountID)
     return {
       items,
       hasMore: msgRows.length === MESSAGES_LIMIT,

src/mappers.ts

@@ -59,7 +59,10 @@ const removeObjReplacementChar = (text: string): string => {
   return text.replaceAll(OBJ_REPLACEMENT_CHAR, ' ').trim()
 }
 
-function assignReactions(currentUserID: string, message: BeeperMessage, _reactionRows: MappedReactionMessageRow[] = [], filterIndex?: number) {
+const reactionStickerAssetURL = (accountID: string, rowID: MappedReactionMessageRow['ROWID']) =>
+  `asset://${accountID}/reaction-sticker/${rowID}.heic`
+
+function assignReactions(currentUserID: string, accountID: string, message: BeeperMessage, _reactionRows: MappedReactionMessageRow[] = [], filterIndex?: number) {
   const reactions: MessageReaction[] = []
   const reactionRows = filterIndex != null
     ? _reactionRows.filter(r => r.associated_message_guid.startsWith(`p:${filterIndex}/`))
@@ -75,6 +78,7 @@ function assignReactions(currentUserID: string, message: BeeperMessage, _reactio
           id: participantID,
           reactionKey: actionKey === 'emoji' ? reaction.associated_message_emoji : actionKey,
           participantID,
+          imgURL: actionKey === 'sticker' ? reactionStickerAssetURL(accountID, reaction.ROWID) : undefined,
         })
       } else if (actionType === 'unreacted') {
         const index = reactions.findIndex(r => r.id === participantID)
@@ -241,7 +245,7 @@ const UUID_START = 11
 const UUID_LENGTH = 36
 const UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$/i
 // eslint-disable-next-line @typescript-eslint/default-param-last -- FIXME(skip)
-export function mapMessage(msgRow: MappedMessageRow, attachmentRows: MappedAttachmentRow[] = [], reactionRows: MappedReactionMessageRow[], currentUserID: string): BeeperMessage[] {
+export function mapMessage(msgRow: MappedMessageRow, attachmentRows: MappedAttachmentRow[] = [], reactionRows: MappedReactionMessageRow[], currentUserID: string, accountID: string): BeeperMessage[] {
   const attachments = attachmentRows.map(a => mapAttachment(a, msgRow)).filter(attachment => attachment != null)
   const isSMS = msgRow.service === 'SMS' || msgRow.service === 'RCS'
   const isGroup = !!msgRow.room_name
@@ -615,9 +619,10 @@ export function mapMessage(msgRow: MappedMessageRow, attachmentRows: MappedAttac
           type: reactionType,
           messageID: m.linkedMessageID,
           participantID: m.senderID,
+          imgURL: assocMsgType === 'reacted_sticker' ? reactionStickerAssetURL(accountID, msgRow.ROWID) : undefined,
           reactionKey: actionKey === 'emoji' ? msgRow.associated_message_emoji : actionKey,
         }
-        if (actionKey === 'emoji' || actionKey in supportedReactions) {
+        if (actionKey === 'emoji' || actionKey === 'sticker' || actionKey in supportedReactions) {
           m.parseTemplate = true
           m.text = `${msgRow.is_from_me ? 'You' : '{{sender}}'} ${REACTION_VERB_MAP[assocMsgType]} ${msi?.ams ? `"${msi?.ams}"` : 'a message'}`
           m.isHidden = true
@@ -629,7 +634,7 @@ export function mapMessage(msgRow: MappedMessageRow, attachmentRows: MappedAttac
 
   return messages.map(msg => {
     // texts.log('assigning reactions', msg.id, msg.index, reactionRows)
-    assignReactions(currentUserID, msg, reactionRows, messages.length === 1 ? undefined : msg.extra?.part)
+    assignReactions(currentUserID, accountID, msg, reactionRows, messages.length === 1 ? undefined : msg.extra?.part)
     return msg
   })
 }
@@ -672,6 +677,7 @@ function mapParticipant({ participantID: id, uncanonicalized_id }: MappedHandleR
 export const mapAccountLogin = (al: string) => al?.replace(/^(E|P):/, '')
 
 type Context = {
+  accountID: string
   currentUserID: string
   handleRowsMap: { [threadID: string]: MappedHandleRow[] }
   mapMessageArgsMap: { [threadID: string]: [MappedMessageRow[], MappedAttachmentRow[], MappedReactionMessageRow[]] }
@@ -688,16 +694,16 @@ type Context = {
 
 // @ts-expect-error FIXME(skip): argument ordering
 // eslint-disable-next-line @typescript-eslint/default-param-last
-export function mapMessages(messages: MappedMessageRow[], attachmentRows?: MappedAttachmentRow[], reactionRows?: MappedReactionMessageRow[], currentUserID: string): BeeperMessage[] {
+export function mapMessages(messages: MappedMessageRow[], attachmentRows?: MappedAttachmentRow[], reactionRows?: MappedReactionMessageRow[], currentUserID: string, accountID: string): BeeperMessage[] {
   const groupedAttachmentRows = groupBy(attachmentRows, 'msgRowID')
   const groupedReactionRows = groupBy(reactionRows, r => r.associated_message_guid.replace(assocMsgGuidPrefix, ''))
   return messages
-    .flatMap(message => mapMessage(message, groupedAttachmentRows[message.ROWID], groupedReactionRows[message.guid], currentUserID))
+    .flatMap(message => mapMessage(message, groupedAttachmentRows[message.ROWID], groupedReactionRows[message.guid], currentUserID, accountID))
     .filter(Boolean)
 }
 
 export function mapThread(chat: MappedChatRow, context: Context): BeeperThread {
-  const { currentUserID } = context
+  const { currentUserID, accountID } = context
   const handleRows = context.handleRowsMap[chat.guid]
   const mapMessageArgs = context.mapMessageArgsMap?.[chat.guid]
   const selfID = chat.last_addressed_handle || mapAccountLogin(chat.account_login) || currentUserID
@@ -707,7 +713,7 @@ export function mapThread(chat: MappedChatRow, context: Context): BeeperThread {
   const participants = [...handleRows.map(h => mapParticipant(h, chat.display_name)), selfParticipant].filter(participant => participant != null)
   const isGroup = !!chat.room_name
   const isReadOnly = chat.state === 0 && chat.properties != null
-  const messages = mapMessageArgs ? mapMessages(...mapMessageArgs, currentUserID) : []
+  const messages = mapMessageArgs ? mapMessages(...mapMessageArgs, currentUserID, accountID) : []
   /*
     props = {
       "com.apple.iChat.LastArchivedMessageID": [ 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 101010 ],

src/tests/fixture1.json

@@ -145,5 +145,6 @@
       "participantID": "+918470075752"
     }
   ],
-  "kishan24x7@gmail.com"
+  "kishan24x7@gmail.com",
+  "imessage-test-account"
 ]

src/tests/fixture2.json

@@ -131,5 +131,6 @@
       "participantID": "+918470075752"
     }
   ],
-  "kishan24x7@gmail.com"
+  "kishan24x7@gmail.com",
+  "imessage-test-account"
 ]

src/tests/mappers.test.ts

@@ -4,11 +4,14 @@ import path from 'path'
 
 import { mapMessage } from '../mappers'
 
+type MapMessageFixture = Parameters<typeof mapMessage>
+
 async function testMessageMapFixture(fixturePath: string) {
   const pathRelativeToTests = path.join(__dirname, fixturePath)
 
   test(path.basename(fixturePath), async () => {
-    const parameters: Parameters<typeof mapMessage> = JSON.parse(await fs.readFile(pathRelativeToTests, 'utf8'))
+    const parameters = JSON.parse(await fs.readFile(pathRelativeToTests, 'utf8')) as MapMessageFixture
+    expect(parameters).toHaveLength(5)
 
     type Row = typeof parameters[0]
     type MessageRowBufferKeys = { [Key in keyof Row]: Row[Key] extends Buffer ? Key : never }[keyof Row]

src/tests/partial_leading_unsends.json

@@ -104,5 +104,6 @@
     }
   ],
   [],
-  "tinyslices@gmail.com"
+  "tinyslices@gmail.com",
+  "imessage-test-account"
 ]

src/tests/partial_multiple_middle_adjacent_unsend.json

@@ -104,5 +104,6 @@
     }
   ],
   [],
-  "tinyslices@gmail.com"
+  "tinyslices@gmail.com",
+  "imessage-test-account"
 ]

src/tests/partial_trailing_unsends.json

@@ -104,5 +104,6 @@
     }
   ],
   [],
-  "tinyslices@gmail.com"
+  "tinyslices@gmail.com",
+  "imessage-test-account"
 ]