¿Por qué debería crear operaciones asíncronas de WebAPI en lugar de sincronizar?

Tengo la siguiente operación en una API web que creé:

// GET api/<controller>
[HttpGet]
[Route("pharmacies/{pharmacyId}/page/{page}/{filter?}")]
public CartTotalsDTO GetProductsWithHistory(Guid pharmacyId, int page, string filter = null ,[FromUri] bool refresh = false)
{
    return delegateHelper.GetProductsWithHistory(CustomerContext.Current.GetContactById(pharmacyId), refresh);
}

La llamada a este servicio web se realiza a través de una llamada Jquery Ajax de esta manera:

$.ajax({
      url: "/api/products/pharmacies/<%# Farmacia.PrimaryKeyId.Value.ToString() %>/page/" + vm.currentPage() + "/" + filter,
      type: "GET",
      dataType: "json",
      success: function (result) {
          vm.items([]);
          var data = result.Products;
          vm.totalUnits(result.TotalUnits);
      }          
  });

He visto algunos desarrolladores que implementan la operación anterior de esta manera:

// GET api/<controller>
[HttpGet]
[Route("pharmacies/{pharmacyId}/page/{page}/{filter?}")]
public async Task<CartTotalsDTO> GetProductsWithHistory(Guid pharmacyId, int page, string filter = null ,[FromUri] bool refresh = false)
{
    return await Task.Factory.StartNew(() => delegateHelper.GetProductsWithHistory(CustomerContext.Current.GetContactById(pharmacyId), refresh));
}

Sin embargo, debo decir que GetProductsWithHistory () es una operación bastante larga. Dado mi problema y contexto, ¿cómo me beneficiará hacer que la operación webAPI sea asincrónica?

En su ejemplo específico, la operación no es asincrónica en absoluto, por lo que lo que está haciendo es asíncrona sobre sincronización. Solo estás liberando un hilo y bloqueando otro. No hay ninguna razón para eso, porque todos los subprocesos son subprocesos de grupo de subprocesos (a diferencia de una aplicación GUI).

En mi análisis de "async over sync", sugerí encarecidamente que si tiene una API que se implementa internamente de forma sincrónica, no debe exponer una contraparte asincrónica que simplemente envuelve el método sincrónico en Task.Run.

Desde En caso expongo envoltorios síncronos de métodos asincrónicos?

Sin embargo, al realizar llamadas WebAPI asyncdonde hay una operación asincrónica real (generalmente E / S) en lugar de bloquear un subproceso que se encuentra y espera un resultado, el subproceso vuelve al grupo de subprocesos y, por lo tanto, puede realizar alguna otra operación. Sobre todo, eso significa que su aplicación puede hacer más con menos recursos y eso mejora la escalabilidad.

Un enfoque podría ser (he usado esto con éxito en aplicaciones de clientes) para que un servicio de Windows ejecute las operaciones largas con subprocesos de trabajo, y luego hacer esto en IIS para liberar los subprocesos hasta que se complete la operación de bloqueo: Tenga en cuenta, esto supone Los resultados se almacenan en una tabla (filas identificadas por jobId) y un proceso más limpio los limpia algunas horas después de su uso.

Para responder a la pregunta, "Dado mi problema y contexto, ¿cómo me beneficiará hacer que la operación webAPI sea asincrónica?" Dado que es "una operación bastante larga", creo que muchos segundos en lugar de ms, este enfoque libera subprocesos de IIS. Obviamente, también debe ejecutar un servicio de Windows que a su vez consume recursos, pero este enfoque podría evitar que una avalancha de consultas lentas robe hilos de otras partes del sistema.

// GET api/<controller>
[HttpGet]
[Route("pharmacies/{pharmacyId}/page/{page}/{filter?}")]
public async Task<CartTotalsDTO> GetProductsWithHistory(Guid pharmacyId, int page, string filter = null ,[FromUri] bool refresh = false)
{
        var jobID = Guid.NewGuid().ToString()
        var job = new Job
        {
            Id = jobId,
            jobType = "GetProductsWithHistory",
            pharmacyId = pharmacyId,
            page = page,
            filter = filter,
            Created = DateTime.UtcNow,
            Started = null,
            Finished = null,
            User =  {{extract user id in the normal way}}
        };
        jobService.CreateJob(job);

        var timeout = 10*60*1000; //10 minutes
        Stopwatch sw = new Stopwatch();
        sw.Start();
        bool responseReceived = false;
        do
        {
            //wait for the windows service to process the job and build the results in the results table
            if (jobService.GetJob(jobId).Finished == null)
            {
                if (sw.ElapsedMilliseconds > timeout ) throw new TimeoutException();
                await Task.Delay(2000);
            }
            else
            {
                responseReceived = true;
            }
        } while (responseReceived == false);

    //this fetches the results from the temporary results table
    return jobService.GetProductsWithHistory(jobId);
}