Maintenance: Refactored script for background service processing (a.k…

….a scheduler).

- Added possibility to control process forking for better scalability via env variables. See `script/background-services.rb -h` for details.
- New handle `script/background-services.rb` does not daemonize any more.
- `script/scheduler.rb` is now deprecated and will be removed with Zammad 6.

Co-authored-by: Martin Gruner <[email protected]>
Co-authored-by: Mantas Masalskis <[email protected]>

.rubocop/todo.rspec.yml

@@ -111,7 +111,6 @@ RSpec/ContextWording:
     - 'spec/models/object_manager/attribute_spec.rb'
     - 'spec/models/overview_spec.rb'
     - 'spec/models/role_spec.rb'
-    - 'spec/models/scheduler_spec.rb'
     - 'spec/models/smime_certificate_spec.rb'
     - 'spec/models/store/file_spec.rb'
     - 'spec/models/store/provider/file_spec.rb'
@@ -234,7 +233,6 @@ RSpec/ExampleLength:
     - 'spec/models/recent_view_spec.rb'
     - 'spec/models/role_group_spec.rb'
     - 'spec/models/role_spec.rb'
-    - 'spec/models/scheduler_spec.rb'
     - 'spec/models/sla/has_escalation_calculation_impact_examples.rb'
     - 'spec/models/store/file_spec.rb'
     - 'spec/models/store/provider/file_spec.rb'
@@ -324,7 +322,6 @@ RSpec/InstanceVariable:
   Exclude:
     - 'spec/lib/notification_factory/renderer_spec.rb'
     - 'spec/models/import_job_spec.rb'
-    - 'spec/models/scheduler_spec.rb'
     - 'spec/requests/api_auth_from_spec.rb'
     - 'spec/requests/integration/monitoring_spec.rb'
     - 'spec/requests/integration/sipgate_spec.rb'
@@ -417,7 +414,6 @@ RSpec/MessageSpies:
     - 'spec/models/import_job_spec.rb'
     - 'spec/models/object_manager/attribute/validation/backend_spec.rb'
     - 'spec/models/object_manager/attribute/validation_spec.rb'
-    - 'spec/models/scheduler_spec.rb'
     - 'spec/models/ticket/number_spec.rb'
     - 'spec/models/ticket_spec.rb'
     - 'spec/models/user_spec.rb'
@@ -489,7 +485,6 @@ RSpec/MultipleExpectations:
     - 'spec/models/object_manager/attribute/validation_spec.rb'
     - 'spec/models/object_manager/attribute_spec.rb'
     - 'spec/models/overview_spec.rb'
-    - 'spec/models/scheduler_spec.rb'
     - 'spec/models/session_spec.rb'
     - 'spec/models/sla/has_escalation_calculation_impact_examples.rb'
     - 'spec/models/smime_certificate_spec.rb'

.rubocop/todo.yml

@@ -165,7 +165,6 @@ Metrics/AbcSize:
     - 'app/models/report.rb'
     - 'app/models/role.rb'
     - 'app/models/role/assets.rb'
-    - 'app/models/scheduler.rb'
     - 'app/models/setting.rb'
     - 'app/models/sla/assets.rb'
     - 'app/models/smime_certificate.rb'
@@ -383,7 +382,6 @@ Metrics/BlockLength:
     - 'app/models/organization/search.rb'
     - 'app/models/package.rb'
     - 'app/models/package/migration.rb'
-    - 'app/models/scheduler.rb'
     - 'app/models/ticket.rb'
     - 'app/models/ticket/overviews.rb'
     - 'app/models/ticket/search.rb'
@@ -546,7 +544,6 @@ Metrics/CyclomaticComplexity:
     - 'app/models/recent_view/assets.rb'
     - 'app/models/role.rb'
     - 'app/models/role/assets.rb'
-    - 'app/models/scheduler.rb'
     - 'app/models/setting.rb'
     - 'app/models/sla/assets.rb'
     - 'app/models/store.rb'
@@ -774,7 +771,6 @@ Metrics/PerceivedComplexity:
     - 'app/models/recent_view/assets.rb'
     - 'app/models/role.rb'
     - 'app/models/role/assets.rb'
-    - 'app/models/scheduler.rb'
     - 'app/models/setting.rb'
     - 'app/models/sla/assets.rb'
     - 'app/models/taskbar.rb'
@@ -913,7 +909,6 @@ Style/OptionalBooleanParameter:
     - 'app/models/karma/activity_log.rb'
     - 'app/models/object_manager/attribute.rb'
     - 'app/models/package.rb'
-    - 'app/models/scheduler.rb'
     - 'app/models/setting.rb'
     - 'app/models/store/file.rb'
     - 'app/models/text_module.rb'

Procfile

@@ -1,3 +1,3 @@
 web: bundle exec script/rails server -b ${ZAMMAD_BIND_IP:=127.0.0.1} -p ${ZAMMAD_RAILS_PORT:=3000}
 websocket: bundle exec script/websocket-server.rb -b ${ZAMMAD_BIND_IP:=127.0.0.1} -p ${ZAMMAD_WEBSOCKET_PORT:=6042} start
-worker: bundle exec script/scheduler.rb start -t
+worker: bundle exec script/background-services.rb start

Procfile.dev

@@ -1,4 +1,4 @@
 vite: bin/vite dev
 web: bundle exec script/rails server -b ${ZAMMAD_BIND_IP:=127.0.0.1} -p ${ZAMMAD_RAILS_PORT:=3000}
 websocket: bundle exec script/websocket-server.rb -b ${ZAMMAD_BIND_IP:=127.0.0.1} -p ${ZAMMAD_WEBSOCKET_PORT:=6042} start
-worker: bundle exec script/scheduler.rb start -t
+worker: bundle exec script/background-services.rb start

app/models/import_job.rb

@@ -1,6 +1,7 @@
 # Copyright (C) 2012-2022 Zammad Foundation, https://zammad-foundation.org/
 
 class ImportJob < ApplicationModel
+  extend ::Mixin::StartFinishLogger
 
   store :payload
   store :result
@@ -161,4 +162,31 @@ def self.backends
       true
     end || []
   end
+
+  # Checks for killed import jobs and marks them as finished and adds a note.
+  #
+  # @param [ActiveSupport::TimeWithZone] after the time the cleanup was started
+  #
+  # @example
+  #   Scheduler.cleanup_import_jobs(TimeZone.now)
+  #
+  # return [nil]
+  def self.cleanup_import_jobs(after)
+    log_start_finish(:info, "Cleanup of left over import jobs #{after}") do
+      error = __('Interrupted by scheduler restart. Please restart manually or wait until the next execution time.').freeze
+
+      # we need to exclude jobs that were updated at or since we started
+      # cleaning up (via the #reschedule? call) because they might
+      # were started `.delay`-ed and are flagged for restart
+      ImportJob.running.where('updated_at < ?', after).each do |job|
+
+        job.update!(
+          finished_at: after,
+          result:      {
+            error: error
+          }
+        )
+      end
+    end
+  end
 end