journaled 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 895598e96b01aad6c51bd55355c5d7d0fab963b97326c2943bcb76450dd7cdb7
-  data.tar.gz: 61073882361fbb34ca243d8cc4dbedb494f798bcaaf2bde124f820eb8e175439
+  metadata.gz: 358c3ced2b976724c62e951ca88b635709d1fb7da0276ed4538bdc44bc02f468
+  data.tar.gz: ca65a5b0531ba4540de1b79fd36d247c7c164f3aef8b397254ed7b34503ebf0f
 SHA512:
-  metadata.gz: 4564bc7e637fc2d032ee00b1f2b9e21282d65a531ae758ac374f863b1964100c3ea755db1e558c43d3503a74b995ffc310bb6343f255591357bf4d7ffe556e54
-  data.tar.gz: b456385727f88392465553ff9c63f313902536a9a13cae00fae011e40c7afb2490f3f5ff5fb1012346c18cedfb5cfabcbd20ed2dcaf1cd039dc27551d756647c
+  metadata.gz: 236c6169ef41b1af9043f2549248ae43fad665a91d43cdd2f579e891685788aa5a008cf4f1dc8aba13abcce5dccfa6513c82232fdaaf3ab4f42f8a7b1b222bf7
+  data.tar.gz: 9e325f6c1e41eb577f5e0d7320517f5435b9570d7b0274c5b6ad9c593abc2a4a66dc6b6eb10d668617e645e5731804ecd65d4b6403fda63005de129443ed9332

data/README.md

@@ -1,16 +1,16 @@
 # Journaled
 
-A Rails engine to durably deliver schematized events to Amazon Kinesis via DelayedJob.
+A Rails engine to durably deliver schematized events to Amazon Kinesis via ActiveJob.
 
 More specifically, `journaled` is composed of three opinionated pieces:
 schema definition/validation via JSON Schema, transactional enqueueing
-via Delayed::Job (specifically `delayed_job_active_record`), and event
+via ActiveJob (specifically, via a DB-backed queue adapter), and event
 transmission via Amazon Kinesis. Our current use-cases include
 transmitting audit events for durable storage in S3 and/or analytical
 querying in Amazon Redshift.
 
 Journaled provides an at-least-once event delivery guarantee assuming
-Delayed::Job is configured not to delete jobs on failure.
+ActiveJob's queue adapter is not configured to delete jobs on failure.
 
 Note: Do not use the journaled gem to build an event sourcing solution
 as it does not guarantee total ordering of events. It's possible we'll
@@ -20,9 +20,20 @@ durable, eventually consistent record that discrete events happened.
 
 ## Installation
 
-1. [Install `delayed_job_active_record`](https://github.com/collectiveidea/delayed_job_active_record#installation)
-if you haven't already.
+1. If you haven't already,
+[configure ActiveJob](https://guides.rubyonrails.org/active_job_basics.html)
+to use one of the following queue adapters:
 
+- `:delayed_job` (via `delayed_job_active_record`)
+- `:que`
+- `:good_job`
+- `:delayed`
+
+Ensure that your queue adapter is not configured to delete jobs on failure.
+
+**If you launch your application in production mode and the gem detects that
+`ActiveJob::Base.queue_adapter` is not in the above list, it will raise an exception
+and prevent your application from performing unsafe journaling.**
 
 2. To integrate Journaled into your application, simply include the gem in your
 app's Gemfile.
@@ -85,9 +96,11 @@ Journaling provides a number of different configuation options that can be set i
 
 #### `Journaled.job_priority` (default: 20)
 
-  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.
+  This can be used to configure what `priority` the ActiveJobs are enqueued with. This will be applied to all the `Journaled::DeliveryJob`s that are created by this application.
   Ex: `Journaled.job_priority = 14`
 
+  _Note that job priority is only supported on Rails 6.0+. Prior Rails versions will ignore this parameter and enqueue jobs with the underlying ActiveJob adapter's default priority._
+
 #### `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.
@@ -100,9 +113,9 @@ Journaling provides a number of different configuation options that can be set i
 
   The number of seconds before the :http_handler should timeout while waiting for a HTTP response.
 
-#### DJ `enqueue` options
+#### ActiveJob `set` options
 
-Both model-level directives accept additional options to be passed into DelayedJob's `enqueue` method:
+Both model-level directives accept additional options to be passed into ActiveJob's `set` method:
 
 ```ruby
 # For change journaling:

data/Rakefile

@@ -28,7 +28,13 @@ if %w(development test).include? Rails.env
   RuboCop::RakeTask.new
 
   task(:default).clear
-  task default: %i(rubocop spec)
+  if ENV['APPRAISAL_INITIALIZED'] || ENV['CI']
+    task default: %i(rubocop spec)
+  else
+    require 'appraisal'
+    Appraisal::Task.new
+    task default: :appraisal
+  end
 
   task 'db:test:prepare' => 'db:setup'
 end

data/app/jobs/journaled/application_job.rb

@@ -0,0 +1,4 @@
+module Journaled
+  class ApplicationJob < Journaled.job_base_class_name.constantize
+  end
+end

data/app/jobs/journaled/delivery_job.rb

@@ -0,0 +1,96 @@
+module Journaled
+  class DeliveryJob < ApplicationJob
+    DEFAULT_REGION = 'us-east-1'.freeze
+
+    rescue_from(Aws::Kinesis::Errors::InternalFailure, Aws::Kinesis::Errors::ServiceUnavailable, Aws::Kinesis::Errors::Http503Error) do |e|
+      Rails.logger.error "Kinesis Error - Server Error occurred - #{e.class}"
+      raise KinesisTemporaryFailure
+    end
+
+    rescue_from(Seahorse::Client::NetworkingError) do |e|
+      Rails.logger.error "Kinesis Error - Networking Error occurred - #{e.class}"
+      raise KinesisTemporaryFailure
+    end
+
+    def perform(serialized_event:, partition_key:, app_name:)
+      @serialized_event = serialized_event
+      @partition_key = partition_key
+      @app_name = app_name
+
+      journal!
+    end
+
+    def self.stream_name(app_name:)
+      env_var_name = [app_name&.upcase, 'JOURNALED_STREAM_NAME'].compact.join('_')
+      ENV.fetch(env_var_name)
+    end
+
+    def kinesis_client_config
+      {
+        region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION),
+        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
+
+    private
+
+    attr_reader :serialized_event, :partition_key, :app_name
+
+    def journal!
+      kinesis_client.put_record record if Journaled.enabled?
+    end
+
+    def record
+      {
+        stream_name: self.class.stream_name(app_name: app_name),
+        data: serialized_event,
+        partition_key: partition_key,
+      }
+    end
+
+    def kinesis_client
+      Aws::Kinesis::Client.new(kinesis_client_config)
+    end
+
+    def credentials
+      if ENV.key?('JOURNALED_IAM_ROLE_ARN')
+        {
+          credentials: iam_assume_role_credentials,
+        }
+      else
+        legacy_credentials_hash_if_present
+      end
+    end
+
+    def legacy_credentials_hash_if_present
+      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'),
+        }
+      else
+        {}
+      end
+    end
+
+    def sts_client
+      Aws::STS::Client.new({
+        region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION),
+      }.merge(legacy_credentials_hash_if_present))
+    end
+
+    def iam_assume_role_credentials
+      @iam_assume_role_credentials ||= Aws::AssumeRoleCredentials.new(
+        client: sts_client,
+        role_arn: ENV.fetch('JOURNALED_IAM_ROLE_ARN'),
+        role_session_name: "JournaledAssumeRoleAccess",
+      )
+    end
+
+    class KinesisTemporaryFailure < NotTrulyExceptionalError
+    end
+  end
+end

data/app/models/journaled/delivery.rb

@@ -83,6 +83,6 @@ class Journaled::Delivery # rubocop:disable Betterment/ActiveJobPerformable
     )
   end
 
-  class KinesisTemporaryFailure < NotTrulyExceptionalError
+  class KinesisTemporaryFailure < ::Journaled::NotTrulyExceptionalError
   end
 end

data/app/models/journaled/writer.rb

@@ -27,7 +27,9 @@ class Journaled::Writer
   def journal!
     base_event_json_schema_validator.validate! serialized_event
     json_schema_validator.validate! serialized_event
-    Journaled.enqueue!(journaled_delivery, journaled_enqueue_opts)
+    Journaled::DeliveryJob
+      .set(journaled_enqueue_opts.reverse_merge(priority: Journaled.job_priority))
+      .perform_later(delivery_perform_args)
   end
 
   private
@@ -35,12 +37,12 @@ class Journaled::Writer
   attr_reader :journaled_event
   delegate(*EVENT_METHOD_NAMES, to: :journaled_event)
 
-  def journaled_delivery
-    @journaled_delivery ||= Journaled::Delivery.new(
+  def delivery_perform_args
+    {
       serialized_event: serialized_event,
       partition_key: journaled_partition_key,
       app_name: journaled_app_name,
-    )
+    }
   end
 
   def serialized_event

data/lib/journaled.rb

@@ -1,17 +1,19 @@
 require "aws-sdk-kinesis"
-require "delayed_job"
+require "active_job"
 require "json-schema"
 require "request_store"
 
 require "journaled/engine"
-require 'journaled/enqueue'
 
 module Journaled
+  SUPPORTED_QUEUE_ADAPTERS = %w(delayed delayed_job good_job que).freeze
+
   mattr_accessor :default_app_name
   mattr_accessor(:job_priority) { 20 }
   mattr_accessor(:http_idle_timeout) { 5 }
   mattr_accessor(:http_open_timeout) { 2 }
   mattr_accessor(:http_read_timeout) { 60 }
+  mattr_accessor(:job_base_class_name) { 'ActiveJob::Base' }
 
   def development_or_test?
     %w(development test).include?(Rails.env)
@@ -33,5 +35,21 @@ module Journaled
     Journaled::ActorUriProvider.instance.actor_uri
   end
 
-  module_function :development_or_test?, :enabled?, :schema_providers, :commit_hash, :actor_uri
+  def detect_queue_adapter!
+    adapter = job_base_class_name.constantize.queue_adapter.class.name.split('::').last.underscore.gsub("_adapter", "")
+    unless SUPPORTED_QUEUE_ADAPTERS.include?(adapter)
+      raise <<~MSG
+        Journaled has detected an unsupported ActiveJob queue adapter: `:#{adapter}`
+
+        Journaled jobs must be enqueued transactionally to your primary database.
+
+        Please install the appropriate gems and set `queue_adapter` to one of the following:
+        #{SUPPORTED_QUEUE_ADAPTERS.map { |a| "- `:#{a}`" }.join("\n")}
+
+        Read more at https://github.com/Betterment/journaled
+      MSG
+    end
+  end
+
+  module_function :development_or_test?, :enabled?, :schema_providers, :commit_hash, :actor_uri, :detect_queue_adapter!
 end

data/lib/journaled/engine.rb

@@ -1,4 +1,9 @@
 module Journaled
   class Engine < ::Rails::Engine
+    config.after_initialize do
+      ActiveSupport.on_load(:active_job) do
+        Journaled.detect_queue_adapter! unless Journaled.development_or_test?
+      end
+    end
   end
 end

data/lib/journaled/version.rb

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

data/spec/dummy/config/application.rb

@@ -1,10 +1,9 @@
 require File.expand_path('boot', __dir__)
 
 require "active_record/railtie"
+require "active_job/railtie"
 require "active_model/railtie"
 require "action_controller/railtie"
-require "action_mailer/railtie"
-require "sprockets/railtie"
 
 Bundler.require(*Rails.groups)
 require "journaled"

data/spec/dummy/config/database.yml

@@ -1,21 +1,6 @@
-default: &default
-  pool: 5
-  encoding: unicode
-
-postgresql:
-  default: &postgres_default
-    adapter: postgresql
-    url: <%= ENV['DATABASE_URL'] %>
-  test: &postgres_test
-    <<: *postgres_default
-    url: <%= ENV['DATABASE_URL'] || "postgresql://localhost:#{ENV.fetch('PGPORT', 5432)}/journaled_test" %>
-    database: journaled_test
-  development: &postgres_development
-    <<: *postgres_default
-    url: <%= ENV['DATABASE_URL'] || "postgresql://localhost:#{ENV.fetch('PGPORT', 5432)}/journaled_development" %>
-    database: journaled_development
-
 development:
-  <<: *postgres_development
+  adapter: sqlite3
+  database: ":memory:"
 test:
-  <<: *postgres_test
+  adapter: sqlite3
+  database: ":memory:"

data/spec/dummy/config/environments/development.rb

@@ -13,25 +13,12 @@ Rails.application.configure do
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send.
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
   # Raise an error on page load if there are pending migrations.
   config.active_record.migration_error = :page_load
 
-  # Debug mode disables concatenation and preprocessing of assets.
-  # This option may cause significant delays in view rendering with a large
-  # number of complex assets.
-  config.assets.debug = true
-
-  # Adds additional error checking when serving assets at runtime.
-  # Checks for improperly declared sprockets dependencies.
-  # Raises helpful error messages.
-  config.assets.raise_runtime_errors = true
-
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/config/environments/test.rb

@@ -26,14 +26,12 @@ Rails.application.configure do
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  # Use ActiveJob test adapter
+  config.active_job.queue_adapter = :test
 end

data/spec/dummy/db/schema.rb

@@ -11,21 +11,8 @@
 # It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema.define(version: 20180606205114) do
-  # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
-
-  create_table "delayed_jobs", force: :cascade do |t|
-    t.integer "priority", default: 0, null: false
-    t.integer "attempts", default: 0, null: false
-    t.text "handler", null: false
-    t.text "last_error"
-    t.datetime "run_at"
-    t.datetime "locked_at"
-    t.datetime "failed_at"
-    t.string "locked_by"
-    t.string "queue"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-    t.index ["priority", "run_at"], name: "delayed_jobs_priority"
+  create_table "widgets", force: :cascade do |t|
+    t.string "name"
+    t.string "other_column"
   end
 end

data/spec/jobs/journaled/delivery_job_spec.rb

@@ -0,0 +1,221 @@
+require 'rails_helper'
+
+RSpec.describe Journaled::DeliveryJob do
+  let(:stream_name) { 'test_events' }
+  let(:partition_key) { 'fake_partition_key' }
+  let(:serialized_event) { '{"foo":"bar"}' }
+  let(:kinesis_client) { Aws::Kinesis::Client.new(stub_responses: true) }
+  let(:args) { { serialized_event: serialized_event, partition_key: partition_key, app_name: nil } }
+
+  around do |example|
+    with_env(JOURNALED_STREAM_NAME: stream_name) { example.run }
+  end
+
+  describe '#perform' do
+    let(:return_status_body) { { shard_id: '101', sequence_number: '101123' } }
+    let(:return_object) { instance_double Aws::Kinesis::Types::PutRecordOutput, return_status_body }
+
+    before do
+      allow(Aws::AssumeRoleCredentials).to receive(:new).and_call_original
+      allow(Aws::Kinesis::Client).to receive(:new).and_return kinesis_client
+      kinesis_client.stub_responses(:put_record, return_status_body)
+
+      allow(Journaled).to receive(:enabled?).and_return(true)
+    end
+
+    it 'makes requests to AWS to put the event on the Kinesis with the correct body' do
+      event = described_class.perform_now(args)
+
+      expect(event.shard_id).to eq '101'
+      expect(event.sequence_number).to eq '101123'
+    end
+
+    context 'when JOURNALED_IAM_ROLE_ARN is defined' do
+      let(:aws_sts_client) { Aws::STS::Client.new(stub_responses: true) }
+
+      around do |example|
+        with_env(JOURNALED_IAM_ROLE_ARN: 'iam-role-arn-for-assuming-kinesis-access') { example.run }
+      end
+
+      before do
+        allow(Aws::STS::Client).to receive(:new).and_return aws_sts_client
+        aws_sts_client.stub_responses(:assume_role, assume_role_response)
+      end
+
+      let(:assume_role_response) do
+        {
+          assumed_role_user: {
+            arn: 'iam-role-arn-for-assuming-kinesis-access',
+            assumed_role_id: "ARO123EXAMPLE123:Bob",
+          },
+          credentials: {
+            access_key_id: "AKIAIOSFODNN7EXAMPLE",
+            secret_access_key: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
+            session_token: "EXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI",
+            expiration: Time.zone.parse("2011-07-15T23:28:33.359Z"),
+          },
+        }
+      end
+
+      it 'initializes a Kinesis client with assume role credentials' do
+        described_class.perform_now(args)
+
+        expect(Aws::AssumeRoleCredentials).to have_received(:new).with(
+          client: aws_sts_client,
+          role_arn: "iam-role-arn-for-assuming-kinesis-access",
+          role_session_name: "JournaledAssumeRoleAccess",
+        )
+      end
+    end
+
+    context 'when the stream name env var is NOT set' do
+      let(:stream_name) { nil }
+
+      it 'raises an KeyError error' do
+        expect { described_class.perform_now(args) }.to raise_error KeyError
+      end
+    end
+
+    context 'when Amazon responds with an InternalFailure' do
+      before do
+        kinesis_client.stub_responses(:put_record, 'InternalFailure')
+      end
+
+      it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
+        allow(Rails.logger).to receive(:error)
+        expect { described_class.perform_now(args) }.to raise_error described_class::KinesisTemporaryFailure
+        expect(Rails.logger).to have_received(:error).with(
+          "Kinesis Error - Server Error occurred - Aws::Kinesis::Errors::InternalFailure",
+        ).once
+      end
+    end
+
+    context 'when Amazon responds with a ServiceUnavailable' do
+      before do
+        kinesis_client.stub_responses(:put_record, 'ServiceUnavailable')
+      end
+
+      it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
+        allow(Rails.logger).to receive(:error)
+        expect { described_class.perform_now(args) }.to raise_error described_class::KinesisTemporaryFailure
+        expect(Rails.logger).to have_received(:error).with(/\AKinesis Error/).once
+      end
+    end
+
+    context 'when we receive a 504 Gateway timeout' do
+      before do
+        kinesis_client.stub_responses(:put_record, 'Aws::Kinesis::Errors::ServiceError')
+      end
+
+      it 'raises an error that subclasses Aws::Kinesis::Errors::ServiceError' do
+        expect { described_class.perform_now(args) }.to raise_error Aws::Kinesis::Errors::ServiceError
+      end
+    end
+
+    context 'when the IAM user does not have permission to put_record to the specified stream' do
+      before do
+        kinesis_client.stub_responses(:put_record, 'AccessDeniedException')
+      end
+
+      it 'raises an AccessDeniedException error' do
+        expect { described_class.perform_now(args) }.to raise_error Aws::Kinesis::Errors::AccessDeniedException
+      end
+    end
+
+    context 'when the request timesout' do
+      before do
+        kinesis_client.stub_responses(:put_record, Seahorse::Client::NetworkingError.new(Timeout::Error.new))
+      end
+
+      it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
+        allow(Rails.logger).to receive(:error)
+        expect { described_class.perform_now(args) }.to raise_error described_class::KinesisTemporaryFailure
+        expect(Rails.logger).to have_received(:error).with(
+          "Kinesis Error - Networking Error occurred - Seahorse::Client::NetworkingError",
+        ).once
+      end
+    end
+  end
+
+  describe ".stream_name" do
+    context "when app_name is unspecified" do
+      it "is fetched from a prefixed ENV var if specified" do
+        allow(ENV).to receive(:fetch).and_return("expected_stream_name")
+        expect(described_class.stream_name(app_name: nil)).to eq("expected_stream_name")
+        expect(ENV).to have_received(:fetch).with("JOURNALED_STREAM_NAME")
+      end
+    end
+
+    context "when app_name is specified" do
+      it "is fetched from a prefixed ENV var if specified" do
+        allow(ENV).to receive(:fetch).and_return("expected_stream_name")
+        expect(described_class.stream_name(app_name: "my_funky_app_name")).to eq("expected_stream_name")
+        expect(ENV).to have_received(:fetch).with("MY_FUNKY_APP_NAME_JOURNALED_STREAM_NAME")
+      end
+    end
+  end
+
+  describe "#kinesis_client_config" do
+    it "is in us-east-1 by default" do
+      with_env(AWS_DEFAULT_REGION: nil) do
+        expect(subject.kinesis_client_config).to include(region: 'us-east-1')
+      end
+    end
+
+    it "respects AWS_DEFAULT_REGION env var" do
+      with_env(AWS_DEFAULT_REGION: 'us-west-2') do
+        expect(subject.kinesis_client_config).to include(region: 'us-west-2')
+      end
+    end
+
+    it "doesn't limit retry" do
+      expect(subject.kinesis_client_config).to include(retry_limit: 0)
+    end
+
+    it "provides no AWS credentials by default" do
+      with_env(RUBY_AWS_ACCESS_KEY_ID: nil, RUBY_AWS_SECRET_ACCESS_KEY: nil) do
+        expect(subject.kinesis_client_config).not_to have_key(:access_key_id)
+        expect(subject.kinesis_client_config).not_to have_key(:secret_access_key)
+      end
+    end
+
+    it "will use legacy credentials if specified" do
+      with_env(RUBY_AWS_ACCESS_KEY_ID: 'key_id', RUBY_AWS_SECRET_ACCESS_KEY: 'secret') 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/lib/journaled_spec.rb

@@ -49,4 +49,43 @@ RSpec.describe Journaled do
       expect(described_class.actor_uri).to eq "my actor uri"
     end
   end
+
+  describe '.detect_queue_adapter!' do
+    it 'raises an error unless the queue adapter is DB-backed' do
+      expect { described_class.detect_queue_adapter! }.to raise_error <<~MSG
+        Journaled has detected an unsupported ActiveJob queue adapter: `:test`
+
+        Journaled jobs must be enqueued transactionally to your primary database.
+
+        Please install the appropriate gems and set `queue_adapter` to one of the following:
+        - `:delayed`
+        - `:delayed_job`
+        - `:good_job`
+        - `:que`
+
+        Read more at https://github.com/Betterment/journaled
+      MSG
+    end
+
+    context 'when the queue adapter is supported' do
+      before do
+        stub_const("ActiveJob::QueueAdapters::DelayedAdapter", Class.new)
+        ActiveJob::Base.disable_test_adapter
+        ActiveJob::Base.queue_adapter = :delayed
+      end
+
+      around do |example|
+        begin
+          example.run
+        ensure
+          ActiveJob::Base.queue_adapter = :test
+          ActiveJob::Base.enable_test_adapter(ActiveJob::QueueAdapters::TestAdapter.new)
+        end
+      end
+
+      it 'does not raise an error' do
+        expect { described_class.detect_queue_adapter! }.not_to raise_error
+      end
+    end
+  end
 end

data/spec/models/database_change_protection_spec.rb

@@ -4,38 +4,42 @@ if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::M
   # rubocop:disable Rails/SkipsModelValidations
   RSpec.describe "Raw database change protection" do
     let(:journaled_class) do
-      Class.new(Delayed::Job) do
+      Class.new(ActiveRecord::Base) do
         include Journaled::Changes
 
-        journal_changes_to :locked_at, as: :attempt
+        self.table_name = 'widgets'
+
+        journal_changes_to :name, as: :attempt
       end
     end
 
     let(:journaled_class_with_no_journaled_columns) do
-      Class.new(Delayed::Job) do
+      Class.new(ActiveRecord::Base) do
         include Journaled::Changes
+
+        self.table_name = 'widgets'
       end
     end
 
     describe "the relation" do
       describe "#update_all" do
         it "refuses on journaled columns passed as hash" do
-          expect { journaled_class.update_all(locked_at: nil) }.to raise_error(/aborted by Journaled/)
+          expect { journaled_class.update_all(name: nil) }.to raise_error(/aborted by Journaled/)
         end
 
         it "refuses on journaled columns passed as string" do
-          expect { journaled_class.update_all("\"locked_at\" = NULL") }.to raise_error(/aborted by Journaled/)
-          expect { journaled_class.update_all("locked_at = null") }.to raise_error(/aborted by Journaled/)
-          expect { journaled_class.update_all("delayed_jobs.locked_at = null") }.to raise_error(/aborted by Journaled/)
-          expect { journaled_class.update_all("last_error = 'locked_at'") }.not_to raise_error
+          expect { journaled_class.update_all("\"name\" = NULL") }.to raise_error(/aborted by Journaled/)
+          expect { journaled_class.update_all("name = null") }.to raise_error(/aborted by Journaled/)
+          expect { journaled_class.update_all("widgets.name = null") }.to raise_error(/aborted by Journaled/)
+          expect { journaled_class.update_all("other_column = 'name'") }.not_to raise_error
         end
 
         it "succeeds on unjournaled columns" do
-          expect { journaled_class.update_all(handler: "") }.not_to raise_error
+          expect { journaled_class.update_all(other_column: "") }.not_to raise_error
         end
 
         it "succeeds when forced on journaled columns" do
-          expect { journaled_class.update_all({ locked_at: nil }, force: true) }.not_to raise_error
+          expect { journaled_class.update_all({ name: nil }, force: true) }.not_to raise_error
         end
       end
 
@@ -69,29 +73,19 @@ if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::M
     end
 
     describe "an instance" do
-      let(:job) do
-        module TestJob
-          def perform
-            "foo"
-          end
-
-          module_function :perform
-        end
-      end
-
-      subject { journaled_class.enqueue(job) }
+      subject { journaled_class.create!(name: 'foo') }
 
       describe "#update_columns" do
         it "refuses on journaled columns" do
-          expect { subject.update_columns(locked_at: nil) }.to raise_error(/aborted by Journaled/)
+          expect { subject.update_columns(name: nil) }.to raise_error(/aborted by Journaled/)
         end
 
         it "succeeds on unjournaled columns" do
-          expect { subject.update_columns(handler: "") }.not_to raise_error
+          expect { subject.update_columns(other_column: "") }.not_to raise_error
         end
 
         it "succeeds when forced on journaled columns" do
-          expect { subject.update_columns({ locked_at: nil }, force: true) }.not_to raise_error
+          expect { subject.update_columns({ name: nil }, force: true) }.not_to raise_error
         end
       end
 
@@ -101,7 +95,7 @@ if Rails::VERSION::MAJOR > 5 || (Rails::VERSION::MAJOR == 5 && Rails::VERSION::M
         end
 
         it "succeeds if no journaled columns exist" do
-          instance = journaled_class_with_no_journaled_columns.enqueue(job)
+          instance = journaled_class_with_no_journaled_columns.create!
           expect { instance.delete }.not_to raise_error
         end
 

data/spec/models/journaled/writer_spec.rb

@@ -80,16 +80,12 @@ RSpec.describe Journaled::Writer do
       )
     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
 
@@ -99,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
 
@@ -107,9 +103,8 @@ 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
 
         context 'when there is no job priority specified in the enqueue opts' do
@@ -122,7 +117,11 @@ RSpec.describe Journaled::Writer do
 
           it 'defaults to the global default' do
             expect { subject.journal! }.to change {
-              Delayed::Job.where('handler like ?', '%Journaled::Delivery%').where(priority: 999).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'] == 999 }.count
+              end
             }.from(0).to(1)
           end
         end
@@ -130,9 +129,13 @@ RSpec.describe Journaled::Writer do
         context 'when there is a job priority specified in the enqueue opts' do
           let(:journaled_enqueue_opts) { { priority: 13 } }
 
-          it 'enqueues a Journaled::Delivery object with 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: 13).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.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,24 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-kinesis
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        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:
     - - ">="
@@ -103,48 +117,6 @@ 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
-  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: pry-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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -216,19 +188,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -272,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
@@ -283,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/enqueue.rb
 - lib/journaled/relation_change_protection.rb
 - lib/journaled/rspec.rb
 - lib/journaled/version.rb
@@ -304,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
@@ -317,12 +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/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
@@ -335,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:
@@ -368,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
@@ -380,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
@@ -390,7 +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/README.rdoc
 - spec/models/journaled/json_schema_model/validator_spec.rb
 - spec/models/journaled/actor_uri_provider_spec.rb
@@ -401,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

data/config/routes.rb

@@ -1,2 +0,0 @@
-Rails.application.routes.draw do
-end

data/lib/journaled/enqueue.rb

@@ -1,13 +0,0 @@
-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/spec/dummy/config/environments/production.rb

@@ -1,78 +0,0 @@
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-
-  # Code is not reloaded between requests.
-  config.cache_classes = true
-
-  # Eager load code on boot. This eager loads most of Rails and
-  # your application in memory, allowing both threaded web servers
-  # and those relying on copy on write to perform better.
-  # Rake tasks automatically ignore this option for performance.
-  config.eager_load = true
-
-  # Full error reports are disabled and caching is turned on.
-  config.consider_all_requests_local       = false
-  config.action_controller.perform_caching = true
-
-  # Enable Rack::Cache to put a simple HTTP cache in front of your application
-  # Add `rack-cache` to your Gemfile before enabling this.
-  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
-  # config.action_dispatch.rack_cache = true
-
-  # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_assets = false
-
-  # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
-  # config.assets.css_compressor = :sass
-
-  # Do not fallback to assets pipeline if a precompiled asset is missed.
-  config.assets.compile = false
-
-  # Generate digests for assets URLs.
-  config.assets.digest = true
-
-  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
-
-  # Specifies the header that your server uses for sending files.
-  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
-  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
-
-  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
-  # config.force_ssl = true
-
-  # Set to :debug to see everything in the log.
-  config.log_level = :info
-
-  # Prepend all log lines with the following tags.
-  # config.log_tags = [ :subdomain, :uuid ]
-
-  # Use a different logger for distributed setups.
-  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
-
-  # Use a different cache store in production.
-  # config.cache_store = :mem_cache_store
-
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
-  # config.action_controller.asset_host = "http://assets.example.com"
-
-  # Ignore bad email addresses and do not raise email delivery errors.
-  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
-  # config.action_mailer.raise_delivery_errors = false
-
-  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation cannot be found).
-  config.i18n.fallbacks = true
-
-  # Send deprecation notices to registered listeners.
-  config.active_support.deprecation = :notify
-
-  # Disable automatic flushing of the log to improve performance.
-  # config.autoflush_log = false
-
-  # Use default logging formatter so that PID and timestamp are not suppressed.
-  config.log_formatter = ::Logger::Formatter.new
-
-  # Do not dump schema after migrations.
-  config.active_record.dump_schema_after_migration = false
-end

data/spec/dummy/config/initializers/assets.rb

@@ -1,8 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = '1.0'
-
-# Precompile additional assets.
-# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
-# Rails.application.config.assets.precompile += %w( search.js )

data/spec/dummy/db/migrate/20180606205114_create_delayed_jobs.rb

@@ -1,18 +0,0 @@
-class CreateDelayedJobs < ActiveRecord::Migration[5.1]
-  def change
-    create_table :delayed_jobs do |t|
-      t.integer :priority, default: 0, null: false # Allows some jobs to jump to the front of the queue
-      t.integer :attempts, default: 0, null: false # Provides for retries, but still fail eventually.
-      t.text :handler,                 null: false # YAML-encoded string of the object that will do work
-      t.text :last_error                           # reason for last failure (See Note below)
-      t.datetime :run_at                           # When to run. Could be Time.zone.now for immediately, or sometime in the future.
-      t.datetime :locked_at                        # Set when a client is working on this object
-      t.datetime :failed_at                        # Set when all retries have failed (actually, by default, the record is deleted instead)
-      t.string :locked_by                          # Who is working on this object (if locked)
-      t.string :queue                              # The name of the queue this job is in
-      t.timestamps null: true
-    end
-
-    add_index :delayed_jobs, [:priority, :run_at], name: "delayed_jobs_priority"
-  end
-end

data/spec/support/delayed_job_spec_helper.rb

@@ -1,11 +0,0 @@
-module DelayedJobSpecHelper
-  def with_jobs_delayed(opts = {})
-    work_off = opts.fetch(:work_off, true)
-    original = Delayed::Worker.delay_jobs
-    Delayed::Worker.delay_jobs = true
-    yield
-  ensure
-    Delayed::Worker.delay_jobs = original
-    Delayed::Worker.new.work_off if work_off
-  end
-end