durable_flow 0.1.0

data/lib/durable_flow.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "rails"
+require "active_job"
+require "active_job/continuation"
+require "active_record"
+require "active_support/core_ext/numeric/time"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/module/attribute_accessors"
+require "securerandom"
+
+require "durable_flow/version"
+require "durable_flow/errors"
+require "durable_flow/serializer"
+require "durable_flow/schema"
+require "durable_flow/live"
+require "durable_flow/workflow_logger"
+require "durable_flow/workflow_timeline"
+require "durable_flow/models/application_record"
+require "durable_flow/models/workflow_run"
+require "durable_flow/models/workflow_step"
+require "durable_flow/models/workflow_event"
+require "durable_flow/models/workflow_wait"
+require "durable_flow/models/workflow_log"
+require "durable_flow/dispatcher"
+require "durable_flow/event_subscriber"
+require "durable_flow/step_proxy"
+require "durable_flow/workflow"
+require "durable_flow/engine"
+require "durable_flow/railtie"
+
+module DurableFlow
+  NOOP_LIVE_BROADCASTER = ->(_change) {}
+
+  mattr_accessor :event_subscriber, default: nil
+  mattr_accessor :execution_lock_ttl, default: 10.minutes
+  mattr_accessor :live_broadcaster, default: NOOP_LIVE_BROADCASTER
+  mattr_accessor :live_subscribers, default: []
+
+  WORKFLOW_COMPLETED_EVENT = "durable_flow.workflow.completed"
+  WORKFLOW_FAILED_EVENT = "durable_flow.workflow.failed"
+  IGNORED_EVENT_NAMESPACES = %w[
+    action_controller
+    action_mailbox
+    action_mailer
+    action_text
+    action_view
+    active_job
+    active_record
+    active_storage
+    active_support
+    rails
+  ].freeze
+
+  class << self
+    def subscribe_to_rails_events!
+      return event_subscriber if event_subscriber
+      return unless defined?(Rails) && Rails.respond_to?(:event)
+
+      self.event_subscriber = EventSubscriber.new
+      Rails.event.subscribe(event_subscriber) { |event| record_event?(event[:name]) }
+      event_subscriber
+    end
+
+    def unsubscribe_from_rails_events!
+      return unless event_subscriber
+      return unless defined?(Rails) && Rails.respond_to?(:event)
+
+      Rails.event.unsubscribe(event_subscriber)
+      self.event_subscriber = nil
+    end
+
+    def notify(name, payload = nil, **kwargs)
+      if defined?(Rails) && Rails.respond_to?(:event)
+        payload ? Rails.event.notify(name, payload, **kwargs) : Rails.event.notify(name, **kwargs)
+      else
+        event = {
+          name: name.to_s,
+          payload: payload || kwargs,
+          tags: {},
+          context: {},
+          timestamp: Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond),
+        }
+        EventSubscriber.new.emit(event)
+      end
+    end
+
+    def broadcast_change(change)
+      broadcast_live_change(live_broadcaster, change)
+      live_subscribers.each { |subscriber| broadcast_live_change(subscriber, change) }
+      change
+    end
+
+    def on_change(&block)
+      raise ArgumentError, "Provide a block" unless block
+
+      self.live_subscribers += [ block ]
+      block
+    end
+
+    def unsubscribe_from_changes(subscriber)
+      self.live_subscribers -= [ subscriber ]
+    end
+
+    def reset_live_broadcasters!
+      self.live_broadcaster = NOOP_LIVE_BROADCASTER
+      self.live_subscribers = []
+    end
+
+    def database_ready?
+      return false unless defined?(ActiveRecord::Base)
+      return false unless ActiveRecord::Base.connected?
+
+      connection = ActiveRecord::Base.connection
+      %w[
+        durable_flow_workflow_runs
+        durable_flow_workflow_steps
+        durable_flow_workflow_events
+        durable_flow_workflow_waits
+        durable_flow_workflow_logs
+      ].all? { |table| connection.data_source_exists?(table) }
+    rescue ActiveRecord::ActiveRecordError
+      false
+    end
+
+    def record_event?(name)
+      return false if Fiber[:durable_flow_recording_event]
+
+      name = name.to_s
+      return true if name.start_with?("durable_flow.")
+
+      IGNORED_EVENT_NAMESPACES.none? do |namespace|
+        name == namespace || name.start_with?("#{namespace}.") || name.end_with?(".#{namespace}")
+      end
+    end
+
+    private
+      def broadcast_live_change(callable, change)
+        callable.call(change)
+      rescue StandardError => error
+        if defined?(Rails) && Rails.respond_to?(:error)
+          Rails.error.report(error, handled: true)
+        end
+      end
+  end
+end

data/lib/generators/durable_flow/install_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module DurableFlow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migration
+        migration_template "create_durable_flow_tables.rb", "db/migrate/create_durable_flow_tables.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/durable_flow/templates/create_durable_flow_tables.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+class CreateDurableFlowTables < ActiveRecord::Migration[8.0]
+  def change
+    create_table :durable_flow_workflow_runs do |t|
+      t.string :run_id, null: false
+      t.string :job_id, null: false
+      t.string :workflow_class, null: false
+      t.string :status, null: false, default: "enqueued"
+      t.string :queue_name
+      t.integer :priority
+      t.json :arguments
+      t.json :serialized_job
+      t.json :last_error
+      t.datetime :started_at
+      t.datetime :interrupted_at
+      t.datetime :completed_at
+      t.datetime :failed_at
+      t.string :execution_locked_by
+      t.datetime :execution_locked_at
+      t.datetime :execution_lock_expires_at
+      t.timestamps
+    end
+
+    add_index :durable_flow_workflow_runs, :run_id, unique: true
+    add_index :durable_flow_workflow_runs, [ :workflow_class, :status ], name: "idx_durable_flow_runs_on_class_status"
+    add_index :durable_flow_workflow_runs, :execution_lock_expires_at, name: "idx_durable_flow_runs_on_lock_expiry"
+
+    create_table :durable_flow_workflow_steps do |t|
+      t.references :workflow_run, null: false, index: false
+      t.string :name, null: false
+      t.string :status, null: false, default: "pending"
+      t.integer :attempts, null: false, default: 0
+      t.json :result
+      t.json :metadata
+      t.datetime :started_at
+      t.datetime :completed_at
+      t.timestamps
+    end
+
+    add_index :durable_flow_workflow_steps,
+      [ :workflow_run_id, :name ],
+      unique: true,
+      name: "idx_durable_flow_steps_on_run_and_name"
+
+    create_table :durable_flow_workflow_events do |t|
+      t.string :name, null: false
+      t.json :payload
+      t.json :tags
+      t.json :context
+      t.json :source_location
+      t.datetime :occurred_at, null: false
+      t.timestamps
+    end
+
+    add_index :durable_flow_workflow_events, [ :name, :occurred_at ], name: "idx_durable_flow_events_on_name_time"
+
+    create_table :durable_flow_workflow_waits do |t|
+      t.references :workflow_run, null: false, index: false
+      t.references :workflow_step, null: false, index: false
+      t.references :workflow_event, index: false
+      t.string :event_name, null: false
+      t.string :status, null: false, default: "pending"
+      t.json :match
+      t.datetime :timeout_at
+      t.timestamps
+    end
+
+    add_index :durable_flow_workflow_waits,
+      [ :workflow_run_id, :workflow_step_id ],
+      unique: true,
+      name: "idx_durable_flow_waits_on_run_and_step"
+    add_index :durable_flow_workflow_waits,
+      [ :event_name, :status ],
+      name: "idx_durable_flow_waits_on_event_status"
+
+    create_table :durable_flow_workflow_logs do |t|
+      t.references :workflow_run, null: false, index: false
+      t.references :workflow_step, index: false
+      t.string :level, null: false
+      t.string :message, null: false
+      t.json :data
+      t.timestamps
+    end
+
+    add_index :durable_flow_workflow_logs,
+      [ :workflow_run_id, :created_at ],
+      name: "idx_durable_flow_logs_on_run_time"
+    add_index :durable_flow_workflow_logs,
+      [ :workflow_step_id, :created_at ],
+      name: "idx_durable_flow_logs_on_step_time"
+  end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: durable_flow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DurableFlow contributors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: solid_queue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: An Inngest-style durable workflow runtime built on ActiveJob::Continuable,
+  Active Record, and Rails.event.
+email:
+- dev@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/controllers/durable_flow/workflow_runs_controller.rb
+- app/views/durable_flow/workflow_runs/index.html.erb
+- app/views/durable_flow/workflow_runs/show.html.erb
+- app/views/layouts/durable_flow/application.html.erb
+- config/routes.rb
+- lib/durable_flow.rb
+- lib/durable_flow/dispatcher.rb
+- lib/durable_flow/engine.rb
+- lib/durable_flow/errors.rb
+- lib/durable_flow/event_subscriber.rb
+- lib/durable_flow/live.rb
+- lib/durable_flow/models/application_record.rb
+- lib/durable_flow/models/workflow_event.rb
+- lib/durable_flow/models/workflow_log.rb
+- lib/durable_flow/models/workflow_run.rb
+- lib/durable_flow/models/workflow_step.rb
+- lib/durable_flow/models/workflow_wait.rb
+- lib/durable_flow/railtie.rb
+- lib/durable_flow/schema.rb
+- lib/durable_flow/serializer.rb
+- lib/durable_flow/step_proxy.rb
+- lib/durable_flow/test_helper.rb
+- lib/durable_flow/version.rb
+- lib/durable_flow/workflow.rb
+- lib/durable_flow/workflow_logger.rb
+- lib/durable_flow/workflow_timeline.rb
+- lib/generators/durable_flow/install_generator.rb
+- lib/generators/durable_flow/templates/create_durable_flow_tables.rb
+homepage: https://github.com/skorfmann/durableflow
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skorfmann/durableflow
+  source_code_uri: https://github.com/skorfmann/durableflow
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Durable workflows on Rails Active Job continuations.
+test_files: []