journaled 2.1.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7a10c3a016b77101958c098880bfcfab640b8277e93d80962a90fd6255c6c8
-  data.tar.gz: 54d9bfb3d13c97c2a40c6be9a9854ce3120671ae06fd9c9c251f766abd822215
+  metadata.gz: 895598e96b01aad6c51bd55355c5d7d0fab963b97326c2943bcb76450dd7cdb7
+  data.tar.gz: 61073882361fbb34ca243d8cc4dbedb494f798bcaaf2bde124f820eb8e175439
 SHA512:
-  metadata.gz: d3bed9db0a770ee95a10309d673ec7b7e3f3d8f7da59303d27bb17ce6e3920e9913e4a34e553fe9e4a99a395f16810c4784844e0161e78292c8383b00b55a9a5
-  data.tar.gz: 930ed61334d18351879b66ac8d36768e0cc0a9d982e1482c40fb313431f9c38ab624f1ad3f6c2797ca76e0c35b69f66a8051fc9e322a36661cacecb6e1d46a76
+  metadata.gz: 4564bc7e637fc2d032ee00b1f2b9e21282d65a531ae758ac374f863b1964100c3ea755db1e558c43d3503a74b995ffc310bb6343f255591357bf4d7ffe556e54
+  data.tar.gz: b456385727f88392465553ff9c63f313902536a9a13cae00fae011e40c7afb2490f3f5ff5fb1012346c18cedfb5cfabcbd20ed2dcaf1cd039dc27551d756647c

data/README.md

@@ -88,6 +88,29 @@ Journaling provides a number of different configuation options that can be set i
   This can be used to configure what `priority` the Delayed Jobs are enqueued with. This will be applied to all the Journaled::Devivery jobs that are created by this application.
   Ex: `Journaled.job_priority = 14`
 
+#### `Journaled.http_idle_timeout` (default: 1 second)
+
+  The number of seconds a persistent connection is allowed to sit idle before it should no longer be used.
+
+#### `Journaled.http_open_timeout` (default: 2 seconds)
+
+  The number of seconds before the :http_handler should timeout while trying to open a new HTTP session.
+
+#### `Journaled.http_read_timeout` (default: 60 seconds)
+
+  The number of seconds before the :http_handler should timeout while waiting for a HTTP response.
+
+#### DJ `enqueue` options
+
+Both model-level directives accept additional options to be passed into DelayedJob's `enqueue` method:
+
+```ruby
+# For change journaling:
+journal_changes_to :email, as: :identity_change, enqueue_with: { priority: 10 }
+
+# Or for custom journaling:
+journal_attributes :email, enqueue_with: { priority: 20, queue: 'journaled' }
+```
 
 ### Change Journaling
 

data/app/controllers/concerns/journaled/actor.rb

@@ -12,6 +12,7 @@ module Journaled::Actor
   class_methods do
     def journaled_actor=(method_name)
       raise "Must provide a symbol method name" unless method_name.is_a?(Symbol)
+
       self._journaled_actor_method_name = method_name
     end
   end

data/app/models/concerns/journaled/changes.rb

@@ -2,10 +2,9 @@ module Journaled::Changes
   extend ActiveSupport::Concern
 
   included do
-    cattr_accessor :_journaled_change_definitions
-    cattr_accessor :journaled_attribute_names
-    self._journaled_change_definitions = []
-    self.journaled_attribute_names = []
+    cattr_accessor(:_journaled_change_definitions) { [] }
+    cattr_accessor(:journaled_attribute_names) { [] }
+    cattr_accessor(:journaled_enqueue_opts, instance_writer: false) { {} }
 
     after_create do
       self.class._journaled_change_definitions.each do |definition|
@@ -57,7 +56,7 @@ module Journaled::Changes
   end
 
   class_methods do
-    def journal_changes_to(*attribute_names, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+    def journal_changes_to(*attribute_names, as:, enqueue_with: {}) # rubocop:disable Naming/UncommunicativeMethodParamName
       if attribute_names.empty? || attribute_names.any? { |n| !n.is_a?(Symbol) }
         raise "one or more symbol attribute_name arguments is required"
       end
@@ -66,6 +65,7 @@ module Journaled::Changes
 
       _journaled_change_definitions << Journaled::ChangeDefinition.new(attribute_names: attribute_names, logical_operation: as)
       journaled_attribute_names.concat(attribute_names)
+      journaled_enqueue_opts.merge!(enqueue_with)
     end
 
     if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 2)

data/app/models/journaled/change.rb

@@ -7,6 +7,7 @@ class Journaled::Change
     :logical_operation,
     :changes,
     :journaled_app_name,
+    :journaled_enqueue_opts,
     :actor
 
   journal_attributes :table_name,
@@ -16,12 +17,13 @@ class Journaled::Change
     :changes,
     :actor
 
-  def initialize(table_name:, # rubocop:disable Metrics/ParameterLists
+  def initialize(table_name:,
                  record_id:,
                  database_operation:,
                  logical_operation:,
                  changes:,
                  journaled_app_name:,
+                 journaled_enqueue_opts:,
                  actor:)
     @table_name = table_name
     @record_id = record_id
@@ -29,6 +31,7 @@ class Journaled::Change
     @logical_operation = logical_operation
     @changes = changes
     @journaled_app_name = journaled_app_name
+    @journaled_enqueue_opts = journaled_enqueue_opts
     @actor = actor
   end
 end

data/app/models/journaled/change_definition.rb

@@ -19,6 +19,7 @@ class Journaled::ChangeDefinition
 
         #{nonexistent_attribute_names.join(', ')}
     ERROR
+
     @validated = true
   end
 end

data/app/models/journaled/change_writer.rb

@@ -28,7 +28,8 @@ class Journaled::ChangeWriter
       logical_operation: logical_operation,
       changes: JSON.dump(changes),
       journaled_app_name: journaled_app_name,
-      actor: actor_uri
+      journaled_enqueue_opts: model.journaled_enqueue_opts,
+      actor: actor_uri,
     )
   end
 

data/app/models/journaled/delivery.rb

@@ -1,4 +1,4 @@
-class Journaled::Delivery
+class Journaled::Delivery # rubocop:disable Betterment/ActiveJobPerformable
   DEFAULT_REGION = 'us-east-1'.freeze
 
   def initialize(serialized_event:, partition_key:, app_name:)
@@ -25,7 +25,10 @@ class Journaled::Delivery
   def kinesis_client_config
     {
       region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION),
-      retry_limit: 0
+      retry_limit: 0,
+      http_idle_timeout: Journaled.http_idle_timeout,
+      http_open_timeout: Journaled.http_open_timeout,
+      http_read_timeout: Journaled.http_read_timeout,
     }.merge(credentials)
   end
 
@@ -37,7 +40,7 @@ class Journaled::Delivery
     {
       stream_name: stream_name,
       data: serialized_event,
-      partition_key: partition_key
+      partition_key: partition_key,
     }
   end
 
@@ -48,7 +51,7 @@ class Journaled::Delivery
   def credentials
     if ENV.key?('JOURNALED_IAM_ROLE_ARN')
       {
-        credentials: iam_assume_role_credentials
+        credentials: iam_assume_role_credentials,
       }
     else
       legacy_credentials_hash_if_present
@@ -59,7 +62,7 @@ class Journaled::Delivery
     if ENV.key?('RUBY_AWS_ACCESS_KEY_ID')
       {
         access_key_id: ENV.fetch('RUBY_AWS_ACCESS_KEY_ID'),
-        secret_access_key: ENV.fetch('RUBY_AWS_SECRET_ACCESS_KEY')
+        secret_access_key: ENV.fetch('RUBY_AWS_SECRET_ACCESS_KEY'),
       }
     else
       {}
@@ -68,7 +71,7 @@ class Journaled::Delivery
 
   def sts_client
     Aws::STS::Client.new({
-      region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION)
+      region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION),
     }.merge(legacy_credentials_hash_if_present))
   end
 
@@ -76,7 +79,7 @@ class Journaled::Delivery
     @iam_assume_role_credentials ||= Aws::AssumeRoleCredentials.new(
       client: sts_client,
       role_arn: ENV.fetch('JOURNALED_IAM_ROLE_ARN'),
-      role_session_name: "JournaledAssumeRoleAccess"
+      role_session_name: "JournaledAssumeRoleAccess",
     )
   end
 

data/app/models/journaled/event.rb

@@ -2,7 +2,7 @@ module Journaled::Event
   extend ActiveSupport::Concern
 
   def journal!
-    Journaled::Writer.new(journaled_event: self, priority: Journaled.job_priority).journal!
+    Journaled::Writer.new(journaled_event: self).journal!
   end
 
   # Base attributes
@@ -42,8 +42,9 @@ module Journaled::Event
   private
 
   class_methods do
-    def journal_attributes(*args)
+    def journal_attributes(*args, enqueue_with: {})
       journaled_attributes.concat(args)
+      journaled_enqueue_opts.merge!(enqueue_with)
     end
 
     def journaled_attributes
@@ -56,6 +57,8 @@ module Journaled::Event
   end
 
   included do
+    cattr_accessor(:journaled_enqueue_opts, instance_writer: false) { {} }
+
     journal_attributes :id, :event_type, :created_at
   end
 end

data/app/models/journaled/writer.rb

@@ -4,9 +4,10 @@ class Journaled::Writer
     journaled_partition_key
     journaled_attributes
     journaled_app_name
+    journaled_enqueue_opts
   ).freeze
 
-  def initialize(journaled_event:, priority:)
+  def initialize(journaled_event:)
     raise "An enqueued event must respond to: #{EVENT_METHOD_NAMES.to_sentence}" unless respond_to_all?(journaled_event, EVENT_METHOD_NAMES)
 
     unless journaled_event.journaled_schema_name.present? &&
@@ -21,25 +22,24 @@ class Journaled::Writer
     end
 
     @journaled_event = journaled_event
-    @priority = priority
   end
 
   def journal!
     base_event_json_schema_validator.validate! serialized_event
     json_schema_validator.validate! serialized_event
-    Delayed::Job.enqueue journaled_delivery, priority: priority
+    Journaled.enqueue!(journaled_delivery, journaled_enqueue_opts)
   end
 
   private
 
-  attr_reader :journaled_event, :priority
-  delegate :journaled_schema_name, :journaled_attributes, :journaled_partition_key, :journaled_app_name, to: :journaled_event
+  attr_reader :journaled_event
+  delegate(*EVENT_METHOD_NAMES, to: :journaled_event)
 
   def journaled_delivery
     @journaled_delivery ||= Journaled::Delivery.new(
       serialized_event: serialized_event,
       partition_key: journaled_partition_key,
-      app_name: journaled_app_name
+      app_name: journaled_app_name,
     )
   end
 

data/lib/journaled.rb

@@ -1,14 +1,17 @@
-require "aws-sdk-resources"
+require "aws-sdk-kinesis"
 require "delayed_job"
 require "json-schema"
 require "request_store"
 
 require "journaled/engine"
-require "journaled/job_priority"
+require 'journaled/enqueue'
 
 module Journaled
   mattr_accessor :default_app_name
-  mattr_accessor(:job_priority) { Journaled::JobPriority::EVENTUAL }
+  mattr_accessor(:job_priority) { 20 }
+  mattr_accessor(:http_idle_timeout) { 5 }
+  mattr_accessor(:http_open_timeout) { 2 }
+  mattr_accessor(:http_read_timeout) { 60 }
 
   def development_or_test?
     %w(development test).include?(Rails.env)

data/lib/journaled/enqueue.rb

@@ -0,0 +1,13 @@
+module Journaled
+  class << self
+    def enqueue!(*args)
+      delayed_job_enqueue(*args)
+    end
+
+    private
+
+    def delayed_job_enqueue(*args, **opts)
+      Delayed::Job.enqueue(*args, **opts.reverse_merge(priority: Journaled.job_priority))
+    end
+  end
+end

data/lib/journaled/relation_change_protection.rb

@@ -1,5 +1,5 @@
 module Journaled::RelationChangeProtection
-  def update_all(updates, force: false) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity
+  def update_all(updates, force: false) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
     unless force || !@klass.respond_to?(:journaled_attribute_names) || @klass.journaled_attribute_names.empty?
       conflicting_journaled_attribute_names = if updates.is_a?(Hash)
                                                 @klass.journaled_attribute_names & updates.keys.map(&:to_sym)

data/lib/journaled/version.rb

@@ -1,3 +1,3 @@
 module Journaled
-  VERSION = "2.1.1".freeze
+  VERSION = "2.5.0".freeze
 end

data/spec/lib/journaled_spec.rb

@@ -3,49 +3,50 @@ require 'rails_helper'
 RSpec.describe Journaled do
   it "is enabled in production" do
     allow(Rails).to receive(:env).and_return("production")
-    expect(Journaled).to be_enabled
+    expect(described_class).to be_enabled
   end
 
   it "is disabled in development" do
     allow(Rails).to receive(:env).and_return("development")
-    expect(Journaled).not_to be_enabled
+    expect(described_class).not_to be_enabled
   end
 
   it "is disabled in test" do
     allow(Rails).to receive(:env).and_return("test")
-    expect(Journaled).not_to be_enabled
+    expect(described_class).not_to be_enabled
   end
 
   it "is enabled in whatevs" do
     allow(Rails).to receive(:env).and_return("whatevs")
-    expect(Journaled).to be_enabled
+    expect(described_class).to be_enabled
   end
 
   it "is enabled when explicitly enabled in development" do
     with_env(JOURNALED_ENABLED: true) do
       allow(Rails).to receive(:env).and_return("development")
-      expect(Journaled).to be_enabled
+      expect(described_class).to be_enabled
     end
   end
 
   it "is disabled when explicitly disabled in production" do
     with_env(JOURNALED_ENABLED: false) do
       allow(Rails).to receive(:env).and_return("production")
-      expect(Journaled).not_to be_enabled
+      expect(described_class).not_to be_enabled
     end
   end
 
   it "is disabled when explicitly disabled with empty string" do
     with_env(JOURNALED_ENABLED: '') do
       allow(Rails).to receive(:env).and_return("production")
-      expect(Journaled).not_to be_enabled
+      expect(described_class).not_to be_enabled
     end
   end
 
   describe "#actor_uri" do
     it "delegates to ActorUriProvider" do
-      allow(Journaled::ActorUriProvider).to receive(:instance).and_return(double(actor_uri: "my actor uri"))
-      expect(Journaled.actor_uri).to eq "my actor uri"
+      allow(Journaled::ActorUriProvider).to receive(:instance)
+        .and_return(instance_double(Journaled::ActorUriProvider, actor_uri: "my actor uri"))
+      expect(described_class.actor_uri).to eq "my actor uri"
     end
   end
 end

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

@@ -17,6 +17,7 @@ RSpec.describe Journaled::Changes do
       def self.after_save(opts, &hook)
         # This is a back-door assertion to prevent regressions in the module's hook definition behavior
         raise "expected `unless: :saved_change_to_id?`" unless opts[:unless] == :saved_change_to_id?
+
         after_save_hooks << hook
       end
 
@@ -91,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

@@ -11,12 +11,13 @@ RSpec.describe Journaled::ChangeWriter do
         "name" => "bob",
         "rank" => "first lieutenant",
         "serial_number" => "foobar",
-        "last_sign_in_at" => now
+        "last_sign_in_at" => now,
       },
       saved_changes: {
         "name" => %w(bill bob),
-        "last_sign_in_at" => now
-      }
+        "last_sign_in_at" => now,
+      },
+      journaled_enqueue_opts: {},
     )
   end
 
@@ -24,21 +25,21 @@ RSpec.describe Journaled::ChangeWriter do
     double(
       "SoldierClass",
       table_name: "soldiers",
-      attribute_names: %w(id name rank serial_number last_sign_in_at)
+      attribute_names: %w(id name rank serial_number last_sign_in_at),
     )
   end
 
   let(:change_definition) do
     Journaled::ChangeDefinition.new(
       attribute_names: %i(name rank serial_number),
-      logical_operation: "identity_change"
+      logical_operation: "identity_change",
     )
   end
 
   let(:faulty_change_definition) do
     Journaled::ChangeDefinition.new(
       attribute_names: %i(name rank serial_number nonexistent_thingie),
-      logical_operation: "identity_change"
+      logical_operation: "identity_change",
     )
   end
 
@@ -58,9 +59,10 @@ RSpec.describe Journaled::ChangeWriter do
           "name" => "bill",
           "rank" => "first lieutenant",
           "serial_number" => "foobar",
-          "last_sign_in_at" => Time.zone.now
+          "last_sign_in_at" => Time.zone.now,
         },
-        saved_changes: {}
+        saved_changes: {},
+        journaled_enqueue_opts: {},
       )
     end
 
@@ -68,7 +70,7 @@ RSpec.describe Journaled::ChangeWriter do
       expect(subject.relevant_attributes).to eq(
         "name" => "bill",
         "rank" => "first lieutenant",
-        "serial_number" => "foobar"
+        "serial_number" => "foobar",
       )
     end
   end
@@ -83,11 +85,12 @@ RSpec.describe Journaled::ChangeWriter do
           "name" => "bill",
           "rank" => "first lieutenant",
           "serial_number" => "foobar",
-          "last_sign_in_at" => Time.zone.now
+          "last_sign_in_at" => Time.zone.now,
         },
         changes: {
-          "name" => %w(bob bill)
-        }
+          "name" => %w(bob bill),
+        },
+        journaled_enqueue_opts: {},
       )
     end
 
@@ -95,7 +98,7 @@ RSpec.describe Journaled::ChangeWriter do
       expect(subject.relevant_unperturbed_attributes).to eq(
         "name" => "bob",
         "rank" => "first lieutenant",
-        "serial_number" => "foobar"
+        "serial_number" => "foobar",
       )
     end
   end
@@ -180,9 +183,10 @@ RSpec.describe Journaled::ChangeWriter do
             "name" => "bill",
             "rank" => "first lieutenant",
             "serial_number" => "foobar",
-            "last_sign_in_at" => Time.zone.now
+            "last_sign_in_at" => Time.zone.now,
           },
-          saved_changes: {}
+          saved_changes: {},
+          journaled_enqueue_opts: {},
         )
       end
 
@@ -222,9 +226,9 @@ RSpec.describe Journaled::ChangeWriter do
               "name" => "bill",
               "rank" => "first lieutenant",
               "serial_number" => "foobar",
-              "last_sign_in_at" => Time.zone.now
+              "last_sign_in_at" => Time.zone.now,
             },
-            saved_changes: {}
+            saved_changes: {},
           )
         end
 
@@ -248,11 +252,12 @@ RSpec.describe Journaled::ChangeWriter do
             "name" => "bob",
             "rank" => "first lieutenant",
             "serial_number" => "foobar",
-            "last_sign_in_at" => now
+            "last_sign_in_at" => now,
           },
           changes: {
-            "name" => %w(bill bob)
-          }
+            "name" => %w(bill bob),
+          },
+          journaled_enqueue_opts: {},
         )
       end
 
@@ -261,7 +266,7 @@ RSpec.describe Journaled::ChangeWriter do
           expect(JSON.parse(opts[:changes])).to eq(
             "name" => "bill",
             "rank" => "first lieutenant",
-            "serial_number" => "foobar"
+            "serial_number" => "foobar",
           )
           journaled_change
         end