Fix retry logic syntax error and add RetryableError exception

Author: swaroopakkineni

lib/workos/audit_logs.rb

@@ -20,9 +20,7 @@ class << self
       # @return [nil]
       def create_event(organization:, event:, idempotency_key: nil)
         # Auto-generate idempotency key if not provided
-        if idempotency_key.nil?
-          idempotency_key = SecureRandom.uuid
-        end
+        idempotency_key = SecureRandom.uuid if idempotency_key.nil?
 
         request = post_request(
           path: '/audit_logs/events',

lib/workos/client.rb

@@ -14,6 +14,7 @@ def client
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def execute_request(request:)
       retries = WorkOS.config.max_retries
       attempt = 0
@@ -27,14 +28,14 @@ def execute_request(request:)
             attempt += 1
             delay = calculate_retry_delay(attempt, response)
             sleep(delay)
-            retry
+            raise RetryableError.new(http_status: http_status)
           else
             handle_error_response(response: response)
           end
         end
 
         response
-      rescue Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout => e
+      rescue Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout
         if attempt < retries
           attempt += 1
           delay = calculate_backoff(attempt)
@@ -45,8 +46,11 @@ def execute_request(request:)
             message: 'API Timeout Error',
           )
         end
+      rescue RetryableError
+        retry
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def get_request(path:, auth: false, params: {}, access_token: nil)
       uri = URI(path)

lib/workos/errors.rb

@@ -89,4 +89,14 @@ class NotFoundError < WorkOSError; end
 
   # UnprocessableEntityError is raised when a request is made that cannot be processed
   class UnprocessableEntityError < WorkOSError; end
+
+  # RetryableError is raised internally to trigger retry logic for retryable HTTP errors
+  class RetryableError < StandardError
+    attr_reader :http_status
+
+    def initialize(http_status:)
+      @http_status = http_status
+      super()
+    end
+  end
 end

spec/lib/workos/client_retry_spec.rb

@@ -23,7 +23,7 @@ def self.test_request
       it 'retries up to max_retries times' do
         allow(test_module).to receive(:client).and_return(double('client'))
         allow(test_module.client).to receive(:request) do
-          double('response', code: '500', body: '{"message": "Internal Server Error"}')
+          double('response', code: '500', body: '{"message": "Internal Server Error"}', '[]': nil)
         end
 
         expect(test_module.client).to receive(:request).exactly(4).times
@@ -39,7 +39,7 @@ def self.test_request
       it 'retries on service unavailable' do
         allow(test_module).to receive(:client).and_return(double('client'))
         allow(test_module.client).to receive(:request) do
-          double('response', code: '503', body: '{"message": "Service Unavailable"}')
+          double('response', code: '503', body: '{"message": "Service Unavailable"}', '[]': nil)
         end
 
         expect(test_module.client).to receive(:request).exactly(4).times
@@ -195,27 +195,27 @@ def self.test_request
         # Allow rand to return a consistent value for testing
         allow_any_instance_of(Object).to receive(:rand).and_return(0.5)
 
-        backoff_1 = test_module.send(:calculate_backoff, 1)
-        backoff_2 = test_module.send(:calculate_backoff, 2)
-        backoff_3 = test_module.send(:calculate_backoff, 3)
+        backoff_attempt_1 = test_module.send(:calculate_backoff, 1)
+        backoff_attempt_2 = test_module.send(:calculate_backoff, 2)
+        backoff_attempt_3 = test_module.send(:calculate_backoff, 3)
 
         # Attempt 1: base_delay * 2^0 = 1.0, jitter = 0.125
-        expect(backoff_1).to eq(1.125)
+        expect(backoff_attempt_1).to eq(1.125)
 
         # Attempt 2: base_delay * 2^1 = 2.0, jitter = 0.25
-        expect(backoff_2).to eq(2.25)
+        expect(backoff_attempt_2).to eq(2.25)
 
         # Attempt 3: base_delay * 2^2 = 4.0, jitter = 0.5
-        expect(backoff_3).to eq(4.5)
+        expect(backoff_attempt_3).to eq(4.5)
       end
 
       it 'respects max_delay' do
         allow_any_instance_of(Object).to receive(:rand).and_return(0.5)
 
-        backoff_10 = test_module.send(:calculate_backoff, 10)
+        backoff_attempt_10 = test_module.send(:calculate_backoff, 10)
 
         # Should cap at 30.0 + jitter (30.0 * 0.25 * 0.5 = 3.75)
-        expect(backoff_10).to eq(33.75)
+        expect(backoff_attempt_10).to eq(33.75)
       end
     end
 
@@ -225,7 +225,7 @@ def self.test_request
 
         allow(test_module).to receive(:client).and_return(double('client'))
         allow(test_module.client).to receive(:request) do
-          double('response', code: '500', body: '{"message": "Internal Server Error"}')
+          double('response', code: '500', body: '{"message": "Internal Server Error"}', '[]': nil)
         end
 
         expect(test_module.client).to receive(:request).exactly(3).times
@@ -243,7 +243,7 @@ def self.test_request
 
         allow(test_module).to receive(:client).and_return(double('client'))
         allow(test_module.client).to receive(:request) do
-          double('response', code: '500', body: '{"message": "Internal Server Error"}')
+          double('response', code: '500', body: '{"message": "Internal Server Error"}', '[]': nil)
         end
 
         expect(test_module.client).to receive(:request).once
@@ -277,4 +277,3 @@ def self.test_request
     end
   end
 end
-