Maintenance: Update to puma 6.

This will update from puma 4 to 6, which no longer provides daemonization.
It also removes the deprecated `script/scheduler.rb` wrapper, please use `script/background-worker.rb` instead.

.gitlab/ci/lint.yml

@@ -26,7 +26,6 @@
   before_script: []
   script:
     - shellcheck -S warning $(find . -name "*.sh" -o -name "functions" | egrep -v "/vendor|node_modules/")
-    - shellcheck -S error script/init.d/*
   after_script: []
 
 'lint: i18n & rails':

.rubocop/todo.yml

@@ -415,7 +415,6 @@ Metrics/BlockLength:
     - 'lib/sessions/backend/ticket_overview_list.rb'
     - 'lib/sessions/client.rb'
     - 'lib/tasks/zammad/search_index_es.rake'
-    - 'lib/tasks/zammad/ci/service/puma/start.rake'
     - 'lib/transaction_dispatcher.rb'
     - 'lib/twitter_sync.rb'
     - 'script/websocket-server.rb'

Gemfile

@@ -20,7 +20,7 @@ gem 'composite_primary_keys'
 gem 'json'
 
 # core - application servers
-gem 'puma', '~> 4', group: :puma
+gem 'puma', group: :puma
 gem 'unicorn', group: :unicorn
 
 # core - supported ORMs

Gemfile.lock

@@ -314,7 +314,7 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
+    nio4r (2.5.9)
     nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
@@ -395,7 +395,7 @@ GEM
       binding_of_caller (~> 1.0)
       pry (~> 0.13)
     public_suffix (5.0.1)
-    puma (4.3.12)
+    puma (6.2.2)
       nio4r (~> 2.0)
     pundit (2.3.0)
       activesupport (>= 3.0.0)
@@ -704,7 +704,7 @@ DEPENDENCIES
   pry-remote
   pry-rescue
   pry-stack_explorer
-  puma (~> 4)
+  puma
   pundit
   pundit-matchers
   rack-attack

doc/developer_manual/development_environment/getting-started.md

@@ -128,8 +128,8 @@ Of course, you can always just start and stop all the processes by hand:
 ```sh
 # in three separate terminal windows
 $ rails server
-$ script/scheduler.rb start         # runs in bg; use -t for fg
-$ script/websocket-server.rb start  # runs in fg; use -d for bg
+$ script/background-worker.rb start
+$ script/websocket-server.rb start
 ```
 
 ## Login

lib/tasks/zammad/ci/app/start.rake

@@ -13,7 +13,7 @@ namespace :zammad do
 
         Rake::Task['zammad:ci:service:puma:start'].invoke(ENV['BROWSER_PORT'], ENV['RAILS_ENV'])
         Rake::Task['zammad:ci:service:websocket:start'].invoke(ENV['WS_PORT'])
-        Rake::Task['zammad:ci:service:scheduler:start'].invoke
+        Rake::Task['zammad:ci:service:background_worker:start'].invoke
       end
     end
   end

lib/tasks/zammad/ci/app/stop.rake

@@ -8,7 +8,7 @@ namespace :zammad do
 
       desc 'Stops the application'
       task stop: %i[
-        zammad:ci:service:scheduler:stop
+        zammad:ci:service:background_worker:stop
         zammad:ci:service:websocket:stop
         zammad:ci:service:puma:stop
       ]

lib/tasks/zammad/ci/service/scheduler/start.rake → lib/tasks/zammad/ci/service/background_worker/start.rake

@@ -6,16 +6,17 @@ namespace :zammad do
 
     namespace :service do
 
-      namespace :scheduler do
+      namespace :background_worker do
 
         desc 'Starts the scheduler'
         task :start do # rubocop:disable Rails/RakeEnvironment
 
           command = [
-            'bundle',
-            'exec',
-            'script/scheduler.rb',
+            'script/ci/daemonize.rb',
             'start',
+            '--',
+            'background-worker',
+            'bundle exec script/background-worker.rb start',
           ]
 
           _stdout, stderr, status = Open3.capture3(*command)

lib/tasks/zammad/ci/service/scheduler/stop.rake → lib/tasks/zammad/ci/service/background_worker/stop.rake

@@ -6,16 +6,17 @@ namespace :zammad do
 
     namespace :service do
 
-      namespace :scheduler do
+      namespace :background_worker do
 
         desc 'Stops the scheduler'
         task :stop do # rubocop:disable Rails/RakeEnvironment
 
           command = [
-            'bundle',
-            'exec',
-            'script/scheduler.rb',
-            'stop',
+            'script/ci/daemonize.rb',
+            'start',
+            '--',
+            'background-worker',
+            'bundle exec script/background-worker.rb stop',
           ]
 
           _stdout, stderr, status = Open3.capture3(*command)

lib/tasks/zammad/ci/service/puma/start.rake

@@ -14,23 +14,18 @@ namespace :zammad do
           env      = args.fetch(:env, 'production')
 
           command = [
-            'bundle',
-            'exec',
+            'script/ci/daemonize.rb',
+            'start',
+            '--',
             'puma',
-            '--pidfile',
-            'tmp/pids/server.pid',
-            '-d',
-            '-p',
-            port,
-            '-e',
-            env
+            "bundle exec puma -p #{port} -e#{env}",
           ]
 
-          _stdout, stderr, status = Open3.capture3(*command)
+          stdout, stderr, status = Open3.capture3(*command)
 
-          next if status.success?
+          next if status.success? && !stdout.include?('ERROR') # rubocop:disable Rails/NegateInclude
 
-          abort("Error while starting Puma - error status #{status.exitstatus}: #{stderr}")
+          abort("Error while starting Puma - error status #{status.exitstatus}: #{stdout} #{stderr}")
         end
       end
     end

lib/tasks/zammad/ci/service/puma/stop.rake

@@ -10,16 +10,20 @@ namespace :zammad do
 
         desc 'Stops the puma application webserver'
         task :stop do # rubocop:disable Rails/RakeEnvironment
-          file = Rails.root.join('tmp/pids/server.pid')
-          pid  = File.read(file).to_i
 
-          Process.kill('SIGTERM', pid)
+          command = [
+            'script/ci/daemonize.rb',
+            'stop',
+            '--',
+            'puma',
+            'bundle exec puma',
+          ]
 
-          sleep 5
+          stdout, stderr, status = Open3.capture3(*command)
 
-          next if !File.exist?(file)
+          next if status.success? && !stdout.include?('ERROR') # rubocop:disable Rails/NegateInclude
 
-          Process.kill('SIGKILL', pid)
+          abort("Error while stopping Puma - error status #{status.exitstatus}: #{stdout} #{stderr}")
         end
       end
     end

script/ci/daemonize.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2012-2023 Zammad Foundation, https://zammad-foundation.org/
+
+require 'daemons'
+
+#
+# Generic daemonization script for legacy CI tests.
+#
+
+def exit_with_usage
+  puts 'Usage: daemonize.rb start|stop -- $name_of_pidfile $commandline'
+  exit false
+end
+
+dir = File.expand_path(File.join(__dir__, '../..'))
+
+daemon_options = {
+  multiple:  false,
+  dir_mode:  :normal,
+  dir:       File.join(dir, 'tmp', 'pids'),
+  backtrace: true
+}
+
+separator_index = ARGV.index('--')
+exit_with_usage if separator_index.nil?
+args = ARGV[(separator_index + 1)..]
+exit_with_usage if args.count < 2
+
+Daemons.run_proc(args[0], daemon_options) do
+  Dir.chdir dir
+  exec(args[1])
+end

script/init.d/README.md

@@ -0,0 +1,8 @@
+This directory used to contain an example init.d script for Zammad installations
+without Systemd. This was discontinued since Zammad now uses non-daemonizing service processes.
+
+If using Systemd is not an option for you, consider using the provided binary packages to install
+even on systems that don't have Systemd.
+
+Pull requests with a new init script that handles foreground
+processes correctly would be welcome as well.