Retries idempotentes

Um cliente Dcision pronto para produção — chaves de idempotência, timeouts, quais erros repetir, backoff exponencial com Retry-After — em JavaScript e Python.

Redes falham. Uma requisição pode estourar o timeout do seu lado depois de a decisão já ter rodado, um provedor pode ficar sobrecarregado por um instante, um pico pode atingir o seu rate limit. Um bom cliente repete os erros certos, espera o tempo certo e nunca roda — nem paga — a mesma decisão duas vezes.

Os SDKs oficiais fazem tudo isso por você. Este guia mostra as regras e um cliente completo para quando você chama a API diretamente.

As regras

  1. Um Idempotency-Key por operação, reutilizado por cada retry dela — o ID do lead, do ticket ou da mensagem funciona bem. Um retry de uma chamada que deu certo é então reproduzido por 24 horas em vez de rodar de novo.
  2. Monte o body sempre do mesmo jeito. A checagem de replay compara o estado como JSON parseado, ordem das chaves incluída; um body diferente com a mesma chave dá 409 IDEMPOTENCY_CONFLICT.
  3. Use um timeout do seu lado um pouco maior que o da Dcision. A Dcision já repete a chamada ao engine — até 2 retries — dentro do timeoutMs da decisão (5 segundos por padrão); 10 segundos do seu lado deixam espaço para isso. Aumente os dois juntos.
  4. Repita só o que pode dar certo depois: erros de rede, 429, 500, 503, 504, 409 IDEMPOTENCY_CONFLICT com Retry-After — a primeira requisição com a chave ainda está rodando — e 502 ENGINE_ERROR uma vez. Corrija todo o resto.
  5. Respeite o Retry-After em 429 e 409; caso contrário, faça backoff exponencial com jitter.
  6. Limite as tentativas e depois siga o seu caminho de erro — normalmente o mesmo de escalate.

JavaScript

dcision.js
import { randomUUID } from "node:crypto";

const API = "https://api.dcision.io/v1/decisions";
const RETRYABLE_STATUS = new Set([429, 500, 503, 504]);

export class DcisionError extends Error {
  constructor(status, error) {
    super(`${error.code}: ${error.message}`);
    Object.assign(this, { status, code: error.code, requestId: error.request_id, details: error.details });
  }
}

/** Runs a decision with retries. Pass a stable idempotencyKey (e.g. the record's ID) per operation. */
export async function decide(slug, state, { idempotencyKey = randomUUID(), attempts = 4, timeoutMs = 10_000 } = {}) {
  for (let attempt = 1; ; attempt++) {
    let response;
    try {
      response = await fetch(`${API}/${slug}`, {
        method: "POST",
        headers: {
          Authorization: `Bearer ${process.env.DCISION_API_KEY}`,
          "Content-Type": "application/json",
          "Idempotency-Key": idempotencyKey,
        },
        body: JSON.stringify({ state }),
        signal: AbortSignal.timeout(timeoutMs),
      });
    } catch (networkError) {
      // The decision may or may not have run: the same Idempotency-Key makes the retry safe.
      if (attempt >= attempts) throw networkError;
      await sleep(backoff(attempt));
      continue;
    }

    const body = await readJson(response);
    if (response.ok) return body;

    const error = body?.error ?? { code: "INTERNAL_ERROR", message: `HTTP ${response.status}` };
    const retryable =
      RETRYABLE_STATUS.has(response.status) ||
      (error.code === "ENGINE_ERROR" && attempt === 1) ||
      // Same key still running: wait for Retry-After, then get its stored response.
      (error.code === "IDEMPOTENCY_CONFLICT" && response.headers.has("Retry-After"));
    if (!retryable || attempt >= attempts) throw new DcisionError(response.status, error);

    const retryAfter = Number(response.headers.get("Retry-After"));
    await sleep(retryAfter > 0 ? retryAfter * 1000 : backoff(attempt));
  }
}

async function readJson(response) {
  try {
    return await response.json();
  } catch {
    return null; // e.g. an HTML error page from a proxy
  }
}

const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
const backoff = (attempt) => Math.min(8_000, 250 * 2 ** attempt) * (0.5 + Math.random() / 2);
uso
import { DcisionError, decide } from "./dcision.js";

try {
  const decision = await decide("lead-qualification", { message: lead.message, company_size: lead.size }, {
    idempotencyKey: `lead-${lead.id}`,
  });
  await act(decision);
} catch (error) {
  if (error instanceof DcisionError && error.code === "INVALID_STATE") return reportBadInput(lead, error.message);
  await escalate(lead, error); // retries exhausted or a non-retryable error
}

Python

dcision.py
import os
import random
import time
import uuid

import requests

API = "https://api.dcision.io/v1/decisions"
RETRYABLE_STATUS = {429, 500, 503, 504}


class DcisionError(Exception):
    def __init__(self, status, error):
        super().__init__(f"{error['code']}: {error['message']}")
        self.status = status
        self.code = error["code"]
        self.request_id = error.get("request_id")
        self.details = error.get("details")


def decide(slug, state, idempotency_key=None, attempts=4, timeout=10):
    """Runs a decision with retries. Pass a stable idempotency_key (e.g. the record's ID) per operation."""
    key = idempotency_key or str(uuid.uuid4())
    for attempt in range(1, attempts + 1):
        try:
            response = requests.post(
                f"{API}/{slug}",
                headers={
                    "Authorization": f"Bearer {os.environ['DCISION_API_KEY']}",
                    "Idempotency-Key": key,
                },
                json={"state": state},
                timeout=timeout,
            )
        except requests.RequestException:
            # The decision may or may not have run: the same Idempotency-Key makes the retry safe.
            if attempt == attempts:
                raise
            time.sleep(_backoff(attempt))
            continue

        try:
            body = response.json()
        except ValueError:
            body = None  # e.g. an HTML error page from a proxy
        if response.ok:
            return body

        error = (body or {}).get("error") or {"code": "INTERNAL_ERROR", "message": f"HTTP {response.status_code}"}
        retryable = (
            response.status_code in RETRYABLE_STATUS
            or (error["code"] == "ENGINE_ERROR" and attempt == 1)
            # Same key still running: wait for Retry-After, then get its stored response.
            or (error["code"] == "IDEMPOTENCY_CONFLICT" and "Retry-After" in response.headers)
        )
        if not retryable or attempt == attempts:
            raise DcisionError(response.status_code, error)

        retry_after = response.headers.get("Retry-After")
        time.sleep(float(retry_after) if retry_after else _backoff(attempt))


def _backoff(attempt):
    return min(8.0, 0.25 * 2**attempt) * (0.5 + random.random() / 2)
uso
from dcision import DcisionError, decide

try:
    decision = decide(
        "support-routing",
        {"message": ticket["message"], "plan": ticket["plan"]},
        idempotency_key=f"ticket-{ticket['id']}",
    )
    act(decision)
except DcisionError as error:
    escalate(ticket, error)

O que não fazer

  • Não gere um novo Idempotency-Key a cada tentativa — os retries rodariam, e seriam cobrados, de novo.
  • Não dispute com os seus próprios retries. Duas requisições enviadas ao mesmo tempo com a mesma chave nunca rodam ambas — a segunda recebe 409 com Retry-After: 1 —, mas isso custa uma ida e volta e uma vaga do rate limit. Repita depois de uma falha ou de um timeout.
  • Não repita erros 4xx sem mudanças (exceto 429): INVALID_STATE, DECISION_DISABLED, CREDITS_EXHAUSTED ou QUOTA_EXCEEDED não se resolvem sozinhos.
  • Não trate IDEMPOTENCY_CONFLICT sem Retry-After como transitório. Ele significa que duas requisições diferentes compartilham uma chave — um bug na forma como as chaves são montadas. Com Retry-After, significa apenas que a primeira requisição ainda está rodando.

Com o fallback de erro do engine

Uma decisão cujo onEngineError é fallback responde 200 mesmo quando o engine falha, com action_reason.type = "engine_error". O cliente acima a devolve como qualquer outra resposta. Se você prefere ter respostas reais quando vale a pena esperar por elas, repita mais tarde com a mesma chave: respostas de fallback não são cobradas nem guardadas para idempotência, então o retry chega ao engine de novo — e dispara os destinos da decisão de novo, com novos IDs de entrega.

const decision = await decide("lead-qualification", state, { idempotencyKey: `lead-${lead.id}` });
if (decision.action_reason.type === "engine_error") queue.retryLater({ lead, idempotencyKey: `lead-${lead.id}` });

O dcision decide da CLI segue as mesmas regras: ele gera um Idempotency-Key quando você não passa um e repete uma vez em erros de rede.

Nesta página