2019-11-30 13:39:55 +00:00
|
|
|
# == Schema Information
|
|
|
|
#
|
|
|
|
# Table name: messages
|
|
|
|
#
|
2020-08-28 20:09:41 +00:00
|
|
|
# id :integer not null, primary key
|
|
|
|
# content :text
|
|
|
|
# content_attributes :json
|
|
|
|
# content_type :integer default("text")
|
|
|
|
# external_source_ids :jsonb
|
|
|
|
# message_type :integer not null
|
|
|
|
# private :boolean default(FALSE)
|
|
|
|
# sender_type :string
|
|
|
|
# status :integer default("sent")
|
|
|
|
# created_at :datetime not null
|
|
|
|
# updated_at :datetime not null
|
|
|
|
# account_id :integer not null
|
|
|
|
# conversation_id :integer not null
|
|
|
|
# inbox_id :integer not null
|
|
|
|
# sender_id :bigint
|
|
|
|
# source_id :string
|
2019-11-30 13:39:55 +00:00
|
|
|
#
|
|
|
|
# Indexes
|
|
|
|
#
|
2020-06-27 16:04:53 +00:00
|
|
|
# index_messages_on_account_id (account_id)
|
|
|
|
# index_messages_on_conversation_id (conversation_id)
|
|
|
|
# index_messages_on_inbox_id (inbox_id)
|
|
|
|
# index_messages_on_sender_type_and_sender_id (sender_type,sender_id)
|
|
|
|
# index_messages_on_source_id (source_id)
|
2019-11-30 13:39:55 +00:00
|
|
|
#
|
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
class Message < ApplicationRecord
|
2020-04-17 15:45:20 +00:00
|
|
|
NUMBER_OF_PERMITTED_ATTACHMENTS = 15
|
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
validates :account_id, presence: true
|
|
|
|
validates :inbox_id, presence: true
|
|
|
|
validates :conversation_id, presence: true
|
2020-04-10 11:12:37 +00:00
|
|
|
validates_with ContentAttributeValidator
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2020-09-13 10:46:52 +00:00
|
|
|
# when you have a temperory id in your frontend and want it echoed back via action cable
|
|
|
|
attr_accessor :echo_id
|
|
|
|
|
2020-01-09 07:36:40 +00:00
|
|
|
enum message_type: { incoming: 0, outgoing: 1, activity: 2, template: 3 }
|
2020-04-10 11:12:37 +00:00
|
|
|
enum content_type: {
|
|
|
|
text: 0,
|
|
|
|
input_text: 1,
|
|
|
|
input_textarea: 2,
|
|
|
|
input_email: 3,
|
|
|
|
input_select: 4,
|
|
|
|
cards: 5,
|
|
|
|
form: 6,
|
2020-04-30 14:50:26 +00:00
|
|
|
article: 7,
|
|
|
|
incoming_email: 8
|
2020-04-10 11:12:37 +00:00
|
|
|
}
|
2020-01-09 07:36:40 +00:00
|
|
|
enum status: { sent: 0, delivered: 1, read: 2, failed: 3 }
|
2020-08-11 04:27:42 +00:00
|
|
|
# [:submitted_email, :items, :submitted_values] : Used for bot message types
|
|
|
|
# [:email] : Used by conversation_continuity incoming email messages
|
|
|
|
# [:in_reply_to] : Used to reply to a particular tweet in threads
|
|
|
|
store :content_attributes, accessors: [:submitted_email, :items, :submitted_values, :email, :in_reply_to], coder: JSON
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2020-08-28 20:09:41 +00:00
|
|
|
store :external_source_ids, accessors: [:slack], coder: JSON, prefix: :external_source_id
|
|
|
|
|
2019-10-12 18:08:41 +00:00
|
|
|
# .succ is a hack to avoid https://makandracards.com/makandra/1057-why-two-ruby-time-objects-are-not-equal-although-they-appear-to-be
|
|
|
|
scope :unread_since, ->(datetime) { where('EXTRACT(EPOCH FROM created_at) > (?)', datetime.to_i.succ) }
|
2020-05-10 07:44:57 +00:00
|
|
|
scope :chat, -> { where.not(message_type: :activity).where(private: false) }
|
2019-08-14 09:48:44 +00:00
|
|
|
default_scope { order(created_at: :asc) }
|
|
|
|
|
|
|
|
belongs_to :account
|
|
|
|
belongs_to :inbox
|
2020-03-24 18:04:22 +00:00
|
|
|
belongs_to :conversation, touch: true
|
2020-06-27 16:04:53 +00:00
|
|
|
|
|
|
|
# FIXME: phase out user and contact after 1.4 since the info is there in sender
|
2019-08-14 09:48:44 +00:00
|
|
|
belongs_to :user, required: false
|
2020-02-26 04:14:24 +00:00
|
|
|
belongs_to :contact, required: false
|
2020-06-27 16:04:53 +00:00
|
|
|
belongs_to :sender, polymorphic: true, required: false
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2020-04-17 15:45:20 +00:00
|
|
|
has_many :attachments, dependent: :destroy, autosave: true, before_add: :validate_attachments_limit
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2019-08-30 22:38:00 +00:00
|
|
|
after_create :reopen_conversation,
|
2020-01-23 17:29:07 +00:00
|
|
|
:notify_via_mail
|
2019-08-30 22:38:00 +00:00
|
|
|
|
2020-06-09 18:24:35 +00:00
|
|
|
after_create_commit :execute_after_create_commit_callbacks
|
2020-04-29 20:11:13 +00:00
|
|
|
|
2020-04-10 11:12:37 +00:00
|
|
|
after_update :dispatch_update_event
|
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
def channel_token
|
|
|
|
@token ||= inbox.channel.try(:page_access_token)
|
|
|
|
end
|
|
|
|
|
|
|
|
def push_event_data
|
2019-08-30 22:38:00 +00:00
|
|
|
data = attributes.merge(
|
|
|
|
created_at: created_at.to_i,
|
|
|
|
message_type: message_type_before_type_cast,
|
|
|
|
conversation_id: conversation.display_id
|
|
|
|
)
|
2020-09-13 10:46:52 +00:00
|
|
|
data.merge!(echo_id: echo_id) if echo_id.present?
|
2020-04-17 15:45:20 +00:00
|
|
|
data.merge!(attachments: attachments.map(&:push_event_data)) if attachments.present?
|
2020-09-13 10:46:52 +00:00
|
|
|
merge_sender_attributes(data)
|
|
|
|
end
|
|
|
|
|
|
|
|
def merge_sender_attributes(data)
|
2020-06-27 16:04:53 +00:00
|
|
|
data.merge!(sender: sender.push_event_data) if sender && !sender.is_a?(AgentBot)
|
|
|
|
data.merge!(sender: sender.push_event_data(inbox)) if sender&.is_a?(AgentBot)
|
2019-08-14 09:48:44 +00:00
|
|
|
data
|
|
|
|
end
|
|
|
|
|
2020-01-13 19:20:18 +00:00
|
|
|
def reportable?
|
|
|
|
incoming? || outgoing?
|
|
|
|
end
|
|
|
|
|
2020-02-26 04:14:24 +00:00
|
|
|
def webhook_data
|
|
|
|
{
|
|
|
|
id: id,
|
|
|
|
content: content,
|
|
|
|
created_at: created_at,
|
|
|
|
message_type: message_type,
|
2020-04-10 11:12:37 +00:00
|
|
|
content_type: content_type,
|
2020-08-25 17:34:02 +00:00
|
|
|
private: private,
|
2020-04-10 11:12:37 +00:00
|
|
|
content_attributes: content_attributes,
|
2020-02-26 04:14:24 +00:00
|
|
|
source_id: source_id,
|
2020-06-27 16:04:53 +00:00
|
|
|
sender: sender.try(:webhook_data),
|
2020-02-26 04:14:24 +00:00
|
|
|
inbox: inbox.webhook_data,
|
|
|
|
conversation: conversation.webhook_data,
|
|
|
|
account: account.webhook_data
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
private
|
|
|
|
|
2020-06-09 18:24:35 +00:00
|
|
|
def execute_after_create_commit_callbacks
|
|
|
|
# rails issue with order of active record callbacks being executed
|
|
|
|
# https://github.com/rails/rails/issues/20911
|
|
|
|
dispatch_create_events
|
|
|
|
send_reply
|
|
|
|
execute_message_template_hooks
|
|
|
|
end
|
|
|
|
|
2020-05-01 09:23:43 +00:00
|
|
|
def dispatch_create_events
|
2019-10-30 05:13:11 +00:00
|
|
|
Rails.configuration.dispatcher.dispatch(MESSAGE_CREATED, Time.zone.now, message: self)
|
2019-08-14 09:48:44 +00:00
|
|
|
|
2019-10-20 08:47:26 +00:00
|
|
|
if outgoing? && conversation.messages.outgoing.count == 1
|
2019-10-12 18:08:41 +00:00
|
|
|
Rails.configuration.dispatcher.dispatch(FIRST_REPLY_CREATED, Time.zone.now, message: self)
|
2019-08-14 09:48:44 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-04-10 11:12:37 +00:00
|
|
|
def dispatch_update_event
|
|
|
|
Rails.configuration.dispatcher.dispatch(MESSAGE_UPDATED, Time.zone.now, message: self)
|
|
|
|
end
|
|
|
|
|
2019-08-14 09:48:44 +00:00
|
|
|
def send_reply
|
2020-07-16 19:02:32 +00:00
|
|
|
::SendReplyJob.perform_later(id)
|
2019-08-14 09:48:44 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def reopen_conversation
|
2020-05-26 12:13:59 +00:00
|
|
|
conversation.open! if incoming? && conversation.resolved? && !conversation.muted?
|
2019-08-14 09:48:44 +00:00
|
|
|
end
|
2020-01-09 07:36:40 +00:00
|
|
|
|
|
|
|
def execute_message_template_hooks
|
|
|
|
::MessageTemplates::HookExecutionService.new(message: self).perform
|
|
|
|
end
|
2020-01-23 17:29:07 +00:00
|
|
|
|
2020-09-10 13:49:15 +00:00
|
|
|
def email_notifiable_message?
|
|
|
|
return false unless outgoing?
|
|
|
|
return false if private?
|
|
|
|
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
def can_notify_via_mail?
|
|
|
|
return unless email_notifiable_message?
|
|
|
|
return false if conversation.contact.email.blank?
|
|
|
|
return false unless %w[Website Email].include? inbox.inbox_type
|
|
|
|
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
2020-01-23 17:29:07 +00:00
|
|
|
def notify_via_mail
|
2020-09-10 13:49:15 +00:00
|
|
|
return unless can_notify_via_mail?
|
2020-01-23 17:29:07 +00:00
|
|
|
|
2020-09-10 13:49:15 +00:00
|
|
|
# set a redis key for the conversation so that we don't need to send email for every new message
|
|
|
|
# last few messages coupled together is sent every 2 minutes rather than one email for each message
|
|
|
|
if Redis::Alfred.get(conversation_mail_key).nil?
|
|
|
|
Redis::Alfred.setex(conversation_mail_key, Time.zone.now)
|
2020-03-01 13:36:13 +00:00
|
|
|
ConversationReplyEmailWorker.perform_in(2.minutes, conversation.id, Time.zone.now)
|
2020-01-23 17:29:07 +00:00
|
|
|
end
|
|
|
|
end
|
2020-04-17 15:45:20 +00:00
|
|
|
|
2020-07-07 18:44:07 +00:00
|
|
|
def conversation_mail_key
|
|
|
|
format(::Redis::Alfred::CONVERSATION_MAILER_KEY, conversation_id: conversation.id)
|
|
|
|
end
|
|
|
|
|
2020-04-17 15:45:20 +00:00
|
|
|
def validate_attachments_limit(_attachment)
|
|
|
|
errors.add(attachments: 'exceeded maximum allowed') if attachments.size >= NUMBER_OF_PERMITTED_ATTACHMENTS
|
|
|
|
end
|
2019-08-14 09:48:44 +00:00
|
|
|
end
|