Class: RailsBase::ServiceBase

Inherits:

Object

• Object
• RailsBase::ServiceBase

Includes:

Interactor, ServiceLogging

Defined in:

app/services/rails_base/service_base.rb

Direct Known Subclasses

AdminRiskyMfaSend, AdminUpdateAttribute, Authentication::AuthenticateUser, Authentication::DecisionTwofaType, Authentication::DestroyUser, Authentication::MfaSetEncryptToken, Authentication::MfaValidator, Authentication::ModifyPassword, Authentication::SendForgotPassword, Authentication::SendLoginMfaToUser, Authentication::SendVerificationEmail, Authentication::SessionTokenVerifier, Authentication::SingleSignOnCreate, Authentication::SingleSignOnSend, Authentication::SingleSignOnVerify, Authentication::SsoVerifyEmail, Authentication::UpdatePhoneSendVerification, Authentication::VerifyForgotPassword, EmailChange, NameChange

Class Method Summary

• .inherited(subclass) ⇒ Object

Instance Method Summary

• #internal_validate(interactor) ⇒ Object
• #service_base_logging(interactor) ⇒ Object
• #validate! ⇒ Object

Methods included from ServiceLogging

#aletered_message, #class_name, #log, #log_prefix, #logger, #service_id

Class Method Details

.inherited(subclass) ⇒ Object

# File 'app/services/rails_base/service_base.rb', line 7

def self.inherited(subclass)
  # Add the base logging to the subclass.
  # Since this is done at inheritence time it should always be the first and last hook to run.
   subclass.around(:service_base_logging)
  subclass.around(:internal_validate)
end

Instance Method Details

#internal_validate(interactor) ⇒ Object

# File 'app/services/rails_base/service_base.rb', line 18

def internal_validate(interactor)
  # call validate that is overidden from child
  begin
    validate!
  rescue StandardError => e
    log(level: :error, msg: "Error during validation. #{e.message}")
    raise
  end

  # call interactor
  interactor.call
end

#service_base_logging(interactor) ⇒ Object

# File 'app/services/rails_base/service_base.rb', line 31

def service_base_logging(interactor)
 beginning_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

  # Pre processing stats
  log(level: :info, msg: 'Start')

  # Run the job!
  interactor.call

  # Set status for use in ensure block
  status = :complete

# Capture Interactor::Failure for logging purposes, then reraise
rescue ::Interactor::Failure
  # set status for use in ensure block
  status = :failure

  # Reraise to let the core Interactor handle this
  raise
# Capture exception explicitly to try to logging purposes. Then reraise.
rescue ::Exception => e # rubocop:disable Lint/RescueException
  # set status for use in ensure block
  status = :error

  # Log error
  log(level: :error, msg: "Error #{e.class.name}")

  raise
ensure
  # Always log how long it took along with a status
  finished_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  elapsed = ((finished_time - beginning_time)).round(1)
  log(level: :info, msg: "Finished with [#{status}]...elapsed #{elapsed}s")
end

#validate! ⇒ Object

# File 'app/services/rails_base/service_base.rb', line 14

def validate!
  # overload from child
end