{"path": "/posts/faca-estados-invalidos-serem-irrepresentaveis/", "title": "Faça estados inválidos serem irrepresentáveis · Bruno Dias", "html": "<!doctype html>\n<html lang=\"pt-BR\">\n<head>\n  <meta charset=\"utf-8\">\n  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n  <meta name=\"description\" content=\"Faça estados inválidos serem irrepresentáveis\">\n  <title>Faça estados inválidos serem irrepresentáveis · Bruno Dias</title>\n  <link rel=\"canonical\" href=\"https://diasbruno.github.io/posts/faca-estados-invalidos-serem-irrepresentaveis/\" data-post-metadata>\n  <meta name=\"author\" content=\"Bruno Dias\" data-post-metadata>\n  <meta property=\"og:type\" content=\"article\" data-post-metadata>\n  <meta property=\"og:title\" content=\"faca-estados-invalidos-serem-irrepresentaveis\" data-post-metadata>\n  <meta property=\"og:url\" content=\"https://diasbruno.github.io/posts/faca-estados-invalidos-serem-irrepresentaveis/\" data-post-metadata>\n  <meta property=\"article:published_time\" content=\"2024-09-26T12:00:00Z\" data-post-metadata>\n  <meta property=\"og:image\" content=\"https://diasbruno.github.io/images/processes-outcome.png\" data-post-metadata>\n  <link rel=\"icon\" href=\"/assets/site/signature.svg\" type=\"image/svg+xml\">\n  <link rel=\"alternate\" type=\"application/atom+xml\" title=\"diasbruno\" href=\"/atom.xml\">\n  <link rel=\"alternate\" type=\"application/json\" href=\"/posts/faca-estados-invalidos-serem-irrepresentaveis/content.json\">\n  <link rel=\"stylesheet\" href=\"/assets/site/tokens.css\">\n  <link rel=\"stylesheet\" href=\"/assets/site/site.css\">\n  <link rel=\"stylesheet\" href=\"/assets/site/footer.css\">\n\n</head>\n<body class=\"light\">\n<div id=\"site-page\">\n<a class=\"skip-link\" href=\"#content\">Skip to content</a>\n<header class=\"site-header\">\n  <a class=\"brand\" href=\"/\" data-site-navigation aria-label=\"Bruno Dias, home\">\n    <img src=\"/assets/site/signature.svg\" width=\"24\" height=\"34\" alt=\"\">\n  </a>\n  <nav aria-label=\"Main navigation\">\n    <ul>\n<li><a class=\"nav-vrn\" href=\"/vrn/\" data-site-navigation><span class=\"nav-label\">vrn</span> <span class=\"nav-badge\">research</span></a></li>\n<li><a class=\"nav-posts\" href=\"/posts/\" data-site-navigation aria-current=\"location\">Posts</a></li>\n<li><a class=\"nav-projects\" href=\"/projects/\" data-site-navigation>Projects</a></li>\n<li><a class=\"nav-about\" href=\"/about/\" data-site-navigation>About</a></li>\n</ul>\n  </nav>\n</header>\n\n<main class=\"section\" id=\"content\" tabindex=\"-1\">\n  <article class=\"post-detail\">\n    <header class=\"section-header\">\n      <p class=\"post-category\">Artigo</p>\n      <h1>Faça estados inválidos serem irrepresentáveis</h1>\n\n      <p><time datetime=\"2024-09-26T12:00:00Z\">2024-09-26</time></p>\n    </header>\n    <div class=\"post-columns\">\n      <section class=\"post-body\" aria-label=\"Artigo\">\n\n<h2>Intro</h2>\n\n<p>Números. Infinitos itens. Porém, por si só, números não tem sentido (algebra?).\nPara que façam sentido, definimos unidades à o que se referem. Nisso, temos coisas contáveis\nque são infinitas, mas também, coisas que são finitas.</p>\n\n<p>Imagine um toca CD de carro do inicio dos anos 2000. Alguns modelos possuem apenas 1 slot, e\noutros, até 10 slots (talvez mais, mas ai é muito chique).</p>\n\n<p>Descrever essa capacidade (slots) como um number ou Int é um convite para introduzir bugs.\nTodos os métodos e variáveis que serão declaradas assim, podem ter valores arbitrários em\ntodos os lugares do sistema, ou, todos os lugares que utilizam deverão ter checks de pre e\npostcondition para saber se o valor está dentro dos constraints específicos a aquele item.</p>\n\n<p>Um aplicação tem vários estados. Se fizéssemos a união de todos os estados possíveis em uma\núnica função, seria praticamente impossível compreender quantos estados a aplicação poderia\ntomar em um determinado momento.</p>\n\n<p>A quantidade de variáveis seria muito grande para se quer acompanhar mentalmente o que está\nacontecendo.</p>\n\n<p>A maioria dos estados não precisam estar disponíveis o tempo todo. Essas variáveis precisariam\nde manutenção do momento em que ela é inicializada, até quando deveria ser descartada - que\ncausa problemas de “stale data” (que pode causar um estado inválido).</p>\n\n<p>Dificilmente, você vai ver um code base que se preocupa com essas coisas (e sempre aparece\num bug). Alguns casos podem ser resolvidos com tipos pequenos ou &ldquo;tipos enumerados”,\noutros, talvez esteja você olhando o problema de uma única perspectiva.</p>\n\n<h2>Dados primitivos e constraints</h2>\n\n<p><em>Number, Int, s64, u64, string, char</em> são primitivos das linguagens. Alguns possuem <em>bounds</em>\n(limites como <em>signed char</em> que vai de <em>-128 até 127</em> ou unsigned char que vai de <em>0 até 255</em>),\noutros o limite é “mais aberto”.</p>\n\n<p>Números tem limites acordo com o tamanho de storage disponível, mas os infinitos tipos de\ndados temos varias constraints que são subsets (sub-conjuntos) desses outros conjuntos.\nExemplos: E-mail (string com constraint no formato e tamanho - leia a RFC e vai ver que existe\num tamanho mínimo - curiosidade), idade (que a constraint varia de acordo com o contexto - se\nfalarmos de idade de uma pessoa, o valor está em entre <em>0 - idade da última pessoa que bateu\no record de longevidade</em>, mas pode ser a idade de uma cidade, que já é outro range aberto,\nmas pelo menos <em>0 - infinito</em>).</p>\n\n<p>Uma das soluções é a cada utilização dessa informação adicionar <em>pre-condition</em> (se os valores\nestão validos para a execução) e <em>post-condition</em> (se depois da operação o valor continua valido).</p>\n\n<p>Existem linguagens como Eiffel que possui a keyword <em>require</em> e <em>ensure</em> - que se referem ao\npattern de precondition e postcondition, ou, um pattern comum de algumas linguagens de\nadicionar <em>assert</em> para verificar que uma determinada propriedade não viola a pre-condition.</p>\n\n<h2>Opções</h2>\n\n<h3>Types</h3>\n\n<p>Tipos são um bom começo. Precisamos dar contexto aos tipos de dados primitivos para\npodermos efetuar operações com mais segurança.\nPodemos definir o tipo &ldquo;número de cartão de credito&rdquo; como</p>\n\n<p>```haskell\ndata CreditCardNumber = CreditCardNumber String &ndash; the number\n                                         Bool   &ndash; valid or not</p>\n\n<p>validCeditCardNumber _ = False</p>\n\n<p>class From a b where\n  from :: a -> b</p>\n\n<p>instance From String CreditCardNumber where\n  from a = CreditCardNumber a (validCeditCardNumber a)</p>\n\n<p>(from &ldquo;1111 1111 1111 1111&rdquo;) :: CreditCardNumber\n&ndash; CreditCardNumber &ldquo;1111 1111 1111 1111&rdquo; False\n```</p>\n\n<p>Agora temos um contexto. Nem todas as strings vão ser permitidas - no que se refere a validade\ndo número.\nAinda sim, existem vários outros tipos para diferentes contextos.</p>\n\n<p>```haskell\ndata ValidCreditCardNumber = ValidCreditCardNumber String &ndash; the number</p>\n\n<p>validCeditCardNumber _ = False</p>\n\n<p>class From a b where\n  from :: a -> b</p>\n\n<p>instance From String CreditCardNumber where\n  from a =\n    if not (validCeditCardNumber a) then\n      error &ldquo;Invalid credit card number.&rdquo;\n    else\n      ValidCreditCardNumber a</p>\n\n<p>(from &ldquo;1111 1111 1111 1111&rdquo;) :: ValidCreditCardNumber\n&ndash; *** Exception: Invalid credit card number.\nCallStack (from HasCallStack):\n  error, called at <interactive>:1:1 in interactive\n```</p>\n\n<p>Agora somente números validos passaram pelo programa, exceto que você instancie por conta\nprópria (sem utilizar o <code>from</code>). Ai o problema é seu…</p>\n\n<p>Essa é representação visual. De todos o elementos, somente um elemento do conjunto das\nstrings possíveis tem um correspondente, porque só números validos podem ser usados. O ideal\né termos funções totais o máximo possível.</p>\n\n<!-- Original: /images/figure-1.png -->\n<figure class=\"missing-figure\"><figcaption>Figura 1 indisponível no arquivo.</figcaption></figure>\n\n<p>Sair de valores infinitos e desconhecidos para um único elemento deixa tudo mais fácil.</p>\n\n<!-- Original: /images/figure-2.png -->\n<figure class=\"missing-figure\"><figcaption>Figura 2 indisponível no arquivo.</figcaption></figure>\n\n<p>A leitura fica mais precisa: “Com um <em>numeração valida</em>, execute a ação <em>f</em>”. Não existe chamar a\nfunção <em>f</em>, vamos imaginar que <code>f</code> é a função <em>comprar algo</em>, com um número de cartão invalido.\nToda a informação necessária está embutida no tipo.</p>\n\n<p>Ainda podemos ter casos com validação e “continuação” com erros, mas terá outro exemplo.</p>\n\n<h3>Null object pattern</h3>\n\n<p>Esse pattern é mais adequado para casos onde temos objetos complexos.</p>\n\n<p>Algumas linguagens permitem declaramos variáveis não incializadas, que recebem o valor null ou undefined.</p>\n\n<p>Ser deixarmos essa variável não inicializada e passarmos para o restante das funções, elas vão ter que verificar\n(pre-condition) se existe um valor ou não.</p>\n\n<p>Uma das principais utilizações:</p>\n\n<p>Evitar que dispare exceções do tipo “null pointer exception”\nDisparar um erro quando o valor deveria existir, mas o objeto nulo continuou (erros previsíveis)\nObjeto cujas as operações não alteram o valor do resultado</p>\n\n<p>```kotlin\nopen class BaseCreditCard {\n  open fun buyStuff() {}\n}</p>\n\n<p>class NullCreditCard: BaseCreditCard {\n  open fun buyStuff() {\n    thow Error(&ldquo;Bailing out! No credit card available.&rdquo;)\n  }\n}</p>\n\n<p>class CreditCard: BaseCreditCard()</p>\n\n<p>fun findCreditCard(number: String): BaseCreditCard {\n  return NullCreditCard();\n}</p>\n\n<p>fun main() {\n  var card: BaseCreditCard = findCreditCard(&ldquo;1111 1111 1111 1111&rdquo;);\n  card.buyStuff();\n}\n```</p>\n\n<p>Esse é um modo de garantir que sempre haverá um objeto concreto, e, ajuda a encontrar edge cases em testes.</p>\n\n<h3>Maybe/Option/Either/Result Functors</h3>\n\n<p>Maybe ou option, dependendo da linguagem que você está usando, pode servir para casos onde o resultado de uma validação não é importante - somente proibir que valores inválidos sejam utilizados.</p>\n\n<p>```rust\nstruct ValidCreditCardNumber {\n  string_number: String\n}</p>\n\n<p>fn valid(_value: &amp;str) -> bool { return true; }</p>\n\n<p>impl From&lt;&amp;str> for ValidCreditCardNumber {\n  fn from(value: &amp;str) -> Self {\n    return Self { string_number: value.to_string() };\n  }\n}</p>\n\n<p>trait SafeFrom<T> {\n  fn from_safe(value: T) -> Option<Self> where Self: Sized;\n}</p>\n\n<p>impl SafeFrom&lt;&amp;str> for ValidCreditCardNumber {\n  fn from_safe(value: &amp;str) -> Option<ValidCreditCardNumber> {\n    if valid(value) { return Some(ValidCreditCardNumber:: from(value)); }\n    return None;\n  }\n}</p>\n\n<p>fn main() {\n  let pipe = ValidCreditCardNumber::from_safe(&ldquo;111111111111111111&rdquo;)\n    .map(|x| x)\n    .map(|x| x);\n  match pipe {\n    Some (x) => printin!(&ldquo;{}&rdquo;, x.string_number),\n    None => println!(&ldquo;meh&rdquo;)\n  }\n}\n```</p>\n\n<p>Nas figurinhas&hellip;</p>\n\n<!-- Original: /images/figure-3.png -->\n<figure class=\"missing-figure\"><figcaption>Figura 3 indisponível no arquivo.</figcaption></figure>\n\n<h4>Existência do Objeto já é o seu valor (unificação)</h4>\n\n<p>Este é mais uma simplificação. Objetos - classes quando possível -, são a definição de algo.</p>\n\n<p>Um dos exemplos mais notórios são GUIs.</p>\n\n<p>Quando navegamos por páginas usamos strings para marcar onde estamos.</p>\n\n<p>```typescript\nexport type Pages = &ldquo;PAGE_A&rdquo; | &ldquo;PAGE_B&rdquo; | &ldquo;PAGE_C&rdquo;</p>\n\n<p>export function getPageComponent (page: Pages) {\n  switch (page) {\n    case &ldquo;PAGE_A&rdquo;: return PageA;\n    case &ldquo;PAGE_B&rdquo;: return PageB;\n    case &ldquo;PAGE_C&rdquo;: return PageC;\n  }\n}\n```</p>\n\n<p>Podemos remover essas strings e utilizar as próprias classes/objetos para formar uma máquina de estado.</p>\n\n<p>```typescript\nexport type Pages =\n  | PageA\n  | PageB\n  | PageC</p>\n\n<p>previousPage(PageA);\nnextPage(PageC);\n```</p>\n\n<h4>Identidade de monoids</h4>\n\n<p>Monoids possuem um elemento que não influenciam no resultado de uma operação. O elemento identidade.</p>\n\n<p>1 + 0 = 0 + 1 = 1</p>\n\n<p>Ou</p>\n\n<p>“\" + “a\" = &ldquo;a&rdquo; + “\" = “a”</p>\n\n<p>Ou</p>\n\n<p>Balde.Empty + Balde(Litro(x)) =\nBalde(Litro(0) + Litro(x)) =\nBalde(Litro(0 + x))</p>\n\n<p>🤷‍♂️</p>\n\n<h3>Conclusão</h3>\n\n<p>Existem várias opções para não deixa informações invalidas causarem problemas no projeto. Cada uma vai ser utilizada de acordo com o contexto da ação que precisa ser feita, e, também de acordo com o tipo de linguagem.</p>\n\n<p>Esse conceito também é responsável por melhora a linguagem do domínio.</p>\n\n<h3>Referências</h3>\n\n<p><a href=\"https://www.awwsmm.com/blog/make-invalid-states-unrepresentable\">https://www.awwsmm.com/blog/make-invalid-states-unrepresentable</a>\n<a href=\"https://fsharpforfunandprofit.com/posts/designing-with-types-making-illegal-states-unrepresentable/\">https://fsharpforfunandprofit.com/posts/designing-with-types-making-illegal-states-unrepresentable/</a>\n<a href=\"https://geeklaunch.io/blog/make-invalid-states-unrepresentable/\">https://geeklaunch.io/blog/make-invalid-states-unrepresentable/</a>\n<a href=\"https://hugotunius.se/2020/05/16/making-invalid-state-unrepresentable.html\">https://hugotunius.se/2020/05/16/making-invalid-state-unrepresentable.html</a></p>\n\n      </section>\n      <aside class=\"post-links\" aria-labelledby=\"post-links-heading\">\n        <h2 id=\"post-links-heading\">Links</h2>\n        <ul>\n<li><a href=\"/posts/\" data-site-navigation>Todos os artigos</a></li>\n        </ul>\n      </aside>\n    </div>\n  </article>\n</main>\n\n<footer class=\"site-footer\">\n  <div class=\"site-footer-inner\">\n    <a class=\"site-footer-home\" href=\"/\" data-site-navigation>Bruno Dias</a>\n    <ul aria-label=\"Footer links\">\n      <li><a href=\"https://github.com/diasbruno\">GitHub</a></li>\n      <li><a href=\"/atom.xml\">Atom feed</a></li>\n    </ul>\n  </div>\n</footer>\n\n</div>\n<script type=\"module\" src=\"/assets/site/navigation.js\"></script>\n</body>\n</html>\n"}
