journaled 2.2.0 → 2.3.0

data/spec/models/concerns/journaled/changes_spec.rb

@@ -92,4 +92,15 @@ RSpec.describe Journaled::Changes do
     expect(change_writer).to have_received(:delete)
     expect(Journaled::ChangeWriter).to have_received(:new)
   end
+
+  context 'when DJ opts are provided' do
+    before do
+      klass.journal_changes_to :thing, as: :other_thing, enqueue_with: { asdf: 1, foo: 'bar' }
+    end
+
+    it 'sets them on the model' do
+      expect(klass.journaled_enqueue_opts).to eq(asdf: 1, foo: 'bar')
+      expect(klass.new.journaled_enqueue_opts).to eq(asdf: 1, foo: 'bar')
+    end
+  end
 end

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/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,12 +69,14 @@ 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
 
@@ -108,18 +112,27 @@ RSpec.describe Journaled::Writer do
           expect(Journaled::Delivery).to have_received(:new).with(hash_including(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 {
+              Delayed::Job.where('handler like ?', '%Journaled::Delivery%').where(priority: 999).count
+            }.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::Delivery object with the given priority' do
             expect { subject.journal! }.to change {
-              Delayed::Job.where('handler like ?', '%Journaled::Delivery%').where(priority: Journaled::JobPriority::INTERACTIVE).count
+              Delayed::Job.where('handler like ?', '%Journaled::Delivery%').where(priority: 13).count
             }.from(0).to(1)
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -215,6 +215,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +289,7 @@ files:
 - journaled_schemas/journaled/change.json
 - lib/journaled.rb
 - lib/journaled/engine.rb
-- lib/journaled/job_priority.rb
+- lib/journaled/enqueue.rb
 - lib/journaled/relation_change_protection.rb
 - lib/journaled/rspec.rb
 - lib/journaled/version.rb
@@ -344,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Journaling for Betterment apps.

data/lib/journaled/job_priority.rb

@@ -1,5 +0,0 @@
-module Journaled::JobPriority
-  INTERACTIVE = 0 # These jobs will actively hinder end-user interactions until complete, e.g. assembling a report a user is polling for.
-  USER_VISIBLE = 10 # These jobs have end-user-visible side effects that will not obviously impact customers, e.g. welcome emails
-  EVENTUAL = 20 # These jobs affect business process that are tolerant to some degree of queue backlog, e.g. desk record synchronization
-end