Как опросить API как часть $ .Deferred()

Question

Ниже приведенный ниже нефункциональный пример должен объяснить, что я пытаюсь сделать, я просто не понимаю шаблон, который мне нужно использовать для его выполнения. Я попробовал поиск в Google, чтобы понять опрос и отложить, но я не мог найти ничего, что мог бы понять.

У меня есть функция, которая опроса API, и я хочу дождаться, пока этот опрос вернет ожидаемый результат (ожидая, что конечная точка укажет, что что-то изменилось), прежде чем продолжить мою основную функцию. Что я делаю не так?

Edit: Я хотел бы добавить, что КАЖЕТСЯ пойти не так с кодом ниже, что даже если deferred.resolve() в конечном итоге получает называется, кажется, что это не то же самое deferred, что получил вернулся, так что when никогда не активируется в main(). Я предполагаю, что это связано с таймаутом, то есть deferred получить clobbered на первом повторе. Это мое предположение, так или иначе.

function pollAPI() { 
    var deferred = $.Deferred(); 

    $.ajax({                 
     url: url,          
     contentType: 'application/JSON',          
     method: 'GET'               
    }).done(function(data){                                
     if (!desiredResult) {             
      setTimeout(function() {           
       pollAPI();        
      }, 1000);              
     } else {                
      deferred.resolve(); 
     }                                   
    }).error(deferred.reject());            

    return deferred.promise(); 
} 

function main() { 
    $.when(pollAPI()).then(function() { 
     // do something now that the API has returned the expected result 
    }); 

Answer 1

Вы можете использовать цепочки последующих вызовов функции pollAPI() создать единое обещание, что есть другие прикованные на него. Это будет выглядеть так:

// utility function to create a promise that is resolved after a delay 
$.promiseDelay = function(t) { 
    return $.Deferred(function(def) { 
     setTimeout(def.resolve, t); 
    }).promise(); 
} 

function pollAPI() { 
    return $.ajax({ 
     url: url, 
     contentType: 'application/JSON', 
     method: 'GET' 
    }).then(function(data) { 
     // some logic here to test if we have desired result 
     if (!desiredResult) { 
      // chain the next promise onto it after a delay 
      return $.promiseDelay(1000).then(pollAPI); 
     } else { 
      // return resolved value 
      return someValue; 
     } 
    }); 
} 

function main() { 
    pollAPI().then(function(result) { 
     // got desired result here 
    }, function(err) { 
     // ended with an error here 
    }); 
} 

Это имеет следующие преимущества:

1. Нет ненужного обещание не создано, чтобы попытаться окружить вызов AJAX, что уже есть обещание. Это позволяет избежать одного из common promise anti-patterns.
2. Последующие звонки в API просто связаны с оригинальным обещанием.
3. Нет необходимости использовать $.when(), когда у вас есть только одно обещание. Вы можете просто использовать .then() прямо на нем.
4. Все ошибки автоматически перколяются обратно к первоначальному обещанию.
5. Это использует ES6-стандарт .then() (который фактически становится более законным стандартом в jQuery 3.x - хотя он работает в jQuery 1.x и 2.x со своими нестандартными причудами), что делает эту логику более совместимой с другие перспективные асинхронные функции.

Кроме того, ряд других Retry идей здесь: Promise Retry Design Patterns