Kā īstenot gaidīšanas (Waiter) paraugu API?

API gaidāmo gaidīšanas modeļa (Waiter) īstenošana ir cikliska resursa stāvokļa vai operācijas izpildes pārbaude līdz tiek sasniegts gaidītais nosacījums vai beidzas noteiktais laiks.

Galvenie soļi:

1. Pārbaudāmā nosacījuma noteikšana: Skaidri saprast, kāds API vai resursa stāvoklis tiek uzskatīts par "gatavu" (piemēram, pieprasījuma statuss ir mainījies, ir parādījusies jauna ieraksts, ir atgriezušās gaidītās dati).
2. Pārbaudes mehānisma izvēle: Noteikt, kā tiks veikta stāvokļa pārbaude. Tas var būt atkārtots pieprasījums tam pašam endpointam, pieprasījums uz īpašu statusa endpointu vai atbildes satura pārbaude.
3. Gaidīšanas parametru iestatīšana: Iestatīt maksimālo gaidīšanas laiku (laika ierobežojumu) un intervālu starp pārbaudēm.
4. Cikla īstenošana: Izveidot ciklu, kas veiks stāvokļa pārbaudi ar noteiktu intervālu.
5. Iziešanas nosacījumu apstrāde:
   • Iziet, sasniedzot gaidīto nosacījumu.
   • Iziet, ja ir beidzies laika ierobežojums, kas tiek saistīts ar izņēmumu vai kļūdu.
6. Kļūdu apstrāde pārbaudes laikā: Ieplānot iespējamās kļūdas pārbaudes laikā cikla iekšienē (piemēram, API pagaidu nepieejamība).

Piemērs pseudokodā:

# wait_for_resource_ready(api_endpoint, expected_condition, timeout_seconds, interval_seconds)

start_time = current_time
while current_time - start_time < timeout_seconds:
    response = make_api_request(api_endpoint) # Veikt pieprasījumu API

    if check_condition(response, expected_condition): # Pārbaudīt gatavības nosacījumu
        return True # Nosacījums ir sasniegts

    sleep(interval_seconds) # Pagaidīt pirms nākamās pārbaudes
    current_time = current_time # Atjaunot pašreizējo laiku

raise TimeoutError("Resurss nav gatavs noteiktajā laikā") # Laika ierobežojums ir beidzies

# check_condition(response, expected_condition):
# Nosacījuma pārbaudes loģika, pamatojoties uz API atbildi
# Piemēram, return response['status'] == 'ready'

Python piemērs ar requests bibliotēku:

import requests
import time

def wait_for_status(url, expected_status, timeout=60, interval=5):
    """
    Gaidīt, kamēr endpoint atgriež noteiktu statusu.
    """
    start_time = time.time()

    while time.time() - start_time < timeout:
        try:
            response = requests.get(url)
            if response.status_code == expected_status:
                print(f"[{time.strftime('%H:%M:%S')}] Saņemts statuss {expected_status}.")
                return True
        except requests.exceptions.RequestException as e:
            print(f"[{time.strftime('%H:%M:%S')}] Kļūda pieprasījumā: {e}. Pārtraukšana pēc {interval} sekundēm.")

        time.sleep(interval)

    raise TimeoutError(f"Neizdevās saņemt statusu {expected_status} pēc {timeout} sekundēm.")

# Piemērs lietošanai
# try:
#     wait_for_status("http://api.example.com/status", 200)
# except TimeoutError as e:
#     print(e)

Konkrētās īstenošanas izvēle ir atkarīga no API specifikas un testēšanas prasībām. Ir svarīgi nodrošināt elastību laika ierobežojumu un intervālu iestatījumos, kā arī informatīvas ziņas par laika ierobežojuma pārtraukšanu.