Gestion des erreurs Lambda dans API Gateway

Pour les intégrations personnalisées Lambda, vous devez mapper les erreurs renvoyées par Lambda dans la réponse d'intégration à des réponses d'erreurs HTTP standard pour vos clients. Sinon, les erreurs Lambda sont renvoyées en tant que réponses 200 OK par défaut et le résultat n'est pas intuitif pour les utilisateurs de l'API.

Lambda peut renvoyer deux types d'erreurs : des erreurs standard et des erreurs personnalisées. Dans votre API, vous devez les gérer différemment.

Avec l'intégration de proxy Lambda, Lambda doit renvoyer une sortie au format suivant :

{
  "isBase64Encoded" : "boolean",
  "statusCode": "number",
  "headers": { ... },
  "body": "JSON string"
}

Dans cette sortie, statusCode est généralement 4XX pour une erreur de client et 5XX pour une erreur de serveur. API Gateway traite ces erreurs en mappant l'erreur Lambda à une réponse d'erreur HTTP, en fonction du code statusCode spécifié. Pour qu'API Gateway transmette le type d'erreur, (par exemple InvalidParameterException), dans le cadre de la réponse au client, la fonction Lambda doit inclure un en-tête (par exemple, "X-Amzn-ErrorType":"InvalidParameterException") dans la propriété headers.

Gestion des erreurs Lambda standard dans API Gateway

Une erreur AWS Lambda standard se présente sous le format suivant :

{
  "errorMessage": "<replaceable>string</replaceable>",
  "errorType": "<replaceable>string</replaceable>",
  "stackTrace": [
    "<replaceable>string</replaceable>",
    ...
  ]
}

Ici, errorMessage est une expression de chaîne de l'erreur. errorType est un type d'erreur ou d'exception dépendant du langage. stackTrace est une liste d'expressions de chaîne montrant la trace de la pile conduisant à l'apparition de l'erreur.

Prenons l'exemple de la fonction Lambda JavaScript (Node.js) suivante.

export const handler = function(event, context, callback) {
    callback(new Error("Malformed input ..."));
};

Cette fonction renvoie l'erreur Lambda standard suivante, contenant Malformed input ... comme message d'erreur :

{
  "errorMessage": "Malformed input ...",
  "errorType": "Error",
  "stackTrace": [
    "export const handler (/var/task/index.js:3:14)"
  ]
}

De même, examinez la fonction Lambda Python suivante qui génère une Exception avec le même message d'erreur Malformed input ....

def lambda_handler(event, context):
    raise Exception('Malformed input ...')

Cette fonction renvoie l'erreur Lambda standard suivante :

{
  "stackTrace": [
    [
      "/var/task/lambda_function.py",
      3,
      "lambda_handler",
      "raise Exception('Malformed input ...')"
    ]
  ],
  "errorType": "Exception",
  "errorMessage": "Malformed input ..."
}

Notez que les valeurs de propriété errorType et stackTrace sont dépendantes du langage. L'erreur standard s'applique également à n'importe quel objet d'erreur qui est une extension de l'objet Error ou une sous-classe de la classe Exception.

Pour mapper l'erreur Lambda standard à une réponse de méthode, vous devez d'abord décider d'un code de statut HTTP pour une erreur Lambda donnée. Vous devez ensuite définir un modèle d'expression régulière sur la propriété selectionPattern de la réponse d'intégration IntegrationResponse associée au code de statut HTTP donné. Dans la console API Gateway, ce selectionPattern est désigné comme Expressions régulières de l’erreur Lambda dans la section Réponse d’intégration sous chaque réponse d’intégration.

Note

API Gateway utilise des expressions régulières de type modèle Java pour le mappage de réponse. Pour plus d'informations, consultez la section Modèles dans la documentation Oracle.

Par exemple, pour configurer une nouvelle expression selectionPattern, à l'aide de l'AWS CLI, appelez la commande put-integration-response suivante :

aws apigateway put-integration-response --rest-api-id z0vprf0mdh --resource-id x3o5ih --http-method GET --status-code 400 --selection-pattern "Malformed.*" --region us-west-2

Veillez également à configurer le code d'erreur correspondant (400) dans la réponse de méthode. Sinon, API Gateway renvoie une réponse d'erreur de configuration non valide lors de l'exécution.

Note

Lors de l'exécution, API Gateway met en correspondance le message errorMessage de l'erreur Lambda avec le modèle de l'expression régulière sur la propriété selectionPattern. S'il existe une correspondance, API Gateway renvoie l'erreur Lambda en tant que réponse HTTP du code de statut HTTP correspondant. S'il n'existe pas de correspondance, API Gateway renvoie l'erreur sous la forme d'une réponse par défaut ou émet une exception de configuration non valide si aucune réponse par défaut n'est configurée.

La définition de la valeur selectionPattern sur .* pour une réponse donnée revient à réinitialiser cette réponse comme la réponse par défaut. En effet, un tel modèle de sélection correspond à tous les messages d'erreur, y compris null, c'est-à-dire, tout message d'erreur non spécifié. Le mappage résultant remplace le mappage par défaut.

Pour mettre à jour une valeur selectionPattern existante à l'aide de l'AWS CLI appelez l'opération integrationresponse:update pour remplacer la valeur de chemin /selectionPattern par l'expression regex spécifiée du modèle Malformed*.

Pour définir l’expression selectionPattern à l’aide de la console API Gateway, saisissez l’expression dans la zone de texte Expressions régulières de l’erreur Lambda lors de la configuration ou de la mise à jour d’une réponse d’intégration d’un code de statut HTTP spécifié.

Gestion des erreurs Lambda personnalisées dans API Gateway

Au lieu de l'erreur standard décrite dans la section précédente, AWS Lambda vous permet de renvoyer un objet d'erreur personnalisé en tant que chaîne JSON. L'erreur peut être n'importe quel objet JSON valide. Par exemple, la fonction Lambda JavaScript (Node.js) renvoie une erreur personnalisée :

export const handler = (event, context, callback) => {
    ...
    // Error caught here:
    var myErrorObj = {
        errorType : "InternalServerError",
        httpStatus : 500,
        requestId : context.awsRequestId,
        trace : {
            "function": "abc()",
            "line": 123,
            "file": "abc.js"
        }
    }
    callback(JSON.stringify(myErrorObj));
};

Vous devez transformer l'objet myErrorObj en chaîne JSON avant d'appeler callback pour quitter la fonction. Sinon, myErrorObj est renvoyé sous la forme d'une chaîne "[object Object]". Lorsqu'une méthode de votre API est intégrée à la fonction Lambda précédente, API Gateway reçoit une réponse d'intégration avec la charge utile suivante :

{
    "errorMessage": "{\"errorType\":\"InternalServerError\",\"httpStatus\":500,\"requestId\":\"e5849002-39a0-11e7-a419-5bb5807c9fb2\",\"trace\":{\"function\":\"abc()\",\"line\":123,\"file\":\"abc.js\"}}"
}

Comme avec toute réponse d'intégration, vous pouvez transmettre cette réponse d'erreur telle quelle à la réponse de méthode. Vous pouvez aussi avoir un modèle de mappage pour transformer la charge utile en un autre format. Prenons l'exemple du modèle de mappage de corps suivant pour une réponse de méthode d'un code du statut 500 :

{
    errorMessage: $input.path('$.errorMessage');
}

Ce modèle convertit le corps de réponse d'intégration qui contient la chaîne JSON d'erreur personnalisée en le corps de réponse de méthode suivant. Ce corps de réponse de méthode contient l'objet JSON d'erreur personnalisée :

{
    "errorMessage" : {
        errorType : "InternalServerError",
        httpStatus : 500,
        requestId : context.awsRequestId,
        trace : {
            "function": "abc()",
            "line": 123,
            "file": "abc.js"
        }
    }
};

En fonction des exigences de votre API, il se peut que vous ayez besoin de transmettre tout ou partie des propriétés d'erreur personnalisée comme paramètres d'en-tête de réponse de méthode. Vous pouvez le faire en appliquant les mappages d'erreur personnalisée du corps de réponse d'intégration aux en-têtes de réponse de méthode.

Par exemple, l'extension OpenAPI suivante définit un mappage à partir des propriétés errorMessage.errorType, errorMessage.httpStatus, errorMessage.trace.function et errorMessage.trace aux en-têtes error_type, error_status, error_trace_function et error_trace, respectivement.

"x-amazon-apigateway-integration": {
    "responses": {
        "default": {
          "statusCode": "200",
          "responseParameters": {
            "method.response.header.error_trace_function": "integration.response.body.errorMessage.trace.function",
            "method.response.header.error_status": "integration.response.body.errorMessage.httpStatus",
            "method.response.header.error_type": "integration.response.body.errorMessage.errorType",
            "method.response.header.error_trace": "integration.response.body.errorMessage.trace"
          },
          ...
        }
    }
}

Lors de l'exécution, API Gateway désérialise le paramètre integration.response.body lorsqu'il effectue les mappages d'en-tête. Cependant, cette désérialisation s'applique uniquement aux mappages corps à en-tête pour les réponses d'erreur personnalisée Lambda et ne s'applique pas aux mappages corps à corps à l'aide de $input.body. Avec ces mappages corps à en-tête d'erreur personnalisée, le client reçoit les en-têtes suivants dans la réponse de méthode, dans la mesure où les en-têtes error_status, error_trace, error_trace_function et error_type sont déclarés dans la demande de méthode.

"error_status":"500",
"error_trace":"{\"function\":\"abc()\",\"line\":123,\"file\":\"abc.js\"}",
"error_trace_function":"abc()",
"error_type":"InternalServerError"

La propriété errorMessage.trace du corps de réponse d'intégration est une propriété complexe. Elle est mappée à l'en-tête error_trace sous la forme d'une chaîne JSON.