capistrano3-puma 5.0.0.beta1 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e8a658109b9d4bae5177d3fe539a2354c343904916a779cc2e9a16ad337cf2
-  data.tar.gz: f70546d3675eeb4fc0998574f07c75355f25e236c2f53d45a187ae75babac5c5
+  metadata.gz: 4528e38ecbf164322621f3b7d410bc02afc0a768bb34d0aabfceb5ff580c0e3b
+  data.tar.gz: ef77825a1e3616b3d38d2e32d3d157ee586b190725b7f124eb06ee23e56878c3
 SHA512:
-  metadata.gz: d16d5ac8433ab8aa783efaffa734b0b8843034f349727cec57c5d9f47e247d7ef38afdcddb4f8bc08ef465c69153fc51aa94969b3c8fb85ffe40373a93665182
-  data.tar.gz: e8be34856e21d6ed840f9fe9d72428a11668b239f60aeb1b4ae1eff66661cb793fe284884f97a41d76dee43b0573fb55bf3acce45ea79de810f3032f1057bb12
+  metadata.gz: 7b4a5bfe7b2bc2069ed44fcf9e182ae8e3e2507e1e22725216c891248a20d357e561b03a4aced23911dc3b1f5fdcca3838312efd2838a181ce69534749ed9e54
+  data.tar.gz: 711219b1bbeb37c64f48251b76adf1a472715e0f5aa38fae18e2e6252083735b7cc7fb7a58a35a00f583d4daee347be10be8fc81c2c26e39e91c2826b0117729

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 ## Changelog
+- 5.0.4:
+  - fix: puma_systemctl_user default value (#319)
+- 5.0.3:
+  - Remove ExecStop from systemd unit file (#314)
+  - Systemd user service manager and lingering (#307)
+- 5.0.2:  
+  - Single name for systemd config template
+- 5.0.1:
+  - Fix #301, Task "puma:smart_restart" not found
 - 5.0.0:
   - Support puma 5.0
   - Support SystemD service manager

data/README.md

@@ -116,6 +116,18 @@ To generate unit file use:
 cap production puma:systemd:config puma:systemd:enable
 ```
 
+To use customize environment variables
+
+```ruby
+  set :puma_service_unit_env_file, '/etc/environment'
+```
+```ruby
+  set :puma_service_unit_env_vars, %w[
+      RAILSE_NV=development
+      PUMA_METRICS_HTTP=tcp://0.0.0.0:9393
+  ]
+```
+
 ### Multi bind
 
 Multi-bind can be set with an array in the puma_bind variable
@@ -158,6 +170,12 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :puma_plugins, []  #accept array of plugins
     set :puma_tag, fetch(:application)
     set :puma_restart_command, 'bundle exec puma'
+    set :puma_service_unit_name, "puma_#{fetch(:application)}_#{fetch(:stage)}"
+    set :puma_systemctl_user, :system # accepts :user
+    set :puma_enable_lingering, fetch(:puma_systemctl_user) != :system # https://wiki.archlinux.org/index.php/systemd/User#Automatic_start-up_of_systemd_user_instances
+    set :puma_lingering_user, fetch(:user)
+    set :puma_service_unit_env_file, nil
+    set :puma_service_unit_env_vars, []
 
     set :nginx_config_name, "#{fetch(:application)}_#{fetch(:stage)}"
     set :nginx_flags, 'fail_timeout=0'

data/lib/capistrano/puma/systemd.rb

@@ -11,9 +11,11 @@ module Capistrano
     end
 
     def set_defaults
-      set_if_empty :puma_systemd_conf_dir, '/etc/systemd/system'
       set_if_empty :puma_systemctl_bin, '/bin/systemctl'
-      set_if_empty :puma_service_unit_name, 'puma'
+      set_if_empty :puma_service_unit_name, -> { "puma_#{fetch(:application)}_#{fetch(:stage)}" }
+      set_if_empty :puma_systemctl_user, :system
+      set_if_empty :puma_enable_lingering, -> { fetch(:puma_systemctl_user) != :system }
+      set_if_empty :puma_lingering_user, -> { fetch(:user) }
     end
   end
 end

data/lib/capistrano/puma/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  PUMAVERSION = '5.0.0.beta1'
+  PUMAVERSION = '5.0.4'
 end

data/lib/capistrano/tasks/daemon.rake

@@ -63,4 +63,12 @@ namespace :puma do
       end
     end
   end
+
+  task :smart_restart do
+    if !fetch(:puma_preload_app) && fetch(:puma_workers, 0).to_i > 1
+      invoke 'puma:phased-restart'
+    else
+      invoke 'puma:restart'
+    end
+  end
 end

data/lib/capistrano/tasks/systemd.rake

@@ -8,52 +8,95 @@ namespace :puma do
     task :config do
       on roles(fetch(:puma_role)) do |role|
         unit_filename = "#{fetch(:puma_service_unit_name)}.service"
-        git_plugin.template_puma unit_filename, "#{fetch(:tmp_dir)}/#{unit_filename}", role
-        sudo "mv #{fetch(:tmp_dir)}/#{unit_filename} #{fetch(:puma_systemd_conf_dir)}"
-        sudo "#{fetch(:puma_systemctl_bin)} daemon-reload"
+        git_plugin.template_puma "puma.service", "#{fetch(:tmp_dir)}/#{unit_filename}", role
+        systemd_path = fetch(:puma_systemd_conf_dir, git_plugin.fetch_systemd_unit_path)
+        if fetch(:puma_systemctl_user) == :system
+          sudo "mv #{fetch(:tmp_dir)}/#{unit_filename} #{systemd_path}"
+          sudo "#{fetch(:puma_systemctl_bin)} daemon-reload"
+        else
+          execute :mkdir, "-p", systemd_path
+          execute :mv, "#{fetch(:tmp_dir)}/#{unit_filename}", "#{systemd_path}"
+          execute fetch(:puma_systemctl_bin), "--user", "daemon-reload"
+        end
       end
     end
 
     desc 'Enable Puma systemd service'
     task :enable do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_systemctl_bin)} enable #{fetch(:puma_service_unit_name)}"
+        if fetch(:puma_systemctl_user) == :system
+          sudo "#{fetch(:puma_systemctl_bin)} enable #{fetch(:puma_service_unit_name)}"
+        else
+          execute "#{fetch(:puma_systemctl_bin)}", "--user", "enable", fetch(:puma_service_unit_name)
+          execute :loginctl, "enable-linger", fetch(:puma_lingering_user) if fetch(:puma_enable_lingering)
+        end
       end
     end
 
     desc 'Disable Puma systemd service'
     task :disable do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_systemctl_bin)} disable #{fetch(:puma_service_unit_name)}"
+        if fetch(:puma_systemctl_user) == :system
+          sudo "#{fetch(:puma_systemctl_bin)} disable #{fetch(:puma_service_unit_name)}"
+        else
+          execute "#{fetch(:puma_systemctl_bin)}", "--user", "disable", fetch(:puma_service_unit_name)
+        end
       end
     end
+
   end
 
   desc 'Start Puma service via systemd'
   task :start do
     on roles(fetch(:puma_role)) do
-      sudo "#{fetch(:puma_systemctl_bin)} start #{fetch(:puma_service_unit_name)}"
+      if fetch(:puma_systemctl_user) == :system
+        sudo "#{fetch(:puma_systemctl_bin)} start #{fetch(:puma_service_unit_name)}"
+      else
+        execute "#{fetch(:puma_systemctl_bin)}", "--user", "start", fetch(:puma_service_unit_name)
+      end
     end
   end
 
   desc 'Stop Puma service via systemd'
   task :stop do
     on roles(fetch(:puma_role)) do
-      sudo "#{fetch(:puma_systemctl_bin)} stop #{fetch(:puma_service_unit_name)}"
+      if fetch(:puma_systemctl_user) == :system
+        sudo "#{fetch(:puma_systemctl_bin)} stop #{fetch(:puma_service_unit_name)}"
+      else
+        execute "#{fetch(:puma_systemctl_bin)}", "--user", "stop", fetch(:puma_service_unit_name)
+      end
     end
   end
 
   desc 'Restart Puma service via systemd'
   task :restart do
     on roles(fetch(:puma_role)) do
-      sudo "#{fetch(:puma_systemctl_bin)} restart #{fetch(:puma_service_unit_name)}"
+      if fetch(:puma_systemctl_user) == :system
+        sudo "#{fetch(:puma_systemctl_bin)} restart #{fetch(:puma_service_unit_name)}"
+      else
+        execute "#{fetch(:puma_systemctl_bin)}", "--user", "restart", fetch(:puma_service_unit_name)
+      end
     end
   end
 
   desc 'Get Puma service status via systemd'
   task :status do
     on roles(fetch(:puma_role)) do
-      sudo "#{fetch(:puma_systemctl_bin)} status #{fetch(:puma_service_unit_name)}"
+      if fetch(:puma_systemctl_user) == :system
+        sudo "#{fetch(:puma_systemctl_bin)} status #{fetch(:puma_service_unit_name)}"
+      else
+        execute "#{fetch(:puma_systemctl_bin)}", "--user", "status", fetch(:puma_service_unit_name)
+      end
     end
   end
+
+  def fetch_systemd_unit_path
+    if fetch(:puma_systemctl_user) == :system
+      "/etc/systemd/system/"
+    else
+      home_dir = backend.capture :pwd
+      File.join(home_dir, ".config", "systemd", "user")
+    end
+  end
+
 end

data/lib/capistrano/templates/nginx_conf.erb

@@ -51,6 +51,7 @@ server {
   location @puma_<%= fetch(:nginx_config_name) %> {
     proxy_http_version 1.1;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
     proxy_set_header Host $host;
     proxy_redirect off;
     proxy_set_header Upgrade $http_upgrade;

data/lib/capistrano/templates/puma.service.erb

@@ -4,15 +4,22 @@ After=network.target
 
 [Service]
 Type=simple
-User=<%= puma_user(@role) %>
+<%="User=#{puma_user(@role)}" if fetch(:puma_systemctl_user) == :system %>
 WorkingDirectory=<%= current_path %>
 ExecStart=<%= SSHKit.config.command_map[:bundle] %> exec puma -C <%= fetch(:puma_conf) %>
 ExecReload=/bin/kill -TSTP $MAINPID
-ExecStop=/bin/kill -TERM $MAINPID
 StandardOutput=append:<%= fetch(:puma_access_log) %>
 StandardError=append:<%= fetch(:puma_error_log) %>
+<%="EnvironmentFile=#{fetch(:puma_service_unit_env_file)}" if fetch(:puma_service_unit_env_file) %>
+
+<% fetch(:puma_service_unit_env_vars, []).each do |environment_variable| %>
+<%="Environment=#{environment_variable}" %>
+<% end %>
 
 Restart=always
+RestartSec=1
+
+SyslogIdentifier=puma
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=<%=(fetch(:puma_systemctl_user) == :system) ? "multi-user.target" : "default.target"%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-puma
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta1
+  version: 5.0.4
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -114,9 +114,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: