journaled 2.2.0 → 3.0.0

data/spec/models/journaled/change_writer_spec.rb

@@ -17,6 +17,7 @@ RSpec.describe Journaled::ChangeWriter do
         "name" => %w(bill bob),
         "last_sign_in_at" => now,
       },
+      journaled_enqueue_opts: {},
     )
   end
 
@@ -61,6 +62,7 @@ RSpec.describe Journaled::ChangeWriter do
           "last_sign_in_at" => Time.zone.now,
         },
         saved_changes: {},
+        journaled_enqueue_opts: {},
       )
     end
 
@@ -88,6 +90,7 @@ RSpec.describe Journaled::ChangeWriter do
         changes: {
           "name" => %w(bob bill),
         },
+        journaled_enqueue_opts: {},
       )
     end
 
@@ -183,6 +186,7 @@ RSpec.describe Journaled::ChangeWriter do
             "last_sign_in_at" => Time.zone.now,
           },
           saved_changes: {},
+          journaled_enqueue_opts: {},
         )
       end
 
@@ -253,6 +257,7 @@ RSpec.describe Journaled::ChangeWriter do
           changes: {
             "name" => %w(bill bob),
           },
+          journaled_enqueue_opts: {},
         )
       end
 

data/spec/models/journaled/delivery_spec.rb

@@ -185,5 +185,38 @@ RSpec.describe Journaled::Delivery do
         expect(subject.kinesis_client_config).to include(access_key_id: 'key_id', secret_access_key: 'secret')
       end
     end
+
+    it "will set http_idle_timeout by default" do
+      expect(subject.kinesis_client_config).to include(http_idle_timeout: 5)
+    end
+
+    it "will set http_open_timeout by default" do
+      expect(subject.kinesis_client_config).to include(http_open_timeout: 2)
+    end
+
+    it "will set http_read_timeout by default" do
+      expect(subject.kinesis_client_config).to include(http_read_timeout: 60)
+    end
+
+    context "when Journaled.http_idle_timeout is specified" do
+      it "will set http_idle_timeout by specified value" do
+        allow(Journaled).to receive(:http_idle_timeout).and_return(2)
+        expect(subject.kinesis_client_config).to include(http_idle_timeout: 2)
+      end
+    end
+
+    context "when Journaled.http_open_timeout is specified" do
+      it "will set http_open_timeout by specified value" do
+        allow(Journaled).to receive(:http_open_timeout).and_return(1)
+        expect(subject.kinesis_client_config).to include(http_open_timeout: 1)
+      end
+    end
+
+    context "when Journaled.http_read_timeout is specified" do
+      it "will set http_read_timeout by specified value" do
+        allow(Journaled).to receive(:http_read_timeout).and_return(2)
+        expect(subject.kinesis_client_config).to include(http_read_timeout: 2)
+      end
+    end
   end
 end

data/spec/models/journaled/event_spec.rb

@@ -25,22 +25,7 @@ RSpec.describe Journaled::Event do
       it 'creates a Journaled::Writer with this event and journals it with the default priority' do
         sample_journaled_event.journal!
         expect(Journaled::Writer).to have_received(:new)
-          .with(journaled_event: sample_journaled_event, priority: Journaled::JobPriority::EVENTUAL)
-        expect(mock_journaled_writer).to have_received(:journal!)
-      end
-    end
-
-    context 'when there is an app job priority is set' do
-      around do |example|
-        orig_priority = Journaled.job_priority
-        Journaled.job_priority = 13
-        example.run
-        Journaled.job_priority = orig_priority
-      end
-
-      it 'creates a Journaled::Writer with this event and journals it with the given priority' do
-        sample_journaled_event.journal!
-        expect(Journaled::Writer).to have_received(:new).with(journaled_event: sample_journaled_event, priority: 13)
+          .with(journaled_event: sample_journaled_event)
         expect(mock_journaled_writer).to have_received(:journal!)
       end
     end
@@ -150,4 +135,26 @@ RSpec.describe Journaled::Event do
       end
     end
   end
+
+  describe '#journaled_enqueue_opts, .journaled_enqueue_opts' do
+    it 'defaults to an empty hash' do
+      expect(sample_journaled_event.journaled_enqueue_opts).to eq({})
+      expect(sample_journaled_event_class.journaled_enqueue_opts).to eq({})
+    end
+
+    context 'when there are custom opts provided' do
+      let(:sample_journaled_event_class) do
+        Class.new do
+          include Journaled::Event
+
+          journal_attributes :foo, enqueue_with: { priority: 34, foo: 'bar' }
+        end
+      end
+
+      it 'merges in the custom opts' do
+        expect(sample_journaled_event.journaled_enqueue_opts).to eq(priority: 34, foo: 'bar')
+        expect(sample_journaled_event_class.journaled_enqueue_opts).to eq(priority: 34, foo: 'bar')
+      end
+    end
+  end
 end

data/spec/models/journaled/writer_spec.rb

@@ -1,7 +1,7 @@
 require 'rails_helper'
 
 RSpec.describe Journaled::Writer do
-  subject { described_class.new journaled_event: journaled_event, priority: Journaled::JobPriority::EVENTUAL }
+  subject { described_class.new journaled_event: journaled_event }
 
   describe '#initialize' do
     context 'when the Journaled Event does not implement all the necessary methods' do
@@ -19,6 +19,7 @@ RSpec.describe Journaled::Writer do
           journaled_attributes: {},
           journaled_partition_key: '',
           journaled_app_name: nil,
+          journaled_enqueue_opts: {},
         )
       end
 
@@ -34,6 +35,7 @@ RSpec.describe Journaled::Writer do
           journaled_attributes: { foo: :bar },
           journaled_partition_key: 'fake_partition_key',
           journaled_app_name: nil,
+          journaled_enqueue_opts: {},
         )
       end
 
@@ -67,25 +69,23 @@ RSpec.describe Journaled::Writer do
       allow(File).to receive(:read).with(schema_path).and_return(schema_file_contents)
     end
 
+    let(:journaled_enqueue_opts) { {} }
     let(:journaled_event) do
       double(
         journaled_schema_name: :fake_schema_name,
         journaled_attributes: journaled_event_attributes,
         journaled_partition_key: 'fake_partition_key',
         journaled_app_name: 'my_app',
+        journaled_enqueue_opts: journaled_enqueue_opts,
       )
     end
 
-    around do |example|
-      with_jobs_delayed { example.run }
-    end
-
     context 'when the journaled event does NOT comply with the base_event schema' do
       let(:journaled_event_attributes) { { foo: 1 } }
 
       it 'raises an error and does not enqueue anything' do
         expect { subject.journal! }.to raise_error JSON::Schema::ValidationError
-        expect(Delayed::Job.where('handler like ?', '%Journaled::Delivery%').count).to eq 0
+        expect(enqueued_jobs.count).to eq 0
       end
     end
 
@@ -95,7 +95,7 @@ RSpec.describe Journaled::Writer do
 
         it 'raises an error and does not enqueue anything' do
           expect { subject.journal! }.to raise_error JSON::Schema::ValidationError
-          expect(Delayed::Job.where('handler like ?', '%Journaled::Delivery%').count).to eq 0
+          expect(enqueued_jobs.count).to eq 0
         end
       end
 
@@ -103,23 +103,39 @@ RSpec.describe Journaled::Writer do
         let(:journaled_event_attributes) { { id: 'FAKE_UUID', event_type: 'fake_event', created_at: Time.zone.now, foo: :bar } }
 
         it 'creates a delivery with the app name passed through' do
-          allow(Journaled::Delivery).to receive(:new).and_call_original
-          subject.journal!
-          expect(Journaled::Delivery).to have_received(:new).with(hash_including(app_name: 'my_app'))
+          expect { subject.journal! }.to change { enqueued_jobs.count }.from(0).to(1)
+          expect(enqueued_jobs.first[:args].first).to include('app_name' => 'my_app')
         end
 
-        it 'enqueues a Journaled::Delivery object with the serialized journaled_event at the lowest priority' do
-          expect { subject.journal! }.to change {
-            Delayed::Job.where('handler like ?', '%Journaled::Delivery%').where(priority: Journaled::JobPriority::EVENTUAL).count
-          }.from(0).to(1)
+        context 'when there is no job priority specified in the enqueue opts' do
+          around do |example|
+            old_priority = Journaled.job_priority
+            Journaled.job_priority = 999
+            example.run
+            Journaled.job_priority = old_priority
+          end
+
+          it 'defaults to the global default' do
+            expect { subject.journal! }.to change {
+              if Rails::VERSION::MAJOR < 6
+                enqueued_jobs.select { |j| j[:job] == Journaled::DeliveryJob }.count
+              else
+                enqueued_jobs.select { |j| j['job_class'] == 'Journaled::DeliveryJob' && j['priority'] == 999 }.count
+              end
+            }.from(0).to(1)
+          end
         end
 
-        context 'when the Writer was initialized with a priority' do
-          subject { described_class.new journaled_event: journaled_event, priority: Journaled::JobPriority::INTERACTIVE }
+        context 'when there is a job priority specified in the enqueue opts' do
+          let(:journaled_enqueue_opts) { { priority: 13 } }
 
-          it 'enqueues the event at the given priority' do
+          it 'enqueues a Journaled::DeliveryJob with the given priority' do
             expect { subject.journal! }.to change {
-              Delayed::Job.where('handler like ?', '%Journaled::Delivery%').where(priority: Journaled::JobPriority::INTERACTIVE).count
+              if Rails::VERSION::MAJOR < 6
+                enqueued_jobs.select { |j| j[:job] == Journaled::DeliveryJob }.count
+              else
+                enqueued_jobs.select { |j| j['job_class'] == 'Journaled::DeliveryJob' && j['priority'] == 13 }.count
+              end
             }.from(0).to(1)
           end
         end

data/spec/rails_helper.rb

@@ -6,7 +6,6 @@ require 'rspec/rails'
 require 'timecop'
 require 'webmock/rspec'
 require 'journaled/rspec'
-require 'pry-rails'
 
 Dir[Rails.root.join('..', 'support', '**', '*.rb')].each { |f| require f }
 
@@ -15,6 +14,6 @@ RSpec.configure do |config|
 
   config.infer_spec_type_from_file_location!
 
-  config.include DelayedJobSpecHelper
+  config.include ActiveJob::TestHelper
   config.include EnvironmentSpecHelper
 end

data/spec/spec_helper.rb

@@ -1,9 +1,7 @@
-require 'delayed_job_active_record'
 rails_env = ENV['RAILS_ENV'] ||= 'test'
-db_adapter = ENV['DB_ADAPTER'] ||= 'postgresql'
 require File.expand_path('dummy/config/environment.rb', __dir__)
 
-Rails.configuration.database_configuration[db_adapter][rails_env].tap do |c|
+Rails.configuration.database_configuration[rails_env].tap do |c|
   ActiveRecord::Tasks::DatabaseTasks.create(c)
   ActiveRecord::Base.establish_connection(c)
   load File.expand_path('dummy/db/schema.rb', __dir__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,24 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-resources
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: delayed_job
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -41,6 +41,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-kinesis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -104,21 +118,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: delayed_job_active_record
-  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
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -132,7 +132,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-rails
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,21 +146,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop-betterment
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: spring
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -174,21 +174,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-betterment
-  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'
-- !ruby/object:Gem::Dependency
-  name: spring
+  name: spring-commands-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -202,7 +188,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spring-commands-rspec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -258,6 +244,8 @@ files:
 - README.md
 - Rakefile
 - app/controllers/concerns/journaled/actor.rb
+- app/jobs/journaled/application_job.rb
+- app/jobs/journaled/delivery_job.rb
 - app/models/concerns/journaled/changes.rb
 - app/models/journaled/actor_uri_provider.rb
 - app/models/journaled/change.rb
@@ -269,13 +257,11 @@ files:
 - app/models/journaled/not_truly_exceptional_error.rb
 - app/models/journaled/writer.rb
 - config/initializers/change_protection.rb
-- config/routes.rb
 - config/spring.rb
 - journaled_schemas/base_event.json
 - journaled_schemas/journaled/change.json
 - lib/journaled.rb
 - lib/journaled/engine.rb
-- lib/journaled/job_priority.rb
 - lib/journaled/relation_change_protection.rb
 - lib/journaled/rspec.rb
 - lib/journaled/version.rb
@@ -290,9 +276,7 @@ files:
 - spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
 - spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
@@ -303,14 +287,12 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
-- spec/dummy/db/migrate/20180606205114_create_delayed_jobs.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/jobs/journaled/delivery_job_spec.rb
 - spec/lib/journaled_spec.rb
 - spec/models/concerns/journaled/actor_spec.rb
 - spec/models/concerns/journaled/changes_spec.rb
@@ -323,7 +305,6 @@ files:
 - spec/models/journaled/writer_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
-- spec/support/delayed_job_spec_helper.rb
 - spec/support/environment_spec_helper.rb
 homepage: http://github.com/Betterment/journaled
 licenses:
@@ -344,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Journaling for Betterment apps.
@@ -356,7 +337,6 @@ test_files:
 - spec/dummy/config/secrets.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/locales/en.yml
-- spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/environment.rb
@@ -368,7 +348,6 @@ test_files:
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config.ru
@@ -378,9 +357,6 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/404.html
 - spec/dummy/db/schema.rb
-- spec/dummy/db/migrate/20180606205114_create_delayed_jobs.rb
-- spec/dummy/log/test.log
-- spec/dummy/log/development.log
 - spec/dummy/README.rdoc
 - spec/models/journaled/json_schema_model/validator_spec.rb
 - spec/models/journaled/actor_uri_provider_spec.rb
@@ -391,7 +367,7 @@ test_files:
 - spec/models/database_change_protection_spec.rb
 - spec/models/concerns/journaled/changes_spec.rb
 - spec/models/concerns/journaled/actor_spec.rb
-- spec/support/delayed_job_spec_helper.rb
 - spec/support/environment_spec_helper.rb
 - spec/lib/journaled_spec.rb
+- spec/jobs/journaled/delivery_job_spec.rb
 - spec/rails_helper.rb