{"id":2164,"date":"2023-08-09T11:00:15","date_gmt":"2023-08-09T11:00:15","guid":{"rendered":"https:\/\/blogs.encamina.com\/piensa-en-software-desarrolla-en-colores\/?p=2164"},"modified":"2023-08-09T11:00:15","modified_gmt":"2023-08-09T11:00:15","slug":"la-importancia-de-usar-cancellationtoken-en-nuestras-apis","status":"publish","type":"post","link":"https:\/\/blogs.encamina.com\/piensa-en-software-desarrolla-en-colores\/la-importancia-de-usar-cancellationtoken-en-nuestras-apis\/","title":{"rendered":"La importancia de usar CancellationToken en nuestras APIs"},"content":{"rendered":"

Sobre este \u00faltimo punto, vamos a ver un ejemplo a continuaci\u00f3n.<\/p>\n

Utilizando CancellationToken<\/h2>\n

Este ejemplo lo vamos a hacer sobre un endpoint<\/em> que llama a un servicio que lo \u00fanico que hace es guardar un registro en una base de datos y esperar 5 segundos antes de materializar la transacci\u00f3n.<\/p>\n

public async Task<int> AddAsync(CreatingTask businessModel, CancellationToken cancellationToken = default)\r\n{\r\n    return await unitOfWork.SaveChangesInTransactionAsync(async () =>\r\n    {\r\n        await ValidateEntityToAddAsync(businessModel);\r\n\r\n        var entity = MapCreating(businessModel);\r\n        await _repository.AddAsync(entity, cancellationToken);\r\n        await unitOfWork.SaveChangesAsync(cancellationToken);\r\n\r\n        await Task.Delay(5000, cancellationToken);\r\n\r\n        return entity.Id;\r\n    }, cancellationToken);\r\n}<\/code><\/pre>\n
En el c\u00f3digo anterior se muestra el servicio que os he comentado. Como puede apreciarse, lo que hace es lanzar algunas validaciones sobre el DTO recibido (ValidateEntityToAddAsync<\/em>), mapear a la entidad utilizada por el repositorio (MapCreating<\/em>) y a\u00f1adir la entidad a la base de datos. Todo ello encapsulado en una transacci\u00f3n que se materializa 5 segundos despu\u00e9s de haberse guardado la entidad. La espera de 5 segundos, obviamente no se ver\u00e1 en un escenario real, pero lo hago para simular una tarea larga.<\/p>\n
A continuaci\u00f3n se muestran los endpoints que he creado. Uno recibe un CancellationToken<\/em> y otro no.<\/p>\n
[HttpPost]\r\n[ProducesResponseType(StatusCodes.Status201Created)]\r\n[ProducesResponseType(StatusCodes.Status400BadRequest)]\r\n[ProducesResponseType(StatusCodes.Status409Conflict)]\r\npublic async Task<IActionResult> Post([FromBody]CreatingTask item, CancellationToken cancellationToken = default)\r\n{\r\n    if (item == null)\r\n        return BadRequest();\r\n\r\n    if (!ModelState.IsValid)\r\n        return BadRequest();\r\n\r\n    int createdId = await _service.AddAsync(item, cancellationToken);\r\n    return Created(nameof(GetById), new { id = createdId });\r\n}\r\n\r\n[HttpPost]\r\n[Route(\"nonCancellable\")]\r\n[ProducesResponseType(StatusCodes.Status201Created)]\r\n[ProducesResponseType(StatusCodes.Status400BadRequest)]\r\n[ProducesResponseType(StatusCodes.Status409Conflict)]\r\npublic async Task<IActionResult> PostNonCancellable([FromBody]CreatingTask item)\r\n{\r\n    if (item == null)\r\n        return BadRequest();\r\n\r\n    if (!ModelState.IsValid)\r\n        return BadRequest();\r\n\r\n    int createdId = await _service.AddAsync(item);\r\n    return Created(nameof(GetById), new { id = createdId });\r\n}<\/code><\/pre>\n
La gran diferencia entre los dos endpoints, es que uno recibe un CancellationToken<\/em> que pasa al servicio, por lo que la operaci\u00f3n es cancelable. Y el otro no, por lo que, aunque cancelemos la operaci\u00f3n desde el lado cliente, el servidor seguir\u00e1 realizando la tarea y guardar\u00e1 los valores de la tarea en la base de datos.<\/p>\n
Para probar todo esto, he creado la siguiente bater\u00eda de tests.<\/p>\n
private static readonly string url = \"\/api\/task\";\r\nprivate HttpClient _client;\r\n\r\n[TestInitialize]\r\npublic async Task InitDbContext()\r\n{\r\n    \/\/Creates a temporary database and inserts some data to make tests\r\n    WebApplicationFactory<Program> factory = await BuildWebApplicationFactory(Guid.NewGuid().ToString());\r\n\r\n    _client = factory.CreateClient();\r\n    AddApiKeyHeader(_client);\r\n}\r\n\r\n[TestCleanup]\r\npublic async Task RemoveDbContext()\r\n{\r\n    \/\/Removes the temporary database create in the test initialization\r\n    await DeleteDatabase();\r\n    _client.Dispose();\r\n    await Task.CompletedTask;\r\n}\r\n\r\n[TestMethod]\r\npublic async Task post_created()\r\n{\r\n    CreatingTask creatingTask = new CreatingTask { TaskListId = 2, Description = \"Task 8\" };\r\n    StringContent content = new StringContent(JsonConvert.SerializeObject(creatingTask), Encoding.UTF8, \"application\/json\");\r\n    HttpResponseMessage response = await _client.PostAsync(url, content);\r\n\r\n    Assert.AreEqual(System.Net.HttpStatusCode.Created, response.StatusCode);\r\n}\r\n\r\n[TestMethod]\r\npublic async Task post_cancelled()\r\n{\r\n    CancellationTokenSource source = new CancellationTokenSource(3000);\r\n    CreatingTask creatingTask = new CreatingTask { TaskListId = 2, Description = \"Task 9\" };\r\n    StringContent content = new StringContent(JsonConvert.SerializeObject(creatingTask), Encoding.UTF8, \"application\/json\");\r\n    await Assert.ThrowsExceptionAsync<OperationCanceledException>(async() => await _client.PostAsync(url, content, source.Token));\r\n}\r\n\r\n[TestMethod]\r\npublic async Task post_non_cancellable_created()\r\n{\r\n    CreatingTask creatingTask = new CreatingTask { TaskListId = 2, Description = \"Task 10\" };\r\n    StringContent content = new StringContent(JsonConvert.SerializeObject(creatingTask), Encoding.UTF8, \"application\/json\");\r\n    HttpResponseMessage response = await _client.PostAsync($\"{url}\/nonCancellable\", content);\r\n\r\n    Assert.AreEqual(System.Net.HttpStatusCode.Created, response.StatusCode);\r\n}\r\n\r\n[TestMethod]\r\npublic async Task post_non_cancellable_cancelled()\r\n{\r\n    CancellationTokenSource source = new CancellationTokenSource(3000);\r\n    CreatingTask creatingTask = new CreatingTask { TaskListId = 2, Description = \"Task 11\" };\r\n    StringContent content = new StringContent(JsonConvert.SerializeObject(creatingTask), Encoding.UTF8, \"application\/json\");\r\n    await Assert.ThrowsExceptionAsync<OperationCanceledException>(async() => await _client.PostAsync($\"{url}\/nonCancellable\", content, source.Token));\r\n}<\/code><\/pre>\n
Todos los tests anteriores se completan correctamente, pero si echamos un vistazo al resultado de la base de datos en los dos m\u00e9todos que se cancelan, vemos algo que marca la diferencia.<\/p>\n
post_cancelled<\/em> llama al endpoint<\/em> que permite cancelaci\u00f3n y cancela la petici\u00f3n a los 3 segundos, por lo que la tarea cuya descripci\u00f3n es Task 9<\/em> no se a\u00f1ade a la base de datos. Recordemos que el servicio materializa la transacci\u00f3n que guarda los valores en la base de datos tras un delay<\/em> de 5 segundos.<\/p>\n
\n
\"\"<\/figure>\n<\/div>\n
En cambio, post_non_cancellable_cancelled<\/em> llama al endpoint que no permite cancelaci\u00f3n, por lo que, aunque cancelemos la petici\u00f3n, la transacci\u00f3n se materializa en la base de datos y la tarea cuya descripci\u00f3n es Task 11<\/em> se guarda.<\/p>\n
\n
\"\"<\/figure>\n<\/div>\n
Con todo lo anterior, queda demostrado que el uso de CancellationToken<\/em> es una pr\u00e1ctica recomendada, sobretodo en escenarios donde las operaciones pueden ser costosas o tomar un tiempo significativo para completarse.<\/p>\n
Puedes visitar el post original en el blog de Jorge Diego Crespo<\/a><\/p>\n
<\/p>\n
\"\"Hoy vengo a contaros por qu\u00e9 es importante utilizar tokens de cancelaci\u00f3n en los endpoints de nuestras APIs<\/em>.<\/p>\n
(Puedes visitar el post original en el blog de Jorge Diego Crespo)<\/a><\/p>\n
<\/p>\n
<\/p>\n
<\/p>\n
Primero de todo. \u00bfQu\u00e9 es un token de cancelaci\u00f3n (CancellationToken<\/em> de aqu\u00ed en adelante)?<\/strong><\/p>\n
<\/p>\n
<\/p>\n
Un CancellationToken<\/em> es un mecanismo de cancelaci\u00f3n proporcionado por dotNet<\/em> que se utiliza para solicitar la cancelaci\u00f3n de una operaci\u00f3n en progreso. Por ejemplo, supongamos que tenemos un endpoint<\/em> que realiza una tarea larga o costosa, como realizar una consulta a una base de datos o llamar a un servicio externo. Si un cliente realiza una solicitud y luego cambia de opini\u00f3n o cierra la conexi\u00f3n, puede ser deseable cancelar la tarea en curso para liberar recursos y evitar un trabajo innecesario.<\/p>\n
<\/p>\n
<\/p>\n
Una vez que sabemos qu\u00e9 es un CancellationToken<\/em> toca contestar la siguiente pregunta. \u00bfPor qu\u00e9 debo usarlo?<\/strong><\/p>\n
<\/p>\n
<\/p>\n
Existen varias razones para usarlo. Aqu\u00ed enumero algunas de ellas:<\/p>\n
<\/p>\n
<\/p>\n