mark message read on receipt

Author: clairton

README.md

@@ -385,6 +385,7 @@ WEBHOOK_SEND_OUTGOING_MESSAGES=true, send outgoing messages to webhook, default
 IGNORE_GROUP_MESSAGES=false to send group messages received in socket to webhook, default true
 IGNORE_BROADCAST_STATUSES=false to send stories in socket to webhook, default true
 IGNORE_STATUS_MESSAGE=false to send stories in socket to webhook, default true
+READ_ON_RECEIPT=false mark message as read on receipt
 IGNORE_BROADCAST_MESSAGES=false to send broadcast messages in socket to webhook, default false
 IGNORE_HISTORY_MESSAGES=false to import messages when connect, default is true
 IGNORE_OWN_MESSAGES=false to send own messages in socket to webhook, default true

public/index.html

@@ -287,6 +287,13 @@ <h5 class="modal-title" id="editModalLabel">Editar/Adicionar Sessão</h5>
                                 </label>
                                 <label for="ignoreHistoryMessages" class="form-label">Ignorar Histórico de Mensagens</label>
                             </div>
+                            <div class="col-12 col-md-6 col-lg-6 col-xl-4 col-xxl-3">
+                                <label class="switch">
+                                    <input type="checkbox" id="readOnReceipt" name="readOnReceipt" checked>
+                                    <span class="slider round"></span>
+                                </label>
+                                <label for="readOnReceipt" class="form-label">Ler a mensagem ao receber</label>
+                            </div>
                             <div class="col-12 col-md-6 col-lg-6 col-xl-4 col-xxl-3">
                                 <label class="switch">
                                     <input type="checkbox" id="sendProfilePicture" name="sendProfilePicture">
@@ -614,6 +621,7 @@ <h5 class="modal-title" id="connectModalLabel">Conectar Sessão</h5>
                 $('#rejectCalls').val(session.rejectCalls);
                 $('#ignoreGroupMessages').prop('checked', session.ignoreGroupMessages);
                 $('#ignoreHistoryMessages').prop('checked', session.ignoreHistoryMessages);
+                $('#readOnReceipt').prop('checked', session.readOnReceipt);
                 $('#sendProfilePicture').prop('checked', session.sendProfilePicture);
                 $('#ignoreOwnMessages').prop('checked', session.ignoreOwnMessages);
                 $('#ignoreYourselfMessages').prop('checked', session.ignoreYourselfMessages);
@@ -672,6 +680,7 @@ <h5 class="modal-title" id="connectModalLabel">Conectar Sessão</h5>
                         rejectCallsWebhook: $('#rejectCallsWebhook').val(),
                         ignoreGroupMessages: $('#ignoreGroupMessages').is(':checked'),
                         ignoreHistoryMessages: $('#ignoreHistoryMessages').is(':checked'),
+                        readOnReceipt: $('#readOnReceipt').is(':checked'),
                         sendProfilePicture: $('#sendProfilePicture').is(':checked'),
                         ignoreOwnMessages: $('#ignoreOwnMessages').is(':checked'),
                         ignoreYourselfMessages: $('#ignoreYourselfMessages').is(':checked'),

src/defaults.ts

@@ -96,6 +96,7 @@ export const COMPOSING_MESSAGE: boolean = process.env.COMPOSING_MESSAGE === _und
 export const IGNORE_GROUP_MESSAGES: boolean = process.env.IGNORE_GROUP_MESSAGES == _undefined ? true : process.env.IGNORE_GROUP_MESSAGES == 'true'
 export const IGNORE_BROADCAST_STATUSES: boolean =
   process.env.IGNORE_BROADCAST_STATUSES === _undefined ? true : process.env.IGNORE_BROADCAST_STATUSES == 'true'
+export const READ_ON_RECEIPT: boolean = process.env.READ_ON_RECEIPT === _undefined ? false : process.env.READ_ON_RECEIPT == 'true'
 export const IGNORE_BROADCAST_MESSAGES: boolean =
   process.env.IGNORE_BROADCAST_MESSAGES === _undefined ? false : process.env.IGNORE_OWN_MESSAGES == 'true'
 export const IGNORE_HISTORY_MESSAGES: boolean =

src/services/client_baileys.ts

@@ -20,7 +20,7 @@ import {
 } from './socket'
 import { Client, getClient, clients, Contact } from './client'
 import { Config, configs, defaultConfig, getConfig, getMessageMetadataDefault } from './config'
-import { toBaileysMessageContent, phoneNumberToJid, jidToPhoneNumber } from './transformer'
+import { toBaileysMessageContent, phoneNumberToJid, jidToPhoneNumber, getMessageType, TYPE_MESSAGES_TO_READ } from './transformer'
 import { v1 as uuid } from 'uuid'
 import { Response } from './response'
 import QRCode from 'qrcode'
@@ -304,11 +304,27 @@ export class ClientBaileys implements Client {
   async subscribe() {
     this.event('messages.upsert', async (payload: { messages: []; type }) => {
       logger.debug('messages.upsert %s', this.phone, JSON.stringify(payload))
-      this.listener.process(this.phone, payload.messages, payload.type)
+      await this.listener.process(this.phone, payload.messages, payload.type)
+      console.log('>>>>>>>>>> readOnReceipt 1')
+      if (this.config.readOnReceipt) {
+        console.log('>>>>>>>>>> readOnReceipt 2')
+        await Promise.all(
+          payload.messages
+            .filter((message: any) => {
+              console.log('>>>>>>>>>> readOnReceipt 3')
+              const messageType = getMessageType(message)
+              return !message?.key?.fromMe && messageType && TYPE_MESSAGES_TO_READ.includes(messageType)
+            })
+            .map(async (message: any) => {
+              console.log('>>>>>>>>>> readOnReceipt 2')
+              return this.readMessages([message.key!])
+            })
+        )
+      }
     })
-    this.event('messages.update', (messages: object[]) => {
+    this.event('messages.update', async (messages: object[]) => {
       logger.debug('messages.update %s %s', this.phone, JSON.stringify(messages))
-      this.listener.process(this.phone, messages, 'update')
+      return this.listener.process(this.phone, messages, 'update')
     })
     this.event('message-receipt.update', (updates: object[]) => {
       logger.debug('message-receipt.update %s %s', this.phone, JSON.stringify(updates))

src/services/config.ts

@@ -30,6 +30,7 @@ export type Config = {
   ignoreGroupMessages: boolean
   ignoreBroadcastMessages: boolean
   ignoreBroadcastStatuses: boolean
+  readOnReceipt: boolean
   ignoreHistoryMessages: boolean
   ignoreYourselfMessages: boolean
   ignoreOwnMessages: boolean
@@ -70,6 +71,7 @@ export const defaultConfig: Config = {
   ignoreGroupMessages: true,
   ignoreBroadcastStatuses: true,
   ignoreBroadcastMessages: false,
+  readOnReceipt: false,
   ignoreHistoryMessages: true,
   ignoreOwnMessages: true,
   ignoreYourselfMessages: true,

src/services/config_by_env.ts

@@ -40,13 +40,15 @@ import {
   WAVOIP_TOKEN,
   CONNECTION_TYPE,
   QR_TIMEOUT_MS,
+  READ_ON_RECEIPT,
 } from '../defaults'
 
 export const getConfigByEnv: getConfig = async (phone: string): Promise<Config> => {
   if (!configs.has(phone)) {
     const config: Config = { ...defaultConfig }
     config.logLevel = LOG_LEVEL as Level
     config.ignoreGroupMessages = IGNORE_GROUP_MESSAGES
+    config.readOnReceipt = READ_ON_RECEIPT
     config.ignoreBroadcastStatuses = IGNORE_BROADCAST_STATUSES
     config.ignoreBroadcastMessages = IGNORE_BROADCAST_MESSAGES
     config.ignoreHistoryMessages = IGNORE_HISTORY_MESSAGES

src/services/transformer.ts

@@ -38,7 +38,7 @@ export class DecryptError extends Error {
   }
 }
 
-const TYPE_MESSAGES_TO_PROCESS = [
+export const TYPE_MESSAGES_TO_READ = [
   'viewOnceMessage',
   'editedMessage',
   'ephemeralMessage',
@@ -59,11 +59,14 @@ const TYPE_MESSAGES_TO_PROCESS = [
   'listResponseMessage',
   'conversation',
   'ptvMessage',
+]
+
+const TYPE_MESSAGES_TO_PROCESS = TYPE_MESSAGES_TO_READ.concat([
   'protocolMessage',
   'senderKeyDistributionMessage',
   'messageContextInfo',
   'messageStubType',
-]
+])
 
 export const getMimetype = (payload: any) => {
   const { type } = payload