Add auto-idempotency keys and retry logic for audit log events #405

swaroopAkkineniWorkos · 2025-11-18T13:06:36Z

Updating python library sdk to always generating an idempotencyKey if not present when POSTing audit-logs events.
Also updated to add retryability to endpoints. I set it up to not be enabled by default

- Add max_retries and auto_idempotency_keys config options - Implement exponential backoff with jitter for retryable errors - Auto-generate UUID v4 idempotency keys when not provided - Retry on 5xx, 429, and network timeout errors - Add retryable? method to WorkOSError - Add comprehensive test coverage for retry and idempotency features

linear · 2025-11-18T13:06:40Z

ENT-3983 sdk: Audit and add idempotency key + auto retries in all supported sdks

- Remove auto_idempotency_keys config flag - Always auto-generate idempotency keys when not provided - Remove related test for disabled flag

- Set max_retries=3 in test setup since default is now 0 - Add after hook to reset config between tests - Fix successful retry test to properly mock response headers - Remove redundant manual reset calls in individual tests

- Add Metrics/PerceivedComplexity to existing rubocop:disable comment - Remove trailing whitespace in client_retry_spec.rb

swaroopAkkineniWorkos · 2025-11-18T14:55:29Z

lib/workos/configuration.rb


    def initialize
      @timeout = 60
+      @max_retries = 0


default to 0 retries

swaroopAkkineniWorkos · 2025-11-18T15:22:19Z

/review

swaroopAkkineniWorkos · 2025-11-18T16:01:31Z

@greptile review plz

greptile-apps · 2025-11-18T16:05:31Z

Greptile Summary

Adds automatic UUID generation for idempotency keys when not provided for audit log event creation
Implements retry logic with exponential backoff for 5xx, 408, and 429 HTTP errors with configurable max retries (defaults: 0 for general requests, 3 for audit logs)

Confidence Score: 5/5

This PR is safe to merge with no critical issues found
The implementation is well-designed with proper retry logic, comprehensive test coverage, and follows Ruby best practices. The retry mechanism correctly handles retryable errors with exponential backoff, reuses HTTP connections, and maintains idempotency across retries. All edge cases are tested.
No files require special attention

Important Files Changed

Filename	Overview
lib/workos/audit_logs.rb	Added auto-generation of idempotency keys using `SecureRandom.uuid` and configured retry logic to use `audit_log_max_retries` setting
lib/workos/client.rb	Implemented retry logic with exponential backoff for 5xx, 408, and 429 errors, including support for Retry-After headers

Sequence Diagram

sequenceDiagram
    participant User
    participant AuditLogs
    participant Client
    participant API

    User->>AuditLogs: create_event(organization, event, idempotency_key)
    AuditLogs->>AuditLogs: Generate UUID if idempotency_key is nil
    AuditLogs->>Client: execute_request(request, retries: audit_log_max_retries)
    Client->>API: POST /audit_logs/events with Idempotency-Key
    
    alt Request succeeds (2xx)
        API-->>Client: 200/201 response
        Client-->>AuditLogs: response
        AuditLogs-->>User: response
    else Retryable error (5xx, 408, 429)
        API-->>Client: 500/503/408/429 response
        Client->>Client: Check attempt < retries
        Client->>Client: Calculate backoff delay
        Client->>Client: Sleep for delay
        Client->>Client: Increment attempt counter
        Client->>API: Retry POST with same Idempotency-Key
        
        alt Retry succeeds
            API-->>Client: 200/201 response
            Client-->>AuditLogs: response
            AuditLogs-->>User: response
        else Max retries exceeded
            API-->>Client: Still failing
            Client->>Client: Raise error (APIError/TimeoutError)
            Client-->>User: Error
        end
    else Non-retryable error (4xx)
        API-->>Client: 400/401/403/404 response
        Client->>Client: Raise error immediately
        Client-->>User: Error
    end

greptile-apps

_{7 files reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

lib/workos/client.rb

lib/workos/audit_logs.rb

lib/workos/client.rb

spec/lib/workos/audit_logs_spec.rb

swaroopAkkineniWorkos · 2025-11-18T16:27:38Z

@greptile re-review plz

swaroopAkkineniWorkos · 2025-11-18T16:45:59Z

@greptile re-review plz

greptile-apps

_{7 files reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

lib/workos/errors.rb

lib/workos/audit_logs.rb

.ruby-version

swaroopAkkineniWorkos · 2025-11-18T17:00:39Z

@greptile re-review plz

greptile-apps

_{7 files reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

spec/lib/workos/audit_logs_spec.rb

swaroopAkkineniWorkos · 2025-11-18T17:25:10Z

@greptile re-review plz

greptile-apps

_{7 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

swaroopAkkineniWorkos · 2025-11-18T17:40:04Z

@greptile re-review plz

greptile-apps

_{6 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

swaroopakkineni added 9 commits November 18, 2025 07:06

Simplify auto-idempotency to always generate keys

2ff7955

- Remove auto_idempotency_keys config flag - Always auto-generate idempotency keys when not provided - Remove related test for disabled flag

Fix retry logic syntax error and add RetryableError exception

4aea845

Fix linting issues in client_retry_spec.rb variable names

0b94a2a

Update retry tests to handle opt-in retry behavior

8f675dd

- Set max_retries=3 in test setup since default is now 0 - Add after hook to reset config between tests - Fix successful retry test to properly mock response headers - Remove redundant manual reset calls in individual tests

Sup

096c09d

Fix RuboCop PerceivedComplexity warning in execute_request

d40af61

- Add Metrics/PerceivedComplexity to existing rubocop:disable comment - Remove trailing whitespace in client_retry_spec.rb

moar test

a113d80

Remove duplicate idempotency test context in audit_logs_spec

31d6a6a

sup

e0683f1

swaroopAkkineniWorkos commented Nov 18, 2025

View reviewed changes

lib/workos/configuration.rb

def initialize

@timeout = 60

@max_retries = 0

Copy link

Author

swaroopAkkineniWorkos Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default to 0 retries

swaroopakkineni added 3 commits November 18, 2025 09:09

Add 408 timeout error as retryable with idempotency key support

40db4ca

Refactor HTTP status check to use array inclusion

c22371b

Fix missing end statement in client_retry_spec

ca5341a

final

9b1945e

swaroopAkkineniWorkos marked this pull request as ready for review November 18, 2025 16:01