The latest articles on DEV Community by Celso Costa (@jccl). https://dev.to/jccl https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F1821045%2F5a98341f-7375-4805-b580-fe8818ac3d1b.png https://dev.to/jccl en Celso Costa Wed, 24 Jul 2024 21:41:43 +0000 https://dev.to/jccl/projeto-desenvolvimento-de-um-marketplace-14n8 https://dev.to/jccl/projeto-desenvolvimento-de-um-marketplace-14n8 <h2> Descrição do Projeto </h2> <p>Desenvolvendo um marketplace. Como único desenvolvedor, fiquei responsável por desenvolver tanto o frontend quanto o backend, além de gerenciar a infraestrutura em uma VPS para colocar o sistema em produção. Estamos utilizando o padrão REST para a comunicação entre o frontend e o backend, bem como entre os serviços internos. Nosso objetivo é que esta primeira versão tenha funcionalidades essenciais, como registro e autenticação de usuários, listagem e gerenciamento de produtos, carrinho de compras, checkout e integração com um gateway de pagamento.</p> <p>O intuito deste post é mostrar como o projeto foi pensado e desenvolvido, apontar as dificuldades enfrentadas e, por fim, sugerir melhorias para as próximas versões. Caso você esteja pensando em construir um marketplace ou e-commerce, leve em consideração as informações contidas neste post, mas use o bom senso, pois nem tudo o que está aqui pode se aplicar ao seu caso.</p> <p><strong>Observação:</strong> Esse post não irá detalhar como foi desenvolvido o frontend.</p> <h2> Requisitos </h2> <p><strong>Definição:</strong> Definem o que um sistema deve fazer e sob quais restrições. Requisitos relacionados com a primeira parte dessa definição - "o que um sistema deve fazer", ou seja, suas funcionalidades - são chamados de <strong>Requisitos Funcionais.</strong> Já os requisitos relacionados a segunda parte - "sob que restrições" - são chamados de <strong>Requisitos Não Funcionais</strong>.[1]</p> <p><strong>Requisitos Funcionais(RF)</strong></p> <p><u>Lojista</u></p> <p>[RF01]: O sistema deve permitir que os lojistas se registrem sendo do tipo pessoa física ou jurídica.<br> [RF02]: O sistema deve permitir que o administrador possa autorizar ou desautorizar o lojistas caso não esteja em conformidades com as informações verdadeiras informadas no cadastro.<br> [RF03]: O sistema deve permitir que o lojista vincule o seu perfil a uma comunidade<br> [RF04]: O sistema deve permitir que o lojista possa cria sua loja com foto da loja, descrição e contato.<br> [RF05]: O sistema deve permitir que o lojista cadastre produtos<br> [RF06]: O sistema deve permitir que o lojista possa alterar o preço do produto, quantidade e excluir produto.<br> [RF08]: O sistema deve permitir que o lojista possa</p> <p><u>Cliente</u></p> <p>[RF01]: O sistema deve permitir que o cliente se registrem sendo do tipo pessoa física ou jurídica.<br> [RF02]: O sistema deve permitir que o cliente cadastre endereços, cartões para pagamentos e informações básicas de contato como email e telefone.<br> [RF03]: O sistema deve permitir que o cliente adicione ao carrinho o item desejado<br> [RF04]: O sistema deve permitir o pagamento de cartão de crédito ou pix<br> [RF05]: O sistema deve permitir que o cliente escolha se prefere retirar na loja ou entrega(via transportadora).<br> [RF06]: O sistema deve permitir que o cliente acompanhe o status do pedido, como: pedido feito, pedido autorizado, pedido em transporte e pedido entregue<br> [RF07]: O sistema deve permitir que o cliente receba um email informando os itens comprados</p> <p><u>Comunidades</u></p> <p>[RF01]: O sistema deve permitir que o um líder de comunidade se registre com informações do tipo quem são os líderes da comunidade CPF, CNPJ, informações de contato e endereço.<br> [RF02]: O sistema deve permitir que o líder da comunidade liste todos os lojistas vinculada a essa comunidade.</p> <p><u>Administrador</u></p> <p>[RF01]: O sistema deve permitir o administrador listar todos os clientes cadastrados.<br> [RF02]: O sistema deve permitir que o administrador liste todos os lojistas e consiga desautorizar o lojista que não esteja em conformidades com a regras da plataforma.<br> [RF03]: O sistema deve permitir que o administrador liste todas as comunidades, tenha informações sobre os responsáveis delas e possa autorizar ou desautorizar as comunidades.</p> <p><strong>Requisitos não funcionais(RNF)</strong></p> <p><u>Segurança</u></p> <p>[RNF01]: O armazenamento dos tokens de acesso e de renovação deve ser seguro, preferencialmente em armazenamento seguro do navegador (por exemplo, localStorage ou cookies com flags Secure e HttpOnly).</p> <p>[RNF02]: O sistema deve implementar a renovação de tokens (refresh tokens) de forma segura para permitir sessões prolongadas sem comprometer a segurança.</p> <h2> Stack </h2> <ul> <li>NextJS/ReactJS</li> <li>NodeJS</li> <li>PostgreSQL</li> <li>Nginx</li> <li>minIO</li> <li>Docker</li> <li>RabbitMQ</li> </ul> <h2> System Design </h2> <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F9f1cmtw3fo67554tfv9w.png" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F9f1cmtw3fo67554tfv9w.png" alt="Image description" width="800" height="397"></a></p> <h2> Explicando o Fluxo </h2> <ul> <li> <strong>public-gateway</strong> </li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> Atua como ponto de entrada para gerenciar e rotear. Redireciona o tráfego de entrada e saída entre a rede interna e externa.</p> <ul> <li> <strong>auth</strong> </li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de Autenticação recebe as requisições de autenticação do <strong>public-gateway</strong>, valida essas requisições, e faz chamadas apropriadas para o serviço de <strong>identity</strong> para verificar as credenciais e gerenciar o registro dos usuários.</p> <ul> <li> <strong>identity</strong> </li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de Identity gerencia as operações relacionadas aos usuários e contas, incluindo autenticação, registro, atualização de perfis.</p> <ul> <li><strong>community</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de Community gerencia a criação, atualização e manutenção de dados de comunidades e seus respectivos responsáveis, incluindo endereços, e-mails e telefones.</p> <ul> <li><strong>customer</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de Customer gerencia a criação, atualização e manutenção de dados de comunidades e seus respectivos responsáveis, incluindo endereços, e-mails e telefones.</p> <ul> <li><strong>marketplace</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de marketplace é responsável por gerenciar as operações essenciais de um marketplace, incluindo carrinho de compras, categorias de produtos, inventário e pedidos. Ele utiliza diversos modelos, como <em>Cart</em>, que representa um carrinho de compras; <em>CartSessionCartItem</em>, que gerencia a associação entre uma sessão de carrinho e itens; Category, que classifica os itens em categorias; e Department, que organiza os produtos por departamentos. Além disso, inclui Item, que representa os produtos disponíveis; <em>ItemMedia</em>, para gerenciar as fotos dos itens; <em>ItemNumbering</em>, que lida com a numeração dos itens; e <em>ItemSize</em>, que define os tamanhos dos itens (P, M, G, etc.). O serviço também abrange <em>OrderItem</em>, que representa itens dentro de um pedido; <em>OrderStatus</em>, que gerencia o status dos pedidos; <em>OrderShipping</em>, que lida com as informações de envio dos pedidos; e <em>OrderItemShipping</em>, que gerencia o envio de itens específicos dentro de um pedido. Outros modelos incluem <em>ShippingToken</em>, que representa tokens de envio para rastreamento; <em>ShippingService</em>, que gerencia os serviços de envio disponíveis; e <em>StoreStoreAddress</em>, que representa o endereço das lojas. O serviço permite a adição e remoção de itens do carrinho, a categorização e organização dos produtos, e o processamento completo dos pedidos, desde a criação até o envio.</p> <ul> <li><strong>media</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript, minIO</p> <p><em>Descrição:</em> O Serviço de media é responsável pelo gerenciamento e armazenamento de arquivos de mídia, incluindo fotos das lojas, fotos de perfil e fotos dos itens (produtos). Organiza por buckets do MinIO para armazenar essas mídias.</p> <ul> <li><strong>supplier</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de supplier gerencia a criação, atualização e manutenção de dados do lojista incluindo endereços, e-mails e telefones.</p> <ul> <li><strong>marketplace-cart-session-cron</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço de marketplace-cart-session-cron é responsável por gerenciar e limpar carrinhos de compras abandonados. Este serviço executa uma tarefa programada que verifica e remove carrinhos inativos no banco de dados. Para carrinhos de usuários não autenticados, ou seja, aqueles que não fizeram login, o serviço mantém o carrinho ativo por um período de 24 horas antes de removê-lo. Para carrinhos de usuários autenticados, o carrinho permanece ativo por 7 dias.</p> <ul> <li> <strong>marketplace-order-cron</strong> </li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> A crontab marketplace-order-cron é responsável pela automação do processo de verificação e atualização dos pedidos com status de pagamento pendente. O serviço opera em intervalos regulares para consultar todos os pedidos que estão com o status "pendente de pagamento". Para cada pedido identificado, o serviço realiza uma solicitação à API de pagamento para processar o pagamento. Se o pagamento for bem-sucedido, o serviço atualiza o status do pedido no banco de dados para refletir a nova condição.</p> <ul> <li><strong>shipping-cron</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O Serviço shipping-cron é responsável por manter a validade dos tokens da API da transportadora. Este serviço é executado periodicamente para atualizar o token de autenticação, que é necessário para realizar chamadas à API da transportadora. Como os tokens fornecidos pela transportadora têm um período de expiração, o shipping-cron garante que um novo token seja obtido e registrado antes que o token atual expire, assegurando que as operações de envio e rastreamento continuem a funcionar sem interrupções.</p> <ul> <li><strong>customer-external-consumer</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> <br> O customer-external-consumer é um serviço que consome mensagens de uma fila no RabbitMQ. Sua principal função é cadastrar clientes na API de pagamento e obter o identificador exclusivo do cliente fornecido pela API de pagamento. Esse identificador é então armazenado no banco de dados. Isso permite que, ao fazer pedidos de itens, o serviço envie à API de pagamento o identificador do cliente, facilitando a associação dos pagamentos com os clientes corretos.</p> <ul> <li><strong>supplier-external-consumer</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O supplier-external-consumer é um serviço que consome mensagens de uma fila no RabbitMQ. Sua principal função é cadastrar (lojistas) fornecedores na API de pagamento e obter o identificador exclusivo do fornecedor fornecido pela API de pagamento. Esse identificador é então armazenado no banco de dados local. Isso permite que, ao processar transações relacionadas aos fornecedores, o serviço envie à API de pagamento o identificador do fornecedor, garantindo a correta associação dos pagamentos com os fornecedores registrados.</p> <ul> <li><strong>email-consumer</strong></li> </ul> <p><em>Tecnologia:</em> NodeJS, Typescript</p> <p><em>Descrição:</em> O email-consumer é um serviço que consome mensagens de email de uma fila no RabbitMQ. Ao receber uma mensagem, o serviço monta o template de email utilizando os atributos fornecidos no payload da mensagem. Após a montagem do email, o serviço envia o email formatado para o servidor SMTP para ser entregue ao destinatário.</p> <h2> Dificuldades enfrentadas </h2> <ol> <li><p>Inicialmente, eu não quis trabalhar com nenhum ORM, o que foi um grande erro, porque no início, quando eu desenvolvia uma feature e o cliente pedia para adicionar ou remover uma nova informação, a manutenção das queries ficava bastante custosa. Então, tive que refatorar e adotei o ORM, facilitando a manutenção do sistema.</p></li> <li><p>Inicialmente, não tínhamos um(a) designer para o projeto, então precisei dedicar muito tempo à construção dos layouts das telas, e o cliente acabou achando-os muito simples. No final do projeto, uma UX/UI foi integrada à equipe e conseguiu criar, no Figma, os layouts da maneira que o cliente desejava. Minha observação: ter um(a) UX/UI facilitará e agregará valor ao seu projeto.</p></li> <li><p>Como as especificações não estavam definidas desde o primeiro dia, a primeira versão foi desenvolvida de forma iterativa e contínua. Decidi aplicar os conceitos de Domain-Driven Design (DDD), mas, ao precisar refatorar, era necessário modificar muitos arquivos, como interfaces de repositório e validações. Então, para a versão 1 e considerando que o cliente ainda não tinha clareza sobre o que precisava ser implementado, eu optaria por uma arquitetura mais simples para facilitar o desenvolvimento. Acredito que isso tenha sido um exemplo de overengineering no projeto, o que custou tempo de desenvolvimento.</p></li> </ol> <h2> Melhorias futuras </h2> <ol> <li><p>Adicionar um BFF (Backend For Frontend) com GraphQL, isso vai agregar bastante ao front-end ao consumir os dados da API.</p></li> <li><p>Adicionar testes, já que temos vários serviços e, ao alterar um, é necessário que todos estejam consistentes.</p></li> <li><p>Adicionar CI/CD para automatizar a integração e deploy conforme as equipes forem contratadas para gerenciar o projeto.</p></li> <li><p>Adicionar observabilidade dos serviços. [OpenTelemetry, Grafana]</p></li> <li><p>Adicionar CDN para imagens dos produtos.</p></li> </ol> <h2> Referência </h2> <ol> <li><a href="https://engsoftmoderna.info/cap3.html" rel="noopener noreferrer">https://engsoftmoderna.info/cap3.html</a></li> </ol> engenhariadesoftware softwareengineering product saas Celso Costa Tue, 23 Jul 2024 15:28:06 +0000 https://dev.to/jccl/producerconsumer-produtorconsumidor-1jok https://dev.to/jccl/producerconsumer-produtorconsumidor-1jok <h2> Definição </h2> <blockquote> <p><em>Consideramos dois processos, chamados de “produtor” e “consumidor”, respectivamente. O produtor é um processo cíclico e cada vez que passa pelo seu ciclo produz uma determinada porção de informação, que deve ser processada pelo consumidor. O consumidor também é um processo cíclico e cada vez que passa pelo seu ciclo pode processar a próxima porção de informação, tal como foi produzida pelo produtor. Um exemplo simples é dado por um processo computacional, que produz como “porções de informação” imagens de cartões perfurados a serem perfurados por um cartão perfurado, que desempenha o papel do consumidor.[1]</em></p> </blockquote> <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fdayimui4rbceibqmj7t8.png" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fdayimui4rbceibqmj7t8.png" alt="Image description" width="800" height="162"></a></p> <h2> Explicação </h2> <p>Um produtor cria itens e os armazena em uma estrutura de dados, enquanto um consumidor remove os itens dessa estrutura e os processa.</p> <blockquote> <p>Se o consumo for <strong>maior que</strong> a produção o buffer(estrutura de dados) esvazia, e o consumidor não tem o que consumir<br> Se o consumo for <strong>menor que</strong> a produção o buffer enche, e o produtor não consegue adicionar mais itens. Esse é um problema clássico chamado de <strong>buffer limitado</strong>.</p> </blockquote> <h2> Contextualização do Problema </h2> <p>Suponha que temos um produtor que publica um e-mail no buffer, e um consumidor que consome o e-mail do buffer e exibe uma mensagem informando que foi enviado um e-mail com a nova senha de acesso para o e-mail informado.</p> <h2> Implementação em go </h2> <div class="highlight js-code-highlight"> <pre class="highlight go"><code> <span class="k">package</span> <span class="n">main</span> <span class="k">import</span> <span class="p">(</span> <span class="s">"fmt"</span> <span class="s">"os"</span> <span class="s">"strconv"</span> <span class="s">"sync"</span> <span class="s">"time"</span> <span class="p">)</span> <span class="k">type</span> <span class="n">buffer</span> <span class="k">struct</span> <span class="p">{</span> <span class="n">items</span> <span class="p">[]</span><span class="kt">string</span> <span class="n">mu</span> <span class="n">sync</span><span class="o">.</span><span class="n">Mutex</span> <span class="p">}</span> <span class="k">func</span> <span class="p">(</span><span class="n">buff</span> <span class="o">*</span><span class="n">buffer</span><span class="p">)</span> <span class="n">add</span><span class="p">(</span><span class="n">item</span> <span class="kt">string</span><span class="p">)</span> <span class="p">{</span> <span class="n">buff</span><span class="o">.</span><span class="n">mu</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span> <span class="k">defer</span> <span class="n">buff</span><span class="o">.</span><span class="n">mu</span><span class="o">.</span><span class="n">Unlock</span><span class="p">()</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">buff</span><span class="o">.</span><span class="n">items</span><span class="p">)</span> <span class="o">&lt;</span> <span class="m">5</span> <span class="p">{</span> <span class="n">buff</span><span class="o">.</span><span class="n">items</span> <span class="o">=</span> <span class="nb">append</span><span class="p">(</span><span class="n">buff</span><span class="o">.</span><span class="n">items</span><span class="p">,</span> <span class="n">item</span><span class="p">)</span> <span class="c">// fmt.Println("Foi adicionado o item " + item)</span> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Println</span><span class="p">(</span><span class="s">"O Buffer não pode armazenar nenhum item mais está com a capacidade máxima"</span><span class="p">)</span> <span class="n">os</span><span class="o">.</span><span class="n">Exit</span><span class="p">(</span><span class="m">0</span><span class="p">)</span> <span class="p">}</span> <span class="p">}</span> <span class="k">func</span> <span class="p">(</span><span class="n">buff</span> <span class="o">*</span><span class="n">buffer</span><span class="p">)</span> <span class="n">get</span><span class="p">()</span> <span class="kt">string</span> <span class="p">{</span> <span class="n">buff</span><span class="o">.</span><span class="n">mu</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span> <span class="k">defer</span> <span class="n">buff</span><span class="o">.</span><span class="n">mu</span><span class="o">.</span><span class="n">Unlock</span><span class="p">()</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">buff</span><span class="o">.</span><span class="n">items</span><span class="p">)</span> <span class="o">==</span> <span class="m">0</span> <span class="p">{</span> <span class="k">return</span> <span class="s">""</span> <span class="p">}</span> <span class="n">target</span> <span class="o">:=</span> <span class="n">buff</span><span class="o">.</span><span class="n">items</span><span class="p">[</span><span class="m">0</span><span class="p">]</span> <span class="n">buff</span><span class="o">.</span><span class="n">items</span> <span class="o">=</span> <span class="n">buff</span><span class="o">.</span><span class="n">items</span><span class="p">[</span><span class="m">1</span><span class="o">:</span><span class="p">]</span> <span class="k">return</span> <span class="n">target</span> <span class="p">}</span> <span class="k">var</span> <span class="n">wg</span> <span class="n">sync</span><span class="o">.</span><span class="n">WaitGroup</span> <span class="k">func</span> <span class="n">main</span><span class="p">()</span> <span class="p">{</span> <span class="n">buff</span> <span class="o">:=</span> <span class="n">buffer</span><span class="p">{}</span> <span class="n">wg</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="m">2</span><span class="p">)</span> <span class="k">go</span> <span class="n">producer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">buff</span><span class="p">)</span> <span class="k">go</span> <span class="n">consumer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">buff</span><span class="p">)</span> <span class="n">wg</span><span class="o">.</span><span class="n">Wait</span><span class="p">()</span> <span class="p">}</span> <span class="k">func</span> <span class="n">producer</span><span class="p">(</span><span class="n">buff</span> <span class="o">*</span><span class="n">buffer</span><span class="p">)</span> <span class="p">{</span> <span class="k">defer</span> <span class="n">wg</span><span class="o">.</span><span class="n">Done</span><span class="p">()</span> <span class="k">for</span> <span class="n">index</span> <span class="o">:=</span> <span class="m">1</span><span class="p">;</span> <span class="p">;</span> <span class="n">index</span><span class="o">++</span> <span class="p">{</span> <span class="n">str</span> <span class="o">:=</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">index</span><span class="p">)</span> <span class="o">+</span> <span class="s">"@email.com"</span> <span class="n">buff</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">str</span><span class="p">)</span> <span class="n">time</span><span class="o">.</span><span class="n">Sleep</span><span class="p">(</span><span class="m">5</span> <span class="o">*</span> <span class="n">time</span><span class="o">.</span><span class="n">Millisecond</span><span class="p">)</span> <span class="c">// Adiciona um pequeno atraso para simular produção</span> <span class="p">}</span> <span class="p">}</span> <span class="k">func</span> <span class="n">consumer</span><span class="p">(</span><span class="n">buff</span> <span class="o">*</span><span class="n">buffer</span><span class="p">)</span> <span class="p">{</span> <span class="k">defer</span> <span class="n">wg</span><span class="o">.</span><span class="n">Done</span><span class="p">()</span> <span class="k">for</span> <span class="p">{</span> <span class="n">data</span> <span class="o">:=</span> <span class="n">buff</span><span class="o">.</span><span class="n">get</span><span class="p">()</span> <span class="k">if</span> <span class="n">data</span> <span class="o">!=</span> <span class="s">""</span> <span class="p">{</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Println</span><span class="p">(</span><span class="s">"Enviado um email com a nova senha de acesso para: "</span> <span class="o">+</span> <span class="n">data</span><span class="p">)</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> </code></pre> </div> <h2> Explicando a implementação </h2> <ul> <li>Primeiro, criamos uma estrutura chamada <em>buffer</em>, que contém um array de strings chamado <em>items</em> e um mecanismo de controle do tipo mutex, chamado mu, para gerenciar o acesso concorrente.</li> <li>Temos duas funções: uma chamada add, que basicamente adiciona um item ao buffer, desde que haja espaço disponível, já que a capacidade do buffer é de apenas 5 itens; e outra chamada get, que, se houver itens no buffer, retorna o primeiro elemento e remove esse elemento do buffer.</li> <li>O <em>Producer</em> basicamente pega o index do loop e o concatena em uma string chamada <em>str</em>, que contém o índice e um domínio de e-mail fictício, e adiciona no buffer. Foi adicionado um intervalo de tempo para simular um atraso.</li> <li>O <em>Consumer</em> solicita ao buffer um item, caso tenha ao menos um item. Em seguida, o Consumer exibe uma mensagem na tela informando que foi enviado um e-mail com a nova senha de acesso para o item que foi publicado publicado no buffer.</li> </ul> <p><strong>Link do código:</strong> <a href="https://github.com/jcelsocosta/race_condition/blob/main/producerconsumer/buffer/producerconsumer.go" rel="noopener noreferrer">https://github.com/jcelsocosta/race_condition/blob/main/producerconsumer/buffer/producerconsumer.go</a></p> <h2> Referência </h2> <ol> <li> <a href="https://www.cs.utexas.edu/%7EEWD/transcriptions/EWD01xx/EWD123.html#4.1.%20Typical%20Uses%20of%20the%20General%20Semaphore" rel="noopener noreferrer">https://www.cs.utexas.edu/~EWD/transcriptions/EWD01xx/EWD123.html#4.1.%20Typical%20Uses%20of%20the%20General%20Semaphore</a>.</li> </ol> <h2> Bibliografia </h2> <p><a href="https://www.cin.ufpe.br/%7Ecagf/if677/2015-2/slides/08_Concorrencia%20(Jorge).pdf" rel="noopener noreferrer">https://www.cin.ufpe.br/~cagf/if677/2015-2/slides/08_Concorrencia%20(Jorge).pdf</a></p> go producerconsumer monitor concurrency Celso Costa Mon, 22 Jul 2024 22:47:11 +0000 https://dev.to/jccl/race-condition-condicao-de-corrida-2461 https://dev.to/jccl/race-condition-condicao-de-corrida-2461 <blockquote> <p>Quando dois ou mais Threads/Processos competem por um recurso.</p> </blockquote> <h2> Race Condition (Condição de Corrida) </h2> <p>Iremos utilizar goroutines que é a forma de executar uma atividade de maneira concorrente em go.</p> <p>Problema:</p> <p><em>Suponha que temos três clientes: um chamado A, outro chamado B e outro C. Todos estão interessados em comprar a mesma camisa em um e-commerce, porém existem apenas 10 unidades disponíveis dessa camisa. Crie uma goroutine para cada cliente e simule a compra dessa camisa, "printando" na tela qual cliente comprou a camisa, a quantidade comprada e qual a quantidade restante de camisas no estoque.</em><br> </p> <div class="highlight js-code-highlight"> <pre class="highlight go"><code><span class="k">package</span> <span class="n">main</span> <span class="k">import</span> <span class="p">(</span> <span class="s">"fmt"</span> <span class="s">"strconv"</span> <span class="s">"sync"</span> <span class="s">"time"</span> <span class="p">)</span> <span class="k">type</span> <span class="n">itemType</span> <span class="k">struct</span> <span class="p">{</span> <span class="n">itemId</span> <span class="kt">int</span> <span class="n">name</span> <span class="kt">string</span> <span class="n">price</span> <span class="kt">int</span> <span class="n">unit</span> <span class="kt">int</span> <span class="p">}</span> <span class="k">func</span> <span class="p">(</span><span class="n">i</span> <span class="o">*</span><span class="n">itemType</span><span class="p">)</span> <span class="n">takeItem</span><span class="p">(</span><span class="n">customer</span> <span class="o">*</span><span class="n">customerType</span><span class="p">,</span> <span class="n">unit</span> <span class="kt">int</span><span class="p">)</span> <span class="p">{</span> <span class="c">// Simula um atraso para aumentar a chance de condição de corrida</span> <span class="n">time</span><span class="o">.</span><span class="n">Sleep</span><span class="p">(</span><span class="m">50</span> <span class="o">*</span> <span class="n">time</span><span class="o">.</span><span class="n">Millisecond</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">&gt;</span> <span class="m">0</span> <span class="o">&amp;&amp;</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">&gt;=</span> <span class="n">unit</span> <span class="p">{</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">-</span> <span class="n">unit</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Println</span><span class="p">(</span><span class="s">"O Cliente "</span> <span class="o">+</span> <span class="n">customer</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">" comprou "</span> <span class="o">+</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">unit</span><span class="p">)</span> <span class="o">+</span> <span class="s">" unidade(s) de "</span> <span class="o">+</span> <span class="n">i</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">" e a quantidade restante no estoque é "</span> <span class="o">+</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">i</span><span class="o">.</span><span class="n">unit</span><span class="p">))</span> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Println</span><span class="p">(</span><span class="s">"O Cliente "</span> <span class="o">+</span> <span class="n">customer</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">" não conseguiu comprar "</span> <span class="o">+</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">unit</span><span class="p">)</span> <span class="o">+</span> <span class="s">" unidade(s) de "</span> <span class="o">+</span> <span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="p">}</span> <span class="p">}</span> <span class="k">type</span> <span class="n">customerType</span> <span class="k">struct</span> <span class="p">{</span> <span class="n">customerId</span> <span class="kt">int</span> <span class="n">name</span> <span class="kt">string</span> <span class="p">}</span> <span class="k">var</span> <span class="n">wg</span> <span class="n">sync</span><span class="o">.</span><span class="n">WaitGroup</span> <span class="k">func</span> <span class="n">main</span><span class="p">()</span> <span class="p">{</span> <span class="n">shirt</span> <span class="o">:=</span> <span class="n">itemType</span><span class="p">{</span><span class="m">441</span><span class="p">,</span> <span class="s">"camisa"</span><span class="p">,</span> <span class="m">1000</span><span class="p">,</span> <span class="m">10</span><span class="p">}</span> <span class="n">customerA</span> <span class="o">:=</span> <span class="n">customerType</span><span class="p">{</span><span class="m">1</span><span class="p">,</span> <span class="s">"A"</span><span class="p">}</span> <span class="n">customerB</span> <span class="o">:=</span> <span class="n">customerType</span><span class="p">{</span><span class="m">2</span><span class="p">,</span> <span class="s">"B"</span><span class="p">}</span> <span class="n">customerC</span> <span class="o">:=</span> <span class="n">customerType</span><span class="p">{</span><span class="m">3</span><span class="p">,</span> <span class="s">"C"</span><span class="p">}</span> <span class="n">wg</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="m">3</span><span class="p">)</span> <span class="k">go</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">shirt</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">customerA</span><span class="p">,</span> <span class="m">4</span><span class="p">)</span> <span class="k">go</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">shirt</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">customerB</span><span class="p">,</span> <span class="m">5</span><span class="p">)</span> <span class="k">go</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">shirt</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">customerC</span><span class="p">,</span> <span class="m">3</span><span class="p">)</span> <span class="n">wg</span><span class="o">.</span><span class="n">Wait</span><span class="p">()</span> <span class="p">}</span> <span class="k">func</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="n">shirt</span> <span class="o">*</span><span class="n">itemType</span><span class="p">,</span> <span class="n">customer</span> <span class="o">*</span><span class="n">customerType</span><span class="p">,</span> <span class="n">unit</span> <span class="kt">int</span><span class="p">)</span> <span class="p">{</span> <span class="n">shirt</span><span class="o">.</span><span class="n">takeItem</span><span class="p">(</span><span class="n">customer</span><span class="p">,</span> <span class="n">unit</span><span class="p">)</span> <span class="n">wg</span><span class="o">.</span><span class="n">Done</span><span class="p">()</span> <span class="p">}</span> </code></pre> </div> <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fyw40wi93chcptvzt94ca.png" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fyw40wi93chcptvzt94ca.png" alt="Image description" width="800" height="232"></a></p> <p>Dado que a camisa tem apenas 10 unidades e três clientes querem comprar um total de 12 unidades. A primeira resposta é que o Cliente C comprou 3 unidades de camisa e a quantidade restante no estoque é de 2 unidades. Porém, se o total de camisas é 10 unidades e o Cliente C comprou 3 unidades, deveria haver 7 unidades no estoque. Após o Cliente C, temos o Cliente A que não conseguiu comprar 4 camisas e, por fim, o Cliente B que conseguiu comprar 5 unidades, mostrando na tela que ainda há 5 unidades em estoque. Isso demonstra um problema de race condition onde temos threads/processos competindo por um recurso.</p> <h2> Adicionando o controle de concorrência com mutex </h2> <p>Agora queremos que cada cliente que estiver com o item possa subtrair uma unidade desse item sem que nenhuma outra goroutine esteja acessando e modificando a quantidade do item.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight go"><code><span class="k">package</span> <span class="n">main</span> <span class="k">import</span> <span class="p">(</span> <span class="s">"fmt"</span> <span class="s">"strconv"</span> <span class="s">"sync"</span> <span class="s">"time"</span> <span class="p">)</span> <span class="k">type</span> <span class="n">itemType</span> <span class="k">struct</span> <span class="p">{</span> <span class="n">itemId</span> <span class="kt">int</span> <span class="n">name</span> <span class="kt">string</span> <span class="n">price</span> <span class="kt">int</span> <span class="n">unit</span> <span class="kt">int</span> <span class="p">}</span> <span class="k">func</span> <span class="p">(</span><span class="n">i</span> <span class="o">*</span><span class="n">itemType</span><span class="p">)</span> <span class="n">takeItem</span><span class="p">(</span><span class="n">customer</span> <span class="o">*</span><span class="n">customerType</span><span class="p">,</span> <span class="n">unit</span> <span class="kt">int</span><span class="p">)</span> <span class="p">{</span> <span class="n">mu</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span> <span class="c">// Simula um atraso para aumentar a chance de condição de corrida</span> <span class="n">time</span><span class="o">.</span><span class="n">Sleep</span><span class="p">(</span><span class="m">50</span> <span class="o">*</span> <span class="n">time</span><span class="o">.</span><span class="n">Millisecond</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">&gt;</span> <span class="m">0</span> <span class="o">&amp;&amp;</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">&gt;=</span> <span class="n">unit</span> <span class="p">{</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">unit</span> <span class="o">-</span> <span class="n">unit</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Println</span><span class="p">(</span><span class="s">"O Cliente "</span> <span class="o">+</span> <span class="n">customer</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">" comprou "</span> <span class="o">+</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">unit</span><span class="p">)</span> <span class="o">+</span> <span class="s">" unidade(s) de "</span> <span class="o">+</span> <span class="n">i</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">" e a quantidade restante no estoque é "</span> <span class="o">+</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">i</span><span class="o">.</span><span class="n">unit</span><span class="p">))</span> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Println</span><span class="p">(</span><span class="s">"O Cliente "</span> <span class="o">+</span> <span class="n">customer</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">" não conseguiu comprar "</span> <span class="o">+</span> <span class="n">strconv</span><span class="o">.</span><span class="n">Itoa</span><span class="p">(</span><span class="n">unit</span><span class="p">)</span> <span class="o">+</span> <span class="s">" unidade(s) de "</span> <span class="o">+</span> <span class="n">i</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="p">}</span> <span class="n">mu</span><span class="o">.</span><span class="n">Unlock</span><span class="p">()</span> <span class="p">}</span> <span class="k">type</span> <span class="n">customerType</span> <span class="k">struct</span> <span class="p">{</span> <span class="n">customerId</span> <span class="kt">int</span> <span class="n">name</span> <span class="kt">string</span> <span class="p">}</span> <span class="k">var</span> <span class="n">wg</span> <span class="n">sync</span><span class="o">.</span><span class="n">WaitGroup</span> <span class="k">var</span> <span class="n">mu</span> <span class="n">sync</span><span class="o">.</span><span class="n">Mutex</span> <span class="k">func</span> <span class="n">main</span><span class="p">()</span> <span class="p">{</span> <span class="n">shirt</span> <span class="o">:=</span> <span class="n">itemType</span><span class="p">{</span><span class="m">441</span><span class="p">,</span> <span class="s">"camisa"</span><span class="p">,</span> <span class="m">1000</span><span class="p">,</span> <span class="m">10</span><span class="p">}</span> <span class="n">customerA</span> <span class="o">:=</span> <span class="n">customerType</span><span class="p">{</span><span class="m">1</span><span class="p">,</span> <span class="s">"A"</span><span class="p">}</span> <span class="n">customerB</span> <span class="o">:=</span> <span class="n">customerType</span><span class="p">{</span><span class="m">2</span><span class="p">,</span> <span class="s">"B"</span><span class="p">}</span> <span class="n">customerC</span> <span class="o">:=</span> <span class="n">customerType</span><span class="p">{</span><span class="m">3</span><span class="p">,</span> <span class="s">"C"</span><span class="p">}</span> <span class="n">wg</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="m">3</span><span class="p">)</span> <span class="k">go</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">shirt</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">customerA</span><span class="p">,</span> <span class="m">4</span><span class="p">)</span> <span class="k">go</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">shirt</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">customerB</span><span class="p">,</span> <span class="m">5</span><span class="p">)</span> <span class="k">go</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="o">&amp;</span><span class="n">shirt</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">customerC</span><span class="p">,</span> <span class="m">3</span><span class="p">)</span> <span class="n">wg</span><span class="o">.</span><span class="n">Wait</span><span class="p">()</span> <span class="p">}</span> <span class="k">func</span> <span class="n">routineCustomer</span><span class="p">(</span><span class="n">shirt</span> <span class="o">*</span><span class="n">itemType</span><span class="p">,</span> <span class="n">customer</span> <span class="o">*</span><span class="n">customerType</span><span class="p">,</span> <span class="n">unit</span> <span class="kt">int</span><span class="p">)</span> <span class="p">{</span> <span class="n">shirt</span><span class="o">.</span><span class="n">takeItem</span><span class="p">(</span><span class="n">customer</span><span class="p">,</span> <span class="n">unit</span><span class="p">)</span> <span class="n">wg</span><span class="o">.</span><span class="n">Done</span><span class="p">()</span> <span class="p">}</span> </code></pre> </div> <p><a href="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fd2tkgswvzm3mjey9pm8f.png" class="article-body-image-wrapper"><img src="https://media2.dev.to/dynamic/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2Fd2tkgswvzm3mjey9pm8f.png" alt="Image description" width="800" height="222"></a></p> <p>Agora temos como saída o Cliente B comprando 5 unidades e a quantidade do estoque sendo 5, logo após o Cliente C comprando 3 unidades e a quantidade do estoque sendo 2, e por fim, o Cliente A não consegue comprar 4 unidades porque só existem 2 unidades disponíveis.</p> <p>Nesse caso, o que ocorre é o seguinte: quando uma goroutine tenta subtrair a unidade do item, ela deve chamar o método Lock do mutex para adquirir uma trava exclusiva. Se outra goroutine tiver adquirido a trava, essa operação ficará bloqueada até a outra goroutine chamar Unlock e a trava tornar-se disponível novamente. O mutex protege as variáveis compartilhadas.</p> <p>A região de código entre Lock e Unlock, em que a goroutine é livre para ler e modificar as variáveis compartilhadas, é chamada de seção crítica.</p> <p><strong>Link do Código</strong><br> Github: <a href="https://github.com/jcelsocosta/race_condition/tree/main" rel="noopener noreferrer">https://github.com/jcelsocosta/race_condition/tree/main</a></p> <p><strong>Referências</strong> </p> <ol> <li>DONOVAN, Alan A. A.; KERNIGHAN, Brian W. A Linguagem de Programação Go. 1. ed. São Paulo: Novatec, 2016. 400 p.</li> </ol> go concurrency race condition