tomo-plugin-solid_queue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b0eeb3e1010b46eee073015145bd0747241d144020259d8a3e83f3be4aa14ab
+  data.tar.gz: 1b91d02b927bccbdabbfeb2db9c229532d9af8f835474251d590de24d1687bc3
+SHA512:
+  metadata.gz: 96606c598123dd2a12842f56cc47c34d51b2588d528cc969ab2b620e9a30d57435e8c88a2d9afe11bf274c8bb85d1b8c806c197af2faea00b869ab2da8916585
+  data.tar.gz: 47c56b96b4a9357c7b31bd8baadddab145903de2bed1d112cb6501635ecd399c71b8d02b6166deeefe26e635b0dc7bed63b6fbc475994b60cfd2ab949203ede0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Matt Brictson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# tomo-plugin-solid_queue
+
+[![Gem Version](https://img.shields.io/gem/v/tomo-plugin-solid_queue)](https://rubygems.org/gems/tomo-plugin-solid_queue)
+[![Gem Downloads](https://img.shields.io/gem/dt/tomo-plugin-solid_queue)](https://www.ruby-toolbox.com/projects/tomo-plugin-solid_queue)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/uxxman/tomo-plugin-solid_queue/ci.yml)](https://github.com/uxxman/tomo-plugin-solid_queue/actions/workflows/ci.yml)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/uxxman/tomo-plugin-solid_queue)](https://codeclimate.com/github/uxxman/tomo-plugin-solid_queue)
+
+This is a [tomo](https://github.com/mattbrictson/tomo) plugin that provides tasks for managing [solid_queue](https://github.com/rails/solid_queue) via [systemd](https://en.wikipedia.org/wiki/Systemd), based on the recommendations in the solid_queue documentation. This plugin assumes that you are also using the tomo `rbenv` and `env` plugins, and that you are using a systemd-based Linux distribution like Ubuntu 18 LTS.
+
+**This plugin requires solid_queue 0.6.0 or newer.**
+
+---
+
+- [Installation](#installation)
+- [Settings](#settings)
+- [Tasks](#tasks)
+- [Recommendations](#recommendations)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Installation
+
+Run:
+
+```
+$ gem install tomo-plugin-solid_queue
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem "tomo-plugin-solid_queue"
+```
+
+Then add the following to `.tomo/config.rb`:
+
+```ruby
+plugin "solid_queue"
+
+setup do
+  # ...
+  run "solid_queue:setup_systemd"
+end
+
+deploy do
+  # ...
+  # Place this task at *after* core:symlink_current
+  run "solid_queue:restart"
+end
+```
+
+### enable-linger
+
+This plugin installs solid_queue as a user-level service using `systemctl --user`. This allows solid_queue to be installed, started, stopped, and restarted without a root user or sudo. However, when provisioning the host you must make sure to run the following command as root to allow the solid_queue process to continue running even after the tomo deploy user disconnects:
+
+```
+# run as root
+$ loginctl enable-linger <DEPLOY_USER>
+```
+
+## Settings
+
+| Name                  | Purpose |
+| --------------------- | ------- |
+| `solid_queue_systemd_service` | Name of the systemd unit that will be used to manage solid_queue <br>**Default:** `"solid_queue_%{application}.service"`   |
+| `solid_queue_systemd_service_path` | Location where the systemd unit will be installed <br>**Default:** `".config/systemd/user/%{solid_queue_systemd_service}"`   |
+| `solid_queue_systemd_service_template_path` | Local path to the ERB template that will be used to create the systemd unit <br>**Default:** [service.erb](https://github.com/uxxman/tomo-plugin-solid_queue/blob/main/lib/tomo/plugin/solid_queue/service.erb)   |
+
+## Tasks
+
+### solid_queue:setup_systemd
+
+Configures systemd to manage solid_queue. This means that solid_queue will automatically be restarted if it crashes, or if the host is rebooted. This task essentially does two things:
+
+1. Installs a `solid_queue.service` systemd unit
+1. Enables it using `systemctl --user enable`
+
+Note that these units will be installed and run for the deploy user. You can use `:solid_queue_systemd_service_template_path` to provide your own template and customize how solid_queue and systemd are configured.
+
+`solid_queue:setup_systemd` is intended for use as a [setup](https://tomo.mattbrictson.com/commands/setup/) task. It must be run before solid_queue can be started during a deploy.
+
+### solid_queue:restart
+
+Gracefully restarts the solid_queue service via systemd, or starts it if it isn't running already. Equivalent to:
+
+```
+systemctl --user restart solid_queue.service
+```
+
+### solid_queue:start
+
+Starts the solid_queue service via systemd, if it isn't running already. Equivalent to:
+
+```
+systemctl --user start solid_queue.service
+```
+
+### solid_queue:stop
+
+Stops the solid_queue service via systemd. Equivalent to:
+
+```
+systemctl --user stop solid_queue.service
+```
+
+### solid_queue:status
+
+Prints the status of the solid_queue systemd service. Equivalent to:
+
+```
+systemctl --user status solid_queue.service
+```
+
+### solid_queue:log
+
+Uses `journalctl` (part of systemd) to view the log output of the solid_queue service. This task is intended for use as a [run](https://tomo.mattbrictson.com/commands/run/) task and accepts command-line arguments. The arguments are passed through to the `journalctl` command. For example:
+
+```
+$ tomo run -- solid_queue:log -f
+```
+
+Will run this remote script:
+
+```
+journalctl -q --user-unit=solid_queue.service -f
+```
+
+## Recommendations
+
+### solid_queue configuration
+
+Add a `config/solid_queue.yml` file to your application (i.e. checked into git) and use that to configure solid_queue, using environment variables as necessary. For examples see https://github.com/rails/solid_queue?tab=readme-ov-file#configuration.
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/uxxman/tomo-plugin-solid_queue/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/tomo/plugin/solid_queue/service.erb

@@ -0,0 +1,22 @@
+[Unit]
+Description=Solid Queue for <%= settings[:application] %>
+After=syslog.target network.target
+ConditionPathExists=<%= paths.current %>
+
+[Service]
+ExecStart=/bin/bash -lc 'exec bundle exec rake solid_queue:start'
+Restart=always
+RestartSec=1
+StandardError=syslog
+StandardOutput=syslog
+SyslogIdentifier=%n
+Type=notify
+WatchdogSec=10
+WorkingDirectory=<%= paths.current %>
+
+# Greatly reduce Ruby memory fragmentation and heap usage
+# https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
+Environment=MALLOC_ARENA_MAX=2
+
+[Install]
+WantedBy=default.target

data/lib/tomo/plugin/solid_queue/tasks.rb

@@ -0,0 +1,48 @@
+module Tomo::Plugin::SolidQueue
+  class Tasks < Tomo::TaskLibrary
+    SystemdUnit = Struct.new(:name, :template, :path)
+
+    def setup_systemd
+      linger_must_be_enabled!
+
+      remote.mkdir_p service.path.dirname
+      remote.write template: service.template, to: service.path
+
+      remote.run "systemctl --user daemon-reload"
+      remote.run "systemctl", "--user", "enable", service.name
+    end
+
+    %i[reload restart start stop status].each do |action|
+      define_method(action) do
+        remote.run "systemctl", "--user", action, service.name
+      end
+    end
+
+    def log
+      remote.attach "journalctl", "-q", raw("--user-unit=#{service.name.shellescape}"), *settings[:run_args]
+    end
+
+    private
+
+    def service
+      SystemdUnit.new(
+        settings[:solid_queue_systemd_service],
+        paths.solid_queue_systemd_service_template,
+        paths.solid_queue_systemd_service
+      )
+    end
+
+    def linger_must_be_enabled!
+      linger_users = remote.list_files("/var/lib/systemd/linger", raise_on_error: false)
+      return if dry_run? || linger_users.include?(remote.host.user)
+
+      die <<~ERROR.strip
+        Linger must be enabled for the #{remote.host.user} user in order for
+        solid_queue to stay running in the background via systemd. Run the following
+        command as root:
+
+          loginctl enable-linger #{remote.host.user}
+      ERROR
+    end
+  end
+end

data/lib/tomo/plugin/solid_queue/version.rb

@@ -0,0 +1,8 @@
+module Tomo
+  module Plugin
+  end
+end
+
+module Tomo::Plugin::SolidQueue
+  VERSION = "0.0.1".freeze
+end

data/lib/tomo/plugin/solid_queue.rb

@@ -0,0 +1,12 @@
+require "tomo"
+require_relative "solid_queue/tasks"
+require_relative "solid_queue/version"
+
+module Tomo::Plugin::SolidQueue
+  extend Tomo::PluginDSL
+
+  tasks Tomo::Plugin::SolidQueue::Tasks
+  defaults solid_queue_systemd_service: "solid_queue_%{application}.service",
+           solid_queue_systemd_service_path: ".config/systemd/user/%{solid_queue_systemd_service}",
+           solid_queue_systemd_service_template_path: File.expand_path("solid_queue/service.erb", __dir__)
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: tomo-plugin-solid_queue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Muhammad Usman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- uxman.sherwani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tomo/plugin/solid_queue.rb
+- lib/tomo/plugin/solid_queue/service.erb
+- lib/tomo/plugin/solid_queue/tasks.rb
+- lib/tomo/plugin/solid_queue/version.rb
+homepage: https://github.com/uxxman/tomo-plugin-solid_queue
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/uxxman/tomo-plugin-solid_queue/issues
+  changelog_uri: https://github.com/uxxman/tomo-plugin-solid_queue/releases
+  source_code_uri: https://github.com/uxxman/tomo-plugin-solid_queue
+  homepage_uri: https://github.com/uxxman/tomo-plugin-solid_queue
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Solid Queue deployment tasks for tomo
+test_files: []