web47core 2.0.0 → 3.0.0

data/lib/app/models/concerns/switchboard_configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+#
+# Switchboard configuration, both the fields and methods needed to determine configuration
+#
+module SwitchboardConfiguration
+  extend ActiveSupport::Concern
+  #
+  # Switchboard configuration
+  #
+  def self.included(base)
+    base.class_eval do
+      # Switchboard
+      field :switchboard_base_url, type: String, default: 'https://switchboard.app47.com'
+      field :switchboard_stack_id, type: String
+      field :switchboard_stack_api_token, type: String
+      field :switchboard_last_sync_at, type: Time
+      #
+      # Validations
+      #
+      validates :switchboard_base_url, url: true
+    end
+  end
+
+  #
+  # Make sure the password doesn't get blanked out on an update
+  #
+  def secure_fields
+    super + %i[switchboard_stack_api_token]
+  end
+
+  #
+  # Public: Determine if switchboard is configured
+  #
+  # Examples
+  #
+  #   switchboard_configured?
+  #   # => true || false
+  #
+  def switchboard_configured?
+    [switchboard_base_url.present?, switchboard_stack_api_token.present?, switchboard_stack_id.present?].all?
+  end
+end

data/lib/app/models/concerns/twilio_configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+#
+# Twilio configuration, both fields and methods to determine configuration
+#
+module TwilioConfiguration
+  extend ActiveSupport::Concern
+  #
+  # The Twilio Configuration
+  #
+  def self.included(base)
+    base.class_eval do
+      field :twilio_account_id, type: String
+      field :twilio_auth_token, type: String
+      field :twilio_phone_number, type: String
+    end
+  end
+
+  #
+  # Make sure the password doesn't get blanked out on an update
+  #
+  def secure_fields
+    super + %i[twilio_auth_token]
+  end
+
+  #
+  # Determine if twilio is configured at a system configuration
+  #
+  # Examples
+  #
+  #   twilio_configured??
+  #   # => true || false
+  #
+  def twilio_configured?
+    [twilio_account_id.present?, twilio_auth_token.present?, twilio_phone_number.present?].all?
+  end
+end

data/lib/app/models/concerns/zendesk_configuration.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+#
+# Add zendesk capability to an object to integrate via JWT with Zendesk. Most commonly this will be added
+# to SystemConfiguration, however this can also be added to a different object (i.e., switchboard).
+#
+module ZendeskConfiguration
+  extend ActiveSupport::Concern
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :zendesk_token, type: String
+      field :zendesk_base_url, type: String, default: 'https://app47.zendesk.com'
+      field :zendesk_documentation_path, type: String, default: 'hc'
+      field :zendesk_support_path, type: String, default: 'hc/en-us/requests'
+      field :zendesk_updates_path, type: String, default: 'hc'
+      #
+      # Validations
+      #
+      validates :zendesk_base_url, url: true
+    end
+  end
+
+  #
+  # Make sure the password doesn't get blanked out on an update
+  #
+  def secure_fields
+    super + %i[zendesk_token]
+  end
+
+  #
+  # Return the zendesk documentation URL
+  #
+  def zendesk_documentation_url(user = nil)
+    zendesk_url(forward_to: zendesk_documentation_path, user: user)
+  end
+
+  #
+  # Return the zendesk support URL
+  #
+  def zendesk_requests_url(user = nil)
+    zendesk_url(forward_to: zendesk_support_path, user: user)
+  end
+
+  #
+  # Return the zendesk support URL
+  #
+  def zendesk_new_request_url(user = nil)
+    zendesk_url(forward_to: "#{zendesk_support_path}/new", user: user)
+  end
+
+  #
+  # Return the zendesk update URL
+  #
+  def zendesk_updates_url(user = nil)
+    zendesk_url(forward_to: zendesk_updates_path, user: user)
+  end
+
+  #
+  # Generate a Zendesk URL
+  #
+  # If a user is passed in and Zendesk is configured then return a JWT enabled URL for
+  # SSO authentication to Zendesk.
+  #
+  def zendesk_url(forward_to: zendesk_documentation_path, user: nil)
+    path = if zendesk_configured? && user.present?
+             time_now = Time.now.to_i
+             jti = "#{time_now}/#{rand(36**64).to_s(36)}"
+             payload = { jwt: JWT.encode({ iat: time_now, # Seconds since epoch, determine when this token is stale
+                                           jti: jti, # Unique token identifier, helps prevent replay attacks
+                                           name: user.name,
+                                           email: user.email }, zendesk_token),
+                         return_to: CGI.escape([zendesk_base_url, forward_to].join('/')) }
+             ['access/jwt', payload.to_query].join('?')
+           else
+             forward_to
+           end
+    [zendesk_base_url, path].join('/')
+  end
+
+  #
+  # Is zendesk configured?
+  #
+  def zendesk_configured?
+    [zendesk_token.present?,
+     zendesk_base_url.present?,
+     zendesk_documentation_path.present?,
+     zendesk_support_path.present?].all?
+  end
+end

data/lib/app/models/{delayed_job.rb → delayed/backend/delayed_job.rb}

@@ -74,6 +74,47 @@ module Delayed
         rescue StandardError
           ''
         end
+
+        #
+        # Is this job running?
+        #
+        def running?
+          locked_by.present?
+        end
+
+        #
+        # Retrieve the host we are running on
+        #
+        def worker
+          Delayed::Jobs::Worker.where(host_name: worker_host_name, pid: worker_pid).first
+        rescue StandardError => error
+          App47Logger.log_warn 'Unable to fetch Worker information', error
+          nil
+        end
+
+        def worker_host_name
+          parts = locked_by.split
+          case parts.count
+          when 2
+            parts.first
+          when 3
+            parts[1]
+          else
+            raise "Unknown locked_by for delayed job #{parts}"
+          end.split(':').last
+        end
+
+        def worker_pid
+          parts = locked_by.split
+          case parts.count
+          when 2
+            parts.last
+          when 3
+            parts[2]
+          else
+            raise "Unknown locked_by for delayed job #{parts}"
+          end.split(':').last
+        end
       end
     end
   end

data/lib/app/models/delayed/jobs/metric.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Delayed
+  module Jobs
+    #
+    # Hold the job metric information for a specific job, used to determine if the job should be auto restarted
+    #
+    class Metric
+      include StandardModel
+
+      #
+      # Fields
+      #
+      field :name, type: String
+      field :count, type: Integer, default: 0
+      field :max, type: Float, default: 0
+      field :min, type: Float, default: 1_000_000_000
+      field :total, type: Float, default: 0
+      field :last_run_at, type: Time
+
+      #
+      # Validations
+      #
+      validates :name, uniqueness: true, presence: true
+
+      #
+      # Max allowed time for a currently running job
+      #
+      def max_allowed_seconds
+        send(max_allowed_method) * max_allowed_factor
+      rescue StandardError
+        max * 5
+      end
+
+      #
+      # Return the average time to run this job
+      #
+      def avg
+        count.zero? ? 0 : total / count
+      rescue StandardError
+        0
+      end
+
+      private
+
+      #
+      # Pull the method from system configuration to evalutate max allowed time
+      #
+      def max_allowed_method
+        @max_allowed_method ||= SystemConfiguration.delayed_job_max_allowed_method
+      end
+
+      #
+      # Pull the factor for max allowed when evaluating allowed time
+      #
+      def max_allowed_factor
+        @max_allowed_factor ||= SystemConfiguration.delayed_job_max_allowed_factor
+      end
+    end
+  end
+end

data/lib/app/models/delayed/jobs/run.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Delayed
+  module Jobs
+    #
+    # Single execution of a Job
+    #
+    class Run
+      include StandardModel
+      #
+      # Fields
+      #
+      field :name, type: String
+      field :locked_at, type: Time
+      field :locked_by, type: String
+      field :duration, type: Float, default: 0
+      #
+      # Relationships
+      #
+      belongs_to :worker, class_name: 'Delayed::Jobs::Worker'
+      #
+      # Validations
+      #
+      validates :name, presence: true
+      validates :locked_at, presence: true
+      validates :duration, numericality: { greater_than_or_equal_to: 0 }
+      #
+      # Callbacks
+      #
+      before_validation :record_duration
+
+      #
+      # Finish execution
+      #
+      def record_duration
+        self.duration = duration.zero? ? Time.now.utc - locked_at : duration
+      end
+    end
+  end
+end

data/lib/app/models/delayed/jobs/worker.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Delayed
+  module Jobs
+    #
+    # Capture a specific worker process
+    #
+    class Worker
+      include StandardModel
+      include ServerProcessAble
+      #
+      # Relationships
+      #
+      has_many :runs, class_name: 'Delayed::Jobs::Run', dependent: :restrict_with_exception
+
+      #
+      # Record a job relative to the worker
+      #
+      def record_job(job)
+        stop
+        runs.create!(name: job.display_name, locked_at: job.locked_at, locked_by: job.locked_by)
+      end
+
+      #
+      # Is this worker dead?, meaning has it reported in a timely manner
+      #
+      def dead?
+        last_check_in_at.present? ? check_in_limit > last_check_in_at : false
+      rescue StandardError
+        true
+      end
+
+      private
+
+      #
+      # Return the check in time limit based on if we are running or not
+      #
+      def check_in_limit
+        running? ? 3.hour.ago.utc : 1.minute.ago.utc
+      end
+    end
+  end
+end

data/lib/app/models/delayed/plugins/time_keeper.rb

@@ -0,0 +1,33 @@
+module Delayed
+  module Plugins
+    #
+    # Add callbacks to the lifecycle to capture two main aspects
+    # 1. When are workers checking in
+    # 2. How long jobs are taking
+    #
+    class TimeKeeper < Plugin
+      callbacks do |lifecycle|
+        lifecycle.before(:perform) do |_worker, job|
+          job.worker.start
+        rescue StandardError => error
+          App47Logger.log_warn 'before job perform', error
+        end
+        lifecycle.after(:perform) do |_worker, job|
+          job.worker.record_job(job)
+        rescue StandardError => error
+          App47Logger.log_warn 'after job perform', error
+        end
+        lifecycle.before(:loop) do
+          Delayed::Jobs::Worker.find_or_create_server.check_in
+        rescue StandardError => error
+          App47Logger.log_warn 'before worker loop', error
+        end
+        lifecycle.after(:loop) do
+          Delayed::Jobs::Worker.find_or_create_server.check_in
+        rescue StandardError => error
+          App47Logger.log_warn 'after worker loop', error
+        end
+      end
+    end
+  end
+end

data/lib/app/models/delayed/worker.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Delayed
+  #
+  # Override the start and stop of the worker itself to capture start/end of the worker lifecycle
+  #
+  class Worker
+    #
+    # Starting the worker
+    #
+    def start
+      super
+      Delayed::Jobs::Worker.find_or_create_server
+    end
+
+    #
+    # Stop the worker
+    #
+    def stop
+      Delayed::Jobs::Worker.find_server&.stop
+      super
+    end
+  end
+end

data/lib/app/models/email_notification.rb

@@ -17,6 +17,7 @@
 #
 # email = EmailNotification.new
 # email.to = 'user@abc.com'
+# email.recipient_name = 'users name'
 # email.sender = 'me@abc.com'
 # email.subject = 'Today is the day!'
 # email.message = 'Day is today!'
@@ -217,7 +218,7 @@ class EmailNotification < Notification
     return html_message if html_message.include?(tracker_url)
 
     image_tag = "<img style='height:0;width:0;border:none;display:none;' src='#{tracker_url}' alt=''/></body>"
-    html_message.sub(%r{<\/body>}, image_tag)
+    html_message.sub(%r{</body>}, image_tag)
   end
 
   def subject_from_haml_text(haml_text, locals)

data/lib/app/models/email_template.rb

@@ -17,16 +17,15 @@ class EmailTemplate < Template
 
   #
   # Make sure the template is wrapped in html
+  #
   def htmlize_template
-    if template.present? && !template.strip.start_with?("<")
-      self.template = "<body><pre>#{template}</pre></body>"
-    end
+    self.template = "<body><pre>#{template}</pre></body>" if template.present? && !template.strip.start_with?('<')
   end
 
   def valid_liquid_template
-    super && Liquid::Template.parse(self.subject).nil?
-  rescue Exception => error
-    self.errors.add(:subject, "Invalid liquid text in subject: #{error.message}")
+    super && Liquid::Template.parse(subject).nil?
+  rescue StandardError => error
+    errors.add(:subject, "Invalid liquid text in subject: #{error.message}")
     false
   end
 

data/lib/app/models/notification.rb

@@ -5,6 +5,7 @@
 #
 class Notification
   include StandardModel
+  include SearchAble
   #
   # Constants
   #
@@ -42,6 +43,7 @@ class Notification
   field :error_message, type: String
   field :last_viewed_at, type: Time
   field :viewed_count, type: Integer, default: 0
+  field :recipient_name, type: String
   #
   # Relationships
   #
@@ -100,10 +102,11 @@ class Notification
   #
   def finish_processing(processing_message = nil)
     if processing_message.present?
-      set state: STATE_INVALID, error_message: processing_message
+      assign_attributes state: STATE_INVALID, error_message: processing_message
     else
-      set state: STATE_PROCESSED, error_message: ''
+      assign_attributes state: STATE_PROCESSED, error_message: ''
     end
+    save(validate: false)
   end
 
   #
@@ -242,6 +245,13 @@ class Notification
     _type
   end
 
+  #
+  # Support search fields
+  #
+  def search_fields
+    %w[to state recipient_name]
+  end
+
   private
 
   #

data/lib/app/models/notification_template.rb

@@ -7,7 +7,7 @@ class NotificationTemplate < Template
   #
   # Fields
   #
-  field :draft, type: Boolean, default: true
+  field :draft, type: Mongoid::Boolean, default: true
   #
   # Relationships
   #

data/lib/app/models/sms_notification.rb

@@ -35,12 +35,15 @@ class SmsNotification < Notification
     account_sid = config.twilio_account_id
     auth_token = config.twilio_auth_token
     client = Twilio::REST::Client.new account_sid, auth_token
-
-    twilio_message = client.account.messages.create(
-      body: message,
-      to: to,
-      from: config.twilio_phone_number
-    )
+    twilio_message = if client.respond_to?(:account)
+                       client.account.messages.create(body: message,
+                                                      to: to,
+                                                      from: config.twilio_phone_number)
+                     else
+                       client.messages.create(body: message,
+                                              to: to,
+                                              from: config.twilio_phone_number)
+                     end
     # We are saved in the calling class, no reason to save again
     set sid: twilio_message.sid
   end

data/lib/app/models/smtp_configuration.rb

@@ -10,10 +10,10 @@ class SmtpConfiguration
   field :port, type: Integer, default: 587
   field :authentication_method, type: String
   field :confirmation_token, type: String
-  field :confirmed, type: Boolean, default: false
+  field :confirmed, type: Mongoid::Boolean, default: false
   field :verification_message, type: String
-  field :active, type: Boolean, default: false
-  field :ssl, type: Boolean, default: false
+  field :active, type: Mongoid::Boolean, default: false
+  field :ssl, type: Mongoid::Boolean, default: false
   field :server_name, type: String
   field :username, type: String
   field :password, type: String

data/lib/app/models/template.rb

@@ -20,18 +20,6 @@ class Template
   validates :template, presence: true
   validate :valid_liquid_template
 
-  private
-
-  #
-  # Ensure that the template is correct from a liquid statement
-  #
-  def valid_liquid_template
-    Liquid::Template.parse(self.template).nil?
-  rescue Exception => error
-    self.errors.add(:template, "Invalid liquid text in template: #{error.message}")
-    false
-  end
-
   #
   # Retrieve the template out of the project
   #
@@ -45,4 +33,16 @@ class Template
   rescue StandardError
     nil
   end
+
+  private
+
+  #
+  # Ensure that the template is correct from a liquid statement
+  #
+  def valid_liquid_template
+    Liquid::Template.parse(template).nil?
+  rescue StandardError => error
+    errors.add(:template, "Invalid liquid text in template: #{error.message}")
+    false
+  end
 end

data/lib/web47core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Web47core
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/lib/web47core.rb

@@ -1,28 +1,47 @@
 require 'web47core/config'
 require 'app/models/concerns/app47_logger'
+require 'app/models/concerns/api_tokenable'
+require 'app/models/concerns/aws_configuration'
+require 'app/models/concerns/core_system_configuration'
+require 'app/models/concerns/core_account'
 require 'app/models/concerns/cipher_able'
 require 'app/models/concerns/cdn_url'
+require 'app/models/concerns/delayed_job_configuration'
 require 'app/models/concerns/email_able'
+require 'app/models/concerns/encrypted_password'
 require 'app/models/concerns/search_able'
 require 'app/models/concerns/role_able'
 require 'app/models/concerns/time_zone_able'
+require 'app/models/concerns/slack_configuration'
+require 'app/models/concerns/server_process_able'
+require 'app/models/concerns/core_smtp_configuration'
 require 'app/models/concerns/standard_model'
 require 'app/models/concerns/switchboard_able'
-require 'app/models/concerns/core_system_configuration'
-require 'app/models/concerns/core_account'
+require 'app/models/concerns/switchboard_configuration'
 require 'app/models/concerns/secure_fields'
-require 'app/models/concerns/encrypted_password'
-require 'app/models/delayed_job'
-require 'app/models/redis_configuration'
+require 'app/models/concerns/twilio_configuration'
+require 'app/models/concerns/zendesk_configuration'
+require 'app/models/command_job'
+require 'app/models/command_job_log'
+#
+# Delayed jobs
+#
+require 'app/models/delayed/backend/delayed_job'
+require 'app/models/delayed/plugins/time_keeper'
+require 'app/models/delayed/jobs/metric'
+require 'app/models/delayed/jobs/run'
+require 'app/models/delayed/jobs/worker'
+
+require 'app/models/api_token'
 require 'app/models/notification'
-require 'app/models/sms_notification'
 require 'app/models/template'
-require 'app/models/notification_template'
 require 'app/models/email_notification'
 require 'app/models/email_template'
+require 'app/models/redis_configuration'
+require 'app/models/notification_template'
 require 'app/models/slack_notification'
-require 'app/models/smtp_configuration'
 require 'app/models/sms_notification'
+require 'app/models/smtp_configuration'
 #
 # Cron
 #
@@ -31,13 +50,18 @@ require 'app/jobs/cron/job'
 require 'app/jobs/cron/tab'
 require 'app/jobs/cron/job_tab'
 require 'app/jobs/cron/command'
-require 'app/jobs/cron/server'
 require 'app/jobs/cron/trim_collection'
+require 'app/jobs/cron/record_delayed_job_metrics'
+require 'app/jobs/cron/restart_orphaned_delayed_jobs'
+require 'app/jobs/cron/trim_delayed_job_metrics'
+require 'app/jobs/cron/trim_delayed_job_workers'
+require 'app/jobs/cron/server'
 require 'app/jobs/cron/switchboard_sync_configuration'
 require 'app/jobs/cron/switchboard_sync_models'
 require 'app/jobs/cron/trim_audit_logs'
 require 'app/jobs/cron/trim_cron_servers'
 require 'app/jobs/cron/trim_failed_delayed_jobs'
+require 'app/jobs/cron/trim_command_jobs'
 require 'app/jobs/cron/trim_notifications'
 #
 # Audit Logs
@@ -57,3 +81,5 @@ require 'app/controllers/concerns/core_controller'
 require 'app/controllers/concerns/core_system_configuration_controller'
 require 'app/controllers/concerns/core_cron_controller'
 require 'app/controllers/concerns/core_delayed_jobs_controller'
+require 'app/controllers/concerns/core_delayed_job_metrics_controller'
+require 'app/controllers/concerns/core_delayed_job_workers_controller'