falqon 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315b92a750d6358553f6b0a46623c016f871e556eb9c787fe154454cd426ef56
-  data.tar.gz: c0fda1f5f23662c9c0ff2316bdf976fec620fb3f4b8a3be29c79fd65b5da5ac9
+  metadata.gz: 2a6de2c2359a6d2aebf3f7f0531b9dea885d46f579a64aa0b46036c204c7df52
+  data.tar.gz: 8896a1d994cd209f436c8c260c5eba7985c9b3055064f186e26d7ff8452f7407
 SHA512:
-  metadata.gz: 2205cb5ebf976ee5a61b33dd8157619d27ae6d2d0f2f8eca5d93fbf52b2e6719d38d697218525bfab105ec7db6fd496f70a681587a2eb4da6677e10b20a170a4
-  data.tar.gz: d460ebf86b84a2814f41cdb94f134f28eafcebaab3d7ec9bf90fe11d1b8329f739ae7a17c4b40c07c69834c393fad1db79997602ae45b8a1637aa4b2838d451a
+  metadata.gz: 465c3dc7415da3ee83118227916a0d21a653fd8c74b2876a73e2510e545e7b210d0a96425d3f014ad997516f9314fea9de819b81deb373ec949162a3b7d6ca15
+  data.tar.gz: 231afe294759e0cc1fe0b0a884a99044808021e0d6d1f7201a8406f7a5b0b0128c6821f25b6d743d9c2475e9397c94dce10fc12ec831fbd123c7875495e067a1

data/CHANGELOG.md

@@ -1,13 +1,5 @@
 # Changelog
 
-## Falqon v0.1.0 (2024-11-16)
-
-Initial release
-
-## Falqon v0.0.1 (2023-06-22)
-
-# Changelog
-
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
@@ -21,5 +13,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-[unreleased]: https://github.com/floriandejonckheere/falqon/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/floriandejonckheere/falqon/compare/v0.0.1...v0.1.0
+## Falqon v1.0.0 (2024-12-07)
+
+### Changed
+
+- Use atomic execution (MULTI/EXEC) where possible.
+
+## Falqon v0.1.0 (2024-11-16)
+
+Initial release
+
+## Falqon v0.0.1 (2023-06-22)
+
+[unreleased]: https://github.com/floriandejonckheere/falqon/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/floriandejonckheere/falqon-pro/releases/tag/v1.0.0
+[0.1.0]: https://github.com/floriandejonckheere/falqon-pro/releases/tag/v0.1.0

data/Gemfile

@@ -14,7 +14,7 @@ group :development do
   gem "yard-sorbet", "0.9.0", require: false
 
   # Simple server
-  gem "webrick", "1.8.2", require: false
+  gem "webrick", "1.9.1", require: false
 end
 
 group :development, :test do
@@ -28,21 +28,21 @@ group :development, :test do
   gem "ffaker", "2.23.0", require: false
 
   # Mock Redis server
-  gem "mock_redis", "0.45.0", require: false
+  gem "mock_redis", "0.48.1", require: false
 
   # Behavior-driven test framework
   gem "rspec", "3.13.0", require: false
 
   # Linter
-  gem "rubocop", "1.68.0", require: false
+  gem "rubocop", "1.69.0", require: false
   gem "rubocop-factory_bot", "2.26.1", require: false
-  gem "rubocop-performance", "1.22.1", require: false
+  gem "rubocop-performance", "1.23.0", require: false
   gem "rubocop-rake", "0.6.0", require: false
   gem "rubocop-rspec", "3.2.0", require: false
 
   # Type checker
-  gem "sorbet", "0.5.11645", require: false
-  gem "tapioca", "0.16.4", require: false
+  gem "sorbet", "0.5.11672", require: false
+  gem "tapioca", "0.16.5", require: false
 
   # Time control
   gem "timecop", "0.9.10", require: false

data/README.md

@@ -23,8 +23,9 @@ Falqon offers an elegant solution for messaging queues in Ruby.
 
 - Install Falqon and get working with messaging queues in a heartbeat using the [quickstart guide](#quickstart)
 - Check out the [API documentation](https://docs.falqon.dev/) for more information on how to use Falqon in your application
-- Check out the CLI documentation](https://docs.falqon.dev/) for more information on how to manage queues and messages from the command line
+- Check out the [CLI documentation](https://docs.falqon.dev/Falqon/CLI.html) for more information on how to manage queues and messages from the command line
 - Read the [architecture documentation](#architecture) to learn more about how Falqon works under the hood
+- Read about [Falqon Pro](https://docs.falqon.dev/pro), the commercial addon for Falqon that offers additional features
 
 ## Quickstart
 
@@ -52,7 +53,7 @@ Or install it yourself as:
 ### Configuration
 
 The default configuration works out of the box with the provided `docker-compose.yml` file.
-See [configuration](#configuration) if you want to adjust the configuration.
+See [configuration](https://docs.falqon.dev/Falqon/Configuration.html) if you want to adjust the configuration.
 
 ### Usage
 
@@ -134,7 +135,7 @@ The documentation in `docs/` is automatically built by [YARD](https://yardoc.org
 Locally, you can build the documentation using the following commands:
 
 ```sh
-rake yrad
+rake yard
 ```
 
 In development, you can start a local server to preview the documentation:

data/lib/falqon/message.rb

@@ -101,13 +101,17 @@ module Falqon
     sig { returns(Message) }
     def create
       redis.with do |r|
-        # Store data
-        r.set("#{queue.id}:data:#{id}", data)
+        message_id = id
 
-        # Set metadata
-        r.hset("#{queue.id}:metadata:#{id}",
-               :created_at, Time.now.to_i,
-               :updated_at, Time.now.to_i,)
+        r.multi do |t|
+          # Store data
+          t.set("#{queue.id}:data:#{message_id}", data)
+
+          # Set metadata
+          t.hset("#{queue.id}:metadata:#{message_id}",
+                 :created_at, Time.now.to_i,
+                 :updated_at, Time.now.to_i,)
+        end
       end
 
       self
@@ -141,12 +145,14 @@ module Falqon
     sig { void }
     def delete
       redis.with do |r|
-        # Delete message from queue
-        queue.pending.remove(id)
-        queue.dead.remove(id)
-
-        # Delete data and metadata
-        r.del("#{queue.id}:data:#{id}", "#{queue.id}:metadata:#{id}")
+        r.multi do |t|
+          # Delete message from queue
+          queue.pending.remove(id)
+          queue.dead.remove(id)
+
+          # Delete data and metadata
+          t.del("#{queue.id}:data:#{id}", "#{queue.id}:metadata:#{id}")
+        end
       end
     end
 
@@ -156,9 +162,7 @@ module Falqon
     #
     sig { returns Integer }
     def size
-      redis.with do |r|
-        r.strlen("#{queue.id}:data:#{id}")
-      end
+      redis.with { |r| r.strlen("#{queue.id}:data:#{id}") }
     end
 
     # Metadata of the message
@@ -183,7 +187,7 @@ module Falqon
     def_delegator :queue, :logger
 
     ##
-    # Metadata for an message
+    # Metadata for a message
     #
     class Metadata < T::Struct
       # Status (unknown, pending, processing, scheduled, dead)
@@ -209,11 +213,8 @@ module Falqon
       # @!visibility private
       #
       def self.parse(data)
-        # Keys that are not numeric
-        keys = ["status", "retry_error"]
-
         # Transform keys to symbols, and values to integers
-        new(data.to_h { |k, v| [k.to_sym, keys.include?(k) ? v : v.to_i] })
+        new(data.to_h { |k, v| [k.to_sym, (send(props.dig(k.to_sym, :type).name.to_sym, v) if v)] })
       end
     end
   end

data/lib/falqon/queue.rb

@@ -91,15 +91,17 @@ module Falqon
 
         raise Falqon::VersionMismatchError, "Queue #{name} is using protocol version #{queue_version}, but this client is using protocol version #{version}" if queue_version && queue_version.to_i != @version
 
-        # Register the queue
-        r.sadd([Falqon.configuration.prefix, "queues"].compact.join(":"), name)
+        r.multi do |t|
+          # Register the queue
+          t.sadd([Falqon.configuration.prefix, "queues"].compact.join(":"), name)
 
-        # Set creation and update timestamp (if not set)
-        r.hsetnx("#{id}:metadata", :created_at, Time.now.to_i)
-        r.hsetnx("#{id}:metadata", :updated_at, Time.now.to_i)
+          # Set creation and update timestamp (if not set)
+          t.hsetnx("#{id}:metadata", :created_at, Time.now.to_i)
+          t.hsetnx("#{id}:metadata", :updated_at, Time.now.to_i)
 
-        # Set protocol version
-        r.hsetnx("#{id}:metadata", :version, @version)
+          # Set protocol version
+          t.hsetnx("#{id}:metadata", :version, @version)
+        end
       end
 
       run_hook :initialize, :after
@@ -185,18 +187,23 @@ module Falqon
         # Move identifier from pending queue to processing queue
         message_id = r.blmove(pending.id, processing.id, :left, :right).to_i
 
-        # Set message status
-        r.hset("#{id}:metadata:#{message_id}", :status, "processing")
+        # Get retry count
+        retries = r.hget("#{id}:metadata:#{message_id}", :retries).to_i
 
-        # Set update timestamp
-        r.hset("#{id}:metadata", :updated_at, Time.now.to_i)
-        r.hset("#{id}:metadata:#{message_id}", :updated_at, Time.now.to_i)
+        r.multi do |t|
+          # Set message status
+          t.hset("#{id}:metadata:#{message_id}", :status, "processing")
 
-        # Increment processing counter
-        r.hincrby("#{id}:metadata", :processed, 1)
+          # Set update timestamp
+          t.hset("#{id}:metadata", :updated_at, Time.now.to_i)
+          t.hset("#{id}:metadata:#{message_id}", :updated_at, Time.now.to_i)
 
-        # Increment retry counter if message is retried
-        r.hincrby("#{id}:metadata", :retried, 1) if r.hget("#{id}:metadata:#{message_id}", :retries).to_i.positive?
+          # Increment processing counter
+          t.hincrby("#{id}:metadata", :processed, 1)
+
+          # Increment retry counter if message is retried
+          t.hincrby("#{id}:metadata", :retried, 1) if retries.positive?
+        end
 
         Message.new(self, id: message_id)
       end
@@ -318,11 +325,13 @@ module Falqon
       message_ids = pending.clear + processing.clear + scheduled.clear + dead.clear
 
       redis.with do |r|
-        # Clear metadata
-        r.hdel("#{id}:metadata", :processed, :failed, :retried)
+        r.multi do |t|
+          # Clear metadata
+          t.hdel("#{id}:metadata", :processed, :failed, :retried)
 
-        # Set update timestamp
-        r.hset("#{id}:metadata", :updated_at, Time.now.to_i)
+          # Set update timestamp
+          t.hset("#{id}:metadata", :updated_at, Time.now.to_i)
+        end
       end
 
       run_hook :clear, :after
@@ -351,11 +360,13 @@ module Falqon
         .each(&:clear)
 
       redis.with do |r|
-        # Delete metadata
-        r.del("#{id}:metadata")
+        r.multi do |t|
+          # Delete metadata
+          t.del("#{id}:metadata")
 
-        # Deregister the queue
-        r.srem([Falqon.configuration.prefix, "queues"].compact.join(":"), name)
+          # Deregister the queue
+          t.srem([Falqon.configuration.prefix, "queues"].compact.join(":"), name)
+        end
       end
 
       run_hook :delete, :after
@@ -461,19 +472,22 @@ module Falqon
       redis.with do |r|
         # Select all identifiers that are due (score <= current timestamp)
         # FIXME: replace with zrange(by_score: true) when https://github.com/sds/mock_redis/issues/307 is resolved
+        # TODO: work in batches
         message_ids = r.zrangebyscore(scheduled.id, 0, Time.now.to_i).map(&:to_i)
 
         logger.debug "Scheduling messages #{message_ids.join(', ')} on queue #{name}"
 
-        message_ids.each do |message_id|
-          # Set message status
-          r.hset("#{id}:metadata:#{message_id}", :status, "pending")
+        r.multi do |t|
+          message_ids.each do |message_id|
+            # Set message status
+            t.hset("#{id}:metadata:#{message_id}", :status, "pending")
 
-          # Add identifier to pending queue
-          pending.add(message_id)
+            # Add identifier to pending queue
+            pending.add(message_id)
 
-          # Remove identifier from scheduled queue
-          scheduled.remove(message_id)
+            # Remove identifier from scheduled queue
+            scheduled.remove(message_id)
+          end
         end
       end
 

data/lib/falqon/strategies/linear.rb

@@ -38,14 +38,14 @@ module Falqon
           # Increment retry count
           retries = r.hincrby("#{queue.id}:metadata:#{message.id}", :retries, 1)
 
-          # Set error metadata
-          r.hset(
-            "#{queue.id}:metadata:#{message.id}",
-            :retried_at, Time.now.to_i,
-            :retry_error, error.message,
-          )
-
           r.multi do |t|
+            # Set error metadata
+            t.hset(
+              "#{queue.id}:metadata:#{message.id}",
+              :retried_at, Time.now.to_i,
+              :retry_error, error.message,
+            )
+
             if retries < queue.max_retries || queue.max_retries == -1
               if queue.retry_delay.positive?
                 queue.logger.debug "Scheduling message #{message.id} on queue #{queue.name} in #{queue.retry_delay} seconds (attempt #{retries})"

data/lib/falqon/strategies/none.rb

@@ -20,14 +20,14 @@ module Falqon
       sig { params(message: Message, error: Error).void }
       def retry(message, error)
         queue.redis.with do |r|
-          # Set error metadata
-          r.hset(
-            "#{queue.id}:metadata:#{message.id}",
-            :retried_at, Time.now.to_i,
-            :retry_error, error.message,
-          )
-
           r.multi do |t|
+            # Set error metadata
+            t.hset(
+              "#{queue.id}:metadata:#{message.id}",
+              :retried_at, Time.now.to_i,
+              :retry_error, error.message,
+            )
+
             # Kill message immediately
             message.kill
 

data/lib/falqon/sub_queue.rb

@@ -65,6 +65,7 @@ module Falqon
         message_ids = r.lrange(id, 0, -1)
 
         # Delete all data and clear queue
+        # TODO: clear data in batches
         r.del(*message_ids.flat_map { |message_id| ["#{queue.id}:data:#{message_id}", "#{queue.id}:metadata:#{message_id}"] }, id, "#{queue.id}:id")
 
         # Return identifiers

data/lib/falqon/sub_set.rb

@@ -58,6 +58,7 @@ module Falqon
     def clear
       queue.redis.with do |r|
         # Get all identifiers from queue
+        # TODO: work in batches
         message_ids = r.zrange(id, 0, -1)
 
         # Delete all data and clear queue

data/lib/falqon/version.rb

@@ -3,8 +3,8 @@
 module Falqon
   # @!visibility private
   module Version
-    MAJOR = 0
-    MINOR = 1
+    MAJOR = 1
+    MINOR = 0
     PATCH = 0
     PRE   = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falqon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Florian Dejonckheere
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -130,7 +130,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/floriandejonckheere/falqon.git
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Simple messaging queue
 test_files: []