Por que devo criar operações WebAPI assíncronas em vez de sincronizar?

Eu tenho a seguinte operação em uma API Web que criei:

// 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);
}

A chamada para este serviço da web é feita por meio de uma chamada Jquery Ajax desta forma:

$.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);
      }          
  });

Já vi alguns desenvolvedores que implementam a operação anterior desta forma:

// 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));
}

Devo dizer, porém, que GetProductsWithHistory () é uma operação bastante longa. Dado o meu problema e contexto, como tornar a operação webAPI assíncrona me beneficiará?

Em seu exemplo específico, a operação não é assíncrona, então o que você está fazendo é assíncrono durante a sincronização. Você está apenas liberando um tópico e bloqueando outro. Não há razão para isso, porque todos os threads são threads de pool de threads (ao contrário de um aplicativo GUI).

Em minha discussão sobre “async over sync”, sugeri fortemente que, se você tiver uma API que é implementada internamente de forma síncrona, não deve expor uma contraparte assíncrona que simplesmente envolve o método síncrono Task.Run.

De Devo expor wrappers síncronos para métodos assíncronos?

No entanto, ao fazer chamadas WebAPI asynconde há uma operação assíncrona real (geralmente E / S) em vez de bloquear um thread que fica e espera por um resultado, o thread volta para o pool de threads e, portanto, é capaz de realizar alguma outra operação. Acima de tudo, isso significa que seu aplicativo pode fazer mais com menos recursos e isso melhora a escalabilidade.

Uma abordagem poderia ser (eu usei isso com sucesso em aplicativos de cliente) ter um serviço do Windows executando as operações demoradas com threads de trabalho e, em seguida, fazer isso no IIS para liberar os threads até que a operação de bloqueio seja concluída: Observe, isso pressupõe os resultados são armazenados em uma tabela (linhas identificadas por jobId) e um processo mais limpo limpando-os algumas horas após o uso.

Para responder à pergunta, "Dado meu problema e contexto, como tornar a operação assíncrona da webAPI me beneficiará?" considerando que é "uma operação bastante longa", estou pensando em muitos segundos em vez de ms, essa abordagem libera threads do IIS. Obviamente, você também deve executar um serviço do Windows que consome recursos, mas essa abordagem pode evitar que uma inundação de consultas lentas roube threads de outras partes do 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);
}