journaled 4.1.0 → 5.0.0

data/lib/journaled/rspec.rb

@@ -16,3 +16,89 @@ RSpec::Matchers.define :journal_changes_to do |*attribute_names, as:|
     "expected #{model_class} not to journal changes to #{attribute_names.map(&:inspect).join(', ')} as #{as.inspect}"
   end
 end
+
+RSpec::Matchers.define_negated_matcher :not_journal_changes_to, :journal_changes_to
+
+RSpec::Matchers.define :journal_events_including do |*expected_events|
+  raise "Please specify at least one expected event. RSpec argument matchers are supported." if expected_events.empty?
+
+  attr_accessor :expected, :actual, :matches, :nonmatches
+
+  chain :with_schema_name, :expected_schema_name
+  chain :with_partition_key, :expected_partition_key
+  chain :with_stream_name, :expected_stream_name
+  chain :with_enqueue_opts, :expected_enqueue_opts
+  chain :with_priority, :expected_priority
+
+  def supports_block_expectations?
+    true
+  end
+
+  def hash_including_recursive(hash)
+    hash_including(
+      hash.transform_values { |v| v.is_a?(Hash) ? hash_including_recursive(v) : v },
+    )
+  end
+
+  match do |block|
+    expected_events = [expected_events.first].flatten(1) unless expected_events.length > 1
+
+    self.expected = expected_events.map { |e| { journaled_attributes: e } }
+    expected.each { |e| e.merge!(journaled_schema_name: expected_schema_name) } if expected_schema_name
+    expected.each { |e| e.merge!(journaled_partition_key: expected_partition_key) } if expected_partition_key
+    expected.each { |e| e.merge!(journaled_stream_name: expected_stream_name) } if expected_stream_name
+    expected.each { |e| e.merge!(journaled_enqueue_opts: expected_enqueue_opts) } if expected_enqueue_opts
+    expected.each { |e| e.merge!(priority: expected_priority) } if expected_priority
+    self.actual = []
+
+    callback = ->(_name, _started, _finished, _unique_id, payload) do
+      event = payload[:event]
+      a = { journaled_attributes: event.journaled_attributes }
+      a[:journaled_schema_name] = event.journaled_schema_name if expected_schema_name
+      a[:journaled_partition_key] = event.journaled_partition_key if expected_partition_key
+      a[:journaled_stream_name] = event.journaled_stream_name if expected_stream_name
+      a[:journaled_enqueue_opts] = event.journaled_enqueue_opts if expected_enqueue_opts
+      a[:priority] = payload[:priority] if expected_priority
+      actual << a
+    end
+
+    ActiveSupport::Notifications.subscribed(callback, 'journaled.event.enqueue', &block)
+
+    self.matches = actual.select do |a|
+      expected.any? { |e| values_match?(hash_including_recursive(e), a) }
+    end
+
+    self.nonmatches = actual - matches
+
+    exact_matches = matches.dup
+    matches.count == expected.count && expected.all? do |e|
+      match, index = exact_matches.each_with_index.find { |a, _| values_match?(hash_including_recursive(e), a) }
+      exact_matches.delete_at(index) if match
+    end && exact_matches.empty?
+  end
+
+  failure_message do
+    <<~MSG
+      Expected the code block to journal exactly one matching event per expected event.
+
+      Expected Events (#{expected.count}):
+      ===============================================================================
+        #{expected.map(&:to_json).join("\n ")}
+      ===============================================================================
+
+      Matching Events (#{matches.count}):
+      ===============================================================================
+        #{matches.map(&:to_json).join("\n ")}
+      ===============================================================================
+
+      Non-Matching Events (#{nonmatches.count}):
+      ===============================================================================
+        #{nonmatches.map(&:to_json).join("\n  ")}
+      ===============================================================================
+    MSG
+  end
+end
+
+RSpec::Matchers.alias_matcher :journal_event_including, :journal_events_including
+RSpec::Matchers.define_negated_matcher :not_journal_events_including, :journal_events_including
+RSpec::Matchers.define_negated_matcher :not_journal_event_including, :journal_event_including

data/lib/journaled/transaction_ext.rb

@@ -0,0 +1,31 @@
+require 'active_record/connection_adapters/abstract/transaction'
+
+module Journaled
+  module TransactionExt
+    def initialize(*, **)
+      super.tap do
+        raise TransactionSafetyError, <<~MSG unless instance_variable_defined?(:@run_commit_callbacks)
+          Journaled::TransactionExt expects @run_commit_callbacks to be defined on Transaction!
+          This is an internal API that may have changed in a recent Rails release.
+          If you were not expecting to see this error, please file an issue here:
+          https://github.com/Betterment/journaled/issues
+        MSG
+      end
+    end
+
+    def before_commit_records
+      super.tap do
+        Writer.enqueue!(*_journaled_staged_events) if @run_commit_callbacks
+      end
+    end
+
+    def commit_records
+      connection.current_transaction._journaled_staged_events.push(*_journaled_staged_events) unless @run_commit_callbacks
+      super
+    end
+
+    def _journaled_staged_events
+      @_journaled_staged_events ||= []
+    end
+  end
+end

data/lib/journaled/version.rb

@@ -1,3 +1,3 @@
 module Journaled
-  VERSION = "4.1.0".freeze
+  VERSION = "5.0.0".freeze
 end

data/lib/journaled.rb

@@ -4,6 +4,8 @@ require "json-schema"
 
 require "journaled/engine"
 require "journaled/current"
+require "journaled/errors"
+require 'journaled/connection'
 
 module Journaled
   SUPPORTED_QUEUE_ADAPTERS = %w(delayed delayed_job good_job que).freeze
@@ -14,32 +16,36 @@ module Journaled
   mattr_accessor(:http_open_timeout) { 2 }
   mattr_accessor(:http_read_timeout) { 60 }
   mattr_accessor(:job_base_class_name) { 'ActiveJob::Base' }
+  mattr_accessor(:transactional_batching_enabled) { true }
 
-  def development_or_test?
+  def self.development_or_test?
     %w(development test).include?(Rails.env)
   end
 
-  def enabled?
-    !['0', 'false', false, 'f', ''].include?(ENV.fetch('JOURNALED_ENABLED', !development_or_test?))
+  def self.enabled?
+    ['0', 'false', false, 'f', ''].exclude?(ENV.fetch('JOURNALED_ENABLED', !development_or_test?))
   end
 
-  def schema_providers
+  def self.schema_providers
     @schema_providers ||= [Journaled::Engine, Rails]
   end
 
-  def commit_hash
+  def self.commit_hash
     ENV.fetch('GIT_COMMIT')
   end
 
-  def actor_uri
+  def self.actor_uri
     Journaled::ActorUriProvider.instance.actor_uri
   end
 
-  def detect_queue_adapter!
-    adapter = job_base_class_name.constantize.queue_adapter_name
-    unless SUPPORTED_QUEUE_ADAPTERS.include?(adapter)
+  def self.queue_adapter
+    job_base_class_name.constantize.queue_adapter_name
+  end
+
+  def self.detect_queue_adapter!
+    unless SUPPORTED_QUEUE_ADAPTERS.include?(queue_adapter)
       raise <<~MSG
-        Journaled has detected an unsupported ActiveJob queue adapter: `:#{adapter}`
+        Journaled has detected an unsupported ActiveJob queue adapter: `:#{queue_adapter}`
 
         Journaled jobs must be enqueued transactionally to your primary database.
 
@@ -53,7 +59,7 @@ module Journaled
 
   def self.tagged(**tags)
     existing_tags = Current.tags
-    tag!(tags)
+    tag!(**tags)
     yield
   ensure
     Current.tags = existing_tags
@@ -62,6 +68,4 @@ module Journaled
   def self.tag!(**tags)
     Current.tags = Current.tags.merge(tags)
   end
-
-  module_function :development_or_test?, :enabled?, :schema_providers, :commit_hash, :actor_uri, :detect_queue_adapter!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -87,18 +87,18 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: betterlint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,19 +126,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-betterment
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spring
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +195,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uncruft
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -241,56 +255,39 @@ files:
 - journaled_schemas/journaled/change.json
 - journaled_schemas/tagged_event.json
 - lib/journaled.rb
+- lib/journaled/connection.rb
 - lib/journaled/current.rb
 - lib/journaled/engine.rb
+- lib/journaled/errors.rb
 - lib/journaled/relation_change_protection.rb
 - lib/journaled/rspec.rb
+- lib/journaled/transaction_ext.rb
 - lib/journaled/version.rb
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/secrets.yml
-- 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
-- spec/models/database_change_protection_spec.rb
-- spec/models/journaled/actor_uri_provider_spec.rb
-- spec/models/journaled/change_writer_spec.rb
-- spec/models/journaled/event_spec.rb
-- spec/models/journaled/json_schema_model/validator_spec.rb
-- spec/models/journaled/writer_spec.rb
-- spec/rails_helper.rb
-- spec/spec_helper.rb
-- spec/support/environment_spec_helper.rb
 homepage: http://github.com/Betterment/journaled
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: |+
+  ============================
+  NOTE FOR UPGRADING JOURNALED
+  ============================
+
+  If you are upgrading from an older `journaled` version, please be sure to
+  increment only ONE major version at a time.
+
+  ⚠️ IF YOU ARE UPGRADING FROM 3.1 OR EARLIER, you should NOT USE THIS VERSION. ⚠️
+
+  Instead, install a version of the gem that is backwards compatible with your
+  app's currently-enqueued journaled jobs:
+
+  gem 'journaled', '~> 4.2.0' # upgrading from 3.0-3.1
+  gem 'journaled', '~> 3.1.0' # upgrading from 2.0-2.5
+
+  For additional upgrade instructions (e.g. how to handle a few BREAKING CHANGES
+  to environment variables), please see the README:
+  https://github.com/Betterment/journaled/blob/v5.0.0/README.md#upgrades
+
 rdoc_options: []
 require_paths:
 - lib
@@ -298,55 +295,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Journaling for Betterment apps.
-test_files:
-- spec/spec_helper.rb
-- spec/dummy/bin/rake
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/config/secrets.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environment.rb
-- spec/dummy/config/application.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/boot.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/mime_types.rb
-- 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/cookies_serializer.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config.ru
-- spec/dummy/Rakefile
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/404.html
-- spec/dummy/db/schema.rb
-- spec/dummy/README.rdoc
-- spec/models/journaled/json_schema_model/validator_spec.rb
-- spec/models/journaled/actor_uri_provider_spec.rb
-- spec/models/journaled/event_spec.rb
-- spec/models/journaled/change_writer_spec.rb
-- spec/models/journaled/writer_spec.rb
-- spec/models/database_change_protection_spec.rb
-- spec/models/concerns/journaled/changes_spec.rb
-- spec/models/concerns/journaled/actor_spec.rb
-- spec/support/environment_spec_helper.rb
-- spec/lib/journaled_spec.rb
-- spec/jobs/journaled/delivery_job_spec.rb
-- spec/rails_helper.rb
+test_files: []

data/spec/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('config/application', __dir__)
-
-Rails.application.load_tasks

data/spec/dummy/bin/bundle

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
-load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-APP_PATH = File.expand_path('../config/application', __dir__)
-require_relative '../config/boot'
-require 'rails/commands'

data/spec/dummy/bin/rake

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
-Rake.application.run

data/spec/dummy/config/application.rb

@@ -1,25 +0,0 @@
-require File.expand_path('boot', __dir__)
-
-require "active_record/railtie"
-require "active_job/railtie"
-require "active_model/railtie"
-require "action_controller/railtie"
-
-Bundler.require(*Rails.groups)
-require "journaled"
-
-module Dummy
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-  end
-end

data/spec/dummy/config/boot.rb

@@ -1,5 +0,0 @@
-# Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
-
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/database.yml

@@ -1,6 +0,0 @@
-development:
-  adapter: sqlite3
-  database: ":memory:"
-test:
-  adapter: sqlite3
-  database: ":memory:"

data/spec/dummy/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the Rails application.
-require File.expand_path('application', __dir__)
-
-# Initialize the Rails application.
-Rails.application.initialize!

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

@@ -1,24 +0,0 @@
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-
-  # In the development environment your application's code is reloaded on
-  # every request. This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
-
-  # Do not eager load code on boot.
-  config.eager_load = false
-
-  # Show full error reports and disable caching.
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = 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
-
-  # Raises error for missing translations
-  # config.action_view.raise_on_missing_translations = true
-end

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

@@ -1,37 +0,0 @@
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-
-  # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
-  config.cache_classes = true
-
-  # Do not eager load code on boot. This avoids loading your whole application
-  # just for the purpose of running a single test. If you are using a tool that
-  # preloads Rails for running tests, you may have to set it to true.
-  config.eager_load = false
-
-  # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
-  config.static_cache_control = 'public, max-age=3600'
-
-  # Show full error reports and disable caching.
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = false
-
-  # Disable request forgery protection in test environment.
-  config.action_controller.allow_forgery_protection = false
-
-  # 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/config/initializers/backtrace_silencers.rb

@@ -1,7 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
-# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
-
-# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
-# Rails.backtrace_cleaner.remove_silencers!

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

@@ -1,3 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-Rails.application.config.action_dispatch.cookies_serializer = :json

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

@@ -1,4 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Configure sensitive parameters which will be filtered from the log file.
-Rails.application.config.filter_parameters += [:password]

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

@@ -1,16 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new inflection rules using the following format. Inflections
-# are locale specific, and you may define rules for as many different
-# locales as you wish. All of these examples are active by default:
-# ActiveSupport::Inflector.inflections(:en) do |inflect|
-#   inflect.plural /^(ox)$/i, '\1en'
-#   inflect.singular /^(ox)en/i, '\1'
-#   inflect.irregular 'person', 'people'
-#   inflect.uncountable %w( fish sheep )
-# end
-
-# These inflection rules are supported but not enabled by default:
-# ActiveSupport::Inflector.inflections(:en) do |inflect|
-#   inflect.acronym 'RESTful'
-# end

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

@@ -1,4 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new mime types for use in respond_to blocks:
-# Mime::Type.register "text/richtext", :rtf

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

@@ -1,3 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-Rails.application.config.session_store :cookie_store, key: '_dummy_session'

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

@@ -1,14 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# This file contains settings for ActionController::ParamsWrapper which
-# is enabled by default.
-
-# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
-ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
-end
-
-# To enable root element in JSON for ActiveRecord objects.
-# ActiveSupport.on_load(:active_record) do
-#  self.include_root_in_json = true
-# end