Gestion des erreurs dans CloudScript - XBOX Game Development Documentation

Ce tutoriel explique comment reconnaître et gérer les erreurs dans vos gestionnaires CloudScript.

Identification

La première étape consiste à identifier l’erreur. Bien que chaque erreur non interceptée soit journalisée et disponible dans la réponse retournée à l’appelant (client), vous pouvez intercepter l’erreur en amont à l’aide d’un bloc try/catch. Considérez l’extrait CloudScript suivant, qui produit et intercepte l’erreur.

"use strict";

handlers.GenerateError = () => {
    try {
        server.GetPlayerStatistics({
            PlayFabId : "non-existing-player-id"
        });
    } catch (ex) {
        let error = ex.apiErrorInfo.apiError.error; // In this case - "InvalidParams"
        let errorCode = ex.apiErrorInfo.apiError.errorCode; // In this case : 1000
    }
}

Avez-vous remarqué comment les codes d’erreur ont été extraits dans le bloc catch? Consultez notre documentation sur les codes d’erreur globaux des méthodes d’API pour obtenir la liste complète des erreurs.

Le code d’erreur suffit à lui seul pour identifier l’erreur.

Journalisation

Toute erreur non gérée est ajoutée à la réponse, ce qui permet au client de traiter le problème. Parallèlement, une entrée d’erreur CloudScript est créée et ajoutée aux statistiques totales disponibles dans votre tableau de bord CloudScript.

Game Manager : tableau de bord CloudScript affichant un graphique des erreurs d'API

Pour forcer la journalisation de l’exception sous forme de chaîne JSON, utilisez la journalisation des erreurs au moyen de l’objet log.

"use strict";

handlers.GenerateError = () => {
    try {
        server.GetPlayerStatistics({
            PlayFabId : "non-existing-player-id"
        });
    } catch (ex) {
        log.error(ex);
    }
}

Enfin, vous pouvez écrire des événements de titre/joueur pour un traitement ultérieur au moyen de l’analytique.

"use strict";

handlers.GenerateError = () => {
    try {
        server.GetPlayerStatistics({
            PlayFabId : "non-existing-player-id"
        });
    } catch (ex) {
        server.WriteTitleEvent({
            EventName : 'cs_error',
            Body : ex
        });
    }
}

Récupération

Il n’est pas toujours possible de se remettre d’une erreur. Avec des problèmes tels que InvalidArguments, vous n’avez d’autre choix que de signaler le problème au joueur. Il existe un sous-ensemble d’erreurs pour lesquelles une stratégie de nouvelle tentative peut être appliquée. Les types d’erreurs pouvant faire l’objet d’une nouvelle tentative sont décrits dans Codes d’erreur globaux des méthodes d’API. Nous vous demandons de vous assurer de respecter les exigences suivantes lorsque vous appliquez une stratégie de nouvelle tentative :

À chaque nouvelle tentative, le délai entre les tentatives doit augmenter de façon exponentielle. Cela augmente vos chances de réussite de l’appel et évite que votre jeu ne submerge le serveur PlayFab (ce qui entraînerait davantage d’appels rejetés).
Vous devez appliquer cette stratégie de nouvelle tentative de façon sélective, uniquement pour les codes qui justifient une nouvelle tentative.

Erreur de délai d’expiration de CloudScript

Le temps d’exécution des appels d’API CloudScript est limité à 4 secondes. Si le temps d’exécution dépasse 4 secondes, une erreur InternalServerError est levée et l’événement PlayStream écrit un objet Logs semblable au suivant :

    "Logs":[
        {
        "Level":"Error",
        "Message":"PlayFab API request failure",
        "Data":{
            "request":{
                "PlayFabId":"9437A5ADDAE3012D"
            },
            "error":"Timeout",
            "api":"/Server/GetPlayerSegments"
        }
        }
    ]

Si vous rencontrez cette erreur, vous pouvez :

diviser votre CloudScript en segments de code plus petits qui s’exécutent en moins de 4 secondes.
Passer à CloudScript avec Azure Functions, dont les délais d’expiration sont plus longs dans certains cas. Vous pouvez consulter les limites dans le guide de démarrage rapide.

​Identification

​Journalisation

​Récupération

​Erreur de délai d’expiration de CloudScript

Identification

Journalisation

Récupération

Erreur de délai d’expiration de CloudScript