tobox 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f199b223858e41b8fae97f8e6d8a07f83b16a349010c4c35d402884fefcf5954
-  data.tar.gz: f7c5db09b9b477535cceef7522a9afca13bf16da6c4394f426d5a637d290662d
+  metadata.gz: 565eb7ae45be10c2048e62cb9b2e3b85787e80bba0b07917ba169016d347274b
+  data.tar.gz: 5a235f35084ab94d83d14be26d8ddb75d1a77582998f6bdf39ecf176052f308e
 SHA512:
-  metadata.gz: a30f871ceb72033405eab56005aad942e8f34405852d33cf979e9c6a46474ff6e6459d098ed7aacf967140d232035ad1d093b2e27998179606eff7a99b41f8e0
-  data.tar.gz: 10da8b5d25df57d13d971f37126619872a7ae92208496faf028f2ddd4e66df28e6d76e207498030ee0efd8842231e231b51b1c14f59cdc0b4067873802a4d74b
+  metadata.gz: 8548a5fa78246b4d2be197c0f9b2a7d606f4b74c0205622d85e12d54cf649152dcce400668cce0cfc4c2cbcc2ce5ea729e6242f5e918ff989009a2188decc0d9
+  data.tar.gz: b377e117f8d1424118efb080dc9df5c22c17c7d2d087d231a52425c4e2166009f2e09fe90e1a5f95aeb58c19120010e77c7225547b0295ebaba2d6f4aa3f1b29

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.7.2] - 2026-02-03
+
+### Improvements
+
+* Added support for SQLite as a backend.
+
+### Bugfixes
+
+* Fixed `sentry` plugin to work with the `sentry-ruby` sdk v6.
+* `:progress` plugin: when using postgresql, the "UPDATE with subquery" used to fetch-and-mark a job to process will use a CTE instead, in order to avoid a known issue with the former where the query planner may decide to scan over the entries of the subquery and cause more UPDATEs than intended when the subquery has a LIMIT.
+
 ## [0.7.1] - 2025-02-07
 
 * `:datadog` plugin: support datadog gem v2 or higher.

data/README.md

@@ -43,6 +43,8 @@ Simple, data-first events processing framework based on the [transactional outbo
 * Oracle
 * Microsoft SQL Server
 
+`tobox` supports `sqlite` as well, despite its lack of `SKIP LOCKED`, due to the caveat of write operations being performed one-at-a-time.
+
 <a id="markdown-installation" name="installation"></a>
 ## Installation
 
@@ -456,6 +458,13 @@ end
 
 Timeout (in seconds) after which a previously marked-for-consumption event can be retried (default: `30`)
 
+##### `cte_table`
+
+the name of the CTE table used in the query to fetch jobs (`:outbox_cte` by default).
+
+(This option is only used when the database is PostgreSQL).
+
+
 <a id="markdown-event-grouping" name="event-grouping"></a>
 ### Event grouping
 
@@ -604,6 +613,8 @@ on_sentry_init do |sentry_cfg|
 end
 ```
 
+This plugin also supports [Sentry transactions](https://docs.sentry.io/product/insights/overview/transaction-summary/), however you're required to be using v6 or higher.
+
 <a id="markdown-datadog" name="datadog"></a>
 ### Datadog
 

data/lib/tobox/fetcher.rb

@@ -82,9 +82,9 @@ module Tobox
     end
 
     def fetch_event_ids
-      @pick_next_sql.for_update
-                    .skip_locked
-                    .limit(@batch_size).select(:id) # lock starts here
+      ds = @pick_next_sql
+      ds = ds.for_update.skip_locked if ds.supports_skip_locked?
+      ds.limit(@batch_size).select(:id) # lock starts here
     end
 
     def do_fetch_events

data/lib/tobox/plugins/event_grouping.rb

@@ -17,10 +17,9 @@ module Tobox
         private
 
         def fetch_event_ids
-          group = @pick_next_sql.for_update
-                                .skip_locked
-                                .limit(1)
-                                .select(@group_column)
+          group = @pick_next_sql
+          group = group.for_update.skip_locked if group.supports_skip_locked?
+          group = group.limit(1).select(@group_column)
 
           # get total from a group, to compare to the number of future locked rows.
           total_from_group = @ds.where(@group_column => group).count
@@ -33,7 +32,8 @@ module Tobox
                         event_ids.order(Sequel.desc(@visibility_column, nulls: :first), :id)
                       end
 
-          event_ids = event_ids.for_update.skip_locked.select_map(:id)
+          event_ids = event_ids.for_update.skip_locked if event_ids.supports_skip_locked?
+          event_ids = event_ids.select_map(:id)
 
           if event_ids.size != total_from_group
             # this happens if concurrent workers locked different rows from the same group,

data/lib/tobox/plugins/progress.rb

@@ -4,10 +4,17 @@ module Tobox
   module Plugins
     module Progress
       def self.configure(conf)
+        conf.config[:cte_table] = :outbox_cte
         conf.config[:visibility_timeout] = 30
       end
 
       module FetcherMethods
+        def initialize(_, configuration)
+          super
+
+          @cte_table = configuration[:cte_table]
+        end
+
         private
 
         def do_fetch_events
@@ -19,17 +26,26 @@ module Tobox
           }
           mark_as_fetched_params[@attempts_column] = Sequel[@table][@attempts_column] + 1 if @attempts_column
 
-          mark_as_fetched_params[@visibility_column] = if @configuration.visibility_type_bool?
-                                                         true
-                                                       else
-                                                         Sequel.date_add(
-                                                           Sequel::CURRENT_TIMESTAMP,
-                                                           seconds: @configuration[:visibility_timeout]
-                                                         )
-                                                       end
+          mark_as_fetched_params[@visibility_column] = (@configuration.visibility_type_bool? || Sequel.date_add(
+            Sequel::CURRENT_TIMESTAMP,
+            seconds: @configuration[:visibility_timeout]
+          ))
 
           if @ds.supports_returning?(:update)
-            @ds.where(id: fetch_event_ids).returning.update(mark_as_fetched_params)
+            ids = fetch_event_ids
+            ids = if @db.database_type == :postgres && @ds.supports_cte?(:update)
+                    # The Postgres planner can ignore a LIMIT in the subquery, causing more UPDATEs than LIMIT.
+                    # A know solution or workaround is to use a CTE as an "optimization fence".
+                    # https://dba.stackexchange.com/questions/69471/postgres-update-limit-1/69497#69497
+                    ds = @ds.with(@cte_table, ids.select(:id))
+                            .from(@table, @cte_table)
+                            .where(Sequel[@cte_table][:id] => Sequel[@table][:id])
+                    ds = ds.where(Sequel[@table][@attempts_column] < @configuration[:max_attempts]) if @attempts_column
+                    ds
+                  else
+                    @ds.where(id: ids)
+                  end
+            ids.returning.update(mark_as_fetched_params)
           else
             event_ids = fetch_event_ids.select_map(:id)
             events_ds = @ds.where(id: event_ids)

data/lib/tobox/plugins/sentry.rb

@@ -55,7 +55,7 @@ module Tobox
 
           scope.set_transaction_name("#{TOBOX_NAME}/#{event[:type]}") unless scope.transaction_name
 
-          transaction = start_transaction(scope.transaction_name, event[:metadata].to_h["sentry_trace"])
+          transaction = start_transaction(scope.transaction_name, event[:metadata].to_h)
 
           return unless transaction
 
@@ -94,7 +94,7 @@ module Tobox
 
         def start_transaction(transaction_name, sentry_trace)
           options = { name: transaction_name, op: "tobox" }
-          transaction = ::Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+          transaction = ::Sentry.continue_trace(sentry_trace, **options) unless sentry_trace.empty?
           ::Sentry.start_transaction(transaction: transaction, **options)
         end
 

data/lib/tobox/pool/fiber_pool.rb

@@ -52,10 +52,16 @@ module Tobox
 
       return unless th.alive?
 
-      th.raise(KillError)
-      th.join(grace_shutdown_timeout)
-      th.kill
-      th.join(1)
+      th.report_on_exception = false
+      th.abort_on_exception = false
+      begin
+        th.raise(KillError)
+        th.join(grace_shutdown_timeout)
+        th.kill
+        th.join(1)
+      rescue KillError
+        # async re-raises the interrupt error
+      end
     end
 
     private

data/lib/tobox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tobox
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tobox
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - HoneyryderChuck
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Transactional outbox pattern implementation in ruby
 test_files: []