Anti-pattern: utilizza WaitForComplete() nel codice JavaScript

Stai visualizzando la documentazione di Apigee e Apigee hybrid.
Visualizza la documentazione di Apigee Edge.

Il criterio JavaScript consente di aggiungere codice personalizzato da eseguire nel contesto di un flusso proxy API. Ad esempio, il codice personalizzato nel criterio JavaScript può essere utilizzato per:

  • Ottieni e imposta le variabili di flusso
  • Esegui una logica personalizzata ed esegui la gestione dei guasti
  • Estrae dati da richieste o risposte
  • Modifica dinamicamente l'URL di destinazione del backend
  • Aggiunta o rimozione dinamica di intestazioni da una richiesta o una risposta
  • Analizza una risposta JSON

Client HTTP

Una funzionalità efficace del criterio JavaScript è il client HTTP. Il client HTTP (o l'oggetto httpClient) può essere utilizzato per effettuare una o più chiamate al backend o a servizi esterni. Il client HTTP è particolarmente utile quando è necessario effettuare chiamate a più servizi esterni e combinare le risposte in un'unica API.

Codice JavaScript di esempio che effettua una chiamata al backend con l'oggetto httpClient 

var headers = {'X-SOME-HEADER' : 'some value' };
var myRequest = new Request("http://www.example.com","GET",headers);
var exchange = httpClient.send(myRequest);

L'oggetto httpClient espone due metodi get e send (nel codice campione precedente viene utilizzato send) per effettuare richieste HTTP. Entrambi i metodi sono asincroni e restituiscono un oggetto exchange prima del completamento della richiesta HTTP effettiva.

L'operazione potrebbe richiedere alcuni secondi o minuti. Dopo aver effettuato una richiesta HTTP, è importante sapere quando è stata completata, in modo che la risposta della richiesta possa essere elaborata. Uno dei modi più comuni per determinare quando la richiesta HTTP è completa è richiamare il metodo waitForComplete() dell'oggetto exchange.

waitForComplete()

Il metodo waitForComplete() mette in pausa il thread fino al completamento della richiesta HTTP e alla restituzione di una risposta (operazione riuscita/non riuscita). Quindi, può essere elaborata la risposta da un backend o da un servizio esterno.

Codice JavaScript di esempio con WaitForComplete() 

var headers = {'X-SOME-HEADER' : 'some value' };
var myRequest = new Request("http://www.example.com","GET",headers);
var exchange = httpClient.send(myRequest);
// Wait for the asynchronous GET request to finish
exchange.waitForComplete();

// Get and Process the response
if (exchange.isSuccess()) {
    var responseObj = exchange.getResponse().content.asJSON;
    return responseObj.access_token;
} else if (exchange.isError()) {
    throw new Error(exchange.getError());
}

Antipattern

L'utilizzo di waitForComplete() dopo l'invio di una richiesta HTTP nel codice JavaScript avrà implicazioni sulle prestazioni.

Considera il seguente codice JavaScript che chiama waitForComplete() dopo aver inviato una richiesta HTTP.

Codice per sample.js 

// Send the HTTP request
var exchangeObj = httpClient.get("http://example.com");
// Wait until the request is completed
exchangeObj.waitForComplete();
// Check if the request was successful
if (exchangeObj.isSuccess())  {

    response = exchangeObj.getResponse();
    context.setVariable('example.status', response.status);
} else {
   error = exchangeObj.getError();
   context.setVariable('example.error', 'Woops: ' + error);
}

In questo esempio:

  1. Il codice JavaScript invia una richiesta HTTP a un'API di backend.
  2. Quindi chiama waitForComplete() per mettere in pausa l'esecuzione fino al completamento della richiesta.

    L'API waitForComplete() determina il blocco del thread che esegue il codice JavaScript finché il backend non completa l'elaborazione della richiesta e risponde.

Esiste un limite massimo al numero di thread (30%) che possono eseguire contemporaneamente codice JavaScript su un processore di messaggi in qualsiasi momento. Una volta raggiunto questo limite, non saranno disponibili thread per l'esecuzione del codice JavaScript. Quindi, se ci sono troppe richieste in parallelo che eseguono l'API waitForComplete() nel codice JavaScript, le richieste successive non andranno a buon fine con un messaggio di errore 500 Internal Server Error e Timed out anche prima del timeout del criterio JavaScript.

In generale, questo scenario può verificarsi se il backend impiega molto tempo per elaborare le richieste o se il traffico è elevato.

Impatto

  1. Le richieste API non andranno a buon fine con 500 Internal Server Error e con il messaggio di errore Timed out quando il numero di richieste in parallelo in esecuzione waitForComplete() nel codice JavaScript supera il limite predefinito.
  2. La diagnosi della causa del problema può essere difficoltosa perché il codice JavaScript non funziona con l'errore Timed out anche se il limite di tempo per il criterio JavaScript specifico non è trascorso.

Best practice

Utilizza i callback nel client HTTP per semplificare il codice callout e migliorare le prestazioni ed evita di utilizzare waitForComplete() nel codice JavaScript. Questo metodo garantisce che il thread che esegue JavaScript non venga bloccato fino al completamento della richiesta HTTP.

Quando viene utilizzato un callback, il thread invia le richieste HTTP nel codice JavaScript e torna al pool. Poiché il thread non è più bloccato, è disponibile per gestire altre richieste. Dopo che la richiesta HTTP è stata completata e il callback è pronto per essere eseguito, verrà creata un'attività che verrà aggiunta alla coda di attività. Uno dei thread del pool eseguirà il callback in base alla priorità dell'attività.

Esempio di codice JavaScript utilizzando le richiamate in httpClient 

function onComplete(response,error) {
 // Check if the HTTP request was successful
    if (response) {
      context.setVariable('example.status', response.status);
     } else {
      context.setVariable('example.error', 'Woops: ' + error);
     }
}
// Specify the callback Function as an argument
httpClient.get("http://example.com", onComplete);

Per approfondire