feat: handle Channel errors (#11015)

This PR adds missing error handlers for the following channels and cases

1. WhatsApp - Generic Handlers for both Cloud and 360Dialog (Deprecated)
2. Instagram - Handler for a case where there is an HTTP error instead
of an `:error` in the 200 response
3. Facebook - Errors from the two sentry issues
([Net::OpenTimeout](https://chatwoot-p3.sentry.io/issues/6164805227) &
[JSON::ParserError](https://chatwoot-p3.sentry.io/issues/5903200786))
4. SMS: Generic handlers for Bandwidth SMS

#### Checklist

- [x] Bandwidth SMS
- [x] Whatsapp Cloud + 360 Dialog
- [x] Twilio SMS
- [x] Line
- [x] Telegram
- [x] Instagram
- [x] Facebook
- [x] GMail
- [x] 365 Mail
- [x] SMTP Mail

---------

Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>

app/javascript/dashboard/components-next/message/MessageError.vue

@@ -26,7 +26,7 @@ const { t } = useI18n();
         />
       </div>
       <div
-        class="absolute bg-n-alpha-3 px-4 py-3 border rounded-xl border-n-strong text-n-slate-12 bottom-6 w-52 text-xs backdrop-blur-[100px] shadow-[0px_0px_24px_0px_rgba(0,0,0,0.12)] opacity-0 invisible group-hover:opacity-100 group-hover:visible transition-all"
+        class="absolute bg-n-alpha-3 px-4 py-3 border rounded-xl border-n-strong text-n-slate-12 bottom-6 w-52 text-xs backdrop-blur-[100px] shadow-[0px_0px_24px_0px_rgba(0,0,0,0.12)] opacity-0 invisible group-hover:opacity-100 group-hover:visible transition-all break-all"
         :class="{
           'ltr:left-0 rtl:right-0': orientation === ORIENTATION.LEFT,
           'ltr:right-0 rtl:left-0': orientation === ORIENTATION.RIGHT,

app/javascript/dashboard/components-next/message/MessageMeta.vue

@@ -102,6 +102,7 @@ const statusToShow = computed(() => {
   if (isRead.value) return MESSAGE_STATUS.READ;
   if (isDelivered.value) return MESSAGE_STATUS.DELIVERED;
   if (isSent.value) return MESSAGE_STATUS.SENT;
+  if (status.value === MESSAGE_STATUS.FAILED) return MESSAGE_STATUS.FAILED;
 
   return MESSAGE_STATUS.PROGRESS;
 });

app/models/channel/sms.rb

@@ -37,7 +37,7 @@ class Channel::Sms < ApplicationRecord
     body = message_body(contact_number, message.content)
     body['media'] = message.attachments.map(&:download_url) if message.attachments.present?
 
-    send_to_bandwidth(body)
+    send_to_bandwidth(body, message)
   end
 
   def send_text_message(contact_number, message_content)
@@ -56,7 +56,7 @@ class Channel::Sms < ApplicationRecord
     }
   end
 
-  def send_to_bandwidth(body)
+  def send_to_bandwidth(body, message = nil)
     response = HTTParty.post(
       "#{api_base_path}/users/#{provider_config['account_id']}/messages",
       basic_auth: bandwidth_auth,
@@ -64,7 +64,22 @@ class Channel::Sms < ApplicationRecord
       body: body.to_json
     )
 
-    response.success? ? response.parsed_response['id'] : nil
+    if response.success?
+      response.parsed_response['id']
+    else
+      handle_error(response, message)
+      nil
+    end
+  end
+
+  def handle_error(response, message)
+    Rails.logger.error("[#{account_id}] Error sending SMS: #{response.parsed_response['description']}")
+    return if message.blank?
+
+    # https://dev.bandwidth.com/apis/messaging-apis/messaging/#tag/Messages/operation/createMessage
+    message.external_error = response.parsed_response['description']
+    message.status = :failed
+    message.save!
   end
 
   def bandwidth_auth

app/services/facebook/send_on_facebook_service.rb

@@ -20,15 +20,30 @@ class Facebook::SendOnFacebookService < Base::SendOnChannelService
   end
 
   def send_message_to_facebook(delivery_params)
-    result = Facebook::Messenger::Bot.deliver(delivery_params, page_id: channel.page_id)
-    parsed_result = JSON.parse(result)
+    parsed_result = deliver_message(delivery_params)
+    return if parsed_result.nil?
+
     if parsed_result['error'].present?
       message.update!(status: :failed, external_error: external_error(parsed_result))
-      Rails.logger.info "Facebook::SendOnFacebookService: Error sending message to Facebook : Page - #{channel.page_id} : #{result}"
+      Rails.logger.info "Facebook::SendOnFacebookService: Error sending message to Facebook : Page - #{channel.page_id} : #{parsed_result}"
     end
+
     message.update!(source_id: parsed_result['message_id']) if parsed_result['message_id'].present?
   end
 
+  def deliver_message(delivery_params)
+    result = Facebook::Messenger::Bot.deliver(delivery_params, page_id: channel.page_id)
+    JSON.parse(result)
+  rescue JSON::ParserError
+    message.update!(status: :failed, external_error: 'Facebook was unable to process this request')
+    Rails.logger.error "Facebook::SendOnFacebookService: Error parsing JSON response from Facebook : Page - #{channel.page_id} : #{result}"
+    nil
+  rescue Net::OpenTimeout
+    message.update!(status: :failed, external_error: 'Request timed out, please try again later')
+    Rails.logger.error "Facebook::SendOnFacebookService: Timeout error sending message to Facebook : Page - #{channel.page_id}"
+    nil
+  end
+
   def fb_text_message_params
     {
       recipient: { id: contact.get_source_id(inbox.id) },

app/services/instagram/send_on_instagram_service.rb

@@ -70,22 +70,28 @@ class Instagram::SendOnInstagramService < Base::SendOnChannelService
       query: query
     )
 
-    if response[:error].present?
-      Rails.logger.error("Instagram response: #{response['error']} : #{message_content}")
-      message.status = :failed
-      message.external_error = external_error(response)
+    handle_response(response, message_content)
+  end
+
+  def handle_response(response, message_content)
+    parsed_response = response.parsed_response
+    if response.success? && parsed_response['error'].blank?
+      message.update!(source_id: parsed_response['message_id'])
+
+      parsed_response
+    else
+      external_error = external_error(parsed_response)
+      Rails.logger.error("Instagram response: #{external_error} : #{message_content}")
+      message.update!(status: :failed, external_error: external_error)
+
+      nil
     end
-
-    message.source_id = response['message_id'] if response['message_id'].present?
-    message.save!
-
-    response
   end
 
   def external_error(response)
     # https://developers.facebook.com/docs/instagram-api/reference/error-codes/
-    error_message = response[:error][:message]
-    error_code = response[:error][:code]
+    error_message = response.dig('error', 'message')
+    error_code = response.dig('error', 'code')
 
     "#{error_code} - #{error_message}"
   end

app/services/whatsapp/providers/base_service.rb

@@ -27,6 +27,33 @@ class Whatsapp::Providers::BaseService
     raise 'Overwrite this method in child class'
   end
 
+  def error_message
+    raise 'Overwrite this method in child class'
+  end
+
+  def process_response(response)
+    parsed_response = response.parsed_response
+    if response.success? && parsed_response['error'].blank?
+      parsed_response['messages'].first['id']
+    else
+      handle_error(response)
+      nil
+    end
+  end
+
+  def handle_error(response)
+    Rails.logger.error response.body
+    return if @message.blank?
+
+    # https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/#sample-response
+    error_message = error_message(response)
+    return if error_message.blank?
+
+    @message.external_error = error_message
+    @message.status = :failed
+    @message.save!
+  end
+
   def create_buttons(items)
     buttons = []
     items.each do |item|

app/services/whatsapp/providers/whatsapp_360_dialog_service.rb

@@ -1,5 +1,6 @@
 class Whatsapp::Providers::Whatsapp360DialogService < Whatsapp::Providers::BaseService
   def send_message(phone_number, message)
+    @message = message
     if message.attachments.present?
       send_attachment_message(phone_number, message)
     elsif message.content_type == 'input_select'
@@ -78,6 +79,7 @@ class Whatsapp::Providers::Whatsapp360DialogService < Whatsapp::Providers::BaseS
     }
     type_content['caption'] = message.content unless %w[audio sticker].include?(type)
     type_content['filename'] = attachment.file.filename if type == 'document'
+
     response = HTTParty.post(
       "#{api_base_path}/messages",
       headers: api_headers,
@@ -91,13 +93,9 @@ class Whatsapp::Providers::Whatsapp360DialogService < Whatsapp::Providers::BaseS
     process_response(response)
   end
 
-  def process_response(response)
-    if response.success?
-      response['messages'].first['id']
-    else
-      Rails.logger.error response.body
-      nil
-    end
+  def error_message(response)
+    # {"meta": {"success": false, "http_code": 400, "developer_message": "errro-message", "360dialog_trace_id": "someid"}}
+    response.parsed_response.dig('meta', 'developer_message')
   end
 
   def template_body_parameters(template_info)

app/services/whatsapp/providers/whatsapp_cloud_service.rb

@@ -1,5 +1,7 @@
 class Whatsapp::Providers::WhatsappCloudService < Whatsapp::Providers::BaseService
   def send_message(phone_number, message)
+    @message = message
+
     if message.attachments.present?
       send_attachment_message(phone_number, message)
     elsif message.content_type == 'input_select'
@@ -111,13 +113,9 @@ class Whatsapp::Providers::WhatsappCloudService < Whatsapp::Providers::BaseServi
     process_response(response)
   end
 
-  def process_response(response)
-    if response.success?
-      response['messages'].first['id']
-    else
-      Rails.logger.error response.body
-      nil
-    end
+  def error_message(response)
+    # https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/#sample-response
+    response.parsed_response&.dig('error', 'message')
   end
 
   def template_body_parameters(template_info)