job-workflow 0.1.3

data/lib/job_workflow/workflow.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module JobWorkflow
+  class Workflow
+    attr_reader :namespace #: Namespace
+    attr_reader :dry_run_config #: DryRunConfig
+
+    #:  () -> void
+    def initialize
+      @task_graph = TaskGraph.new
+      @argument_defs = {} #: Hash[Symbol, ArgumentDef]
+      @hook_registry = HookRegistry.new
+      @namespace = Namespace.default #: Namespace
+      @schedules = {} #: Hash[Symbol, Schedule]
+      @dry_run_config = DryRunConfig.new
+    end
+
+    #:  (bool | ^(Context) -> bool) -> void
+    def dry_run_config=(value)
+      @dry_run_config = DryRunConfig.from_primitive_value(value)
+    end
+
+    #:  (Namespace) { () -> void } -> void
+    def add_namespace(namespace)
+      original_namespace = @namespace
+      @namespace = namespace.update_parent(original_namespace)
+      yield
+    ensure
+      @namespace = original_namespace
+    end
+
+    #:  (Task) -> void
+    def add_task(task)
+      @task_graph.add(task)
+    end
+
+    #:  (ArgumentDef) -> void
+    def add_argument(argument_def)
+      @argument_defs[argument_def.name] = argument_def
+    end
+
+    #:  (Schedule) -> void
+    def add_schedule(schedule)
+      @schedules[schedule.key] = schedule
+    end
+
+    #:  (Symbol, task_names: Array[Symbol], block: untyped) -> void
+    def add_hook(type, task_names:, block:)
+      return @hook_registry.add_before_hook(task_names:, block:) if type == :before
+      return @hook_registry.add_after_hook(task_names:, block:) if type == :after
+      return @hook_registry.add_around_hook(task_names:, block:) if type == :around
+      return @hook_registry.add_error_hook(task_names:, block:) if type == :error
+
+      raise ArgumentError, "Invalid hook type: #{type.inspect}"
+    end
+
+    #:  () -> HookRegistry
+    def hooks
+      @hook_registry
+    end
+
+    #:  () -> Array[Task]
+    def tasks
+      @task_graph.to_a
+    end
+
+    #:  (Symbol?) -> Task?
+    def fetch_task(task_name)
+      @task_graph.fetch(task_name)
+    end
+
+    #:  () -> Array[ArgumentDef]
+    def arguments
+      @argument_defs.values
+    end
+
+    #:  () -> Hash[Symbol, Hash[Symbol, untyped]]
+    def build_schedules_hash
+      @schedules.transform_values(&:to_config)
+    end
+
+    #:  () -> Hash[Symbol, untyped]
+    def build_arguments_hash
+      arguments.to_h { |def_obj| [def_obj.name, def_obj.default] }
+    end
+  end
+end

data/lib/job_workflow/workflow_status.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module JobWorkflow
+  class WorkflowStatus
+    class NotFoundError < StandardError; end
+
+    # @rbs!
+    #   type status_type = :pending | :running | :completed | :failed
+
+    attr_reader :context #: Context
+    attr_reader :job_class_name #: String
+    attr_reader :status #: status_type
+
+    class << self
+      #:  (String) -> WorkflowStatus
+      def find(job_id)
+        workflow_status = find_by(job_id:)
+        raise NotFoundError, "Workflow with job_id '#{job_id}' not found" if workflow_status.nil?
+
+        workflow_status
+      end
+
+      #:  (job_id: String) -> WorkflowStatus?
+      def find_by(job_id:)
+        data = QueueAdapter.current.find_job(job_id)
+        return if data.nil?
+
+        WorkflowStatus.from_job_data(data)
+      end
+
+      #:  (Hash[String, untyped]) -> WorkflowStatus
+      def from_job_data(data)
+        job_class_name = data["class_name"]
+        job_class = job_class_name.constantize
+        workflow = job_class._workflow
+
+        context_data = data["arguments"].first["job_workflow_context"]
+        context = if context_data
+                    Context.deserialize(context_data.merge("workflow" => workflow))
+                  else
+                    Context.from_hash({ workflow: })
+                  end
+
+        new(context:, job_class_name:, status: data["status"])
+      end
+    end
+
+    #:  (context: Context, job_class_name: String, status: status_type) -> void
+    def initialize(context:, job_class_name:, status:)
+      @context = context #: Context
+      @job_class_name = job_class_name #: String
+      @status = status #: Symbol
+    end
+
+    #:  () -> Symbol?
+    def current_task_name
+      context._task_context.task&.task_name
+    end
+
+    #:  () -> Arguments
+    def arguments
+      context.arguments
+    end
+
+    #:  () -> Output
+    def output
+      context.output
+    end
+
+    #:  () -> JobStatus
+    def job_status
+      context.job_status
+    end
+
+    #:  () -> bool
+    def running?
+      status == :running
+    end
+
+    #:  () -> bool
+    def completed?
+      status == :succeeded
+    end
+
+    #:  () -> bool
+    def failed?
+      status == :failed
+    end
+
+    #:  () -> bool
+    def pending?
+      status == :pending
+    end
+
+    #:  () -> Hash[Symbol, untyped]
+    def to_h
+      {
+        status:,
+        job_class_name:,
+        current_task_name:,
+        arguments: arguments.to_h,
+        output: output.flat_task_outputs.map do |task_output|
+          {
+            task_name: task_output.task_name,
+            each_index: task_output.each_index,
+            data: task_output.data
+          }
+        end
+      }
+    end
+  end
+end

data/lib/job_workflow.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "json"
+require "timeout"
+require "tsort"
+require "uri"
+require "net/http"
+require "active_support"
+require "active_support/concern"
+require "active_support/core_ext"
+require "active_support/log_subscriber"
+require "active_job"
+require_relative "job_workflow/version"
+require_relative "job_workflow/logger"
+require_relative "job_workflow/instrumentation"
+require_relative "job_workflow/instrumentation/log_subscriber"
+require_relative "job_workflow/instrumentation/opentelemetry_subscriber"
+require_relative "job_workflow/queue_adapter"
+require_relative "job_workflow/cache_store_adapters"
+require_relative "job_workflow/dry_run_config"
+require_relative "job_workflow/task_retry"
+require_relative "job_workflow/task_throttle"
+require_relative "job_workflow/task_enqueue"
+require_relative "job_workflow/task_dependency_wait"
+require_relative "job_workflow/semaphore"
+require_relative "job_workflow/namespace"
+require_relative "job_workflow/hook"
+require_relative "job_workflow/error_hook"
+require_relative "job_workflow/hook_registry"
+require_relative "job_workflow/task_callable"
+require_relative "job_workflow/task"
+require_relative "job_workflow/task_graph"
+require_relative "job_workflow/schedule"
+require_relative "job_workflow/dsl"
+require_relative "job_workflow/runner"
+require_relative "job_workflow/workflow_status"
+require_relative "job_workflow/workflow"
+require_relative "job_workflow/argument_def"
+require_relative "job_workflow/arguments"
+require_relative "job_workflow/task_context"
+require_relative "job_workflow/task_job_status"
+require_relative "job_workflow/job_status"
+require_relative "job_workflow/context"
+require_relative "job_workflow/output_def"
+require_relative "job_workflow/task_output"
+require_relative "job_workflow/output"
+require_relative "job_workflow/queue"
+require_relative "job_workflow/auto_scaling"
+
+module JobWorkflow
+  class Error < StandardError; end
+
+  extend Logger
+
+  Instrumentation::LogSubscriber.attach!
+
+  ActiveSupport.on_load(:solid_queue) { QueueAdapter.current.initialize_adapter! }
+  QueueAdapter.current.initialize_adapter!
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,172 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: activejob
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '8.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: bigdecimal
+  version: '4.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: delegate
+  version: '0'
+  source:
+    type: stdlib
+- name: digest
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: globalid
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '5.25'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: net-http
+  version: '0'
+  source:
+    type: stdlib
+- name: net-protocol
+  version: '0'
+  source:
+    type: stdlib
+- name: openssl
+  version: '0'
+  source:
+    type: stdlib
+- name: prism
+  version: 1.7.0
+  source:
+    type: rubygems
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: socket
+  version: '0'
+  source:
+    type: stdlib
+- name: sqlite3
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: stringio
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: tzinfo
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 2af46cde7fec5e4130f6c84c5b691c0538af8789
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,14 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+path: .gem_rbs_collection
+
+gems:
+  - name: net-http
+  - name: activerecord
+  - name: tsort

data/sig/generated/job-workflow.rbs

@@ -0,0 +1,2 @@
+# Generated from lib/job-workflow.rb with RBS::Inline
+

data/sig/generated/job_workflow/argument_def.rbs

@@ -0,0 +1,14 @@
+# Generated from lib/job_workflow/argument_def.rb with RBS::Inline
+
+module JobWorkflow
+  class ArgumentDef
+    attr_reader name: Symbol
+
+    attr_reader type: String
+
+    attr_reader default: untyped
+
+    # :  (name: Symbol, type: String, default: untyped) -> void
+    def initialize: (name: Symbol, type: String, default: untyped) -> void
+  end
+end

data/sig/generated/job_workflow/arguments.rbs

@@ -0,0 +1,26 @@
+# Generated from lib/job_workflow/arguments.rb with RBS::Inline
+
+module JobWorkflow
+  class Arguments
+    # : (data: Hash[Symbol, untyped]) -> void
+    def initialize: (data: Hash[Symbol, untyped]) -> void
+
+    # : (Hash[Symbol, untyped] other_data) -> Arguments
+    def merge: (Hash[Symbol, untyped] other_data) -> Arguments
+
+    # : (Symbol name, *untyped args, **untyped kwargs) ?{ () -> untyped } -> untyped
+    def method_missing: (Symbol name, *untyped args, **untyped kwargs) ?{ () -> untyped } -> untyped
+
+    # : (Symbol sym, bool include_private) -> bool
+    def respond_to_missing?: (Symbol sym, bool include_private) -> bool
+
+    # : () -> Hash[Symbol, untyped]
+    def to_h: () -> Hash[Symbol, untyped]
+
+    private
+
+    attr_reader data: Hash[Symbol, untyped]
+
+    attr_reader reader_names: Set[Symbol]
+  end
+end

data/sig/generated/job_workflow/auto_scaling/adapter/aws_adapter.rbs

@@ -0,0 +1,32 @@
+# Generated from lib/job_workflow/auto_scaling/adapter/aws_adapter.rb with RBS::Inline
+
+module JobWorkflow
+  module AutoScaling
+    module Adapter
+      class AwsAdapter
+        # :  (?ecs_client: Aws::ECS::Client?) -> void
+        def initialize: (?ecs_client: Aws::ECS::Client?) -> void
+
+        # :  (Integer) -> Integer?
+        def update_desired_count: (Integer) -> Integer?
+
+        private
+
+        attr_reader ecs_client: Aws::ECS::Client
+
+        attr_reader cluster: String
+
+        attr_reader task_arn: String
+
+        # :  () -> String
+        def describe_service_name: () -> String
+
+        # :  () -> Aws::ECS::Types::Service
+        def describe_service: () -> Aws::ECS::Types::Service
+
+        # :  (service: Aws::ECS::Types::Service, desired_count: Integer) -> Aws::ECS::Types::UpdateServiceResponse
+        def update_service: (service: Aws::ECS::Types::Service, desired_count: Integer) -> Aws::ECS::Types::UpdateServiceResponse
+      end
+    end
+  end
+end

data/sig/generated/job_workflow/auto_scaling/adapter.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/job_workflow/auto_scaling/adapter.rb with RBS::Inline
+
+module JobWorkflow
+  module AutoScaling
+    module Adapter
+      interface _ClassMethods
+        def new: () -> _InstanceMethods
+      end
+
+      interface _InstanceMethods
+        def class: () -> _ClassMethods
+
+        def update_desired_count: (Integer) -> Integer?
+      end
+
+      ADAPTERS: Hash[Symbol, _ClassMethods]
+
+      # :  (Symbol) -> _ClassMethods
+      def self.fetch: (Symbol) -> _ClassMethods
+    end
+  end
+end

data/sig/generated/job_workflow/auto_scaling/configuration.rbs

@@ -0,0 +1,50 @@
+# Generated from lib/job_workflow/auto_scaling/configuration.rb with RBS::Inline
+
+module JobWorkflow
+  module AutoScaling
+    class Configuration
+      attr_reader queue_name: String
+
+      attr_reader min_count: Integer
+
+      attr_reader max_count: Integer
+
+      attr_reader step_count: Integer
+
+      attr_reader max_latency: Integer
+
+      #
+      # :  (
+      #      ?queue_name: String,
+      #      ?min_count: Integer,
+      #      ?max_count: Integer,
+      #      ?step_count: Integer,
+      #      ?max_latency: Integer
+      #    ) -> void
+      def initialize: (?queue_name: String, ?min_count: Integer, ?max_count: Integer, ?step_count: Integer, ?max_latency: Integer) -> void
+
+      # :  () -> Integer
+      def latency_per_step_count: () -> Integer
+
+      # :  (String) -> void
+      def queue_name=: (String) -> void
+
+      # :  (Integer) -> void
+      def min_count=: (Integer) -> void
+
+      # :  (Integer) -> void
+      def max_count=: (Integer) -> void
+
+      # :  (Integer) -> void
+      def step_count=: (Integer) -> void
+
+      # :  (Integer) -> void
+      def max_latency=: (Integer) -> void
+
+      private
+
+      # :  (Integer) -> void
+      def assert_positive_number!: (Integer) -> void
+    end
+  end
+end

data/sig/generated/job_workflow/auto_scaling/executor.rbs

@@ -0,0 +1,29 @@
+# Generated from lib/job_workflow/auto_scaling/executor.rb with RBS::Inline
+
+module JobWorkflow
+  module AutoScaling
+    class Executor
+      # :  (Configuration) -> void
+      def initialize: (Configuration) -> void
+
+      # :  () -> Integer?
+      def update_desired_count: () -> Integer?
+
+      private
+
+      attr_reader config: Configuration
+
+      # :  () -> Adapter::_InstanceMethods
+      def adapter: () -> Adapter::_InstanceMethods
+
+      # :  () -> Integer?
+      def queue_latency: () -> Integer?
+
+      # :  () -> Integer
+      def desired_count_by_latency: () -> Integer
+
+      # :  () -> Array[Integer]
+      def desired_count_list: () -> Array[Integer]
+    end
+  end
+end

data/sig/generated/job_workflow/auto_scaling.rbs

@@ -0,0 +1,47 @@
+# Generated from lib/job_workflow/auto_scaling.rb with RBS::Inline
+
+module JobWorkflow
+  # @example
+  #   ```ruby
+  #   class AutoScalingJob < ApplicationJob
+  #     include JobWorkflow::AutoScaling
+  #
+  #     target_queue_name "my_queue"
+  #     min_count 2
+  #     max_count 10
+  #     step_count 2
+  #     max_latency 1800
+  #   end
+  #   ```
+  module AutoScaling
+    extend ActiveSupport::Concern
+
+    extend ClassMethods
+
+    def class: () -> ClassMethods
+
+    # :  () -> void
+    def perform: () -> void
+
+    module ClassMethods
+      def class_attribute: (Symbol, default: untyped, ?instance_writer: bool) -> void
+
+      def _config: () -> Configuration
+
+      # :  (String) -> void
+      def target_queue_name: (String) -> void
+
+      # :  (Integer) -> void
+      def min_count: (Integer) -> void
+
+      # :  (Integer) -> void
+      def max_count: (Integer) -> void
+
+      # :  (Integer) -> void
+      def step_count: (Integer) -> void
+
+      # :  (Integer) -> void
+      def max_latency: (Integer) -> void
+    end
+  end
+end