postjob 0.1.1

data/spec/postjob/queue/search_spec.rb

@@ -0,0 +1,141 @@
+require "spec_helper"
+
+# rubocop:disable Metrics/BlockLength
+
+module SearchWorkflow
+  def self.run
+    set_workflow_status "starting-up"
+
+    job = async :manual, timeout: 10
+    set_workflow_status "created-manual"
+
+    _token = workflow_token job
+    set_workflow_status "created-manual-token"
+
+    manual_result = await job
+    set_workflow_status "got-manual-token"
+
+    "manual-result:#{manual_result}"
+  end
+
+  Postjob.register_workflow self
+end
+
+describe "Postjob::Queue::Search" do
+  let!(:id) { Postjob.enqueue! "SearchWorkflow", tags: { "initial" => "yay" } }
+
+  include TestHelper
+
+  Search = Postjob::Queue::Search
+
+  before do
+    Postjob.process_all
+  end
+
+  def load_child_job
+    TestHelper.load_job "SELECT * FROM postjobs WHERE parent_id=$1", id
+  end
+
+  def token
+    load_token(load_child_job)
+  end
+
+  it "creates a token" do
+    expect! token => /[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[a-fA-F0-9]{4}-[A-F0-9]{12}/i
+  end
+
+  describe "returned data shape" do
+    it "returns a specific set of attributes" do
+      result = Search.one(id)
+      expected_keys = [
+        :id,
+        :full_id,
+        :job,
+        :workflow_status,
+        :status,
+        :error,
+        :result,
+        :next_run_at,
+        :error_backtrace,
+        :age,
+        :runtime,
+        :tags
+      ]
+      expect(result.keys).to contain_exactly(*expected_keys)
+    end
+  end
+
+  describe "search_one" do
+    it "can find a job by id" do
+      result = Search.one(id)
+      expect(result).to be_a(Hash)
+      expect(Search.one(id)[:id]).to eq(id)
+    end
+
+    it "writes into the into: type" do
+      result = Search.one(id, into: OpenStruct)
+      expect(result).to be_a(OpenStruct)
+      expect(result.id).to eq(id)
+    end
+  end
+
+  describe "search_all" do
+    it "can find a job by id" do
+      result = Search.all into: OpenStruct
+      expect(result.map(&:id)).to eq([id])
+    end
+
+    context "with multiple jobs" do
+      before do
+        Postjob.enqueue! "SearchWorkflow", tags: { "secondary" => "yay" }
+      end
+
+      it "returns all entries" do
+        result = Search.all into: OpenStruct
+        expect(result.length).to eq(2)
+      end
+
+      it "honors page and per arguments" do
+        result = Search.all into: OpenStruct, page: 0, per: 1
+        expect(result.length).to eq(1)
+        expect(result.first.id).to eq(id)
+
+        result = Search.all into: OpenStruct, page: 1, per: 1
+        expect(result.length).to eq(1)
+        expect(result.first.id).not_to eq(id)
+
+        result = Search.all into: OpenStruct, page: 2, per: 1
+        expect(result.length).to eq(0)
+
+        expect do
+          Search.all into: OpenStruct, page: -10
+        end.to raise_error(ArgumentError)
+
+        expect do
+          Search.all into: OpenStruct, per: -10
+        end.to raise_error(ArgumentError)
+      end
+
+      it "sorts by id" do
+        # Note that the second job has a id larger than the original job's id.
+        result = Search.all into: OpenStruct
+        expect(result.first.id).to eq(id)
+      end
+    end
+
+    describe "filtering" do
+      it "positive filters by tags" do
+        filter = { "initial" => "yay" }
+        result = Search.all filter: filter, into: OpenStruct
+        expect(result.length).to eq(1)
+        expect(result.first.id).to eq(id)
+      end
+
+      it "negative filters by tags" do
+        filter = { "initial" => "nay" }
+        result = Search.all filter: filter, into: OpenStruct
+        expect(result.length).to eq(0)
+      end
+    end
+  end
+end

data/spec/postjob/run_spec.rb

@@ -0,0 +1,69 @@
+# rubocop:disable Metrics/BlockLength
+
+require "spec_helper"
+
+module TwoLevelWorkflow
+  module StringWorker
+    def self.run
+      "my string"
+    end
+
+    Postjob.register_workflow self
+  end
+
+  def self.run
+    r = async StringWorker
+    await r
+  end
+
+  Postjob.register_workflow self
+end
+
+describe "Postjob.Postjob.process_all" do
+  include TestHelper
+
+  let!(:id) { Postjob.enqueue! "TwoLevelWorkflow" }
+
+  it "runs the job returning the result" do
+    expect(Postjob.process_all).to eq(3)
+    processed_job = load_job(id)
+    expect(processed_job.status).to eq("ok")
+    expect(processed_job.resolve).to eq("my string")
+  end
+
+  context "when scheduled to run in the future" do
+    before do
+      Simple::SQL.ask <<~SQL, id
+        UPDATE postjobs
+        SET next_run_at=next_run_at + interval '10 seconds'
+        WHERE id=$1
+        SQL
+    end
+
+    it "does not run the job" do
+      expect(Postjob.process_all).to eq(0)
+      processed_job = load_job(id)
+      # expect(processed_job.status).to eq("ready")
+      expect(processed_job.resolve).to eq(:pending)
+    end
+  end
+
+  context "when scheduled to time out" do
+    before do
+      Simple::SQL.ask <<~SQL, id
+        UPDATE postjobs
+        SET timing_out_at=next_run_at
+        WHERE id=$1
+        SQL
+    end
+
+    it "times out when job is running" do
+      Postjob.process_all
+      processed_job = load_job(id)
+
+      expect do
+        processed_job.resolve
+      end.to raise_error(Timeout::Error)
+    end
+  end
+end

data/spec/postjob/step_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+module StepWorkflow
+  def self.run
+    "Foo"
+  end
+
+  Postjob.register_workflow self, version: "1.2"
+end
+
+describe "Postjob.step" do
+  include TestHelper
+
+  let!(:job_id) { Postjob.enqueue! "StepWorkflow" }
+
+  it "runs the job is there is one" do
+    processed_job = Postjob.step
+    expect(processed_job.id).to eq(job_id)
+  end
+
+  it "returns nil if there is none" do
+    Postjob.process_all
+    processed_job = Postjob.step
+    expect(processed_job).to be_nil
+  end
+end

data/spec/postjob/sub_workflow_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+module SubWorkflow
+  def self.my_string
+    "my string"
+  end
+
+  def self.run
+    r = async :my_string
+    await r
+  end
+
+  Postjob.register_workflow self
+end
+
+describe "Sub Workflows" do
+  include TestHelper
+
+  let!(:id) { Postjob.enqueue! "SubWorkflow" }
+
+  it "runs the job returning the result" do
+    Postjob.process_all
+    processed_job = load_job(id)
+    expect(processed_job.status).to eq("ok")
+    expect(processed_job.resolve).to eq("my string")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+ENV["RACK_ENV"] = "test"
+
+require "rspec"
+require "pry"
+require "simplecov"
+require "awesome_print"
+
+unless ENV["SKIP_SIMPLE_COV"]
+  SimpleCov.start do
+    minimum_coverage 91
+    add_filter "/spec/"
+  end
+end
+
+require "postjob"
+Postjob.fast_mode = true
+
+logger = Logger.new("log/test.log")
+logger.formatter = proc do |severity, _datetime, _progname, msg|
+  "#{severity}: #{msg}\n"
+end
+Simple::SQL.logger = Postjob.logger = logger
+
+require "./spec/support/configure_database"
+require "./spec/support/test_helper"
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run focus: (ENV["CI"] != "true")
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  config.order = "random"
+
+  config.before(:all) {}
+  config.after {}
+end

data/spec/support/configure_active_record.rb

@@ -0,0 +1,18 @@
+require "active_record"
+ActiveRecord::Base.establish_connection(adapter: "postgresql",
+                                        database: "postjob_test",
+                                        username: "postjob",
+                                        password: "postjob")
+
+# RSpec.configure do |config|
+#   config.around(:each) do |example|
+#     if example.metadata[:transactions] == false
+#       example.run
+#     else
+#       ::ActiveRecord::Base.connection.transaction do
+#         example.run
+#         raise ActiveRecord::Rollback, "clean up"
+#       end
+#     end
+#   end
+# end

data/spec/support/configure_database.rb

@@ -0,0 +1,19 @@
+if ENV["USE_ACTIVE_RECORD"]
+  require_relative "configure_active_record"
+else
+  require_relative "configure_simple_sql"
+end
+
+RSpec.configure do |config|
+  config.around(:each) do |example|
+    Simple::SQL.ask "DELETE FROM postjob.postjobs"
+    example.run
+  end
+end
+
+require "postjob/migrations"
+
+Postjob::Migrations.unmigrate!
+Postjob::Migrations.migrate!
+
+Simple::SQL.ask "SET search_path = postjob, public, pg_catalog"

data/spec/support/configure_simple_sql.rb

@@ -0,0 +1,17 @@
+ENV["DATABASE_URL"] = "postgresql://postjob:postjob@localhost/postjob_test"
+::Simple::SQL.connect!
+
+# RSpec.configure do |config|
+#   config.around(:each) do |example|
+#     if example.metadata[:transactions] == false
+#       example.run
+#     else
+#       catch(:rollback) do
+#         ::Simple::SQL.transaction do
+#           example.run
+#           throw :rollback
+#         end
+#       end
+#     end
+#   end
+# end

data/spec/support/connect_active_record.rb

@@ -0,0 +1,6 @@
+require "active_record"
+ActiveRecord::Base.establish_connection(adapter: "postgresql",
+                                        database: "postjob_test",
+                                        username: "postjob",
+                                        password: "postjob")
+

data/spec/support/test_helper.rb

@@ -0,0 +1,53 @@
+Postjob.send :public, :process_job
+
+module TestHelper
+  extend self
+
+  def jobs_count
+    Simple::SQL.ask "SELECT count(*) FROM postjobs"
+  end
+
+  def newest_job
+    Simple::SQL.record "SELECT * FROM postjobs ORDER BY id DESC", into: Postjob::Job
+  end
+
+  def load_job(id_or_sql, *args)
+    case id_or_sql
+    when Integer
+      Simple::SQL.record "SELECT * FROM postjobs WHERE id=$1", id_or_sql, into: Postjob::Job
+    else
+      Simple::SQL.record id_or_sql, *args, into: Postjob::Job
+    end
+  end
+
+  def load_token(job)
+    Simple::SQL.ask "SELECT token FROM tokens WHERE postjob_id=$1", job.id
+  end
+
+  def print_sql(sql, *args)
+    require "table_print"
+
+    records = Simple::SQL.records(sql, *args)
+    tp records
+  end
+
+  def print_jobs
+    print_sql <<~SQL
+      SELECT
+        id,
+        workflow AS job,
+        workflow_method AS m,
+        args,
+        status,
+        (results->0)::varchar AS result,
+        failed_attempts AS attempts,
+        EXTRACT(EPOCH FROM ((now() at time zone 'utc') - created_at)) AS age,
+        EXTRACT(EPOCH FROM (next_run_at - (now() at time zone 'utc'))) AS next_run_in,
+        error,
+        error_message,
+        (error_backtrace->0)::varchar AS backtrace
+        FROM postjobs
+      ORDER BY id
+    SQL
+  end
+end

metadata

@@ -0,0 +1,269 @@
+--- !ruby/object:Gem::Specification
+name: postjob
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple-sql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: simple-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: expectation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: restartable, asynchronous, and distributed processes
+email:
+- radiospiel@open-lab.org
+executables:
+- postjob
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/postjob
+- lib/postjob.rb
+- lib/postjob/cli.rb
+- lib/postjob/cli/db.rb
+- lib/postjob/cli/job.rb
+- lib/postjob/cli/ps.rb
+- lib/postjob/cli/run.rb
+- lib/postjob/error.rb
+- lib/postjob/job.rb
+- lib/postjob/migrations.rb
+- lib/postjob/queue.rb
+- lib/postjob/queue/encoder.rb
+- lib/postjob/queue/notifications.rb
+- lib/postjob/queue/search.rb
+- lib/postjob/registry.rb
+- lib/postjob/runner.rb
+- lib/postjob/workflow.rb
+- spec/postjob/enqueue_spec.rb
+- spec/postjob/full_workflow_spec.rb
+- spec/postjob/job_control/manual_spec.rb
+- spec/postjob/job_control/max_attempts_spec.rb
+- spec/postjob/job_control/timeout_spec.rb
+- spec/postjob/job_control/workflow_status_spec.rb
+- spec/postjob/process_job_spec.rb
+- spec/postjob/queue/encoder_spec.rb
+- spec/postjob/queue/search_spec.rb
+- spec/postjob/run_spec.rb
+- spec/postjob/step_spec.rb
+- spec/postjob/sub_workflow_spec.rb
+- spec/spec_helper.rb
+- spec/support/configure_active_record.rb
+- spec/support/configure_database.rb
+- spec/support/configure_simple_sql.rb
+- spec/support/connect_active_record.rb
+- spec/support/test_helper.rb
+homepage: https://github.com/radiospiel/postjob
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: restartable, asynchronous, and distributed processes
+test_files: []