mirror of
				https://github.com/lingble/chatwoot.git
				synced 2025-11-03 20:48:07 +00:00 
			
		
		
		
	feat: disable automation rules if condition fails multiple times (#9017)
* feat: add email for disabling automation rule * feat: disable automation rules and notify admin * feat: reset error count after update * feat: trigger invalid_condition_error if rule is invalid * feat: setup error trackable concern * refactor: use ErrorTrackable in Reauthorizable * fix: optional argument * feat: separate reauthorization_required_key * test: update case to use ERROR_TRACKABLE_COUNT * Revert "test: update case to use ERROR_TRACKABLE_COUNT" This reverts commit f439847147556a02759a7597a7fcf1d66091cafc. * Revert "feat: separate reauthorization_required_key" This reverts commit f4514fce217b0a2f2c2bf701a15de0a8b47acbc4. * Revert "fix: optional argument" This reverts commit 93b4194ec3f10f67e2402388c966c071c4d3b4fd. * Revert "refactor: use ErrorTrackable in Reauthorizable" This reverts commit 513c2a522bc782e73ea4b0f5ae34ce01e70e042c. * Revert "feat: setup error trackable concern" This reverts commit 278683060cf422f60af5d5c77100aa5272141141. * feat: use reauthorizable for automation rule * feat: remove redis key * test: fix method names * chore: refactor --------- Co-authored-by: Vishnu Narayanan <iamwishnu@gmail.com> Co-authored-by: Sojan <sojan@pepalo.com>
This commit is contained in:
		@@ -69,6 +69,18 @@ class AdministratorNotifications::ChannelNotificationsMailer < ApplicationMailer
 | 
			
		||||
    send_mail_with_liquid(to: email_to, subject: subject) and return
 | 
			
		||||
  end
 | 
			
		||||
 | 
			
		||||
  def automation_rule_disabled(rule)
 | 
			
		||||
    return unless smtp_config_set_or_development?
 | 
			
		||||
 | 
			
		||||
    @action_url ||= "#{ENV.fetch('FRONTEND_URL', nil)}/app/accounts/#{Current.account.id}/settings/automation/list"
 | 
			
		||||
 | 
			
		||||
    subject = 'Automation rule disabled due to validation errors.'.freeze
 | 
			
		||||
    @meta = {}
 | 
			
		||||
    @meta['rule_name'] = rule.name
 | 
			
		||||
 | 
			
		||||
    send_mail_with_liquid(to: admin_emails, subject: subject) and return
 | 
			
		||||
  end
 | 
			
		||||
 | 
			
		||||
  private
 | 
			
		||||
 | 
			
		||||
  def admin_emails
 | 
			
		||||
 
 | 
			
		||||
@@ -19,6 +19,7 @@
 | 
			
		||||
#
 | 
			
		||||
class AutomationRule < ApplicationRecord
 | 
			
		||||
  include Rails.application.routes.url_helpers
 | 
			
		||||
  include Reauthorizable
 | 
			
		||||
 | 
			
		||||
  belongs_to :account
 | 
			
		||||
  has_many_attached :files
 | 
			
		||||
@@ -28,6 +29,8 @@ class AutomationRule < ApplicationRecord
 | 
			
		||||
  validate :query_operator_presence
 | 
			
		||||
  validates :account_id, presence: true
 | 
			
		||||
 | 
			
		||||
  after_update_commit :reauthorized!, if: -> { saved_change_to_conditions? }
 | 
			
		||||
 | 
			
		||||
  scope :active, -> { where(active: true) }
 | 
			
		||||
 | 
			
		||||
  def conditions_attributes
 | 
			
		||||
 
 | 
			
		||||
@@ -50,6 +50,9 @@ module Reauthorizable
 | 
			
		||||
      mailer.whatsapp_disconnect(inbox).deliver_later
 | 
			
		||||
    when 'Channel::Email'
 | 
			
		||||
      mailer.email_disconnect(inbox).deliver_later
 | 
			
		||||
    when 'AutomationRule'
 | 
			
		||||
      update!(active: false)
 | 
			
		||||
      mailer.automation_rule_disabled(self).deliver_later
 | 
			
		||||
    end
 | 
			
		||||
  end
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -45,8 +45,8 @@ class AutomationRules::ConditionsFilterService < FilterService
 | 
			
		||||
 | 
			
		||||
  def rule_valid?
 | 
			
		||||
    is_valid = AutomationRules::ConditionValidationService.new(@rule).perform
 | 
			
		||||
 | 
			
		||||
    Rails.logger.info "Automation rule condition validation failed for rule id: #{@rule.id}" unless is_valid
 | 
			
		||||
    @rule.authorization_error! unless is_valid
 | 
			
		||||
 | 
			
		||||
    is_valid
 | 
			
		||||
  end
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,8 @@
 | 
			
		||||
<p>Hello there,</p>
 | 
			
		||||
 | 
			
		||||
<p>The automation rule <b>{{meta['rule_name']}}</b> has been disabled becuase it has invalid conditions.</p>
 | 
			
		||||
<p>This typically happens when you delete any custom attributes which are still being used in automation rules.</p>
 | 
			
		||||
 | 
			
		||||
<p>
 | 
			
		||||
Click <a href="{{action_url}}">here</a> to update the conditions.
 | 
			
		||||
</p>
 | 
			
		||||
@@ -1,6 +1,11 @@
 | 
			
		||||
require 'rails_helper'
 | 
			
		||||
require Rails.root.join 'spec/models/concerns/reauthorizable_shared.rb'
 | 
			
		||||
 | 
			
		||||
RSpec.describe AutomationRule do
 | 
			
		||||
  describe 'concerns' do
 | 
			
		||||
    it_behaves_like 'reauthorizable'
 | 
			
		||||
  end
 | 
			
		||||
 | 
			
		||||
  describe 'associations' do
 | 
			
		||||
    let(:account) { create(:account) }
 | 
			
		||||
    let(:params) do
 | 
			
		||||
@@ -56,4 +61,35 @@ RSpec.describe AutomationRule do
 | 
			
		||||
      expect(rule.errors.messages[:conditions]).to eq(['Automation conditions should have query operator.'])
 | 
			
		||||
    end
 | 
			
		||||
  end
 | 
			
		||||
 | 
			
		||||
  describe 'reauthorizable' do
 | 
			
		||||
    context 'when prompt_reauthorization!' do
 | 
			
		||||
      it 'marks the rule inactive' do
 | 
			
		||||
        rule = create(:automation_rule)
 | 
			
		||||
        expect(rule.active).to be true
 | 
			
		||||
        rule.prompt_reauthorization!
 | 
			
		||||
        expect(rule.active).to be false
 | 
			
		||||
      end
 | 
			
		||||
    end
 | 
			
		||||
 | 
			
		||||
    context 'when reauthorization_required?' do
 | 
			
		||||
      it 'unsets the error count if conditions are updated' do
 | 
			
		||||
        rule = create(:automation_rule)
 | 
			
		||||
        rule.prompt_reauthorization!
 | 
			
		||||
        expect(rule.reauthorization_required?).to be true
 | 
			
		||||
 | 
			
		||||
        rule.update!(conditions: [{ attribute_key: 'browser_language', filter_operator: 'equal_to', values: ['en'], query_operator: 'AND' }])
 | 
			
		||||
        expect(rule.reauthorization_required?).to be false
 | 
			
		||||
      end
 | 
			
		||||
 | 
			
		||||
      it 'will not unset the error count if conditions are not updated' do
 | 
			
		||||
        rule = create(:automation_rule)
 | 
			
		||||
        rule.prompt_reauthorization!
 | 
			
		||||
        expect(rule.reauthorization_required?).to be true
 | 
			
		||||
 | 
			
		||||
        rule.update!(name: 'Updated name')
 | 
			
		||||
        expect(rule.reauthorization_required?).to be true
 | 
			
		||||
      end
 | 
			
		||||
    end
 | 
			
		||||
  end
 | 
			
		||||
end
 | 
			
		||||
 
 | 
			
		||||
@@ -25,10 +25,19 @@ shared_examples_for 'reauthorizable' do
 | 
			
		||||
 | 
			
		||||
  it 'prompt_reauthorization!' do
 | 
			
		||||
    obj = FactoryBot.create(model.to_s.underscore.tr('/', '_').to_sym)
 | 
			
		||||
    mailer = double
 | 
			
		||||
    mailer_method = double
 | 
			
		||||
    allow(AdministratorNotifications::ChannelNotificationsMailer).to receive(:with).and_return(mailer)
 | 
			
		||||
    # allow mailer to receive any methods and return mailer
 | 
			
		||||
    allow(mailer).to receive(:method_missing).and_return(mailer_method)
 | 
			
		||||
    allow(mailer_method).to receive(:deliver_later)
 | 
			
		||||
 | 
			
		||||
    expect(obj.reauthorization_required?).to be false
 | 
			
		||||
 | 
			
		||||
    obj.prompt_reauthorization!
 | 
			
		||||
    expect(obj.reauthorization_required?).to be true
 | 
			
		||||
    expect(AdministratorNotifications::ChannelNotificationsMailer).to have_received(:with).with(account: obj.account)
 | 
			
		||||
    expect(mailer_method).to have_received(:deliver_later)
 | 
			
		||||
  end
 | 
			
		||||
 | 
			
		||||
  it 'reauthorized!' do
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user