FarmBot/Farmbot-Web-App

View on GitHub
app/mutations/sequences/update.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Sequences
  class Update < Mutations::Command
    include CeleryScriptValidators
    using CanonicalCeleryHelpers
    EXCLUDE = [:sequence, :device, :args, :body, :folder_id]
    BASE = "Can't add 'parent' to sequence because "
    EXPL = {
      FarmEvent => BASE + "it is in use by FarmEvents on these dates: %{items}",
      Regimen => BASE + "the following Regimen(s) are using it: %{items}",
    }

    required do
      model :device, class: Device
      model :sequence, class: Sequence
      string :name
      # HISTORICAL NOTE ========================================================
      # Originally, `args` and `body` were optional. We stored them in a
      args # serialized column and it was very inexpensive to retrieve them
      body # from the database. Serialized columns led to an enormous amount of
      # issues in other parts of the app, however. One of the tradeoffs that we
      # now face is that we can no longer call `sequence.args` and
      # `sequence.body` as quickly as in the old days. It also means these
      # fields are now mandatory for sequence updates.
      #
      # In the long term, the app benefits from the new storage mechanism
      # because it is easier to track sequence dependencies, migrate deprecated
      # sequences, and also to query for data inside of a sequence (nearly
      # impossible under the old database schema).
      #
      # END HISTORICAL NOTE ================================================== ^
    end

    optional do
      color
      integer :folder_id
      boolean :pinned
      boolean :forked
      string :description, empty: true
      string :copyright
    end

    def validate
      validate_sequence
      raise Errors::Forbidden unless device.sequences.include?(sequence)
    end

    def execute
      Sequence.auto_sync_debounce do
        ActiveRecord::Base.transaction do
          sequence.update!(inputs.except(*EXCLUDE).merge(folder_stuff))
          CeleryScript::StoreCelery.run!(sequence: sequence,
                                         args: args,
                                         body: body)
        end
        sequence
      end
      Sequences::Show.run!(sequence: sequence, args: args, body: body)
    end

    def folder_stuff
      if folder_id
        return { folder: device.folders.find_by(id: folder_id) }
      else
        return {}
      end
    end
  end
end