joblin 0.1.0

data/spec/uniqueness/support/lock_strategy.rb

@@ -0,0 +1,28 @@
+require 'uniqueness/spec_helper'
+
+RSpec.shared_context "lock strategy specs" do |strategy:|
+  include_context 'with TestWorker'
+
+  before(:each) { TestWorker.unique_job_options[:strategy] = strategy }
+
+  let(:context1) { Joblin::Uniqueness::LockContext.new({ jid: 'j1', queue: 'default', job_clazz: 'TestWorker'}) }
+  let(:context2) { Joblin::Uniqueness::LockContext.new({ jid: 'j2', queue: 'default', job_clazz: 'TestWorker'}) }
+
+  let(:process_one) { described_class.new(context1) }
+  let(:process_two) { described_class.new(context2) }
+end
+
+RSpec.shared_examples "a lock implementation" do
+  it "is unlocked when done" do
+    process_one.on_enqueue {}
+    did_lock = process_one.locked?
+
+    process_one.on_perform {}
+    did_lock ||= process_one.locked?
+
+    expect(did_lock).to be_truthy
+
+    process_one.batch_callback(:success, nil)
+    expect(process_one).not_to be_locked
+  end
+end

data/spec/uniqueness/support/on_conflict.rb

@@ -0,0 +1,24 @@
+
+RSpec.shared_context "on_conflict specs" do
+  include_context 'with TestWorker'
+  let(:lock_context) { Joblin::Uniqueness::LockContext.new({ jid: 'j1', queue: 'default', job_clazz: 'TestWorker'}) }
+  let(:on_conflict) { described_class.new(lock_context)}
+end
+
+RSpec.shared_examples "OnConflict is compatible with" do |lock_strategies|
+  it "is compatible with the expected Lock Strategies" do
+    lock_strategies.each do |lock_strategy|
+      Joblin::Uniqueness::OnConflict.validate!(described_class, lock_strategy)
+    end
+  end
+end
+
+RSpec.shared_examples "OnConflict is incompatible with" do |lock_strategies|
+  it "is not compatible with the expected Lock Strategies" do
+    lock_strategies.each do |lock_strategy|
+      expect do
+        Joblin::Uniqueness::OnConflict.validate!(described_class, lock_strategy)
+      end.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/uniqueness/support/test_worker.rb

@@ -0,0 +1,19 @@
+require 'uniqueness/spec_helper'
+
+RSpec.shared_context "with TestWorker" do
+  let!(:worker) do
+    Class.new do
+      include Sidekiq::Worker
+
+      ensure_uniqueness(
+        strategy: :until_executed,
+      )
+
+      def perform; end
+    end
+  end
+
+  before(:each) { stub_const('TestWorker', worker) }
+
+  let(:lock_context) { Joblin::Uniqueness::LockContext.new({ jid: 'j1', queue: 'default', job_clazz: 'TestWorker'}) }
+end

data/spec/uniqueness/unique_job_common_spec.rb

@@ -0,0 +1,45 @@
+require 'uniqueness/spec_helper'
+
+RSpec.describe Joblin::Uniqueness::UniqueJobCommon do
+  describe ".unlock!" do
+    include_context "with TestWorker"
+
+    it "unlocks the lock with a specific JID" do
+      jid = TestWorker.perform_async
+      lctx = Joblin::Uniqueness::LockContext.new({ jid: jid, queue: 'default', job_clazz: 'TestWorker'})
+      lstrat = lctx.lock_strategy
+      lsmith = lstrat.send(:locksmith)
+      expect(lsmith.locked?).to be_truthy
+
+      TestWorker.unlock!(jid, queue: 'default')
+      expect(lsmith.locked?).to be_falsey
+    end
+
+    it "unlocks the lock without a specific JID" do
+      jid = TestWorker.perform_async
+      lctx = Joblin::Uniqueness::LockContext.new({ jid: jid, queue: 'default', job_clazz: 'TestWorker'})
+      lstrat = lctx.lock_strategy
+      lsmith = lstrat.send(:locksmith)
+      expect(lsmith.locked?).to be_truthy
+
+      TestWorker.unlock!(queue: 'default')
+      expect(lsmith.locked?).to be_falsey
+    end
+
+    it "unlocks the lock matching parameters" do
+      args = [1, 2, 3]
+      jid = TestWorker.perform_async(*args)
+
+      lctx = Joblin::Uniqueness::LockContext.new({ jid: jid, queue: 'default', job_clazz: 'TestWorker', args: args})
+      lstrat = lctx.lock_strategy
+      lsmith = lstrat.send(:locksmith)
+      expect(lsmith.locked?).to be_truthy
+
+      TestWorker.unlock!(queue: 'default')
+      expect(lsmith.locked?).to be_truthy
+
+      TestWorker.unlock!(queue: 'default', args: args)
+      expect(lsmith.locked?).to be_falsey
+    end
+  end
+end

metadata

@@ -0,0 +1,308 @@
+--- !ruby/object:Gem::Specification
+name: joblin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ethan Knapp
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rediconn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: rspec-rails
+  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: pg
+  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: appraisal
+  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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+email:
+- eknapp@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/models/joblin/background_task.rb
+- app/models/joblin/background_task/api_access.rb
+- app/models/joblin/background_task/attachments.rb
+- app/models/joblin/background_task/executor.rb
+- app/models/joblin/background_task/options.rb
+- app/models/joblin/background_task/retention_policy.rb
+- app/models/joblin/concerns/job_working_dirs.rb
+- db/migrate/20250903184852_create_background_tasks.rb
+- joblin.gemspec
+- lib/joblin.rb
+- lib/joblin/batching/batch.rb
+- lib/joblin/batching/callback.rb
+- lib/joblin/batching/chain_builder.rb
+- lib/joblin/batching/compat.rb
+- lib/joblin/batching/compat/active_job.rb
+- lib/joblin/batching/compat/sidekiq.rb
+- lib/joblin/batching/compat/sidekiq/web.rb
+- lib/joblin/batching/compat/sidekiq/web/batches_assets/css/styles.less
+- lib/joblin/batching/compat/sidekiq/web/batches_assets/js/batch_tree.js
+- lib/joblin/batching/compat/sidekiq/web/batches_assets/js/util.js
+- lib/joblin/batching/compat/sidekiq/web/helpers.rb
+- lib/joblin/batching/compat/sidekiq/web/views/_batch_tree.erb
+- lib/joblin/batching/compat/sidekiq/web/views/_batches_table.erb
+- lib/joblin/batching/compat/sidekiq/web/views/_common.erb
+- lib/joblin/batching/compat/sidekiq/web/views/_jobs_table.erb
+- lib/joblin/batching/compat/sidekiq/web/views/_pagination.erb
+- lib/joblin/batching/compat/sidekiq/web/views/batch.erb
+- lib/joblin/batching/compat/sidekiq/web/views/batches.erb
+- lib/joblin/batching/compat/sidekiq/web/views/pool.erb
+- lib/joblin/batching/compat/sidekiq/web/views/pools.erb
+- lib/joblin/batching/context_hash.rb
+- lib/joblin/batching/hier_batch_ids.lua
+- lib/joblin/batching/jobs/base_job.rb
+- lib/joblin/batching/jobs/concurrent_batch_job.rb
+- lib/joblin/batching/jobs/managed_batch_job.rb
+- lib/joblin/batching/jobs/serial_batch_job.rb
+- lib/joblin/batching/pool.rb
+- lib/joblin/batching/pool_refill.lua
+- lib/joblin/batching/schedule_callback.lua
+- lib/joblin/batching/status.rb
+- lib/joblin/engine.rb
+- lib/joblin/lazy_access.rb
+- lib/joblin/uniqueness/compat.rb
+- lib/joblin/uniqueness/compat/active_job.rb
+- lib/joblin/uniqueness/compat/sidekiq.rb
+- lib/joblin/uniqueness/configuration.rb
+- lib/joblin/uniqueness/job_uniqueness.rb
+- lib/joblin/uniqueness/lock_context.rb
+- lib/joblin/uniqueness/locksmith.rb
+- lib/joblin/uniqueness/on_conflict.rb
+- lib/joblin/uniqueness/on_conflict/base.rb
+- lib/joblin/uniqueness/on_conflict/log.rb
+- lib/joblin/uniqueness/on_conflict/null_strategy.rb
+- lib/joblin/uniqueness/on_conflict/raise.rb
+- lib/joblin/uniqueness/on_conflict/reject.rb
+- lib/joblin/uniqueness/on_conflict/reschedule.rb
+- lib/joblin/uniqueness/strategy.rb
+- lib/joblin/uniqueness/strategy/base.rb
+- lib/joblin/uniqueness/strategy/until_and_while_executing.rb
+- lib/joblin/uniqueness/strategy/until_executed.rb
+- lib/joblin/uniqueness/strategy/until_executing.rb
+- lib/joblin/uniqueness/strategy/until_expired.rb
+- lib/joblin/uniqueness/strategy/while_executing.rb
+- lib/joblin/uniqueness/unique_job_common.rb
+- lib/joblin/version.rb
+- spec/batching/batch_spec.rb
+- spec/batching/callback_spec.rb
+- spec/batching/compat/active_job_spec.rb
+- spec/batching/compat/sidekiq_spec.rb
+- spec/batching/context_hash_spec.rb
+- spec/batching/flow_spec.rb
+- spec/batching/integration/fail_then_succeed.rb
+- spec/batching/integration/integration.rb
+- spec/batching/integration/nested.rb
+- spec/batching/integration/simple.rb
+- spec/batching/integration/workflow.rb
+- spec/batching/integration_helper.rb
+- spec/batching/pool_spec.rb
+- spec/batching/status_spec.rb
+- spec/batching/support/base_job.rb
+- spec/batching/support/sample_callback.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/config/storage.yml
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/test.log
+- spec/internal/public/favicon.ico
+- spec/models/background_task_spec.rb
+- spec/spec_helper.rb
+- spec/uniqueness/compat/active_job_spec.rb
+- spec/uniqueness/compat/sidekiq_spec.rb
+- spec/uniqueness/lock_context_spec.rb
+- spec/uniqueness/on_conflict/log_spec.rb
+- spec/uniqueness/on_conflict/raise_spec.rb
+- spec/uniqueness/on_conflict/reschedule_spec.rb
+- spec/uniqueness/on_conflict_spec.rb
+- spec/uniqueness/spec_helper.rb
+- spec/uniqueness/strategy/base_spec.rb
+- spec/uniqueness/strategy/until_and_while_executing_spec.rb
+- spec/uniqueness/strategy/until_executed_spec.rb
+- spec/uniqueness/strategy/until_executing_spec.rb
+- spec/uniqueness/strategy/until_expired_spec.rb
+- spec/uniqueness/strategy/while_executing_spec.rb
+- spec/uniqueness/support/lock_strategy.rb
+- spec/uniqueness/support/on_conflict.rb
+- spec/uniqueness/support/test_worker.rb
+- spec/uniqueness/unique_job_common_spec.rb
+homepage: https://instructure.com
+licenses: []
+metadata: {}
+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: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Gem for ActiveJob extensions
+test_files:
+- spec/batching/batch_spec.rb
+- spec/batching/callback_spec.rb
+- spec/batching/compat/active_job_spec.rb
+- spec/batching/compat/sidekiq_spec.rb
+- spec/batching/context_hash_spec.rb
+- spec/batching/flow_spec.rb
+- spec/batching/integration/fail_then_succeed.rb
+- spec/batching/integration/integration.rb
+- spec/batching/integration/nested.rb
+- spec/batching/integration/simple.rb
+- spec/batching/integration/workflow.rb
+- spec/batching/integration_helper.rb
+- spec/batching/pool_spec.rb
+- spec/batching/status_spec.rb
+- spec/batching/support/base_job.rb
+- spec/batching/support/sample_callback.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/config/storage.yml
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/test.log
+- spec/internal/public/favicon.ico
+- spec/models/background_task_spec.rb
+- spec/spec_helper.rb
+- spec/uniqueness/compat/active_job_spec.rb
+- spec/uniqueness/compat/sidekiq_spec.rb
+- spec/uniqueness/lock_context_spec.rb
+- spec/uniqueness/on_conflict/log_spec.rb
+- spec/uniqueness/on_conflict/raise_spec.rb
+- spec/uniqueness/on_conflict/reschedule_spec.rb
+- spec/uniqueness/on_conflict_spec.rb
+- spec/uniqueness/spec_helper.rb
+- spec/uniqueness/strategy/base_spec.rb
+- spec/uniqueness/strategy/until_and_while_executing_spec.rb
+- spec/uniqueness/strategy/until_executed_spec.rb
+- spec/uniqueness/strategy/until_executing_spec.rb
+- spec/uniqueness/strategy/until_expired_spec.rb
+- spec/uniqueness/strategy/while_executing_spec.rb
+- spec/uniqueness/support/lock_strategy.rb
+- spec/uniqueness/support/on_conflict.rb
+- spec/uniqueness/support/test_worker.rb
+- spec/uniqueness/unique_job_common_spec.rb