sqs_processor 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b236be094b122ba859d742bff3fb3973e70cc9328dcd14244517ac09c4adec45
-  data.tar.gz: 32d709d43420508be56b438e6ae2958efd6ad5aeef23e1a4408fd296a87e0bb0
+  metadata.gz: 64697b1de1623aae4f565a5fb479f7821a93929cae7962814481e81008ba8006
+  data.tar.gz: 9e0f1bee31f3f0925db9cbb4e98c053742f6e4cc658b9008e71ce72230ce1d87
 SHA512:
-  metadata.gz: bc53c5db71dea861a64b1e282e7466ff9378fc664c0fa3bbe0c161189211f31d3ef925b1da122e4d1a29b8c4cb3fcdcc29acefc71ddc9342002cc6166ad22ba4
-  data.tar.gz: 208bb5ac50214e931dc0935a13d01cdac120460ad1c80a10a8fb060890a86cb07ad353d9730eff40f25d8724bb9d75db598a2564ae342de24837b4afbc6b4dac
+  metadata.gz: a02c92703472e7f58d44009e02b0a992211eb4f456c2ff274f58a7a7c4affae6b082d38143291d8838a4ecd81373a15787185d51e4882e39decd160acd2d75c8
+  data.tar.gz: 26b45ce1da7ec1fb3de5b99274d2d964c01b3deaf5a47efad7e27d97058b0c0d3522d09bbcb1e0aa3052126173e33a4a11dc03f8ecf068fa92f71460360f6d5c

data/README.md

@@ -9,7 +9,7 @@ A Ruby gem for processing messages from Amazon SQS queues with configurable mess
 - **Error Handling**: Robust error handling with message retention on failure
 - **Customizable**: Extensible message processing logic
 - **Logging**: Comprehensive logging with configurable levels
-- **Command Line Options**: Flexible configuration via command line arguments
+- **Graceful Shutdown**: Handles SIGTERM, SIGINT, and SIGQUIT signals gracefully
 - **Environment Variables**: Support for AWS credentials and configuration via environment variables
 
 ## Prerequisites
@@ -196,6 +196,23 @@ The script supports multiple ways to provide AWS credentials:
 - **Network Errors**: Automatic retry with exponential backoff
 - **Queue Errors**: Comprehensive error logging with stack traces
 
+## Graceful Shutdown
+
+The processor handles termination signals gracefully:
+
+- **SIGTERM**: Standard termination signal (used by container orchestrators)
+- **SIGINT**: Interrupt signal (Ctrl+C)
+- **SIGQUIT**: Quit signal
+
+When a shutdown signal is received:
+1. The processor immediately interrupts any blocking operations (like SQS polling)
+2. Stops accepting new messages
+3. Completes processing of any current message batch
+4. Logs the shutdown process
+5. Exits cleanly
+
+**Immediate Response**: Like Puma, the processor responds to shutdown signals immediately, interrupting any blocking operations without waiting for timeouts.
+
 ## Monitoring
 
 The script provides detailed logging including:
@@ -212,6 +229,7 @@ The script provides detailed logging including:
 3. **Handle errors gracefully**: Return `false` from processing methods to keep messages in queue
 4. **Monitor queue depth**: Use the built-in queue attribute reporting
 5. **Use appropriate batch sizes**: Balance between throughput and memory usage
+6. **Deploy with graceful shutdown**: The processor handles SIGTERM gracefully for container deployments
 
 ## Troubleshooting
 

data/lib/sqs_processor/processor.rb

@@ -16,9 +16,11 @@ module SQSProcessor
       @queue_url = queue_url
       @max_messages = max_messages
       @visibility_timeout = visibility_timeout
+      @shutdown_requested = false
 
       setup_logger(logger)
       setup_sqs_client(aws_access_key_id, aws_secret_access_key, aws_session_token, aws_region)
+      setup_signal_handlers
 
       raise 'Queue URL is required.' unless @queue_url
     end
@@ -39,6 +41,29 @@ module SQSProcessor
       )
     end
 
+    def setup_signal_handlers
+      Signal.trap('TERM') do
+        logger.info 'Received SIGTERM, initiating graceful shutdown...'
+        @shutdown_requested = true
+        # Immediately interrupt any blocking operations
+        Thread.main.raise Interrupt.new
+      end
+
+      Signal.trap('INT') do
+        logger.info 'Received SIGINT, initiating graceful shutdown...'
+        @shutdown_requested = true
+        # Immediately interrupt any blocking operations
+        Thread.main.raise Interrupt.new
+      end
+
+      Signal.trap('QUIT') do
+        logger.info 'Received SIGQUIT, initiating graceful shutdown...'
+        @shutdown_requested = true
+        # Immediately interrupt any blocking operations
+        Thread.main.raise Interrupt.new
+      end
+    end
+
     def process_messages
       logger.info 'Starting SQS message processing...'
       logger.info "Queue URL: #{@queue_url}"
@@ -46,13 +71,21 @@ module SQSProcessor
       logger.info "Visibility timeout: #{@visibility_timeout} seconds"
 
       loop do
+        break if @shutdown_requested
+
         receive_messages
         sleep 1 # Small delay between polling cycles
+      rescue Interrupt
+        logger.info 'Interrupted, initiating graceful shutdown...'
+        @shutdown_requested = true
+        break
       rescue StandardError => e
         logger.error "Error in message processing loop: #{e.message}"
         logger.error e.backtrace.join("\n")
         sleep 5 # Longer delay on error
       end
+
+      logger.info 'Graceful shutdown completed.'
     end
 
     def receive_messages
@@ -71,8 +104,13 @@ module SQSProcessor
       logger.info "Received #{response.messages.length} message(s)"
 
       response.messages.each do |message|
+        break if @shutdown_requested
+
         process_single_message(message)
       end
+    rescue Interrupt
+      logger.info 'Interrupted during message reception...'
+      raise
     end
 
     def process_single_message(message)
@@ -134,5 +172,14 @@ module SQSProcessor
 
       attributes
     end
+
+    def shutdown_requested?
+      @shutdown_requested
+    end
+
+    def request_shutdown
+      logger.info 'Shutdown requested manually...'
+      @shutdown_requested = true
+    end
   end
 end

data/lib/sqs_processor/version.rb

@@ -1,3 +1,3 @@
 module SQSProcessor
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqs_processor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Unni Tallman