Risoluzione degli errori di runtime dei criteri JavaScript

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

ScriptExecutionFailed

Codice di errore

steps.javascript.ScriptExecutionFailed

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Execution of javascript_policy_name failed with error: error_type: error_description. (javascript_source_file_name)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Tipi di errori e possibili cause

Il criterio JavaScript può generare molti tipi diversi di errori ScriptExecutionFailed. Alcuni degli errori più comuni sono elencati nella tabella seguente:

Tipo di errore Causa
Errore intervallo Se utilizzi un numero che non rientra nell'intervallo di valori legali, viene visualizzato un errore RangeError.
Errore di riferimento Viene generato un valore ReferenceError se utilizzi (riferimento) una variabile che non è stata dichiarata.
Errore di sintassi Se provi a valutare il codice con un errore di sintassi, viene visualizzato un errore SyntaxError.
Errore di digitazione Se utilizzi un'operazione che non rientra nell'intervallo dei tipi previsti, viene generato un errore TypeError.
Errore URI Se utilizzi caratteri non ammessi in una funzione URI, viene generato un errore URIError.

Errore intervallo

Il tipo di errore RangeError viene generato quando operi su un valore o passi un valore a una funzione che non è compresa nell'insieme o nell'intervallo di valori consentiti.

Ad esempio, questo errore viene generato nelle seguenti circostanze:

  1. Se utilizzi una data non valida, ad esempio 31 settembre 2018, con alcune API delle date.
  2. Se passi un valore non valido a metodi numerici come Number.toPrecision(), Number.tofixed() o Number.toExponential(). Ad esempio, se passi un valore grande come 400 o 500 nel metodo Number.toPrecision(), visualizzerai un errore di intervallo.
  3. Se crei un array con lunghezza non consentita.

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Execution of javascript_policy_name failed with error: Javascript runtime error: \"RangeError: error_description. (javascript_source_file_name:line_number)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Nota:la diagnosi e la risoluzione degli errori di intervallo dipendono dall'esatto messaggio di errore generato dal criterio JavaScript. Di seguito vengono riportati alcuni esempi a scopo di riferimento.

Esempio 1: data non valida

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of ParseDate failed with error: Javascript runtime error: \"RangeError: Date is invalid. (ParseDate.js:2)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine, il numero di riga in cui si è verificato l'errore e la descrizione dell'errore. Puoi trovare tutte queste informazioni nell'elemento faultstring della risposta di errore. Ad esempio, in faultstring seguente, il nome del criterio JavaScript è ParseDate, il file di origine JavaScript è ParseDate.js, il numero di riga in cui si è verificato l'errore è 2 e la descrizione dell'errore è Date is invalid:

    "faultstring": "Execution of ParseDate failed with error: Javascript runtime error: \"RangeError: Date is invalid. (ParseDate.js:2)\""
    
  2. Esamina il file di origine JavaScript (identificato nel passaggio 1 precedente) e controlla se viene utilizzata una data non valida nel numero di riga specificato nell'errore o se la variabile utilizzata nel numero di riga presenta una data non valida. L'utilizzo di una data non valida è dovuto all'errore.

    Di seguito è riportato un file di origine JavaScript di esempio che genera questo errore:

    ParseDate.js

    var date = new Date('2018-09-31T11:19:08.402Z');
    date.toISOString();
    

    In questo esempio viene utilizzata una variabile date nella riga numero 2. Esaminando il file di origine, puoi vedere che la variabile date è impostata con una data non valida: 2018-09-31T11:19:08.402Z. Questa data non è valida perché settembre non ha 31 giorni.

    Nota: il formato ISO-8601 utilizzato in questo esempio è YYYY-MM-DDTHH:mm:ss.sssZ

Risoluzione

Assicurati di utilizzare sempre una data valida mentre utilizzi le API Date nel codice JavaScript.

Per correggere il codice JavaScript di esempio mostrato sopra, puoi impostare la data come Sept 30 2018 come mostrato di seguito:

var date = new Date('2018-09-30T11:19:08.402Z');
date.toISOString();

Esempio 2: numero non valido trasmesso alle API di precisione

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of SetNumberPrecision failed with error: Javascript runtime error: "RangeError: Precision 400 out of range. (SetNumberPrecision.js:2)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine, il numero di riga in cui si è verificato l'errore e la descrizione dell'errore. Puoi trovare tutte queste informazioni nell'elemento faultstring della risposta di errore. Ad esempio, nel seguente faultstring, il nome del criterio JavaScript è SetNumberPrecision, il file di origine JavaScript è SetNumberPrecision.js, il numero di riga in cui si è verificato l'errore è 2 e la descrizione dell'errore è Precision 400 out of range..

    "faultstring": "Execution of SetNumberPrecision failed with error: Javascript runtime error: "RangeError: Precision 400 out of range. (SetNumberPrecision.js:2)\""
    
  2. Esamina il file di origine JavaScript (identificato nel passaggio 1 precedente). Se il numero grande indicato come parte della descrizione dell'errore viene utilizzato nel numero di riga specifico, allora è questa la causa dell'errore.

    Di seguito è riportato un file di origine JavaScript di esempio che genera questo errore:

    SetNumberPrecision.js

    var number = 12.3456;
    var rounded_number = number.toPrecision(400);
    print("rounded_number = " + rounded_number);
    

    In questo esempio, viene utilizzato un valore elevato pari a 400 nella riga 2. Poiché non puoi impostare la precisione su un numero così elevato di cifre, viene visualizzato il seguente errore:

    "faultstring": "Execution of SetNumberPrecision failed with error: Javascript runtime error: "RangeError: Precision 400 out of range. (SetNumberPrecision.js:2)\""
    

Risoluzione

Assicurati che il numero utilizzato nel metodo toPrecision() rientri nell'insieme dei valori consentiti.

Per risolvere il problema con il codice JavaScript di esempio descritto sopra, imposta il numero di cifre significative su 2, che è valido:

var number = 12.3456;
var rounded_number = number.toPrecision(2);
print("rounded_number = " + rounded_number);

Errore riferimento

Il tipo di errore ReferenceError viene generato quando viene utilizzata (a cui viene fatto riferimento) una variabile non definita in JavaScript.

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Execution of javascript_policy_name failed with error: Javascript runtime error: \"ReferenceError: variable_name is not defined. (javascript_source_file_name:line_number)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of ComputeTotalPrice failed with error: Javascript runtime error: \"ReferenceError: \"price\" is not defined. (ComputeTotalPrice.js:3)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine e il numero di riga a cui viene fatto riferimento alla variabile non definita. Puoi trovare tutte queste informazioni nell'elemento faultstring della risposta di errore. Ad esempio, nel seguente faultstring, il nome del criterio JavaScript è ComputeTotalPrice, il file di origine corrispondente è ComputeTotalPrice.js, il numero della riga in cui si è verificato l'errore è 3 e il nome della variabile non definita è price.

    "faultstring": "Execution of ComputeTotalPrice failed with error: Javascript runtime error: \"ReferenceError: \"price\" is not defined. (ComputeTotalPrice.js:3)\""
    
  2. Esamina il numero di riga nel file di origine JavaScript e verifica se viene fatto riferimento alla variabile non definita identificata nel passaggio 1 precedente. Ad esempio, il seguente codice JavaScript fa riferimento alla variabile non definita price nella riga 3, che corrisponde al contenuto della stringa di errore:

    ComputeTotalPrice.js

    var item = context.getVariable("request.queryparam.item");
    var quantity = context.getVariable("request.queryparam.quantity");
    var totalprice = parseInt(quantity) * parseInt(price);
    context.setVariable("TotalPrice", totalprice);
    
    
  3. Verifica se la variabile specifica è definita all'interno del codice JavaScript. Se la variabile non è definita, è questa la causa dell'errore.

    Nello script di esempio mostrato sopra, viene utilizzata la variabile price non dichiarata/definita. Pertanto, visualizzerai il seguente errore:

    "faultstring": "Execution of ComputeTotalPrice failed with error: Javascript runtime error: \"ReferenceError: \"price\" is not defined. (ComputeTotalPrice.js:3)\""
    

Risoluzione

Assicurati che tutte le variabili a cui viene fatto riferimento nel codice JavaScript siano definite correttamente.

Per risolvere il problema con il codice JavaScript di esempio mostrato sopra, definisci il prezzo della variabile prima di utilizzarlo. Ad esempio:

var item = context.getVariable("request.queryparam.item");
var quantity = context.getVariable("request.queryparam.quantity");
var price = context.getVariable("request.queryparam.price");
var totalprice = parseInt(quantity) * parseInt(price);
context.setVariable("TotalPrice", totalprice);

Errore di sintassi

Il tipo di errore SyntaxError viene restituito quando il motore JavaScript rileva token o un ordine dei token non conforme alla sintassi del linguaggio oppure quando un input di formato non valido viene trasmesso alle API del parser, ad esempio l'analisi JSON/XML.

Ad esempio, se il payload JSON non valido o in un formato corretto viene trasmesso come input all'API JSON.parse utilizzata all'interno del criterio JavaScript, viene visualizzato questo errore.

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Execution of javascript_policy_name failed with error: Javascript runtime error: \"SyntaxError: error_description. (javascript_source_file_name:line_number)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of ParseJSONRequest failed with error: Javascript runtime error: \"SyntaxError: Unexpected token: <. (ParseJSONRequest.js:2)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine, il numero di riga in cui si è verificato l'errore e la descrizione dell'errore. Puoi trovare tutte queste informazioni nell'elemento faultstring della risposta di errore. Ad esempio, in faultstring seguente, il nome del criterio JavaScript è ParseJSONRequest, il file di origine JavaScript è ParseJSONRequest.js, il numero di riga in cui si è verificato l'errore è 2 e la descrizione dell'errore è Unexpected token:

    "faultstring": "Execution of ParseJSONRequest failed with error: Javascript runtime error: \"SyntaxError: Unexpected token: <. (ParseJSONRequest.js:2)\""
    
  2. Esamina la riga numero 2 nel file di origine JavaScript (identificato nel passaggio 1 sopra) e controlla quale operazione viene eseguita. Se è in corso l'esecuzione di una funzione JSON.parse(), controlla il parametro di input che le è stato trasmesso. Se il parametro di input non è valido o ha un formato JSON in un formato non valido, è questa la causa dell'errore.

    Di seguito è riportato un codice JavaScript di esempio che genera questo errore:

    var input = context.getVariable("request.content");
    var result = JSON.parse(input);
    

    In questo esempio, il payload della richiesta (request.content) passato al proxy API viene utilizzato come input per la funzione JSON.parse().

    Ecco la chiamata API di esempio che mostra come è stata trasmessa la richiesta:

    curl -v "http://<org>-<env>.apigee.net/v1/js-demo" -H "Content-Type: application/json" -X POST -d '<city>Bangalore</city>'
    

    Nella richiesta riportata sopra, il seguente payload XML viene passato al proxy API <city>Bangalore</city>. L'API JSON.parse prevede che venga trasmesso un JSON valido, ma poiché viene passato un payload XML, l'API non riesce a causa del seguente errore:

    "Execution of ParseJSONRequest failed with error: Javascript runtime error: \"SyntaxError: Unexpected token: <. (ParseJSONRequest.js:2)\""
    

Risoluzione

Assicurati di trasmettere un input valido alle API di analisi utilizzate nel codice JavaScript.

Per risolvere il problema con il criterio di esempio discusso sopra, trasmetti una richiesta di payload JSON valida come segue:

curl -v "http://<org>-<env>.apigee.net/v1/js-demo" -H "Content-Type: application/json" -X POST -d '{"city" : "Bangalore"}'

Errore di tipo

Il tipo di errore TypeError viene generato quando:

  • Un operando o un argomento passato a una funzione non è compatibile con il tipo previsto da tale operatore o funzione.
  • Una funzione viene richiamata su un oggetto nullo, non definito o errato.
  • È possibile accedere a una proprietà da un oggetto nullo, non definito o errato.

Ad esempio, viene restituito un errore di tipo:

  • Se tenti di richiamare la funzione toUpperCase() su un numero. Questo perché la funzione toUpperCase() può essere richiamata solo su oggetti stringa.
  • Se tenti di leggere una proprietà da un oggetto nullo o non definito.

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Execution of javascript_policy_name failed with error: Javascript runtime error: \"TypeError: error_description. (javascript_source_file_name:line_number)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Esempio 1: richiamare una funzione nell'oggetto sbagliato

Se tenti di richiamare una funzione su un oggetto non supportato, viene visualizzato questo errore. Ad esempio, se tenti di richiamare la funzione toUpperCase() su un numero, viene visualizzato l'errore. Questo perché la funzione toUpperCase() può essere richiamata solo su oggetti stringa.

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of ConvertToUpperCase failed with error: Javascript runtime error: \"TypeError: Cannot find function toUpperCase in object 100. (ConvertToUpperCase.js:2)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine, il numero di riga in cui si è verificato l'errore e la descrizione dell'errore. Puoi trovare tutte queste informazioni nell'elemento faultstring della risposta di errore. Ad esempio, nel seguente faultstring, il nome del criterio JavaScript è ConvertToUpperCase, il file di origine è ConvertToUpperCase.js, il numero di riga è 2 e la descrizione dell'errore è **Cannot find function toUpperCase in object 100.

    "faultstring": "Execution of ConvertToUpperCase failed with error: Javascript runtime error: \"TypeError: Cannot find function toUpperCase in object 100. (ConvertToUpperCase.js:2)\""
    

    La descrizione dell'errore indica che stai richiamando la funzione toUpperCase() su un oggetto il cui valore numerico è 100.

  2. Esamina il file di origine JavaScript e verifica se stai richiamando la funzione toUpperCase() su un oggetto il cui valore numerico sia 100 alla riga numero 2 (identificato nel passaggio 1 sopra). Se sì, allora è questa la causa dell'errore.

    Di seguito è riportato un file di origine JavaScript di esempio che genera questo errore:

    ConvertToUpperCase.js

    var number = 100;
    var result = number.toUpperCase();
    

    Nel codice JavaScript mostrato sopra, la variabile number è impostata con un valore pari a 100. La funzione toUpperCase()( viene richiamata nell'oggetto number. Poiché la funzione toUpperCase() può essere richiamata solo sugli oggetti stringa, viene visualizzato questo errore:

    "Execution of ConvertToUpperCase failed with error: Javascript runtime error: \"TypeError: Cannot find function toUpperCase in object 100. (ConvertToUpperCase.js:2)\""
    

Risoluzione

Usa sempre funzioni come toUpperCase() sugli oggetti validi.

Per correggere l'esempio mostrato sopra, puoi creare una variabile stringa e quindi richiamare la funzione toUpperCase() su una stringa:

var text = "Hello Apigee !";
var result = text.toUpperCase();

Esempio 2: impossibile leggere la proprietà da un oggetto non definito

Se tenti di accedere a/leggere una proprietà da un oggetto non definito, viene visualizzato questo errore. Ad esempio, questo errore può verificarsi quando tenti di accedere ai dati da un oggetto in un array, ma l'oggetto non è definito. Consulta la spiegazione dettagliata di seguito.

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of ParseJSONResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"length\" from undefined. (ParseJSONResponse.js:7)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine, il numero di riga in cui si è verificato l'errore e la descrizione dell'errore. Puoi trovare tutte queste informazioni nell'elemento faultstring della risposta di errore. Ad esempio, nel seguente faultstring, il nome del criterio è ParseJSONResponse, il file di origine è ParseJSONResponse.js, il numero di riga è 6 e la descrizione dell'errore è Cannot read property "length" from undefined.

    "faultstring": "Execution of ParseJSONResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"length\" from undefined. (ParseJSONResponse.js:6)\""
    

    L'errore indica che non è possibile leggere la proprietà length da un oggetto non definito.

  2. Esamina il numero di riga nel file di origine JavaScript (identificato nel passaggio 1 precedente) e verifica se l'oggetto ha un valore valido o non è definito. Potresti dover leggere e comprendere l'intero file di origine per determinare come è stato definito o derivato l'oggetto specifico e per determinare la ragione per cui l'oggetto risulta indefinito. Se scopri che l'oggetto specifico è effettivamente indefinito e stai tentando di accedere alla sua lunghezza della proprietà, significa che è questa la causa dell'errore.

    Esaminiamo un esempio per comprendere meglio il problema:

    1. Supponi di ricevere la seguente risposta JSON dal server di backend:

      {
          "cars": [
             { "name":"Toyota", "count": 150 }
             { "name":"Honda", "count": 100 },
             { "name":"Ford", "count": 75 }
          ]
      }
      
    2. Di seguito è riportato un esempio di file sorgente JavaScript che analizza questa risposta JSON e genera l'errore indicato sopra:

      ParseJSONResponse.js

      // Get the JSON response
      var jsonData = context.getVariable("response.content");
      print (jsonData);
      
      // Read the cars array
      for (var i = 0; i < jsonData.cars.length; i++)
        {
        print("name = " + jsonData.cars[i].name);
        print("count = " + jsonData.cars[i].count);
        }
      
    3. Se esamini attentamente il codice JavaScript, puoi vedere che alla riga numero 2, response.content viene letto/memorizzato nella variabile jsonData come una stringa normale (tra virgolette).

    4. Poiché jsonData è una stringa normale, quando tenti di accedere a cars da jsonData (jsonData.cars) il valore non sarà definito.

    5. Successivamente, quando provi a leggere la proprietà length da jsonData.cars, che non è definita, viene visualizzato il seguente errore:

      "faultstring": "Execution of ParseJSONResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"length\" from undefined. (ParseJSONResponse.js:6)\""
      

Risoluzione

Assicurati di leggere sempre i dati JSON come oggetto JSON utilizzando le API JSON pertinenti.

Per correggere il codice JavaScript di esempio descritto sopra, puoi utilizzare la funzione JSON.parse() nell'oggetto response.content per ottenerlo come un oggetto JSON. Successivamente, potrai accedere all'array cars ed eseguire correttamente l'iterazione nell'array.

// Get the JSON response
var data = context.getVariable("response.content");
var jsonData = JSON.parse(data);
print (jsonData);

// Read the cars array
for (var i = 0; i < jsonData.cars.length; i++)
{
    print("name = " + jsonData.cars[i].name);
    print("count = " + jsonData.cars[i].count);
}

Errore URI

Se utilizzi caratteri non ammessi in una funzione URI, viene generato il tipo di errore URIError. Ad esempio, se passi un URI con un simbolo di percentuale alle funzioni decodeURI o decodeURIComponent, riceverai questo errore.

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Execution of javascript_policy_name failed with error: Javascript runtime error: \"URIError: error_description. (javascript_source_file_name:line_number)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Esempio di corpo di risposta di errore

{
    "fault": {
        "faultstring": "Execution of URIDecode failed with error: Javascript runtime error: \"URIError: Malformed URI sequence. (URIDecode.js:2)\"",
        "detail": {
            "errorcode": "steps.javascript.ScriptExecutionFailed"
        }
    }
}

Diagnosi

  1. Identifica il criterio JavaScript, il relativo file di origine, il numero di riga in cui si è verificato l'errore e la descrizione dell'errore. Puoi trovare tutte queste informazioni nell'elemento stringa di errore della risposta di errore. Ad esempio, nella seguente stringa di errore, il nome del criterio JavaScript è URIDecode</code, il file di origine JavaScript è URIDecode.js, il numero di riga è 2 e la descrizione dell'errore è Malformed URI sequence:

    "faultstring": "Execution of URIDecode failed with error: Javascript runtime error: \"URIError: Malformed URI sequence. (URIDecode.js:2)\""
    

    La descrizione dell'errore indica che nella riga 2 di URIDecode.js viene utilizzata una sequenza URI non corretta.

  2. Esamina il file di origine JavaScript e verifica se l'argomento passato a una delle funzioni URI contiene caratteri non ammessi. Se sì, allora è la causa dell'errore.

    Ecco un esempio di file di origine JavaScript che genera questo errore:

    URIDecode.js

    var str = "75%-Completed";
    var decoded_str = decodeURIComponent(str);
    context.setVariable("decoded_str", decoded_str);
    

    Nel codice JavaScript di esempio mostrato sopra, la variabile str passata a decodeURIComponent() ha un simbolo di percentuale, che è considerato un carattere non valido; pertanto, viene visualizzato il seguente errore:

    "Execution of URIDecode failed with error: Javascript runtime error: \"URIError: Malformed URI sequence. (URIDecode.js:2)\""
    

Risoluzione

Assicurati che tutti i caratteri utilizzati nelle funzioni URI siano legali e consentiti.

Per risolvere il problema con il codice JavaScript di esempio descritto sopra, utilizza la codifica del simbolo di percentuale. Ad esempio, %25:

var str = "75%25-Completed";
var decoded_str = decodeURIComponent(str);
context.setVariable("decoded_str", decoded_str);