Devprime | Documentação – Idempotência

Examples: Implementing idempotency in microsserviços

Mon, 01 Jan 0001 00:00:00 +0000

Nós implementaremos um exemplo no modo backend onde não é necessário passar uma chave para consumir a API do microsserviço. O processo gerencia automaticamente a idempotência confrome o payload da API.

O primeiro passo para habilitar a idempotência é modificar a configuração “Idempotency” no Idempotency no “Devprime_App”. Deopis caso não tenha feito é necessário adicionar um segundo State para a persistência da idempotência.

Parâmetros utilizados na configuração

Alias indica o State utilizado na persistência da Idempotency
Duration é utilizado para definir o tempo do registro de controle de duplicidade do comando.
Flow indica tipo de Idempotency e pode ser definido como “backend” ou “frontend”
Key é utilizada para definir uma chave requerida no head no Flow “frontend”
Scope limita a atuação da idepontencia e utiliza os parametros “all|web|stream”
Action define se a idepontencia será automática ou manual com os parâmetros “auto|manual”

Criando um microserviço para utilizar no exemplo

Nós utilizaremos um microsserviço baseado na plataforma Devprime

Utilize uma conta ativa no Devprime e ative o Devprime CLI.
Inicie os containers pelo Docker (MongoDB, RabbitMQ e Redis)
Crie a fila orderevents no RabbitMQ.
Crie um novo microsserviço “order”.

Iniciando a configuração da idempotência

Configuração da idempotência na chave “Devprime_App”
Altere na configuração do Idempotency na opção “Enabled” para “true”
code src/app/appsettings.json

    "Idempotency": {
      "Enable": "true",
      "Alias": "State2",
      "Duration": "86400",
      "Flow": "backend",
      "key": "idempotency-key",
      "Scope": "all",
      "Action": "auto"
    }

Inclua um segunda persistência na chave “Devprime_State”
Nesse exemplo utilizaremos um Redis local com uma senha padrão
code .\src\app\appsettings.json

{
  "enable": "true",
  "alias": "State2",
  "dbtype": "redis",
  "connection": "127.0.0.1:6379,password=LltF8Nx*yo",
  "timeout": "5",
  "retry": "2",
  "durationofbreak": "45"
}

Iniciando idempotência automática no microsserviço

Agora chegou o momento de testar a configuração. Antes de iniciar o microsserviço certifique de ter ativado os containers e criado a fila no RabbitMQ.

Execute a aplicação e faça um post pela API Order
No exemplo abaixo estamos utilizando um json padrão para o post.

{
  "customerName": "Bill",
  "customerTaxID": "string",
  "itens": [
    {
      "description": "short",
      "amount": 1,
      "sku": "XNY1AC",
      "price": 100
    }
  ],
  "total": 100
}

Observe no Log a informação da idempotência
O processo de idempotência entrou automaticamente para proteger esse request HTTP sem a necessidade de nenhuma informação do lado do consumidor da API.

Efetue um segundo um post idêntico pela API Order
Ao observar esse segundo cenário já é possivel perceber que a idempotência protegeu o microsserviço impedindo uma inclusão duplicada.

A API já recebeu um retorno rejeitando o POST duplicado

Ao analisar o Log nós conseguimos acompanhar todo o processo da idempotência

Iniciando a idempotência manual no microsserviço

O Devprime permite que você informe manualmente um método especifico que terá o suporte a idempotência. O primeiro passo é alterar a configuração principal e depois ir diretamente no método para adicionar a configuração.

** Alterando a chave “Action” para “Manual”**

    "Idempotency": {
      "Enable": "true",
      "Alias": "State2",
      "Duration": "86400",
      "Flow": "backend",
      "key": "idempotency-key",
      "Scope": "all",
      "Action": "manual"
    }

Ao utilizar a opção “Action” como “manual” se rodar novamente o microsserviço e fizer um post duplicado irá perceber que ele não vai rejeitar, pois o processo automático está desligado.

** Ativando a idempotência em um método**
Como o processo agora está manual nós ativaremos idempotência em cada método a ser protegido. No exemplo abaixo nós demonstramos essa possibilidade diretamente no Adapter Web.
code src\Adapters\Web\Order.cs

Localize no Adapter Web a API “Order” e efetue a modificação conforme apresentado.

app.MapPost("/v1/order", async (HttpContext http, IOrderService Service, Devprime.Web.ViewModels.Order.Order command) => await Dp(http).Pipeline(() =>
        {
            Dp(http).Idempotency.Enable = true;
            Service.Add(command.ToApplication());
        }));

Execute novamente e vai perceber que voltou a funcionar o recurso de idempotência, porém apenas para o POST na API “/v1/order”.

Mais artigos sobre idempotência

Implementing idempotency in microsserviços
Idempotency in microsserviços and REST APIs

Examples: Idempotency in microsserviços and REST APIs

Mon, 01 Jan 0001 00:00:00 +0000

As aplicações baeadas na plataforma Devprime já dispoem de um recurso automático de idempotência protegendo os serviços para não ocorrer inclusões duplicadas.

Neste cenário nós utilizaremos uma chave obritatória enviada pela aplicação que estiver utilizando a API. Para utilizar o recurso basta alterar as configurações no microserviço baseado no Devprime.

Criando um microserviço para utilizar no exemplo

Nós utilizaremos um microsserviço baseado na plataforma Devprime

Utilize uma conta ativa no Devprime e ative o Devprime CLI.
Inicie os containers pelo Docker (MongoDB, RabbitMQ e Redis)
Crie a fila orderevents no RabbitMQ.
Crie um novo microsserviço “order”.

Iniciando a configuração da idempotência

Configuração da idempotência na chave “Devprime_App”
Altere na configuração do Idempotency na opção “Enabled” para “true” e o “Flow” para “frontend”. Nós alteramos a “key” para “my-idempotency-key”. Com essa configuração a API vai requerer no Headar a chave de idempotência.
code .\src\app\appsettings.json

    "Idempotency": {
      "Enable": "true",
      "Alias": "State2",
      "Duration": "86400",
      "Flow": "frontend",
      "key": "my-idempotency-key",
      "Scope": "all",
      "Action": "auto"
    }

Inclua um segunda persistência na chave “Devprime_State”
Nesse exemplo utilizaremos um Redis local com uma senha padrão
code .\src\app\appsettings.json

{
  "enable": "true",
  "alias": "State2",
  "dbtype": "redis",
  "connection": "127.0.0.1:6379,password=LltF8Nx*yo",
  "timeout": "5",
  "retry": "2",
  "durationofbreak": "45"
}

Iniciando idempotência automática no microsserviço

Agora chegou o momento de testar a configuração. Antes de iniciar o microsserviço certifique de ter ativado os containers e criado a fila no RabbitMQ.

Execute a aplicação e faça um post pela API Order
Nós precisamos passar nesse cenário a chave de idempotência pelo Head por isso você precisa consumiar a API utilizando o curl, podtman, insomnia e muitas outras.

Iniciando o microsserviço configurado para usar uma chave de idempotência
`

Um código json de exemplo para uso na API. Modifique nos seus testes.

{
  "customerName": "Bill",
  "customerTaxID": "string",
  "itens": [
    {
      "description": "short",
      "amount": 1,
      "sku": "XNY1AC",
      "price": 100
    }
  ],
  "total": 100
}

No primeiro teste nós não passaremos a chave da idempotência no POST conforme exemplo realizado no Postman.

Ao olhar o retorna da API nós teremos uma negativa do request pela ausência da chave que na configuração com o “Flow” do tipo “Backend” é obrigatória e deve ser passada pelo Header.

Agora vamos adicionar a nossa chave “my-idempotency-key” e um valor guid.

Após confirmar o post no passo anterior o Log já registra sucesso no processo de idempotência.

Ao tentar realizar um novo Post com a mesma chave anterior o comando duplicado já é negado automaticamente.

Nesse artigo você observou como é fácil implementar o recurso de idempotência nos microsserviços desenvolvimento com a plataforma Devprime.

Você tem a disposição configurações adicionais como “Action” que configurado como “manual” exige que você ative em um metodo especifico e/ou a “Scope” que pode limitar a atuação em um Adapter como “Web” ou “Stream”

Mais artigos sobre idempotência

Implementing idempotency in microsserviços
Building an idempotent event-driven microsserviços

Examples: Building an idempotent event-driven microsserviços

Mon, 01 Jan 0001 00:00:00 +0000

Criando um microserviço para utilizar no exemplo

Nós utilizaremos um microsserviço baseado na plataforma Devprime

Utilize uma conta ativa no Devprime e ative o Devprime CLI.
Inicie os containers pelo Docker (MongoDB, RabbitMQ e Redis)
Crie a fila orderevents e paymentevents no RabbitMQ.
Crie um novo microsserviço seguindo o exemplo do “payment” apresemtado.
Esse microsserviço escutará a fila/tópico “orderevents”

Iniciando a configuração da idempotência

    "Idempotency": {
      "Enable": "true",
      "Alias": "State2",
      "Duration": "86400",
      "Flow": "backend",
      "key": "idempotency-key",
      "Scope": "all",
      "Action": "auto"
    }

Inclua um segunda persistência na chave “Devprime_State”
Nesse exemplo utilizaremos um Redis local com uma senha padrão
code .\src\app\appsettings.json

{
  "enable": "true",
  "alias": "State2",
  "dbtype": "redis",
  "connection": "127.0.0.1:6379,password=LltF8Nx*yo",
  "timeout": "5",
  "retry": "2",
  "durationofbreak": "45"
}

Para esse cenário nós adicionaremos o evento diretamente no RabbitMQ para simularmos uma duplicidade de eventos.

Execute o microsserviço dp-stream e entre no portal do Rabbitmq em
http://localhost:15672 com o usuário guest/guest. Localize o menu Queues > orderevents e localize o item “Publish message”

Localize o campo payload e cole o json abaixo e dpeois vá em “Publish message” para colocar esse evento na fila.

{
   "Headers":{
      "uber-trace-id":"126e838875d34dd3:5644a477603d0a55:bc20635b06c79bc2:1"
   },
   "Id":"36dbd9d0-7b8b-41fb-bdaf-2ff6a0672bd4",
   "CorrelationId":"18c71a48-0253-4247-9c8b-d576c4f8394e",
   "AppId":"21cef89c-229e-4291-8d6a-1ccf5c401484",
   "AppName":"ms-idempotency",
   "TenantID":"",
   "TenantUserID":"",
   "Version":1,
   "Name":"OrderCreated",
   "CreationDate":"2022-03-13T11:14:01.0284863-03:00",
   "Payload":{
      "ID":"ccfc8248-2ab5-4423-92fc-b16c4555add2",
      "CustomerName":"Bill",
      "CustomerTaxID":"string",
      "Total":100
   }
}

O microserviço está escutado essa fila e já vai reagir ao evento e processar com sucesso.

Agora retorne ao RabbitMQ e envie novamente o mesmo evento e vai observar que ao chegar ao microsserviço ele é rejeitado automaticamente.

Para repetir o teste altere um valor no Payload do json colocando um outro guid no ID por exemplo.

Iniciando a idempotência manual

** Alterando a chave “Action” para “Manual”**

    "Idempotency": {
      "Enable": "true",
      "Alias": "State2",
      "Duration": "86400",
      "Flow": "backend",
      "key": "idempotency-key",
      "Scope": "all",
      "Action": "manual"
    }

No modo manual ao efetuar um teste enviando eventos duplicados vai observar que eles serão aceitos. Você precisa visitar cada método desejado e adicionar “Dp.Idempotency.Enable = true;” para a habilitar o controle de idempotência.

** Modificando o Stream para ter idempotência"**
Abra o Hub de eventos e localizar o subscribe do evento desejado que nesse contexto é o “OrderCreated” e adicine o “Dp.Idempotency.Enable = true;”.
code src\Adapters\Stream\EventStream.cs

namespace Devprime.Stream;
public class EventStream : EventStreamBase, IEventStream
{
    public override void StreamEvents()
    {
        Subscribe<IPaymentService>("Stream1", "OrderCreated", (payload, paymentService, Dp) =>
        {
            Dp.Idempotency.Enable = true;

            var dto = System.Text.Json.JsonSerializer.Deserialize<OrderCreatedEventDTO>(payload);
            var command = new Payment()
            {
                CustomerName = dto.CustomerName,
                OrderID = dto.OrderID,
                Value = dto.Value
            };
            paymentService.Add(command);
        });
    }
}

Ao tentar executar novamnente com eventos duplicados já vai perceber que voltou a funcionar.

Mais artigos sobre idempotência

Idempotency in microsserviços and REST APIs
Building an idempotent event-driven microsserviços