Default to adding idempotecy-key to audit-logs/events if not present, added in retryability logic to endpoints

[swaroopAkkineniWorkos]

Description

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

[linear]

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

[swaroopAkkineniWorkos]

/review

[greptile-apps]

Greptile Summary

• Auto-generates UUID v4-based idempotency keys with workos-python- prefix for audit log events when not provided
• Implements retry logic with exponential backoff for status codes 408, 500, 502, 504, network errors, and timeouts (max 3 retries, opt-in via retry_config parameter)
• Changes create_event return type from None to AuditLogEventResponse with success field

Confidence Score: 5/5

• This PR is safe to merge with minimal risk.
• The implementation is well-tested with comprehensive test coverage for both sync and async retry logic, follows existing patterns in the codebase, maintains backward compatibility by defaulting retry to opt-in (None by default), and the idempotency key auto-generation prevents duplicate events while allowing user override.
• No files require special attention.

Important Files Changed

Filename	Overview
workos/audit_logs.py	Modified create_event to auto-generate idempotency keys with workos-python- prefix and enabled retry logic with default RetryConfig()
workos/utils/_base_http_client.py	Added RetryConfig dataclass and helper methods _is_retryable_error, _is_retryable_exception, and _get_backoff_delay for retry functionality
workos/utils/http_client.py	Implemented retry logic with exponential backoff in both SyncHTTPClient and AsyncHTTPClient.request() methods

Sequence Diagram

sequenceDiagram
    participant User
    participant AuditLogs
    participant HTTPClient
    participant API

    User->>AuditLogs: "create_event(org_id, event)"
    AuditLogs->>AuditLogs: "Generate idempotency key if not provided"
    AuditLogs->>HTTPClient: "request with retry configuration"
    
    loop Retry up to 3 times
        HTTPClient->>API: "POST audit logs events"
        alt Status 200
            API-->>HTTPClient: "Response body"
            HTTPClient-->>AuditLogs: "Return JSON"
        else Status 408, 500, 502, or 504
            API-->>HTTPClient: "Error response"
            HTTPClient->>HTTPClient: "Wait with exponential backoff"
        else Network or Timeout Error
            HTTPClient->>HTTPClient: "Wait with exponential backoff"
        end
    end
    
    AuditLogs->>AuditLogs: "Parse to AuditLogEventResponse"
    AuditLogs-->>User: "Return response object"

Loading

[greptile-apps]

_{11 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[nave91]

The changes are perfect!

I found an issue before with this sdk: Can we return the response object when creating the audit log event? Especially for cases where schema validation fails for an event, the caller has no way of knowing that.

[nave91]

Can we return this response object back to the user?

I think we should also add some test cases when the schema validation fails.

[swaroopAkkineniWorkos]

@nave91 updated to return the response back and added some validations

[nave91]

Same question - should we prefix with a string so we can differentiate sdk generated key vs customer?

[nave91]

💯 for using dataclasses, this keeps the retry config abstracted away 👌

[swaroopAkkineniWorkos]

@greptile re-review please

[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}