Antipattern: utilizzare waitForComplete() nel codice JavaScript

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

Il criterio JavaScript ti consente di aggiungere codice personalizzato che viene eseguito nel contesto di un flusso di proxy API. Ad esempio, il codice personalizzato nella norma JavaScript può essere utilizzato per:

  • Recuperare e impostare le variabili di flusso
  • Esegui una logica personalizzata ed esegui la gestione degli errori
  • Estrarre dati da richieste o risposte
  • Modificare dinamicamente l'URL di destinazione backend
  • Aggiungere o rimuovere dinamicamente intestazioni da una richiesta o una risposta
  • Analizzare una risposta JSON

Client HTTP

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

Esempio di codice JavaScript 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 (send viene utilizzato nel codice campione riportato sopra) per effettuare richieste HTTP. Entrambi i metodi sono asincroni e restituiscono un oggetto exchange prima che la richiesta HTTP effettiva venga completata.

Le richieste HTTP potrebbero richiedere da pochi secondi a pochi minuti. Dopo aver effettuato una richiesta HTTP, è importante sapere quando viene completata, in modo che la risposta alla richiesta possa essere elaborata. Uno dei modi più comuni per determinare quando la richiesta HTTP è completata è richiamare il metodo waitForComplete() dell'oggetto exchange.

waitForComplete()

Il metodo waitForComplete() mette in pausa il thread finché la richiesta HTTP non viene completata e non viene restituita una risposta (riuscita/errore). Successivamente, la risposta di un backend o di un servizio esterno può essere elaborata.

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 ha implicazioni per le prestazioni.

Considera il seguente codice JavaScript che chiama waitForComplete() dopo l'invio di 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. Poi chiama waitForComplete() per sospendere l'esecuzione fino al completamento della richiesta.

    L'API waitForComplete() fa sì che il thread che esegue il codice JavaScript venga bloccato 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 eseguire il codice JavaScript. Pertanto, se ci sono troppe richieste simultanee che eseguono l'API waitForComplete() nel codice JavaScript, le richieste successive non andranno a buon fine e verrà visualizzato un messaggio di errore 500 Internal Server Error e Timed out prima ancora che la policy JavaScript scada.

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 simultanee che eseguono waitForComplete() nel codice JavaScript supera il limite predefinito.
  2. Diagnosticare la causa del problema può essere difficile perché JavaScript genera un errore Timed out anche se il limite di tempo per la specifica norma JavaScript non è trascorso.

Best practice

Utilizza i callback nel client HTTP per semplificare il codice di 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 utilizzata una 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. Una volta completata la richiesta HTTP e la callback è pronta per essere eseguita, viene creata un'attività e aggiunta alla coda di attività. Uno dei thread del pool eseguirà il callback in base alla priorità dell'attività.

Codice JavaScript di esempio che utilizza i callback 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