postjob 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04c8dbb68c7f61be34b8bfe642fdd6ce04933e08
-  data.tar.gz: 355aca75cf91e2107d850163802ab87aabf94126
+  metadata.gz: 5bb4b3e0053cc36fb49b56b5711559dd4758ccab
+  data.tar.gz: 5d16630d479c92c4287c03201f3b3a5f28f9126f
 SHA512:
-  metadata.gz: 50c02c184aab359a4c67d5b4b853560aac3a54636ed603cbfd7c161b61057c807d9ea0a752bce79a4c57c77f0f4841c4d7b5cbe33535bfafb42d2c0b8a50e46b
-  data.tar.gz: 56e861011da77177e1e8b147ff2447a26f292b8bdeceeec117dfd2b979cd4ca0449e493c2f00f4cce3cecceb99b2677f2fce177aaca241c61997082d7a6764d5
+  metadata.gz: 052a5b8e8db5e7b13b1c48d7e2a1daadf575f013374634d7f3cca32eefb95d0a0c5ad25d17be223d68807481b63fb64305de4f213835f67c07484bf3c4a39fd3
+  data.tar.gz: 8616e9115a0b6a1e4f5c0e709864b0878db39d65aa4f04ca195b9fe2c79ae54988e0b5678557a1be40e9eebed398280deb577e24927a58cb5a97bc26dabc5921

data/lib/postjob/cli/db.rb

@@ -2,6 +2,16 @@ require "postjob/cli"
 require "postjob/migrations"
 
 module Postjob::CLI
+  # Prints all settings in the queue
+  def db_settings
+    connect_to_database!
+
+    raise "No settings in this database schema" unless ::Postjob::Queue.settings?
+
+    records = "SELECT name,value FROM postjob.settings ORDER BY name"
+    tp Simple::SQL.all(records, into: Hash)
+  end
+
   def db_migrate
     connect_to_database!
     Postjob::Migrations.migrate!

data/lib/postjob/cli/version.rb

@@ -0,0 +1,10 @@
+module Postjob::CLI
+  # Prints version info
+  def version
+    connect_to_database!
+
+    gem_version = Gem.loaded_specs["postjob"].version
+    puts "postjob/ruby: #{gem_version}"
+    puts "postjob/queue: #{::Postjob::Queue.version}"
+  end
+end

data/lib/postjob/migrations.rb

@@ -1,12 +1,15 @@
 # rubocop:disable Security/Eval
 
 module Postjob
+  VERSION = Gem.loaded_specs["postjob"].version
+
   module Migrations
     extend self
 
     SQL = ::Simple::SQL
     SCHEMA_NAME = ::Postjob::Queue::SCHEMA_NAME
     CHANNEL     = ::Postjob::Queue::Notifications::CHANNEL
+    CLIENT_VERSION = "ruby/#{::Postjob::VERSION}"
 
     # Note that the SCHEMA_NAME should not be the default name, since unmigrate!
     # below drops that schema, and we don't want to drop the default schema.

data/lib/postjob/migrations/010_settings.sql

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS {SCHEMA_NAME}.settings (
+  name        VARCHAR PRIMARY KEY NOT NULL,
+  value       VARCHAR
+);
+
+INSERT INTO {SCHEMA_NAME}.settings (name, value) VALUES('version', '0.4.0') ON CONFLICT DO NOTHING;
+INSERT INTO {SCHEMA_NAME}.settings (name, value) VALUES('client_version', '{CLIENT_VERSION}') ON CONFLICT DO NOTHING;

data/lib/postjob/queue.rb

@@ -15,6 +15,7 @@ end
 require_relative "queue/encoder"
 require_relative "queue/notifications"
 require_relative "queue/search"
+require_relative "queue/settings"
 
 module Postjob::Queue
   Job = ::Postjob::Job

data/lib/postjob/queue/search.rb

@@ -1,81 +1,57 @@
 module Postjob::Queue
-end
-
-#
-# The Postjob::Queue::Search module is able to inspect the Postjob Queue.
-module Postjob::Queue::Search
-  extend self
-
-  def one(id, filter: {}, into: Hash)
-    query = query(page: 0, per: 1, filter: filter, id: id)
-    Simple::SQL.ask(query, into: into)
-  end
+  DEFAULT_ATTRIBUTES = [
+    "id",
+    "full_id",
+    "workflow || COALESCE('@' || workflow_version, '') || args AS job",
+    "workflow_status",
+    "status",
+    "error",
+    "COALESCE((results->0)::varchar, error_message) AS result",
+    "next_run_at",
+    "error_backtrace",
+    "(now() at time zone 'utc') - created_at AS age",
+    "updated_at - created_at AS runtime",
+    "tags"
+  ]
+
+  # Builds a search scope (see Simple::SQL::Scope) for the passed in filter criteria.
+  def search(filter = {})
+    expect! filter => Hash
 
-  def all(page: 0, per: 100, filter: {}, into: Hash)
-    query = query(page: page, per: per, filter: filter)
-    Simple::SQL.all(query, into: into)
+    # extract options
+    filter     = filter.dup
+    root_only  = filter.delete(:root_only) || false
+    attributes = filter.delete(:attributes) || DEFAULT_ATTRIBUTES
+    expect! attributes => Array
+
+    # build Scope
+    scope = Simple::SQL::Scope.new("SELECT #{attributes.join(", ")} FROM #{SCHEMA_NAME}.postjobs")
+    scope = scope.where("root_id=id") if root_only
+    scope = apply_filters(scope, filter) if filter && !filter.empty?
+    scope
   end
 
   private
 
-  def query(page: nil, per: nil, filter: {}, root_only: true, id: nil)
-    expect! id => [Integer, nil]
-    expect! page => [Integer, nil]
-    expect! per => [Integer, nil]
-    expect! { page >= 0 && per > 0 }
-    expect! filter => Hash
-
-    conditions = []
-    conditions << "id=#{id}" if id
-    conditions << "root_id=id" if root_only
-    conditions << tags_condition(filter)
-
-    query = base_query(conditions)
-    query = paginated_query query, per: per, page: page
-    query
-  end
-
-  def paginated_query(query, per:, page:)
-    expect! per => Integer
-    expect! page => Integer
+  def apply_filters(scope, filter)
+    filter.each_key do |key|
+      expect! key => [Symbol, String]
+    end
 
-    <<~SQL
-      SELECT * FROM (#{query}) sq LIMIT #{per} OFFSET #{per * page}
-    SQL
-  end
+    column_names = Simple::SQL::Reflection.columns("#{SCHEMA_NAME}.postjobs")
+    column_names += column_names.map(&:to_sym)
 
-  def base_query(conditions = [])
-    conditions.compact!
-    conditions << "TRUE"
-    condition_fragment = conditions
-                         .compact
-                         .map { |s| "(#{s})" }
-                         .join(" AND ")
+    column_filters, tags_filters = filter.partition { |key, _| column_names.include?(key) }
 
-    <<~SQL
-      SELECT
-        id,
-        full_id,
-        workflow || COALESCE('@' || workflow_version, '') || args AS job,
-        workflow_status,
-        status,
-        error,
-        COALESCE((results->0)::varchar, error_message) AS result,
-        next_run_at,
-        error_backtrace,
-        (now() at time zone 'utc') - created_at AS age,
-        updated_at - created_at AS runtime,
-        tags
-      FROM postjob.postjobs
-      WHERE #{condition_fragment}
-      ORDER BY id
-    SQL
-  end
+    scope = column_filters.inject(scope) do |sc, (key, value)|
+      sc.where(key => value)
+    end
 
-  def tags_condition(keys_and_values)
-    expect! keys_and_values => Hash
-    return nil if keys_and_values.empty?
+    unless tags_filters.empty?
+      tags_filters = Hash[tags_filters]
+      scope = scope.where "tags @> '#{Postjob::Queue::Encoder.encode(tags_filters)}'"
+    end
 
-    "tags @> '#{Postjob::Queue::Encoder.encode(keys_and_values)}'"
+    scope
   end
 end

data/lib/postjob/queue/settings.rb

@@ -0,0 +1,13 @@
+module Postjob::Queue
+  def settings?
+    tables = SQL::Reflection.tables(schema: "postjob")
+    tables.include?("postjob.settings")
+  end
+
+  # returns the version of the Postjob queue.
+  def version
+    return "0.3.*" unless settings?
+
+    SQL.ask("SELECT value FROM postjob.settings WHERE name=$1", "version") || "unknown"
+  end
+end

data/spec/postjob/queue/search_spec.rb

@@ -19,32 +19,22 @@ module SearchWorkflow
   Postjob.register_workflow self
 end
 
-describe "Postjob::Queue::Search" do
-  let!(:id) { Postjob.enqueue! "SearchWorkflow", tags: { "initial" => "yay" } }
-
+describe "Postjob::Queue.search" do
   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
+    Simple::SQL.ask("DELETE FROM postjob.postjobs")
   end
 
-  def token
-    load_token(load_child_job)
-  end
+  let!(:id) { Postjob.enqueue! "SearchWorkflow", tags: { "initial" => "yay" } }
 
-  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
+  Queue = Postjob::Queue
 
-  describe "returned data shape" do
+  context "attributes" do
     it "returns a specific set of attributes" do
-      result = Search.one(id)
+      scope = Postjob::Queue.search(id: id)
+      result = Simple::SQL.ask scope, into: Hash
+
       expected_keys = [
         :id,
         :full_id,
@@ -59,81 +49,59 @@ describe "Postjob::Queue::Search" do
         :runtime,
         :tags
       ]
+      expect(result.keys).to include(*expected_keys)
+    end
+
+    it "with attributes: argument it only returns the specified attributes" do
+      scope = Postjob::Queue.search(attributes: %w(id))
+      result = Simple::SQL.ask scope, into: Hash
+
+      expected_keys = [
+        :id
+      ]
       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)
+  context "with multiple jobs" do
+    before do
+      Postjob.enqueue! "SearchWorkflow", tags: { "secondary" => "yay" }
+      expect(Simple::SQL.ask("SELECT COUNT(*) FROM postjob.postjobs")).to eq(2)
+    end
+
+    it "returns all entries" do
+      scope = Postjob::Queue.search
+      result = Simple::SQL.all(scope, into: OpenStruct)
+      expect(result.length).to eq(2)
     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)
+    it "sorts by id" do
+      scope = Postjob::Queue.search
+      result = Simple::SQL.all(scope, into: OpenStruct)
+
+      # Note that the second job has a id larger than the original job's id.
+      expect(result.first.id).to eq(id)
     end
   end
 
-  describe "search_all" do
+  describe "filtering" do
     it "can find a job by id" do
-      result = Search.all into: OpenStruct
-      expect(result.map(&:id)).to eq([id])
+      scope = Postjob::Queue.search(id: id)
+      result = Simple::SQL.ask scope, into: Hash
+      expect(result[: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
+    it "positive filters by tags" do
+      scope = Postjob::Queue.search("initial" => "yay")
+      result = Simple::SQL.all scope, into: OpenStruct
+      expect(result.length).to eq(1)
+      expect(result.first.id).to eq(id)
     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
+    it "negative filters by tags" do
+      scope = Postjob::Queue.search("initial" => "nay")
+      result = Simple::SQL.all(scope)
+      expect(result.length).to eq(0)
     end
   end
 end

data/spec/spec_helper.rb

@@ -29,6 +29,7 @@ RSpec.configure do |config|
   config.filter_run focus: (ENV["CI"] != "true")
   config.expect_with(:rspec) { |c| c.syntax = :expect }
   config.order = "random"
+  config.example_status_persistence_file_path = ".rspec.persistence"
 
   config.before(:all) {}
   config.after {}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postjob
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - radiospiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,7 +123,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -133,7 +133,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: simple-cli
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +210,7 @@ files:
 - lib/postjob/cli/job.rb
 - lib/postjob/cli/ps.rb
 - lib/postjob/cli/run.rb
+- lib/postjob/cli/version.rb
 - lib/postjob/error.rb
 - lib/postjob/job.rb
 - lib/postjob/migrations.rb
@@ -225,10 +226,12 @@ files:
 - lib/postjob/migrations/008_checkout_runnable.sql
 - lib/postjob/migrations/008a_childjobs.sql
 - lib/postjob/migrations/009_tokens.sql
+- lib/postjob/migrations/010_settings.sql
 - lib/postjob/queue.rb
 - lib/postjob/queue/encoder.rb
 - lib/postjob/queue/notifications.rb
 - lib/postjob/queue/search.rb
+- lib/postjob/queue/settings.rb
 - lib/postjob/registry.rb
 - lib/postjob/runner.rb
 - lib/postjob/workflow.rb