Una sinfonía en C#

Un pequeño aporte a la comunidad de habla hispana.

¿Qué es un circuit breaker?

En este post voy a contar de qué se trata el patrón circuit breaker para utilizar cuando dependemos de recursos externos y vamos a ver un ejemplo de implementación en C#.

Objetivo

El objetivo de este patrón es poder manejar un error al cosultar un servicio remoto que puede tomar un tiempo indeterminado en recupearse. La idea es mejorar la capacidad de nuestra aplicación a ser resilente a fallos.

Cuando nuestra aplicación consume un servicio externo puede ocurrir que este servicio sufra problemas momentaneos o que tengamos problemas de latencia o conectividad, en general estos problemas se pueden manejar utilizando el patrón retry, sin embargo si el problema no se resuelve rápidamente ésta no es siempre la mejor estrategia.

Entonces el circuit breaker evita que nuestra aplicación consulte un recurso externo (otra aplicación, un servicio, una base de datos, etc.) que muy probablemente nos de error por un tiempo hasta que se estabilice.

En resumen el circuit breaker se utilizará donde no tenga sentido seguir reintentando que el recurso externo responda y el patrón retry no tendía utilidad y por supuesto trasladar los errores causados por la falla del recurso externo (o la espera a que responda) a nuestra aplicación nos traería otro tipo de problemas como por ejemplo operaciones de que se quedan esperando y consumiendo hilos de ejecución, memoria y potencialmente causando más problemas a nuestra aplicación e incluso podamos empeorar la situación del servicio externo no dándole oportunidad de recuperarse si lo continuamos consultando.

Por último el circuit breaker actuará como un proxy sobre las operaciones que queramos manejar con él, esto por supuesto puede penalizar levemente la performance.

Implementando un circuit breaker con C#

Básicamente el circuit breaker es una máquina de estados que puede exponer los siguientes estados:

  • Open: El recurso no está disponible porque se alcanzó un número de fallas en cierto tiempo.
  • Half-Open: Estando en Open ha transcurrido un tiempo dado y pasa a este estado, si se puede acceder al recurso se pasa a Closed, si falla se vuelve a Open y se pone el contador en cero
  • Closed: el circuito funciona, en caso de detectarse una falla se incrementa un contador, si se alcanza un número determinado en un periodo de tiempo dado se cambiar a Open

Por otro lado tendremos al menos dos parámetros

  • Threshold: La cantidad de veces que aceptamos que el recurso externo de error antes de considerarlo en problemas.
  • Reset timeout: El tiempo que se esperará antes que volver a intentar consultar el servicio (el tiempo que le daremos a que se recupere)

 

image

Implemetación simple en C#

Acá dejo una implementación simple den C# utilizando una máquia de estados clásica, esto se puede evolucionar mucho por supuesto.

public interface ICircuitBreaker
{
    /// <summary>
    /// Obtiene la cantidad de fallas aceptadas hasta pasar a estado Open
    /// </summary>
    int Threshold { get; }

    /// <summary>
    /// Obtine el tiempo de espera para pasar a estado Half-Open
    /// </summary>

    TimeSpan Timeout { get; }
    /// <summary>
    /// Obtiene el estado actual
    /// </summary>

    CircuitBreakerState CurrentState { get; }
    /// <summary>
    /// Permite invocar una acción utilizado el circuit breaker
    /// </summary>
    /// <param name="protectedCode">La acción que será invocada</param>
    /// <returns>El estado resultante</returns>
    CircuitBreakerState AttemptCall(Action protectedCode);
}

Esta sería la interfaz de nuestro circuit breaker, es sencilla y se puede mejorar mucho pero sirve para el ejemplo, vamos a la implementación

public enum CircuitBreakerState
{
    Close,
    Open,
    HalfOpen
}

public class SimpleCircuitBreaker : ICircuitBreaker
{
    private int threshold;
    private TimeSpan timeout;
    private int attemptCounter;
    private DateTime failureTime;
    private CircuitBreakerState currentState = CircuitBreakerState.Close;

    public int Threshold => this.threshold;
    public TimeSpan Timeout => this.timeout;
    public CircuitBreakerState CurrentState => this.currentState;

    public SimpleCircuitBreaker(int threshold, TimeSpan timeout)
    {
        this.threshold = threshold;
        this.timeout = timeout;
    }

    public CircuitBreakerState AttemptCall(Action protectedCode)
    {
        switch (this.currentState)
        {
            case CircuitBreakerState.Close:

                try
                {
                    protectedCode();
                }
                catch (Exception)
                {
                    this.attemptCounter++;
                    if (this.attemptCounter > this.threshold)
                    {
                        this.failureTime = DateTime.Now;
                        this.attemptCounter = 0;
                        this.currentState = CircuitBreakerState.Open;
                    }
                }

                break;
            case CircuitBreakerState.Open:
                if (this.failureTime.Add(this.timeout) > DateTime.Now)
                {
                    this.currentState = CircuitBreakerState.HalfOpen;
                }
                break;
            case CircuitBreakerState.HalfOpen:
                try
                {
                    protectedCode();
                }
                catch (Exception)
                {
                    this.failureTime = DateTime.Now;
                    this.attemptCounter = 0;
                    this.currentState = CircuitBreakerState.Open;
                }
                break;
        }
        return this.currentState;
    }
}

La forma de utilizar el código es crear una instancia del SimpleCircuitBreaker y llamar al recurso externo a través del método AttenptCall.

Como vemos una máquina de estados que inicia en Closed y en caso de error incrementa un contador, si se llega el número de fallos permitos (threshold) pasa a Open, si se ha pasa un tiempo dado (el que consideramos que es adecuado para que el recurso externo se recupere) se pasa al Half-Open, si se intenta acceder nuevamente y falla se vuelve a Open, si funciona a Close.

De esta manera todo el código que dependa de recursos externos puede conocer el estado del recurso y esperar para llamarlo en caso que se encuentre en fallo.

Como dije se puede mejorar mucho este código no tiene sentido para explicar el concepto hacerlo ahora.

Les dejo un link con el código en github.

Nos leemos.

Serverless computing: Azure functions.

Una técnica muy común en el desarrollo de software consiste en desacoplar, es decir, intentar independizar una porción de código de otra cosa, ya sea otra porción de código, un dispositivo, un servicios y todo lo que no se pueda, por diferentes motivos, hoy en día esto se intensifica ya que necesitamos cada vez más tener código funcionando lo más rápido posible.

Los servidores, las máquinas virtuales, la nube, los contenedores

En principio, la forma más común de desplegar una aplicación es utilizar un servidor físico, o sea una PC de carne y hueso con un servidor, bases de datos y cosas dentro, esto fue cambiando con el tiempo y nos quisimos independizar de administrar el hardware (si tenemos una PC que administramos nosotros y se corta la energía eléctrica o se rompe un disco tenemos que solucionarlo nosotros) entonces nos movimos a servidores de terceros.

Por otro lado las máquinas virtuales vinieron a ayudarnos un poco con esto, porque hace un poco más simple aislarnos del hardware sin movernos a un servicio de terceros, sin embargo nos seguimos encargando de administrar el sistema operativo nosotros, mantenerlo actualizado y demás.

La nube nos permite poner nuestras máquinas virtuales, copiarlas y demás fácilmente, mejorando bastante el escenario de hacerlo nosotros incluso se pueden mantener actualizadas y cambiar de tamaño fácilmente, pero seguimos atados a tener que instalar todo el software necesario para nuestra aplicación, IIS, Apache, MySQL o lo que sea, y siguen siendo pesadas por así decirlo, además no es raro que instalemos más de una aplicación por máquina lo cual en algún momento nos puede traer problemas.

Por otro lado están los contenedores, que sería como tener solamente la parte que necesitamos de la máquina virtual necesaria para correr nuestra aplicación, creamos el contenedor y santo remedio, pero seguimos necesitando crear y desplegar el contenedor con el software asociado a éste.

Serverless computing

La mínima expresión de aislar nuestro código del resto del mundo es lo que se denomina Serverless computing, que en pocas palabras es tomar nuestro código y ponerlo en un lugar donde simplemente funciona, sin servidores, ni software adicional, ni contenedores, ni nada, si queremos más potencia movemos un slider y ya, también se conoce como FaaS (functions as a service) y AWSLamda fue lo primero que se vio por el estilo.

Azure functions

La servicio que ofrece Microsoft de Serverless computing se llama Azure Functions y es el tema del que voy a hablar en este post.

Componentes de una Azure Function

  • Código
  • Triggers / Bindings
  • Configuración

El código puede ser escrito en C#, Javascript, Python, PHP, F#, Bash, Batch o cualquier ejecutable.

Los trigger y los bindings son la forma de definir las entradas y salidar de nuestra función y cómo se dispara, un trigger define cómo se dispara la función, solo pude haber un único trigger por función los bindings son los datos de entrada y de salida si los ubiese, éste es el listado de bindings y triggers actualmente soportados.

 

image

La configuración es donde definimos todo lo que necesita nuestra app que es externo, como librerías de terceros, Azure functions soporta NuGet y NPM.

Creando nuestra primera Azure function

Hoy por hoy el soporte para crear Azure functions desde Visual Studio no es tan bueno, así que vamos a hacerlo desde el portal

image

Creamos la función C# y colocamos el siguiente código:

using System.Net;

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log)
{
	dynamic data = await req.Content.ReadAsAsync<object>();
	string name = data?.name;
	return req.CreateResponse(HttpStatusCode.OK, "Hello " + name);
}

En este sencillo ejemplo hay un par de cosas interesante: primero el mensaje de respuesta es una Task, es decir, es asincrónico y dentro del código utilizamos req.Content.ReadAsAsync y lo asignamos a dynamic para poder leer la información pasada  por POST como un JSON.

Probar la función desde el portal

image

En este caso podemos configurar el cuerpo del request y probar el resultado.

Si vamos al panel de la izquierda podemos ver algunos detalles interesantes, por ejemplo el trigger de la función

 

image

 

En este caso nuestro trigger es del tipo HTTP request, es decir nuestra función solamente se ejecuta cuando llega un request HTTP, como vemos hay otras muchas opciones para modificar, como los verbos HTTP permitidos, uno interesante el el Mode, el cual puede ser Standard como ahora o un Webhook.

Si hacemos click en Advanced Editor vemos la configuración avanzada, básicamente todos los parámetros se configuran a través de un JSON.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "function",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in"
    },
    {
      "name": "return",
      "type": "http",
      "direction": "out"
    }
  ]
}

 

Invocar las funciones desde internet

Haciendo click en Get function URL vemos la URL pública de la función junto con la clave de acceso por defecto

image

Podemos regenerar la clave o agregar otras cuando queramos, entonces con la URL hacemos una pequeño formulario y probamos la función, pero antes cambiamos nuestra función para que lea los parámetros que envía el formulario de este modo

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log)
{
  string name = req.GetQueryNameValuePairs()
    .FirstOrDefault(q => string.Compare(q.Key, "name", true) == 0)
    .Value;
        
  return req.CreateResponse(HttpStatusCode.OK, "Hello " + name);
}

gracias al método GetQueryNameValuePairs permite recuperar los parámetros que legan por query string.

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title></title>
</head>
<body>
    <form method="get" action="https://functionslgm.azurewebsites.net/api/HttpTriggerCSharp1">
        <input type="text" name="name" />
        <input type="hidden" name="code" value="HctmiZNEOjyLTNm7uVZCUynbScU2lEsXDrKvO4AJEIwAwtaVxu14vw==" />
        <input type="submit" value="Enviar" />
    </form>
</body>
</html>

Un simple formulario para enviar el parámetro name y la clave en el elemento hidden, hacemos click en Enviar y listo.

image

Por supuesto que es un ejemplo muy simple, pero lo que acabamos de hacer es procesar un request remoto simplemente escribiendo 4 líneas de C# y nada más.

Más adelamente vamos a ver más detalles sobre Azure functions, por ahora lo dejamos acá.

Nos leemos.

Novedades de Visual Studio 2017: Intellisense Filtering

Entre las muchas novedades que nos trae la nueva versión de Visual Studio una que me resultó muy útil es Intellisense filtering, una características que nos permite aplicar filtros sobre los que nos muestra intellisense, es decir, hasta hoy si presionamos Ctrl + Space vemos algo así:

image

Lo clásico un listado con todo lo que tenemos disponible en el contexto actual, por supuesto que la lista puede ser muy larga lo cual dificulta encontrar lo que estamos buscando, más aún si se trata de una API que no conocemos y no tenemos muy claro qué estamos buscando

Intellisense filtering al rescate

Intellisense filtering permite justamente eso, poder usar intellisense y aplicar filtros en el mismo momento

image

Ahí debajo tenemos los filtros, podemos ir con el mouse y tocarlos pero mejor que eso, tenemos teclas de acceso directo para hacerlo

Teclas rápidas

  • Methods (Alt + M)
  • Interface (Alt + I)
  • Classes (Alt + C)
  • Structure (Alt + S)
  • Enums (Alt + E)
  • Delegates (Alt +D)
  • Namespace (Alt + N)
  • Keywords (Alt + K)
  • Snippets (Alt + T)

intellisense filtering

Como se ve se pueden ir tocando las teclas rápidas y agregando o quitando filtros.

De momento no existe la posibilidad de hacer nuestros propios filtros, por ejemplo si quisiéramos mostrar elementos con ciertos atributos hoy no lo podemos hacer.

De todos modos es una característica excelente que seguro le vamos a sacar provecho.

Hasta la próxima, nos leemos.

Typemock o cómo mockear como un campeón.

Todos entendemos el valor de los test unitarios en mayor o menor medida, es decir, poder probar una parte de nuestro código sin intervención de las demás en un “ambiente” aislado y repetible, de modo de poder hacerlo muchas veces y progresivamente, etc. Bien, en ocasiones ocurre que nuestro código depende de componentes que podemos “aislar” porque, por ejemplo tenemos una interfaz, algo así:

public class Negocio
{
    private IServicioExterno servicio;

    public Negocio(IServicioExterno servicio)
    {
        this.servicio = servicio;
    }

    public int HacerAlgo()
    {
        var valores = this.servicio.GetAll();
        return valores++;
    }
}

En este caso sería sencillo desentendernos de la dependencia IServicioExterno creando un mock, con Moq por ejemplo, y probar así:

[TestClass()]
public class NegocioTests
{
    [TestMethod()]
    public void HacerAlgoTest()
    {
        var mock = new Mock();
        var target = new Negocio(mock.Object);

        mock.Setup((servicio) => servicio.GetAll()).Returns(1);

        var result = target.HacerAlgo();

        Assert.AreEqual(2, result);
    }
}

Lo que hacemos es crear un mock y configurarlo para que cuando se llame al servicio GetAll devuelva un 1, esto se puede hacer porque hay una interfaz de por medio, y además tenemos acceso al código de todos los componentes.

¿Qué pasa cuando no tenemos acceso a nuestras dependencias?

No es poco común que nuestro código dependa de un componente de terceros que no tiene una interfaz o que dependamos de un componente del mismo framework de .NET que no podemos controlar y que necesitamos aislar, el clásico ejemplo es el HttpContext en una aplicación web, pero podría ser cualquiera, ahí la cosa se complica.

En estos caso hay quien (y diría que todos lo hemos hecho) genera un wrapper y saca la interfaz afuera para poder cambiar sus dependencias de HttpContext a la interfaz y usar el wrapper contra el context real en la app y una mock en los tests.

Esto es bastante trabajo, y además estamos modificando nuestro código para poder probarlo, lo cual es, al menos, polémico; por otro lado no siempre vamos a poder “inyectar” esas dependencias, habrá casos en los que no podamos simplemente hacer un wrapper porque no tenemos ningún tipo de acceso.

Otro caso aún más polémico es definir mecanismos (inyecciones, interfaces) que realmente no aportan al real funcionamiento ni a la arquitectura solamente para poder, al momento de probar, poner un mock o aislarnos de nuestra base de datos.

Typemock al rescate

Typemock Isolator no es algo nuevo para nada más bien todo lo contrario, es un proyecto bien maduro que tiene varias funcionalidades que nos ayudan a hacer tests, como runners, code coverage, generador de tests automático, etc. En el caso del Isolator en sí, lo que hace es justamente eso: permitir interceptar las llamadas a cualquier objeto de la aplicación, si, cualquier objeto y hacer diferentes cosas:

  • Reemplazarlo por un mock
  • Interceptar y modificar el resultado
  • Interceptar llamadas a métodos estáticos
  • Interceptar llamas a constructores
  • Correrlo contra nuestro entorno de CI

y algunas más, todo sorprendente, y aclaro que no es una herramienta gratuita pero creo que vale la pena, pero no demoremos más, vamos a ver cómo reemplazar una llamada a HttpContext con un mock nuestro

//decimos al Isolator que cualquier llamada a HttpContext.Current retorne un mock recursivamente
Isolate.WhenCalled(() => HttpContext.Current).ReturnRecursiveFake();
//ahora recuperamos el mock del objeto Session 
var fakeSession = HttpContext.Current.Session;
//configuramos el comportamiento del Session para que retorne un 1
Isolate.WhenCalled(() => fakeSession.SessionID).WillReturn("1");
//verificamos el comportamiento
Assert.AreEqual("1", fakeSession.SessionID);

 

Simple no? en este caso le decimos que hago mocks recursivos a partir de HttpContext.Current, después tomamos la sesión (fake) y le asignamos un valor, de ahí en adelante el código que use la sesión va a recibir lo que nosotros configuramos, sorprendente, no?

Conclusiones.

No son pocos los casos en los que agregamos una interaz solamente para poder inyectar un mock durante un test y esto es claramente trabajo de más y arquitectura de más, en este caso y en otros donde no es imposible controlar las dependencias (librería de terceros ya compiladas por ejemplo) Typemock es una excelente opción.

Nos leemos.

Novedades de C#7: Funciones locales

Ya hemos visto algunas de las novedaes de C#7 en este espacio y es momento de hablar de las funciones locales.

¿Qué son las funciones locales?

En pocas palabras C#7 nos da la posibilidad de declarar una función dentro de otra…si, dentro de otra, con las ventajas que esto aporta:

  • Visibilidad acotada
  • Acceso a las variables del entorno en que se declara
  • No ensuciamos el código con algo muy específico del contexto que necesitamos

Vamos a ver un ejemplo, imaginemos que tenemos una estructura tipo árbol guardada en una base de datos

image

Simple, cada elemento tiene un padre y así se arma el árbol, del lado de C# tenemos:

class Hoja
{
    public string Nombre { get; set; }
    public int Id { get; set; }
    public IList Hijos { get; set; }
    public Hoja Padre { get; set; }
}

Básicamente tiene el nombre, id, el id del padre y el listado de hijos, lo que queremos hacer es armar un árbol poniendo los hijos, lo natural sería hacer algo recursivo.

void BuscarHijos(Hoja hoja, IEnumerable hojas)
{
    foreach (var hijo in hojas.Where(i => i.Padre.Id == hoja.Id))
    {
        hoja.Hijos.Add(hijo);
        BuscarHijos(hijo, hojas);
    }
}

public IEnumerable Generar()
{
    var hojas = Hoja.GetAll();
    var lista = new List();

    foreach (var item in hojas.Where(i => i.Padre == null)) // buscamos los nodos raíz
    {
        lista.Add(item);
        BuscarHijos(item, hojas);
    }

    return lista;
}

Entonces, primero buscamos aquellas hojas que no tiene padres (son las raices) y después iteramos esa colección y buscamos las hojas que tienen como padre al nodo raíz actual, usamos una función recursiva para buscar hijos de hijos, esto debería funcionar.

Usando funciones locales.

El mismo código con funciones locales se pude hacer así:

var lista = new List();

foreach (var item in hojas.Where(i=>i.Padre == null))
{
    lista.Add(item);
    BuscarHijos(item);

    void BuscarHijos(Hoja hoja)
    {
        foreach (var hijo in hojas.Where(i => i.Padre.Id == hoja.Id))
        {
            hoja.Hijos.Add(hijo);
            BuscarHijos(hijo);
        }
    };
}

Como vemos declaramos la función BuscarHijos no solo dentro del método sino dentro del bucle y acotamos bien su impacto, además tenemos visibilidad de la lista de hojas y de la misma función BuscarHijo, super cool

Hay más detalles sobre las funciones locales en este link, y la propuesta original de la funcionalidad acá.

Nos leemos.