Module: Dinie::Internal::Idempotency

Defined in:
lib/dinie/runtime/idempotency.rb,
sig/dinie/runtime/idempotency.rbs

Overview

Idempotency-Key generation (architecture §10, RB15; mirrors sdk-js idempotency.ts).

One job: mint a fresh auto-generated key. The dinie-sdk-retry- prefix lets the Dinie backend tell an SDK-generated key apart from a partner-supplied one.

The policy around the key lives in HttpClient (story 003), NOT here:

- only non-GET writes get one (auto on POST/PATCH),
- the key is generated ONCE before the retry loop, so every attempt of the same logical
request reuses it (a retry must never create a duplicate resource),
- a caller can override it via `request_options[:idempotency_key]`,
- the whole behavior can be opted out globally with `idempotency: false`.

Runtime-internal: consumed directly by HttpClient, not part of the public surface.

Constant Summary collapse

KEY_PREFIX =

Prefix marking a key as SDK-auto-generated (vs. partner-supplied) on the backend.

Returns:

  • (String) 
"dinie-sdk-retry-"

Class Method Summary collapse

Class Method Details

.generate_key ⇒ String

A fresh auto-generated Idempotency-Key: dinie-sdk-retry-<uuid v4>.

Returns:

  • (String) 


29
30
31
 
# File 'lib/dinie/runtime/idempotency.rb', line 29

def generate_key
  "#{KEY_PREFIX}#{SecureRandom.uuid}"
end