FarmBot/Farmbot-Web-App

View on GitHub
app/models/application_record.rb

Summary

Maintainability
A
25 mins
Test Coverage
class ApplicationRecord < ActiveRecord::Base
  self.abstract_class = true
  after_create :maybe_broadcast
  after_update :maybe_broadcast
  after_destroy :maybe_broadcast

  class << self
    attr_reader :auto_sync_paused
  end

  DONT_BROADCAST = ["created_at",
                    "last_saw_api",
                    "last_sign_in_at",
                    "last_sign_in_ip",
                    "sign_in_count",
                    "updated_at",
                    "current_sign_in_ip",
                    "current_sign_in_at",
                    "fbos_version"]

  def gone?
    destroyed? || self.try(:discarded?)
  end

  def the_changes
    self.saved_changes.except(*self.class::DONT_BROADCAST)
  end

  # Determine if the changes to the model are worth broadcasting or not.
  # Reduces network noise.
  def notable_changes?
    !the_changes.empty?
  end

  # Perform table operations without triggering
  # echo-ey auto_syncs.
  def self.auto_sync_debounce
    @auto_sync_paused = true
    result = yield
    result.update!(updated_at: Time.now)
    @auto_sync_paused = false
    result.broadcast!
    result
  end

  def broadcast?
    return false if self.class.auto_sync_paused
    return false unless current_device
    return false unless (gone? || notable_changes?)
    return true
  end

  def maybe_broadcast
    self.broadcast! if broadcast?
  end

  def body_as_json # REMEMBER: Subclasses might override this! - RC
    gone? ? nil : force_serialization
  end

  def force_serialization
    serializer = ActiveModel::Serializer.serializer_for(self)
    if serializer
      serializer.new(self).as_json
    else
      self.as_json
    end
  end

  def broadcast_payload(label)
    { args: { label: label }, body: body_as_json }.to_json
  end

  # Overridable
  def name_used_when_syncing
    self.class.name
  end

  def chan_name
    "sync.#{name_used_when_syncing}.#{self.id}"
  end

  def current_device
    @current_device ||= (Device.current || self.try(:device))
  end

  def broadcast!(label = Transport.current.current_request_id)
    AutoSyncJob.perform_later(broadcast_payload(label),
                              current_device.id,
                              chan_name,
                              Time.now.utc.to_i) if current_device
    self
  end

  def manually_sync!
    device && (device.auto_sync_transaction do
      update!(updated_at: Time.now)
    end)
    self
  end
end