active_outbox 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fad444e8c23086a1afdf59fe196c7a866b7c70460013de5e6b686643851b6ce8
-  data.tar.gz: 0be6703e8c5522ed853e59fe91b6bd4636c4ea7e819726955b67e84ed95eba93
+  metadata.gz: 0e7706d5483124adb87010ceb0c1dc612dbbef07e4cbb6f52eee2a0f817f99e9
+  data.tar.gz: f8762e7bc2517a5f2720d2d9617a29d8720cc18fa1cad2129ba017c5e95ef012
 SHA512:
-  metadata.gz: 06bbf4b9548f6e1f1dd1e8eb7e66269a7bb696350a9eda5baafd4abb1cb0c8b3982062107dc62ae9a65a92f6b99578eebbed8f3beb63bacaab8ac924602a7972
-  data.tar.gz: d37e3a4a6f447fc2fa48d34efe65eaebc25e1d4269d4f149e0b9d9ba8a01db4a797532df28b0cdbac8eb864e30cb03bcc581277df40278e6f4cf2916bd70bf7a
+  metadata.gz: 277b1350289860ef9c2a33406fee80d8858ddf7dae84b62c0e960fe442e1645087d7c15ecd610e03e937faf8de8114c15a884f5b7807e276be0b7f58fcbff17b
+  data.tar.gz: a93fb735486c3ed1abfc524798e260b2945844b72bbf2a671e8ef04b48de15ed52fca3756e79882359599040a69055871d97f29c15a07bab94617590c38d2b68

data/README.md

@@ -37,11 +37,11 @@ gem install active_outbox
 
 ## Usage
 ### Setup
-Create an initializer under `config/initializers/active_outbox.rb` and setup the default outbox class to the new `Outbox` model you just created.
+Create an initializer under `config/initializers/active_outbox.rb` and setup the default outbox class to the `Outbox` model you will create in the next step.
 ```bash
 rails g active_outbox:install
 ```
-After creating the initializer, create an `Outbox` table using the provided generator and corresponding model. Any model name can be passed as an argument but if empty it will default to just `Outobx`. The generated table name will be `model_name_outboxes`.
+After creating the initializer, create an `Outbox` table using the provided generator and corresponding model. Any model name can be passed as an argument but if empty it will default to just `outboxes`. The generated table name will be `model_name_outboxes`.
 ```bash
 rails g active_outbox:model <optional model_name>
 ```
@@ -66,6 +66,12 @@ If you want to persist a custom event other than the provided base events, you c
 user.save(outbox_event: 'YOUR_CUSTOM_EVENT')
 ```
 ## Advanced Usage
+### Supporting UUIDs
+By default our Outbox migration has an `aggregate_identifier` field which serves the purpose of identifying which record was involved in the event emission. We default to integer IDs, but if you're using UUIDs as a primary key for your records you have to adjust the migrations accordingly. To do so just run the model generator with the `--uuid` flag.
+```bash
+rails g active_outbox:model <optional model_name> --uuid
+```
+### Multiple Outbox mappings
 If more granularity is desired multiple `Outbox` classes can be configured. After creating the needed `Outbox` classes for each module you can specify multiple mappings in the initializer.
 ```ruby
 # frozen_string_literal: true
@@ -73,8 +79,8 @@ If more granularity is desired multiple `Outbox` classes can be configured. Afte
 Rails.application.reloader.to_prepare do
   ActiveOutbox.configure do |config|
     config.outbox_mapping = {
-      'Member' => 'Member::Outbox',
-      'UserAccess' => 'UserAccess::Outbox'
+      'member' => 'Member::Outbox',
+      'user_access' => 'UserAccess::Outbox'
     }
   end
 end

data/lib/active_outbox/adapter_helper.rb

@@ -16,6 +16,12 @@ module ActiveOutbox
       'string'
     end
 
+    def self.bigint_type
+      return 'bigint' if postgres? || mysql?
+
+      'integer'
+    end
+
     def self.postgres?
       ActiveRecord::Base.connection.adapter_name.downcase == 'postgresql'
     end

data/lib/active_outbox/outboxable.rb

@@ -44,21 +44,20 @@ module ActiveOutbox
     def create_outbox!(action, event_name)
       outbox = outbox_model.new(
         aggregate: self.class.name,
-        aggregate_identifier: try(:identifier) || id,
+        aggregate_identifier: send(self.class.primary_key),
         event: @outbox_event || event_name,
         identifier: SecureRandom.uuid,
         payload: formatted_payload(action)
       )
       @outbox_event = nil
-
       handle_outbox_errors(outbox) if outbox.invalid?
       outbox.save!
     end
 
     def outbox_model
       module_parent = self.class.module_parent
-
-      unless module_parent.const_defined?('OUTBOX_MODEL')
+      # sets _inherit_ option to false so it doesn't lookup in ancestors for the constant
+      unless module_parent.const_defined?('OUTBOX_MODEL', false)
         outbox_model = outbox_model_name!.safe_constantize
         module_parent.const_set('OUTBOX_MODEL', outbox_model)
       end
@@ -71,9 +70,9 @@ module ActiveOutbox
     end
 
     def namespace_outbox_mapping
-      namespace = self.class.name.split('/').first
+      namespace = self.class.module_parent.name.underscore
 
-      ActiveOutbox.config.outbox_mapping[namespace&.underscore]
+      ActiveOutbox.config.outbox_mapping[namespace]
     end
 
     def default_outbox_mapping
@@ -101,8 +100,10 @@ module ActiveOutbox
       when :destroy
         { before: as_json, after: nil }
       else
-        raise ActiveRecord::RecordNotSaved.new("Failed to create Outbox payload for #{self.class.name}: #{identifier}",
-                                               self)
+        raise ActiveRecord::RecordNotSaved.new(
+          "Failed to create Outbox payload for #{self.class.name}: #{send(self.class.primary_key)}",
+          self
+        )
       end
     end
   end

data/lib/generators/active_outbox/model/model_generator.rb

@@ -20,7 +20,13 @@ module ActiveOutbox
       desc 'Creates the Outbox model migration'
 
       argument :model_name, type: :string, default: ''
-      class_option :component_path, type: :string, desc: 'Indicates where to create the outbox migration'
+      class_option :component_path,
+        type: :string,
+        desc: 'Indicates where to create the outbox migration'
+      class_option :uuid,
+        type: :boolean,
+        default: false,
+        desc: 'Use UUID to identify aggregate records in events. Defaults to ID'
 
       def create_migration_file
         migration_path = "#{root_path}/db/migrate"
@@ -42,6 +48,10 @@ module ActiveOutbox
       def table_name
         model_name.blank? ? 'outboxes' : "#{model_name}_outboxes"
       end
+
+      def aggregate_identifier_type
+        options['uuid'].present? ? ActiveOutbox::AdapterHelper.uuid_type : ActiveOutbox::AdapterHelper.bigint_type
+      end
     end
   end
 end

data/lib/generators/active_outbox/templates/migration.rb

@@ -7,7 +7,7 @@ class ActiveOutboxCreate<%= table_name.camelize %> < ActiveRecord::Migration<%=
       t.string :event, null: false
       t.<%= ActiveOutbox::AdapterHelper.json_type %> :payload
       t.string :aggregate, null: false
-      t.<%= ActiveOutbox::AdapterHelper.uuid_type %> :aggregate_identifier, null: false, index: true
+      t.<%= aggregate_identifier_type %> :aggregate_identifier, null: false, index: true
 
       t.timestamps
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_outbox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Guillermo Aguirre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable