xolo-server 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84bf8381f9806f22096c6404f36e62cb49d418384cf8a9cd722bbb4afbfc60d1
-  data.tar.gz: 22e325e7e124104589c946006531cad9e5ab3b8db047b8403e66d5bb83166d0f
+  metadata.gz: 52595d7268e2f989402fd60e3c8c992b993a1342d4a5f4436953a025493d2409
+  data.tar.gz: 39ecea967112210302c3242d7c0f9f53da34ffa8a803c71cf4edced97b26113a
 SHA512:
-  metadata.gz: 8dde7e538db3e32619b7828057e7671c8eef1460a60df222f63754624d98093b66b6badf78b8834ef4517343b0464e965471cd1bbb841ec66886b20d5ca98d0a
-  data.tar.gz: 738fdb9b8c7cd66cb82c1efe39cbc00aafa011a0adc6b4936f6a2fcaadf1733f64fa88a2648a8a7d8639d4866203328be8ce8baee86103d9982e83b4cf144841
+  metadata.gz: be740aa47014789519e5d167bda8fa19d517331945c6e5520403e59643620cf660a09f142031e65e385a254b427362b9e78c459dfde20b1ecf3c0835e6fc030b
+  data.tar.gz: 7c4792d23e49b5d486c3f24aab9b51d35f510d303597d5d1ce84b7eb5dfb4723a5bf07b357d1429b6c99c0d85737df75c04b3cd6f70967277088faa40db76145

data/lib/xolo/core/version.rb

@@ -12,7 +12,7 @@ module Xolo
 
     module Version
 
-      VERSION = '2.2.0'.freeze
+      VERSION = '2.2.2'.freeze
 
     end
 

data/lib/xolo/server/helpers/maintenance.rb

@@ -13,9 +13,10 @@ module Xolo
     module Helpers
 
       # Nightly maintenance tasks
-      # - accept TEd EAs
+      # - accept lingering TEd EAs, if configured to
       # - autorelease versions
       # - clean up old versions
+      # - notify title maintainers of old unreleased pilots
       #
       # Also, alerts will be posted, and Emails will be sent to the
       # admins who added versions that have been in pilot for more than
@@ -32,8 +33,24 @@ module Xolo
         # Constants
         #####################################
 
+        # TODO: ? use the next 3 values as defaults, and
+        # set them in the server config
+
+        # how often does our maint timer check to see if it should run maintenance?
+        # Slightly less than an hour means there will always be at least one check every
+        # hour, sometimes two.
+        MAINT_CHECK_INTERVAL = 3500
+        # MAINT_CHECK_INTERVAL = 600
+
         # At what hour should the nightly maintenance run?
         MAINT_HOUR = 2
+        # MAINT_HOUR = 10
+
+        # Maint won't run unless the last run was at least this many
+        # seconds ago.
+        # 23 hrs ago means that even if we check twice within the
+        # MAINT_HOUR, only the first one will run.
+        MAINT_MAX_FREQ_SECS = 23 * 3600
 
         # the route we POST to, to start the nightly process.
         TIMED_MAINT_TRIGGER_ROUTE = '/maint/maint-internal'
@@ -84,9 +101,10 @@ module Xolo
           return @maint_timer_task if @maint_timer_task
 
           @maint_timer_task =
-            Concurrent::TimerTask.new(execution_interval: 3600) { post_to_start_maint }
+            Concurrent::TimerTask.new(execution_interval: MAINT_CHECK_INTERVAL) { post_to_start_maint }
+
+          Xolo::Server.logger.info "Created Concurrent::TimerTask for nightly maintenance. Will check every #{MAINT_CHECK_INTERVAL} secs, and run during the hour of: #{MAINT_HOUR}"
 
-          Xolo::Server.logger.info 'Created Concurrent::TimerTask for nightly maintenance.'
           @maint_timer_task
         end
 
@@ -118,10 +136,18 @@ module Xolo
             return
           end
 
-          # only run the maintenance if it's between 2am and 3am
-          # and the last one was more than 23 hrs ago
-          last_maint_hrs_ago = (Time.now - last_maint) / 3600
-          return unless force || (Time.now.hour == MAINT_HOUR && last_maint_hrs_ago > 23)
+          # only run the maintenance if it's during the MAINT_HOUR
+          # and the last one was more than MAINT_MAX_FREQ_SECS ago
+          if force
+            Xolo::Server.logger.info 'Maint: Starting now due to force'
+
+          elsif Time.now.hour == MAINT_HOUR && (Time.now - last_maint) > MAINT_MAX_FREQ_SECS
+            Xolo::Server.logger.info 'Maint: Starting nightly run now'
+
+          else
+            Xolo::Server.logger.info "Maint: Not starting, it isn't time"
+            return
+          end
 
           uri = URI.parse "https://#{Xolo::Server::Helpers::Auth::IPV4_LOOPBACK}#{TIMED_MAINT_TRIGGER_ROUTE}"
           https = Net::HTTP.new(uri.host, uri.port)
@@ -155,11 +181,16 @@ module Xolo
           mutex.lock
           log_info 'Maint: starting'
 
+          # instantiate all the titles once now, rather than in all the task methods
+          title_objects_for_maint = Xolo::Server::Title.all_titles.map { |t| instantiate_title t }
+
           # add new maintenance tasks/methods here
-          accept_title_editor_eas
-          auto_release_versions
-          cleanup_versions
+          accept_title_editor_eas title_objects_for_maint
+          auto_release_versions title_objects_for_maint
+          cleanup_versions title_objects_for_maint
+          notify_admins_of_unreleased_pilots title_objects_for_maint
 
+          Xolo::Server::Helpers::Maintenance.last_maint = Time.now
           log_info 'Maint: complete'
         ensure
           mutex&.unlock
@@ -169,17 +200,16 @@ module Xolo
         # and auto accept them if we need to
         # @return [void]
         ######################################
-        def accept_title_editor_eas
+        def accept_title_editor_eas(title_objects)
           unless Xolo::Server.config.jamf_auto_accept_xolo_eas
-            log_info 'Maint: The xolo server is not configured to auto-accept Title Editor EAs'
+            log_debug 'Maint: The xolo server is not configured to auto-accept Title Editor EAs'
             return
           end
 
           log_info 'Maint: Looking for Title Editor EAs to auto-accept'
 
-          # TODO: Be DRY with this stuff and similar in title_jamf_access.rb
-          Xolo::Server::Title.all_titles.each do |title|
-            title_obj = instantiate_title title
+          title_objects.each do |title_obj|
+            title = title_obj.title
             next if title_obj.subscribed?
             next unless title_obj.jamf_patch_ea_awaiting_acceptance?
 
@@ -195,14 +225,17 @@ module Xolo
         # Do any pending auto-releases
         # @return [void]
         ##############################
-        def auto_release_versions
+        def auto_release_versions(title_objects)
           log_info 'Maint: Auto-releasing appropriate versions'
 
           today = Date.today
 
           # Loop thru the titles
-          Xolo::Server::Title.all_titles.each do |title|
-            title_obj = instantiate_title title
+          title_objects.each do |title_obj|
+            title = title_obj.title
+
+            # nothing to do if its nil or 'none'
+            next if title_obj.auto_release_delay.nil? || title_obj.auto_release_delay == Xolo::NONE
 
             # title must be subscribed and autopkg
             # (enforced in xadm)
@@ -214,19 +247,22 @@ module Xolo
             # NOTE: it is stored as a string because it might be 'none'
             # TODO: store none as nil, so we don't have to do the pix_integer check??
             delay = title_obj.auto_release_delay.to_i
-            next unless title_obj.auto_release_delay.pix_integer? && !delay.negative?
+            next unless title_obj.auto_release_delay&.pix_integer? && !delay.negative?
 
             # Any version with this creation date should be released now, skip if not
             # So if the auto_release_delay is 7, its today - 7 days.
             # if the auto_release_delay is 0, its today - 0 days, aka today
             creation_date_to_be_released_today = today - delay
 
-            # Find the newest pilot version whose creation date is creation_date_to_be_released_today
+            # Find the newest pilot version whose creation date is
+            # creation_date_to_be_released_today or earlier
             # That one should be released now.
             vobj_to_release = nil
+
+            # version objects are in order of newest to oldest
             title_obj.version_objects.each do |vobj|
               next unless vobj.pilot?
-              next unless vobj.creation_date.to_date == creation_date_to_be_released_today
+              next unless vobj.creation_date.to_date <= creation_date_to_be_released_today
 
               vobj_to_release = vobj
               break
@@ -251,12 +287,11 @@ module Xolo
         # Cleanup versions.
         # @return [void]
         ################################
-        def cleanup_versions
-          log_info 'Maint: cleaning up deprecated and skipped versions'
-
-          Xolo::Server::Title.all_titles.each do |title|
-            title_obj = instantiate_title title
+        def cleanup_versions(title_objects)
+          log_info 'Maint: Cleaning up deprecated and skipped versions'
 
+          # Loop thru the titles
+          title_objects.each do |title_obj|
             title_obj.version_objects.each do |version|
               if version.deprecated?
                 cleanup_deprecated_version version
@@ -264,12 +299,8 @@ module Xolo
                 cleanup_skipped_version version
               end # case
             end # each version
-
-            notify_admins_of_unreleased_pilots(title_obj)
           end # each title
-
-          Xolo::Server::Helpers::Maintenance.last_maint = Time.now
-          log_info 'Maint: versions cleanup complete'
+          log_info 'Maint: Version cleanup complete'
         end
 
         # Cleanup a deprecated version.
@@ -284,7 +315,7 @@ module Xolo
           days_deprecated = (Time.now - version.deprecation_date) / 86_400
           return unless days_deprecated > deprecated_lifetime_days
 
-          log_info "Cleanup: Deleting deprecated version '#{version.version}' of title '#{version.title}'"
+          log_info "Maint: Deleting deprecated version '#{version.version}' of title '#{version.title}'"
           version.delete
         end
 
@@ -295,38 +326,50 @@ module Xolo
         def cleanup_skipped_version(version)
           return if Xolo::Server.config.keep_skipped_versions
 
-          log_info "Cleanup: Deleting skipped version '#{version.version}' of title '#{version.title}'"
+          log_info "Maint: Deleting skipped version '#{version.version}' of title '#{version.title}'"
           version.delete
         end
 
         # Notify the admins about unreleased pilots if needed
         # @return [void]
         ################################
-        def notify_admins_of_unreleased_pilots(title_obj)
-          return unless Time.now.day == UNRELEASED_PILOTS_NOTIFICATION_DAY
-          return unless unreleased_pilots_notification_days.positive?
-          return unless title_obj.latest_version
+        def notify_admins_of_unreleased_pilots(title_objects)
+          unless Time.now.day == UNRELEASED_PILOTS_NOTIFICATION_DAY
+            log_debug 'Maint: Not notifying admins of old pilots, wrong day of the month.'
+            return
+          end
+          unless unreleased_pilots_notification_days&.positive?
+            log_debug 'Maint: Not notifying admins of old pilots, unreleased_pilots_notification_days is not a positive integer'
+            return
+          end
 
-          latest_vers_obj = instantiate_version title: title_obj, version: title_obj.latest_version
-          return unless latest_vers_obj.pilot?
+          log_info 'Maint: Notifying admins about old unreleased pilots'
 
-          days_in_pilot = ((Time.now - latest_vers_obj.creation_date) / 86_400).to_i
+          title_objects.each do |title_obj|
+            next unless title_obj.latest_version
 
-          return unless days_in_pilot > unreleased_pilots_notification_days
+            latest_vers_obj = instantiate_version title: title_obj, version: title_obj.latest_version
+            next unless latest_vers_obj.pilot?
 
-          alert_msg = "Cleanup: Notifying #{title_obj.contact_email} about unreleased pilot '#{latest_vers}' of title '#{title_obj.title}', in pilot for #{days_in_pilot} days"
+            days_in_pilot = ((Time.now - latest_vers_obj.creation_date) / 86_400).to_i
 
-          log_info alert_msg
-          send_alert alert_msg
+            next unless days_in_pilot > unreleased_pilots_notification_days
 
-          email_msg = <<~MSG
+            alert_msg = "Maint: Notifying #{title_obj.contact_email} about unreleased pilot '#{latest_vers}' of title '#{title_obj.title}', in pilot for #{days_in_pilot} days"
+
+            log_info alert_msg
+            send_alert alert_msg
+
+            email_msg = <<~MSG
             The newest version '#{latest_vers_obj.version}' of title '#{title_obj.title}' has been in pilot for #{days_in_pilot} days, which makes it seem like it's not going to be released.
 
             To reduce clutter, please consider releasing it, deleting it, or deleting the whole title if it's no longer needed.
 
             If this is intentional, you can ignore this monthly message.
-          MSG
-          send_email to: title_obj.contact_email, subject: 'Unreleased Pilot Notification', msg: email_msg
+            MSG
+            send_email to: title_obj.contact_email, subject: 'Unreleased Pilot Notification', msg: email_msg
+          end # each title
+          log_info 'Maint: Done notifying admins about old unreleased pilots'
         end
 
         # how many days can a version be deprecated?

data/lib/xolo/server/mixins/title_jamf_access.rb

@@ -1450,7 +1450,7 @@ module Xolo
           jamf_patch_title.category = Xolo::Server::JAMF_XOLO_CATEGORY
           self.jamf_patch_title_id = jamf_patch_title.save
 
-          log_debug "Activated Jamf Patch Title '#{display_name}' (#{title}) with id #{jamf_patch_title_id}"
+          log_debug "Jamf: Activated Jamf Patch Title '#{display_name}' (#{title}) with id #{jamf_patch_title_id}"
 
           jamf_patch_title
         end

data/lib/xolo/server/routes/maint.rb

@@ -51,6 +51,7 @@ module Xolo
             start_time: Xolo::Server.start_time,
             uptime: uptime_secs.pix_humanize_secs,
             uptime_secs: uptime_secs,
+            last_maint: Xolo::Server::Helpers::Maintenance.last_maint,
             app_env: Xolo::Server.app_env,
             test_server: Xolo::Server.test_server?,
             data_dir: Xolo::Server::DATA_DIR,

data/lib/xolo/server/title.rb

@@ -435,7 +435,7 @@ module Xolo
       def jamf_patch_title_id
         return @jamf_patch_title_id if @jamf_patch_title_id
 
-        log_debug "Getting jamf_patch_title_id for title '#{title}'"
+        log_debug "Jamf: Getting jamf_patch_title_id for title '#{title}'"
 
         self.jamf_patch_title_id =
           if managed?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xolo-server
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Chris Lasell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-14 00:00:00.000000000 Z
+date: 2026-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday