sidekiq-tasks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2e154e5c7dce24a8e35fe82c1bf604aecdceb88bcdc09949bee07b250666044
+  data.tar.gz: 79f0abe2f5d49378ab319b8c4889e35603773616a3c83e4acc12c16a3ad5bf5d
+SHA512:
+  metadata.gz: 46a46f7d5fe0aad48100eb29756bdf9161a6516716a2f0c2e9bfc9ee5d9ffb054ff9cd7c4d19c88032f30fcef2b4eb2253f231ebc752769b54ccd5d9b212e873
+  data.tar.gz: 3381e43c02d4b3c7766ce818fa5b3a8a0272e1a605c2f404fc7ac758b09a420833c4fe90fa83047e9acfdf07568d0609d4168dfc9ffec1b28c5a9705a355ac9f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,59 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: disable
+  SuggestExtensions: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/sidekiq/tasks/web/extension.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - sidekiq-tasks.gemspec
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/sidekiq/tasks/web/extension.rb
+
+Metrics/ParameterLists:
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Exclude:
+    - lib/sidekiq/sidekiq-tasks.rb
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GlobalVars:
+  Exclude:
+    - spec/**/*
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.simplecov

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "simplecov_json_formatter"
+require "sidekiq/tasks"
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter,
+  ]
+)
+
+SimpleCov.start do
+  add_filter "spec/"
+  add_group "Sidekiq-Tasks", "lib/"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Changelog
+
+### [0.1.0] - 2025-02-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Victor
+
+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,178 @@
+# Sidekiq::Tasks
+
+[![CI Status](https://github.com/victorauthiat/sidekiq-tasks/actions/workflows/ci.yml/badge.svg)](https://github.com/victorauthiat/sidekiq-tasks/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/079e91362a810b4ef80d/maintainability)](https://codeclimate.com/github/VictorAuthiat/sidekiq-tasks/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/079e91362a810b4ef80d/test_coverage)](https://codeclimate.com/github/VictorAuthiat/sidekiq-tasks/test_coverage)
+
+> A [Sidekiq](https://github.com/sidekiq/sidekiq) extension for task management.
+
+Sidekiq-Tasks extends Sidekiq by providing an interface to enqueue tasks directly from the web interface. By default it works with Rake tasks but it can be easily extended to support other task execution systems.
+
+![Task view](docs/task.png)
+
+## Installation
+
+```bash
+bundle add sidekiq-tasks
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install sidekiq-tasks
+```
+
+Add the following to your `config/routes.rb` file:
+
+```ruby
+require "sidekiq/web"
+require "sidekiq/tasks/web"
+```
+
+Now you can access the web interface at `/sidekiq/tasks` and you'll see a list of all the available tasks.
+Once you've found your task, you can access the task details page to see the metadata, history and form to enqueue the task.
+
+## Prerequisites
+
+Sidekiq Tasks is based on the concept of **strategies** and **rules** to manage **tasks**.
+
+- A **task** represents a unit of work that can be enqueued and executed.
+- A **strategy** defines how tasks are loaded, built, enqueued, and executed.
+- A **rule** is a condition given to a strategy to determine which tasks are available.
+
+By default, it comes with the `Sidekiq::Tasks::Strategies::RakeTask` strategy, which allows you to enqueue and execute Rake tasks with their arguments.
+
+> [!NOTE]
+> In accordance with the principle of least privilege, it has the following rules:
+> - **`TaskFromLib`** Only tasks from the `lib` folder are loaded.
+> - **`EnableWithComment`** Only tasks explicitly enabled with a magic comment are loaded.
+
+Example of an available task in `lib/tasks/my_task.rake`:
+
+```ruby
+# sidekiq-tasks:enable
+task :my_task do
+  puts "my_task"
+end
+```
+
+## Strategies configuration
+
+Strategies can be configured through the `config.strategies` option.
+For example if you want to remove the `EnableWithComment` rule from the default strategy and enable all tasks from the `lib` folder:
+
+```ruby
+Sidekiq::Tasks.configure do |config|
+  config.strategies = [
+    Sidekiq::Tasks::Strategies::RakeTask.new(
+      rules: [
+        Sidekiq::Tasks::Strategies::Rules::TaskFromLib.new,
+      ]
+    )
+  ]
+end
+```
+
+You can also define your own strategy creating a subclass of `Sidekiq::Tasks::Strategies::Base`.
+
+Each strategy must implement the following methods:
+
+  - `load_tasks`: Returns all the raw tasks that should be filtered.
+  - `build_task_metadata`: Build metadata for a task.
+  - `execute_task`: Execute a task.
+
+A strategy has a `tasks` method that filters the loaded tasks according to the rules and builds `Sidekiq::Tasks::Task` instances with `build_task_metadata` for each raw task.
+
+**Example:**
+
+Here is an example of a strategy that loads tasks from a YAML configuration file, builds metadata and executes them as system commands:
+
+```ruby
+class ScriptStrategy < Sidekiq::Tasks::Strategies::Base
+  def load_tasks
+    YAML.load_file("config/scripts.yml")
+  end
+
+  def build_task_metadata(task)
+    Sidekiq::Tasks::TaskMetadata.new(
+      name: task["name"],
+      desc: task["desc"],
+      args: task["args"],
+      file: task["file"]
+    )
+  end
+
+  def execute_task(name, args = {})
+    system "ruby #{name} #{args.values.join(" ")}"
+  end
+end
+
+Sidekiq::Tasks.configure do |config|
+  config.strategies = [ScriptStrategy.new]
+end
+```
+
+> [!CAUTION]
+> This is an example, executing tasks via system exposes your application to command injection risks.
+> Never execute user input directly without strict validation.
+
+## Strategy rules
+
+Strategies can use rules to determine which tasks should be loaded.
+Rules must inherit from `Sidekiq::Tasks::Strategies::Rules::Base` and implement the `respected?` method.
+Here is an example of a rule that filters only scripts that match 'foo' in their filename:
+
+```ruby
+class FileMatchesFoo < Sidekiq::Tasks::Strategies::Rules::Base
+  def respected?(task)
+    task["file"].match?(/foo/)
+  end
+end
+
+Sidekiq::Tasks.configure do |config|
+  config.strategies = [ScriptStrategy.new(rules: [FileMatchesFoo.new])]
+end
+```
+
+## Strategy enqueuing
+
+By default, strategies enqueue tasks using the `Sidekiq::Tasks::Job` class.
+You can configure `sidekiq_options` as follows:
+
+```ruby
+Sidekiq::Tasks.configure do |config|
+  # Default options are {queue: "default", retry: false}
+  config.sidekiq_options = {queue: "low", retry: false}
+end
+```
+
+You can also override the `enqueue_task` method to implement your own enqueuing logic for your strategy:
+
+```ruby
+class ScriptStrategy < Sidekiq::Tasks::Strategies::Base
+  def enqueue_task(name, params = {})
+    ScriptJob.perform_async(name, params)
+  end
+end
+```
+
+> [!WARNING]
+> Ensure that `enqueue_task` returns the JID of the Sidekiq job that will execute the task.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/victorauthiat/sidekiq-tasks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/victorauthiat/sidekiq-tasks/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Tasks project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/victorauthiat/sidekiq-tasks/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/sidekiq/sidekiq-tasks.rb

@@ -0,0 +1 @@
+require "sidekiq/tasks"

data/lib/sidekiq/tasks/config.rb

@@ -0,0 +1,47 @@
+module Sidekiq
+  module Tasks
+    class Config
+      DEFAULT_SIDEKIQ_OPTIONS = {
+        queue: "default",
+        retry: false,
+      }.freeze
+
+      DEFAULT_STRATEGIES = [
+        Sidekiq::Tasks::Strategies::RakeTask.new(
+          rules: [
+            Sidekiq::Tasks::Strategies::Rules::TaskFromLib.new,
+            Sidekiq::Tasks::Strategies::Rules::EnableWithComment.new,
+          ]
+        ),
+      ].freeze
+
+      include Sidekiq::Tasks::Validations
+
+      attr_reader :strategies, :sidekiq_options
+
+      def initialize
+        @sidekiq_options = DEFAULT_SIDEKIQ_OPTIONS
+        @strategies = DEFAULT_STRATEGIES
+      end
+
+      # @see https://github.com/sidekiq/sidekiq/wiki/Advanced-Options#jobs
+      def sidekiq_options=(options)
+        validate_class!(options, [Hash], "sidekiq_options")
+        validate_hash_option!(options, :queue, [String])
+        validate_hash_option!(options, :retry, [TrueClass, FalseClass])
+        validate_hash_option!(options, :dead, [NilClass, TrueClass, FalseClass])
+        validate_hash_option!(options, :backtrace, [NilClass, TrueClass, FalseClass, Integer])
+        validate_hash_option!(options, :pool, [NilClass, String])
+        validate_hash_option!(options, :tags, [NilClass, Array])
+
+        @sidekiq_options = options
+      end
+
+      def strategies=(strategies)
+        validate_array_classes!(strategies, [Sidekiq::Tasks::Strategies::Base], "strategies")
+
+        @strategies = strategies
+      end
+    end
+  end
+end

data/lib/sidekiq/tasks/errors.rb

@@ -0,0 +1,12 @@
+module Sidekiq
+  module Tasks
+    class NotFoundError < StandardError
+    end
+
+    class ArgumentError < StandardError
+    end
+
+    class NotImplementedError < StandardError
+    end
+  end
+end

data/lib/sidekiq/tasks/job.rb

@@ -0,0 +1,19 @@
+require "sidekiq"
+
+module Sidekiq
+  module Tasks
+    class Job
+      include Sidekiq::Job
+
+      sidekiq_options Sidekiq::Tasks.config.sidekiq_options
+
+      # @param name [String] The name of the task to execute.
+      # @param args [Hash] The arguments to pass to the task.
+      # @raise [Sidekiq::Tasks::TaskNotFoundError] If the task is not found.
+      def perform(name, args)
+        symbolized_args = JSON.parse(args, symbolize_names: true)
+        Sidekiq::Tasks.tasks.find_by!(name: name).execute(symbolized_args, jid: jid)
+      end
+    end
+  end
+end

data/lib/sidekiq/tasks/set.rb

@@ -0,0 +1,57 @@
+module Sidekiq
+  module Tasks
+    class Set
+      include Enumerable
+
+      def self.match?(object, attributes)
+        attributes.any? do |attribute, value|
+          [nil, ""].include?(value) || object.public_send(attribute)&.match?(value)
+        end
+      end
+
+      attr_reader :objects
+
+      def initialize(objects)
+        @objects = objects
+      end
+
+      def each(&block)
+        objects.each(&block)
+      end
+
+      def where(attributes = {})
+        reflect(objects.select { |object| self.class.match?(object, attributes) })
+      end
+
+      def find_by(name: nil)
+        where(name: name).first
+      end
+
+      def find_by!(name: nil)
+        find_by(name: name) || raise(NotFoundError, "'#{name}' not found")
+      end
+
+      def size
+        objects.size
+      end
+
+      def first
+        objects[0]
+      end
+
+      def last
+        objects[-1]
+      end
+
+      def empty?
+        objects.empty?
+      end
+
+      private
+
+      def reflect(objects)
+        self.class.new(objects)
+      end
+    end
+  end
+end

data/lib/sidekiq/tasks/storage.rb

@@ -0,0 +1,85 @@
+module Sidekiq
+  module Tasks
+    class Storage
+      JID_PREFIX = "task".freeze
+      HISTORY_LIMIT = 10
+
+      attr_reader :task_name
+
+      def initialize(task_name)
+        @task_name = task_name
+      end
+
+      def jid_key
+        "#{JID_PREFIX}:#{task_name}"
+      end
+
+      def history_key
+        "#{jid_key}:history"
+      end
+
+      def last_enqueue_at
+        stored_time("last_enqueue_at")
+      end
+
+      def last_execution_at
+        stored_time("last_execution_at")
+      end
+
+      def history
+        redis_history = Sidekiq.redis { |conn| conn.lrange(history_key, 0, -1) }&.map do |raw|
+          entry = Sidekiq.load_json(raw)
+          entry["enqueued_at"] = Time.at(entry["enqueued_at"]) if entry["enqueued_at"]
+          entry["executed_at"] = Time.at(entry["executed_at"]) if entry["executed_at"]
+          entry
+        end
+
+        redis_history || []
+      end
+
+      def store_history(jid, task_args, time)
+        Sidekiq.redis do |conn|
+          task_trace = {jid: jid, name: task_name, args: task_args, enqueued_at: time.to_i}
+          conn.lpush(history_key, Sidekiq.dump_json(task_trace))
+          conn.ltrim(history_key, 0, HISTORY_LIMIT - 1)
+        end
+      end
+
+      def store_enqueue(jid, args)
+        time = Time.now
+        store_time(time, "last_enqueue_at")
+        store_history(jid, args, time)
+      end
+
+      def store_execution(jid)
+        time = Time.now
+        store_time(time, "last_execution_at")
+        store_execution_time_in_history(jid, time)
+      end
+
+      private
+
+      def store_time(time, time_key)
+        Sidekiq.redis { |conn| conn.hset(jid_key, time_key, time.to_i) }
+      end
+
+      def stored_time(time_key)
+        timestamp = Sidekiq.redis { |conn| conn.hget(jid_key, time_key) }
+
+        [nil, ""].include?(timestamp) ? nil : Time.at(timestamp.to_i)
+      end
+
+      def store_execution_time_in_history(jid, time)
+        Sidekiq.redis do |conn|
+          conn.lrange(history_key, 0, -1).each_with_index do |raw, index|
+            entry = Sidekiq.load_json(raw)
+            next unless entry["jid"] == jid
+
+            conn.lset(history_key, index, Sidekiq.dump_json(entry.merge("executed_at" => time.to_i)))
+            break
+          end
+        end
+      end
+    end
+  end
+end