chore: refactor incoming_message_baileys_service using composition and fix some failure points (#53)
* feat: implement connection update handling for Baileys * feat: add message update handling for Baileys integration * feat: implement message processing and handling for Baileys integration * fix: clear message source ID from Redis when contact is not found * fix: raise error when attachment file is not found during media handling * refactor: reorganize includes in incoming_message_baileys_service * feat: add helper methods for message handling in Baileys integration * feat: include IncomingMessageServiceHelpers in MessagesUpdate module * refactor: replace IncomingMessageServiceHelpers with BaileysHandlers::Helpers in connection_update, messages_update, and messages_upsert modules * fix: mark message as unsupported when attachment file is not found * refactor: remove unnecessary namespace for includes in IncomingMessageBaileysService * refactor: add private visibility to methods in connection_update, helpers, messages_update, and messages_upsert modules * refactor: preserve original message in handle_edited_content method * fix: attachment error handling * feat: implement conversation creation logic in set_conversation method * refactor: remove unused error handling for attachment not found in messages update and upsert * feat: update last seen timestamps in conversation on message status update * feat: log warning for unsupported message update status in Baileys service * chore: merge --------- Co-authored-by: gabrieljablonski <contact@gabrieljablonski.com>
This commit is contained in:
Cayo P. R. Oliveira
GitHub
parent
e188262877
commit
76deea996d
@ -27,8 +27,6 @@ class Webhooks::WhatsappController < ActionController::API
|
|||||||
head :unauthorized
|
head :unauthorized
|
||||||
rescue Whatsapp::IncomingMessageBaileysService::MessageNotFoundError
|
rescue Whatsapp::IncomingMessageBaileysService::MessageNotFoundError
|
||||||
head :not_found
|
head :not_found
|
||||||
rescue Whatsapp::IncomingMessageBaileysService::AttachmentNotFoundError
|
|
||||||
head :unprocessable_entity
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def valid_token?(token)
|
def valid_token?(token)
|
||||||
|
|||||||
22
app/services/whatsapp/baileys_handlers/connection_update.rb
Normal file
22
app/services/whatsapp/baileys_handlers/connection_update.rb
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
module Whatsapp::BaileysHandlers::ConnectionUpdate
|
||||||
|
include Whatsapp::BaileysHandlers::Helpers
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def process_connection_update
|
||||||
|
data = processed_params[:data]
|
||||||
|
|
||||||
|
# NOTE: `connection` values
|
||||||
|
# - `close`: Never opened, or closed and no longer able to send/receive messages
|
||||||
|
# - `connecting`: In the process of connecting, expecting QR code to be read
|
||||||
|
# - `reconnecting`: Connection has been established, but not open (i.e. device is being linked for the first time, or Baileys server restart)
|
||||||
|
# - `open`: Open and ready to send/receive messages
|
||||||
|
inbox.channel.update_provider_connection!({
|
||||||
|
connection: data[:connection] || inbox.channel.provider_connection['connection'],
|
||||||
|
qr_data_url: data[:qrDataUrl] || nil,
|
||||||
|
error: data[:error] ? I18n.t("errors.inboxes.channel.provider_connection.#{data[:error]}") : nil
|
||||||
|
}.compact)
|
||||||
|
|
||||||
|
Rails.logger.error "Baileys connection error: #{data[:error]}" if data[:error].present?
|
||||||
|
end
|
||||||
|
end
|
||||||
130
app/services/whatsapp/baileys_handlers/helpers.rb
Normal file
130
app/services/whatsapp/baileys_handlers/helpers.rb
Normal file
@ -0,0 +1,130 @@
|
|||||||
|
module Whatsapp::BaileysHandlers::Helpers # rubocop:disable Metrics/ModuleLength
|
||||||
|
include Whatsapp::IncomingMessageServiceHelpers
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def raw_message_id
|
||||||
|
@raw_message[:key][:id]
|
||||||
|
end
|
||||||
|
|
||||||
|
def incoming?
|
||||||
|
!@raw_message[:key][:fromMe]
|
||||||
|
end
|
||||||
|
|
||||||
|
def jid_type # rubocop:disable Metrics/CyclomaticComplexity
|
||||||
|
jid = @raw_message[:key][:remoteJid]
|
||||||
|
server = jid.split('@').last
|
||||||
|
|
||||||
|
# NOTE: Based on Baileys internal functions
|
||||||
|
# https://github.com/WhiskeySockets/Baileys/blob/v6.7.16/src/WABinary/jid-utils.ts#L48-L58
|
||||||
|
case server
|
||||||
|
when 's.whatsapp.net', 'c.us'
|
||||||
|
'user'
|
||||||
|
when 'g.us'
|
||||||
|
'group'
|
||||||
|
when 'lid'
|
||||||
|
'lid'
|
||||||
|
when 'broadcast'
|
||||||
|
jid.start_with?('status@') ? 'status' : 'broadcast'
|
||||||
|
when 'newsletter'
|
||||||
|
'newsletter'
|
||||||
|
when 'call'
|
||||||
|
'call'
|
||||||
|
else
|
||||||
|
'unknown'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def message_type # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
|
||||||
|
msg = @raw_message[:message]
|
||||||
|
@message_type ||= if msg.key?(:conversation) || msg.dig(:extendedTextMessage, :text).present?
|
||||||
|
'text'
|
||||||
|
elsif msg.key?(:imageMessage)
|
||||||
|
'image'
|
||||||
|
elsif msg.key?(:audioMessage)
|
||||||
|
'audio'
|
||||||
|
elsif msg.key?(:videoMessage)
|
||||||
|
'video'
|
||||||
|
elsif msg.key?(:documentMessage)
|
||||||
|
'file'
|
||||||
|
elsif msg.key?(:stickerMessage)
|
||||||
|
'sticker'
|
||||||
|
elsif msg.key?(:reactionMessage)
|
||||||
|
'reaction'
|
||||||
|
elsif msg.key?(:protocolMessage)
|
||||||
|
'protocol'
|
||||||
|
else
|
||||||
|
'unsupported'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def message_content
|
||||||
|
case message_type
|
||||||
|
when 'text'
|
||||||
|
@raw_message.dig(:message, :conversation) || @raw_message.dig(:message, :extendedTextMessage, :text)
|
||||||
|
when 'image'
|
||||||
|
@raw_message.dig(:message, :imageMessage, :caption)
|
||||||
|
when 'video'
|
||||||
|
@raw_message.dig(:message, :videoMessage, :caption)
|
||||||
|
when 'reaction'
|
||||||
|
@raw_message.dig(:message, :reactionMessage, :text)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def file_content_type
|
||||||
|
return :image if message_type.in?(%w[image sticker])
|
||||||
|
return :video if message_type.in?(%w[video video_note])
|
||||||
|
return :audio if message_type == 'audio'
|
||||||
|
|
||||||
|
:file
|
||||||
|
end
|
||||||
|
|
||||||
|
def message_mimetype
|
||||||
|
case message_type
|
||||||
|
when 'image'
|
||||||
|
@raw_message.dig(:message, :imageMessage, :mimetype)
|
||||||
|
when 'sticker'
|
||||||
|
@raw_message.dig(:message, :stickerMessage, :mimetype)
|
||||||
|
when 'video'
|
||||||
|
@raw_message.dig(:message, :videoMessage, :mimetype)
|
||||||
|
when 'audio'
|
||||||
|
@raw_message.dig(:message, :audioMessage, :mimetype)
|
||||||
|
when 'file'
|
||||||
|
@raw_message.dig(:message, :documentMessage, :mimetype)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def phone_number_from_jid
|
||||||
|
# NOTE: jid shape is `<user>_<agent>:<device>@<server>`
|
||||||
|
# https://github.com/WhiskeySockets/Baileys/blob/v6.7.16/src/WABinary/jid-utils.ts#L19
|
||||||
|
@phone_number_from_jid ||= @raw_message[:key][:remoteJid].split('@').first.split(':').first.split('_').first
|
||||||
|
end
|
||||||
|
|
||||||
|
def contact_name
|
||||||
|
# NOTE: `verifiedBizName` is only available for business accounts and has a higher priority than `pushName`.
|
||||||
|
name = @raw_message[:verifiedBizName].presence || @raw_message[:pushName]
|
||||||
|
return name if self_message? || incoming?
|
||||||
|
|
||||||
|
phone_number_from_jid
|
||||||
|
end
|
||||||
|
|
||||||
|
def self_message?
|
||||||
|
# TODO: Handle denormalized Brazilian phone numbers
|
||||||
|
phone_number_from_jid == inbox.channel.phone_number.delete('+')
|
||||||
|
end
|
||||||
|
|
||||||
|
def message_under_process?
|
||||||
|
key = format(Redis::RedisKeys::MESSAGE_SOURCE_KEY, id: raw_message_id)
|
||||||
|
Redis::Alfred.get(key)
|
||||||
|
end
|
||||||
|
|
||||||
|
def cache_message_source_id_in_redis
|
||||||
|
key = format(Redis::RedisKeys::MESSAGE_SOURCE_KEY, id: raw_message_id)
|
||||||
|
::Redis::Alfred.setex(key, true)
|
||||||
|
end
|
||||||
|
|
||||||
|
def clear_message_source_id_from_redis
|
||||||
|
key = format(Redis::RedisKeys::MESSAGE_SOURCE_KEY, id: raw_message_id)
|
||||||
|
::Redis::Alfred.delete(key)
|
||||||
|
end
|
||||||
|
end
|
||||||
84
app/services/whatsapp/baileys_handlers/messages_update.rb
Normal file
84
app/services/whatsapp/baileys_handlers/messages_update.rb
Normal file
@ -0,0 +1,84 @@
|
|||||||
|
module Whatsapp::BaileysHandlers::MessagesUpdate
|
||||||
|
include Whatsapp::BaileysHandlers::Helpers
|
||||||
|
|
||||||
|
class MessageNotFoundError < StandardError; end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def process_messages_update
|
||||||
|
updates = processed_params[:data]
|
||||||
|
updates.each do |update|
|
||||||
|
@message = nil
|
||||||
|
@raw_message = update
|
||||||
|
|
||||||
|
next handle_update if incoming?
|
||||||
|
|
||||||
|
# NOTE: Shared lock with Whatsapp::SendOnWhatsappService
|
||||||
|
# Avoids race conditions when sending messages.
|
||||||
|
with_baileys_channel_lock_on_outgoing_message(inbox.channel.id) { handle_update }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def handle_update
|
||||||
|
raise MessageNotFoundError unless find_message_by_source_id(raw_message_id)
|
||||||
|
|
||||||
|
update_status if @raw_message.dig(:update, :status).present?
|
||||||
|
handle_edited_content if @raw_message.dig(:update, :message).present?
|
||||||
|
end
|
||||||
|
|
||||||
|
def update_status
|
||||||
|
status = status_mapper
|
||||||
|
update_last_seen_at if incoming? && status == 'read'
|
||||||
|
@message.update!(status: status) if status.present? && status_transition_allowed?(status)
|
||||||
|
end
|
||||||
|
|
||||||
|
def status_mapper
|
||||||
|
# NOTE: Baileys status codes vs. Chatwoot support:
|
||||||
|
# - (0) ERROR → (3) failed
|
||||||
|
# - (1) PENDING → (0) sent
|
||||||
|
# - (2) SERVER_ACK → (0) sent
|
||||||
|
# - (3) DELIVERY_ACK → (1) delivered
|
||||||
|
# - (4) READ → (2) read
|
||||||
|
# - (5) PLAYED → (unsupported: PLAYED)
|
||||||
|
# For details: https://github.com/WhiskeySockets/Baileys/blob/v6.7.16/WAProto/index.d.ts#L36694
|
||||||
|
status = @raw_message.dig(:update, :status)
|
||||||
|
case status
|
||||||
|
when 0
|
||||||
|
'failed'
|
||||||
|
when 1, 2
|
||||||
|
'sent'
|
||||||
|
when 3
|
||||||
|
'delivered'
|
||||||
|
when 4
|
||||||
|
'read'
|
||||||
|
when 5
|
||||||
|
Rails.logger.warn 'Baileys unsupported message update status: PLAYED(5)'
|
||||||
|
else
|
||||||
|
Rails.logger.warn "Baileys unsupported message update status: #{status}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def update_last_seen_at
|
||||||
|
conversation = @message.conversation
|
||||||
|
to_update = { agent_last_seen_at: Time.current }
|
||||||
|
to_update[:assignee_last_seen_at] = Time.current if conversation.assignee_id.present?
|
||||||
|
|
||||||
|
conversation.update_columns(to_update) # rubocop:disable Rails/SkipsModelValidations
|
||||||
|
end
|
||||||
|
|
||||||
|
def status_transition_allowed?(new_status)
|
||||||
|
return false if @message.status == 'read'
|
||||||
|
return false if @message.status == 'delivered' && new_status == 'sent'
|
||||||
|
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
|
def handle_edited_content
|
||||||
|
@raw_message = @raw_message.dig(:update, :message, :editedMessage)
|
||||||
|
content = message_content
|
||||||
|
|
||||||
|
return @message.update!(content: content, is_edited: true, previous_content: @message.content) if content
|
||||||
|
|
||||||
|
Rails.logger.warn 'No valid message content found in the edit event'
|
||||||
|
end
|
||||||
|
end
|
||||||
120
app/services/whatsapp/baileys_handlers/messages_upsert.rb
Normal file
120
app/services/whatsapp/baileys_handlers/messages_upsert.rb
Normal file
@ -0,0 +1,120 @@
|
|||||||
|
module Whatsapp::BaileysHandlers::MessagesUpsert
|
||||||
|
include Whatsapp::BaileysHandlers::Helpers
|
||||||
|
include BaileysHelper
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def process_messages_upsert
|
||||||
|
messages = processed_params[:data][:messages]
|
||||||
|
messages.each do |message|
|
||||||
|
@message = nil
|
||||||
|
@contact_inbox = nil
|
||||||
|
@contact = nil
|
||||||
|
@raw_message = message
|
||||||
|
|
||||||
|
next handle_message if incoming?
|
||||||
|
|
||||||
|
# NOTE: Shared lock with Whatsapp::SendOnWhatsappService
|
||||||
|
# Avoids race conditions when sending messages.
|
||||||
|
with_baileys_channel_lock_on_outgoing_message(inbox.channel.id) { handle_message }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def handle_message
|
||||||
|
return if jid_type != 'user'
|
||||||
|
return if message_type == 'protocol'
|
||||||
|
return if find_message_by_source_id(raw_message_id) || message_under_process?
|
||||||
|
|
||||||
|
cache_message_source_id_in_redis
|
||||||
|
set_contact
|
||||||
|
|
||||||
|
unless @contact
|
||||||
|
clear_message_source_id_from_redis
|
||||||
|
|
||||||
|
Rails.logger.warn "Contact not found for message: #{raw_message_id}"
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
set_conversation
|
||||||
|
handle_create_message
|
||||||
|
clear_message_source_id_from_redis
|
||||||
|
end
|
||||||
|
|
||||||
|
def set_contact
|
||||||
|
push_name = contact_name
|
||||||
|
contact_inbox = ::ContactInboxWithContactBuilder.new(
|
||||||
|
# FIXME: update the source_id to complete jid in future
|
||||||
|
source_id: phone_number_from_jid,
|
||||||
|
inbox: inbox,
|
||||||
|
contact_attributes: { name: push_name, phone_number: "+#{phone_number_from_jid}" }
|
||||||
|
).perform
|
||||||
|
|
||||||
|
@contact_inbox = contact_inbox
|
||||||
|
@contact = contact_inbox.contact
|
||||||
|
|
||||||
|
@contact.update!(name: push_name) if @contact.name == phone_number_from_jid
|
||||||
|
end
|
||||||
|
|
||||||
|
def handle_create_message
|
||||||
|
return if message_type == 'protocol' ||
|
||||||
|
(message_type == 'reaction' && message_content.blank?)
|
||||||
|
|
||||||
|
create_message(attach_media: %w[image file video audio sticker].include?(message_type))
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_message(attach_media: false)
|
||||||
|
@message = @conversation.messages.build(
|
||||||
|
content: message_content,
|
||||||
|
account_id: @inbox.account_id,
|
||||||
|
inbox_id: @inbox.id,
|
||||||
|
source_id: raw_message_id,
|
||||||
|
sender: incoming? ? @contact : @inbox.account.account_users.first.user,
|
||||||
|
sender_type: incoming? ? 'Contact' : 'User',
|
||||||
|
message_type: incoming? ? :incoming : :outgoing,
|
||||||
|
content_attributes: message_content_attributes
|
||||||
|
)
|
||||||
|
|
||||||
|
handle_attach_media if attach_media
|
||||||
|
|
||||||
|
@message.save!
|
||||||
|
end
|
||||||
|
|
||||||
|
def message_content_attributes
|
||||||
|
content_attributes = { external_created_at: baileys_extract_message_timestamp(@raw_message[:messageTimestamp]) }
|
||||||
|
if message_type == 'reaction'
|
||||||
|
content_attributes[:in_reply_to_external_id] = @raw_message.dig(:message, :reactionMessage, :key, :id)
|
||||||
|
content_attributes[:is_reaction] = true
|
||||||
|
elsif message_type == 'unsupported'
|
||||||
|
content_attributes[:is_unsupported] = true
|
||||||
|
end
|
||||||
|
|
||||||
|
content_attributes
|
||||||
|
end
|
||||||
|
|
||||||
|
def handle_attach_media
|
||||||
|
attachment_file = download_attachment_file
|
||||||
|
|
||||||
|
attachment = @message.attachments.build(
|
||||||
|
account_id: @message.account_id,
|
||||||
|
file_type: file_content_type.to_s,
|
||||||
|
file: { io: attachment_file, filename: filename, content_type: message_mimetype }
|
||||||
|
)
|
||||||
|
attachment.meta = { is_recorded_audio: true } if @raw_message.dig(:message, :audioMessage, :ptt)
|
||||||
|
rescue Down::Error => e
|
||||||
|
@message.update!(is_unsupported: true)
|
||||||
|
|
||||||
|
Rails.logger.error "Failed to download attachment for message #{raw_message_id}: #{e.message}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def download_attachment_file
|
||||||
|
Down.download(@conversation.inbox.channel.media_url(@raw_message.dig(:key, :id)), headers: @conversation.inbox.channel.api_headers)
|
||||||
|
end
|
||||||
|
|
||||||
|
def filename
|
||||||
|
filename = @raw_message.dig(:message, :documentMessage, :fileName)
|
||||||
|
return filename if filename.present?
|
||||||
|
|
||||||
|
ext = ".#{message_mimetype.split(';').first.split('/').last}" if message_mimetype.present?
|
||||||
|
"#{file_content_type}_#{raw_message_id}_#{Time.current.strftime('%Y%m%d')}#{ext}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@ -1,9 +1,9 @@
|
|||||||
class Whatsapp::IncomingMessageBaileysService < Whatsapp::IncomingMessageBaseService # rubocop:disable Metrics/ClassLength
|
class Whatsapp::IncomingMessageBaileysService < Whatsapp::IncomingMessageBaseService
|
||||||
include BaileysHelper
|
include Whatsapp::BaileysHandlers::ConnectionUpdate
|
||||||
|
include Whatsapp::BaileysHandlers::MessagesUpsert
|
||||||
|
include Whatsapp::BaileysHandlers::MessagesUpdate
|
||||||
|
|
||||||
class InvalidWebhookVerifyToken < StandardError; end
|
class InvalidWebhookVerifyToken < StandardError; end
|
||||||
class MessageNotFoundError < StandardError; end
|
|
||||||
class AttachmentNotFoundError < StandardError; end
|
|
||||||
|
|
||||||
def perform
|
def perform
|
||||||
raise InvalidWebhookVerifyToken if processed_params[:webhookVerifyToken] != inbox.channel.provider_config['webhook_verify_token']
|
raise InvalidWebhookVerifyToken if processed_params[:webhookVerifyToken] != inbox.channel.provider_config['webhook_verify_token']
|
||||||
@ -18,337 +18,4 @@ class Whatsapp::IncomingMessageBaileysService < Whatsapp::IncomingMessageBaseSer
|
|||||||
Rails.logger.warn "Baileys unsupported event: #{processed_params[:event]}"
|
Rails.logger.warn "Baileys unsupported event: #{processed_params[:event]}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def process_connection_update
|
|
||||||
data = processed_params[:data]
|
|
||||||
|
|
||||||
# NOTE: `connection` values
|
|
||||||
# - `close`: Never opened, or closed and no longer able to send/receive messages
|
|
||||||
# - `connecting`: In the process of connecting, expecting QR code to be read
|
|
||||||
# - `reconnecting`: Connection has been established, but not open (i.e. device is being linked for the first time, or Baileys server restart)
|
|
||||||
# - `open`: Open and ready to send/receive messages
|
|
||||||
inbox.channel.update_provider_connection!({
|
|
||||||
connection: data[:connection] || inbox.channel.provider_connection['connection'],
|
|
||||||
qr_data_url: data[:qrDataUrl] || nil,
|
|
||||||
error: data[:error] ? I18n.t("errors.inboxes.channel.provider_connection.#{data[:error]}") : nil
|
|
||||||
}.compact)
|
|
||||||
|
|
||||||
Rails.logger.error "Baileys connection error: #{data[:error]}" if data[:error].present?
|
|
||||||
end
|
|
||||||
|
|
||||||
def process_messages_upsert
|
|
||||||
messages = processed_params[:data][:messages]
|
|
||||||
messages.each do |message|
|
|
||||||
@message = nil
|
|
||||||
@contact_inbox = nil
|
|
||||||
@contact = nil
|
|
||||||
@raw_message = message
|
|
||||||
|
|
||||||
next handle_message if incoming?
|
|
||||||
|
|
||||||
# NOTE: Shared lock with Whatsapp::SendOnWhatsappService
|
|
||||||
# Avoids race conditions when sending messages.
|
|
||||||
with_baileys_channel_lock_on_outgoing_message(inbox.channel.id) { handle_message }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def handle_message
|
|
||||||
return if jid_type != 'user'
|
|
||||||
return if message_type == 'protocol'
|
|
||||||
return if find_message_by_source_id(raw_message_id) || message_under_process?
|
|
||||||
|
|
||||||
cache_message_source_id_in_redis
|
|
||||||
set_contact
|
|
||||||
|
|
||||||
unless @contact
|
|
||||||
Rails.logger.warn "Contact not found for message: #{raw_message_id}"
|
|
||||||
return
|
|
||||||
end
|
|
||||||
|
|
||||||
set_conversation
|
|
||||||
handle_create_message
|
|
||||||
clear_message_source_id_from_redis
|
|
||||||
end
|
|
||||||
|
|
||||||
def set_contact
|
|
||||||
push_name = contact_name
|
|
||||||
contact_inbox = ::ContactInboxWithContactBuilder.new(
|
|
||||||
# FIXME: update the source_id to complete jid in future
|
|
||||||
source_id: phone_number_from_jid,
|
|
||||||
inbox: inbox,
|
|
||||||
contact_attributes: { name: push_name, phone_number: "+#{phone_number_from_jid}" }
|
|
||||||
).perform
|
|
||||||
|
|
||||||
@contact_inbox = contact_inbox
|
|
||||||
@contact = contact_inbox.contact
|
|
||||||
|
|
||||||
@contact.update!(name: push_name) if @contact.name == phone_number_from_jid
|
|
||||||
end
|
|
||||||
|
|
||||||
def phone_number_from_jid
|
|
||||||
# NOTE: jid shape is `<user>_<agent>:<device>@<server>`
|
|
||||||
# https://github.com/WhiskeySockets/Baileys/blob/v6.7.16/src/WABinary/jid-utils.ts#L19
|
|
||||||
@phone_number_from_jid ||= @raw_message[:key][:remoteJid].split('@').first.split(':').first.split('_').first
|
|
||||||
end
|
|
||||||
|
|
||||||
def contact_name
|
|
||||||
# NOTE: `verifiedBizName` is only available for business accounts and has a higher priority than `pushName`.
|
|
||||||
name = @raw_message[:verifiedBizName].presence || @raw_message[:pushName]
|
|
||||||
return name if self_message? || incoming?
|
|
||||||
|
|
||||||
phone_number_from_jid
|
|
||||||
end
|
|
||||||
|
|
||||||
def self_message?
|
|
||||||
# TODO: Handle denormalized Brazilian phone numbers
|
|
||||||
phone_number_from_jid == inbox.channel.phone_number.delete('+')
|
|
||||||
end
|
|
||||||
|
|
||||||
def handle_create_message
|
|
||||||
return if message_type == 'protocol' ||
|
|
||||||
(message_type == 'reaction' && message_content.blank?)
|
|
||||||
|
|
||||||
create_message(attach_media: %w[image file video audio sticker].include?(message_type))
|
|
||||||
end
|
|
||||||
|
|
||||||
def jid_type # rubocop:disable Metrics/CyclomaticComplexity
|
|
||||||
jid = @raw_message[:key][:remoteJid]
|
|
||||||
server = jid.split('@').last
|
|
||||||
|
|
||||||
# NOTE: Based on Baileys internal functions
|
|
||||||
# https://github.com/WhiskeySockets/Baileys/blob/v6.7.16/src/WABinary/jid-utils.ts#L48-L58
|
|
||||||
case server
|
|
||||||
when 's.whatsapp.net', 'c.us'
|
|
||||||
'user'
|
|
||||||
when 'g.us'
|
|
||||||
'group'
|
|
||||||
when 'lid'
|
|
||||||
'lid'
|
|
||||||
when 'broadcast'
|
|
||||||
jid.start_with?('status@') ? 'status' : 'broadcast'
|
|
||||||
when 'newsletter'
|
|
||||||
'newsletter'
|
|
||||||
when 'call'
|
|
||||||
'call'
|
|
||||||
else
|
|
||||||
'unknown'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def message_type # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
|
|
||||||
msg = @raw_message[:message]
|
|
||||||
@message_type ||= if msg.key?(:conversation) || msg.dig(:extendedTextMessage, :text).present?
|
|
||||||
'text'
|
|
||||||
elsif msg.key?(:imageMessage)
|
|
||||||
'image'
|
|
||||||
elsif msg.key?(:audioMessage)
|
|
||||||
'audio'
|
|
||||||
elsif msg.key?(:videoMessage)
|
|
||||||
'video'
|
|
||||||
elsif msg.key?(:documentMessage)
|
|
||||||
'file'
|
|
||||||
elsif msg.key?(:stickerMessage)
|
|
||||||
'sticker'
|
|
||||||
elsif msg.key?(:reactionMessage)
|
|
||||||
'reaction'
|
|
||||||
elsif msg.key?(:protocolMessage)
|
|
||||||
'protocol'
|
|
||||||
else
|
|
||||||
'unsupported'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def create_message(attach_media: false)
|
|
||||||
@message = @conversation.messages.build(
|
|
||||||
content: message_content,
|
|
||||||
account_id: @inbox.account_id,
|
|
||||||
inbox_id: @inbox.id,
|
|
||||||
source_id: raw_message_id,
|
|
||||||
sender: incoming? ? @contact : @inbox.account.account_users.first.user,
|
|
||||||
sender_type: incoming? ? 'Contact' : 'User',
|
|
||||||
message_type: incoming? ? :incoming : :outgoing,
|
|
||||||
content_attributes: message_content_attributes
|
|
||||||
)
|
|
||||||
|
|
||||||
handle_attach_media if attach_media
|
|
||||||
|
|
||||||
@message.save!
|
|
||||||
end
|
|
||||||
|
|
||||||
def message_content_attributes
|
|
||||||
content_attributes = { external_created_at: baileys_extract_message_timestamp(@raw_message[:messageTimestamp]) }
|
|
||||||
if message_type == 'reaction'
|
|
||||||
content_attributes[:in_reply_to_external_id] = @raw_message.dig(:message, :reactionMessage, :key, :id)
|
|
||||||
content_attributes[:is_reaction] = true
|
|
||||||
elsif message_type == 'unsupported'
|
|
||||||
content_attributes[:is_unsupported] = true
|
|
||||||
end
|
|
||||||
|
|
||||||
content_attributes
|
|
||||||
end
|
|
||||||
|
|
||||||
def incoming?
|
|
||||||
!@raw_message[:key][:fromMe]
|
|
||||||
end
|
|
||||||
|
|
||||||
def handle_attach_media
|
|
||||||
attachment_file = download_attachment_file
|
|
||||||
return unless attachment_file
|
|
||||||
|
|
||||||
attachment = @message.attachments.build(
|
|
||||||
account_id: @message.account_id,
|
|
||||||
file_type: file_content_type.to_s,
|
|
||||||
file: { io: attachment_file, filename: filename, content_type: message_mimetype }
|
|
||||||
)
|
|
||||||
attachment.meta = { is_recorded_audio: true } if @raw_message.dig(:message, :audioMessage, :ptt)
|
|
||||||
end
|
|
||||||
|
|
||||||
def download_attachment_file
|
|
||||||
Down.download(@conversation.inbox.channel.media_url(@raw_message.dig(:key, :id)), headers: @conversation.inbox.channel.api_headers)
|
|
||||||
end
|
|
||||||
|
|
||||||
def file_content_type
|
|
||||||
return :image if message_type.in?(%w[image sticker])
|
|
||||||
return :video if message_type.in?(%w[video video_note])
|
|
||||||
return :audio if message_type == 'audio'
|
|
||||||
|
|
||||||
:file
|
|
||||||
end
|
|
||||||
|
|
||||||
def filename
|
|
||||||
filename = @raw_message.dig(:message, :documentMessage, :fileName)
|
|
||||||
return filename if filename.present?
|
|
||||||
|
|
||||||
ext = ".#{message_mimetype.split(';').first.split('/').last}" if message_mimetype.present?
|
|
||||||
"#{file_content_type}_#{raw_message_id}_#{Time.current.strftime('%Y%m%d')}#{ext}"
|
|
||||||
end
|
|
||||||
|
|
||||||
def message_content
|
|
||||||
case message_type
|
|
||||||
when 'text'
|
|
||||||
@raw_message.dig(:message, :conversation) || @raw_message.dig(:message, :extendedTextMessage, :text)
|
|
||||||
when 'image'
|
|
||||||
@raw_message.dig(:message, :imageMessage, :caption)
|
|
||||||
when 'video'
|
|
||||||
@raw_message.dig(:message, :videoMessage, :caption)
|
|
||||||
when 'reaction'
|
|
||||||
@raw_message.dig(:message, :reactionMessage, :text)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def raw_message_id
|
|
||||||
@raw_message[:key][:id]
|
|
||||||
end
|
|
||||||
|
|
||||||
def message_mimetype
|
|
||||||
case message_type
|
|
||||||
when 'image'
|
|
||||||
@raw_message.dig(:message, :imageMessage, :mimetype)
|
|
||||||
when 'sticker'
|
|
||||||
@raw_message.dig(:message, :stickerMessage, :mimetype)
|
|
||||||
when 'video'
|
|
||||||
@raw_message.dig(:message, :videoMessage, :mimetype)
|
|
||||||
when 'audio'
|
|
||||||
@raw_message.dig(:message, :audioMessage, :mimetype)
|
|
||||||
when 'file'
|
|
||||||
@raw_message.dig(:message, :documentMessage, :mimetype)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def message_under_process?
|
|
||||||
key = format(Redis::RedisKeys::MESSAGE_SOURCE_KEY, id: raw_message_id)
|
|
||||||
Redis::Alfred.get(key)
|
|
||||||
end
|
|
||||||
|
|
||||||
def cache_message_source_id_in_redis
|
|
||||||
key = format(Redis::RedisKeys::MESSAGE_SOURCE_KEY, id: raw_message_id)
|
|
||||||
::Redis::Alfred.setex(key, true)
|
|
||||||
end
|
|
||||||
|
|
||||||
def clear_message_source_id_from_redis
|
|
||||||
key = format(Redis::RedisKeys::MESSAGE_SOURCE_KEY, id: raw_message_id)
|
|
||||||
::Redis::Alfred.delete(key)
|
|
||||||
end
|
|
||||||
|
|
||||||
def process_messages_update
|
|
||||||
updates = processed_params[:data]
|
|
||||||
updates.each do |update|
|
|
||||||
@message = nil
|
|
||||||
@raw_message = update
|
|
||||||
|
|
||||||
next handle_update if incoming?
|
|
||||||
|
|
||||||
# NOTE: Shared lock with Whatsapp::SendOnWhatsappService
|
|
||||||
# Avoids race conditions when sending messages.
|
|
||||||
with_baileys_channel_lock_on_outgoing_message(inbox.channel.id) { handle_update }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def handle_update
|
|
||||||
raise MessageNotFoundError unless find_message_by_source_id(raw_message_id)
|
|
||||||
|
|
||||||
update_status if @raw_message.dig(:update, :status).present?
|
|
||||||
handle_edited_content if @raw_message.dig(:update, :message).present?
|
|
||||||
end
|
|
||||||
|
|
||||||
def update_status
|
|
||||||
status = status_mapper
|
|
||||||
update_last_seen_at if incoming? && status == 'read'
|
|
||||||
@message.update!(status: status) if status.present? && status_transition_allowed?(status)
|
|
||||||
end
|
|
||||||
|
|
||||||
def status_mapper
|
|
||||||
# NOTE: Baileys status codes vs. Chatwoot support:
|
|
||||||
# - (0) ERROR → (3) failed
|
|
||||||
# - (1) PENDING → (0) sent
|
|
||||||
# - (2) SERVER_ACK → (0) sent
|
|
||||||
# - (3) DELIVERY_ACK → (1) delivered
|
|
||||||
# - (4) READ → (2) read
|
|
||||||
# - (5) PLAYED → (unsupported: PLAYED)
|
|
||||||
# For details: https://github.com/WhiskeySockets/Baileys/blob/v6.7.16/WAProto/index.d.ts#L36694
|
|
||||||
status = @raw_message.dig(:update, :status)
|
|
||||||
case status
|
|
||||||
when 0
|
|
||||||
'failed'
|
|
||||||
when 1, 2
|
|
||||||
'sent'
|
|
||||||
when 3
|
|
||||||
'delivered'
|
|
||||||
when 4
|
|
||||||
'read'
|
|
||||||
when 5
|
|
||||||
Rails.logger.warn 'Baileys unsupported message update status: PLAYED(5)'
|
|
||||||
else
|
|
||||||
Rails.logger.warn "Baileys unsupported message update status: #{status}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def update_last_seen_at
|
|
||||||
conversation = @message.conversation
|
|
||||||
to_update = { agent_last_seen_at: Time.current }
|
|
||||||
to_update[:assignee_last_seen_at] = Time.current if conversation.assignee_id.present?
|
|
||||||
|
|
||||||
conversation.update_columns(to_update) # rubocop:disable Rails/SkipsModelValidations
|
|
||||||
end
|
|
||||||
|
|
||||||
def status_transition_allowed?(new_status)
|
|
||||||
return false if @message.status == 'read'
|
|
||||||
return false if @message.status == 'delivered' && new_status == 'sent'
|
|
||||||
|
|
||||||
true
|
|
||||||
end
|
|
||||||
|
|
||||||
def handle_edited_content
|
|
||||||
@raw_message = @raw_message.dig(:update, :message, :editedMessage)
|
|
||||||
content = message_content
|
|
||||||
|
|
||||||
unless content
|
|
||||||
Rails.logger.warn 'No valid message content found in the edit event'
|
|
||||||
return
|
|
||||||
end
|
|
||||||
|
|
||||||
@message.update!(content: content, is_edited: true, previous_content: @message.content)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@ -423,6 +423,18 @@ describe Whatsapp::IncomingMessageBaileysService do
|
|||||||
expect(attachment.file.filename.to_s).to eq("image_msg_123_#{Time.current.strftime('%Y%m%d')}.png")
|
expect(attachment.file.filename.to_s).to eq("image_msg_123_#{Time.current.strftime('%Y%m%d')}.png")
|
||||||
expect(attachment.file.content_type).to eq('image/png')
|
expect(attachment.file.content_type).to eq('image/png')
|
||||||
end
|
end
|
||||||
|
|
||||||
|
it 'sets message as unsupported and logs error if attachment download fails' do
|
||||||
|
allow(Down).to receive(:download).and_raise(Down::ResponseError.new('Attachment not found'))
|
||||||
|
allow(Rails.logger).to receive(:error).with('Failed to download attachment for message msg_123: Attachment not found')
|
||||||
|
|
||||||
|
described_class.new(inbox: inbox, params: params).perform
|
||||||
|
|
||||||
|
expect(Rails.logger).to have_received(:error)
|
||||||
|
message = inbox.conversations.last.messages.last
|
||||||
|
expect(message).to be_present
|
||||||
|
expect(message.is_unsupported).to be(true)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when message type is video' do
|
context 'when message type is video' do
|
||||||
@ -653,6 +665,19 @@ describe Whatsapp::IncomingMessageBaileysService do
|
|||||||
expect(message.previous_content).to eq(original_content)
|
expect(message.previous_content).to eq(original_content)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
context 'when is a content update' do
|
||||||
|
it 'updates the message content' do
|
||||||
|
original_content = message.content
|
||||||
|
update_payload[:update] = { message: { editedMessage: { message: { conversation: 'New message content' } } } }
|
||||||
|
|
||||||
|
described_class.new(inbox: inbox, params: params).perform
|
||||||
|
|
||||||
|
expect(message.reload.content).to eq('New message content')
|
||||||
|
expect(message.is_edited).to be(true)
|
||||||
|
expect(message.previous_content).to eq(original_content)
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user