Spécification du protocole pour https.onCall

Un déclencheur https.onCall pour Cloud Functions est un déclencheur HTTPS avec un format spécifique pour la requête et la réponse. Cette section fournit une spécification pour les formats de requête et de réponse HTTPS utilisés par les SDK clients pour implémenter l'API. Ces informations peuvent vous être utiles si vos exigences ne peuvent pas être satisfaites à l'aide des SDK Android, Apple ou Web.

Format de la requête : en-têtes

La requête HTTP adressée à un point de terminaison de déclencheur appelable doit être une requête POST avec les en-têtes suivants :

Obligatoire : Content-Type: application/json
- Un ; charset=utf-8 facultatif est autorisé.
Facultatif : Authorization: Bearer <token>
- Jeton d'identification utilisateur Firebase Authentication pour l'utilisateur connecté qui effectue la requête. Le backend valide automatiquement ce jeton et le met à disposition dans le context. Si le jeton n'est pas valide, la requête est rejetée.
Facultatif : Firebase-Instance-ID-Token: <iid>
- Jeton d'enregistrement FCM provenant du SDK client Firebase. Il doit s'agir d'une chaîne. Il est disponible dans le context du gestionnaire. Il est utilisé pour cibler les notifications push.
Facultatif : X-Firebase-AppCheck: <token>
- Jeton Firebase App Check fourni par l'application cliente qui effectue la requête. Le backend valide automatiquement ce jeton, le décode et injecte l'appId dans le context du gestionnaire. Si le jeton ne peut pas être validé, la requête est rejetée. (Disponible pour le SDK >= 3.14.0)

Si d'autres en-têtes sont inclus, la requête est rejetée, comme décrit dans la documentation de réponse ci-dessous.

Remarque : Dans les clients JavaScript, ces requêtes déclenchent une pré-vérification CORS OPTIONS, car :

application/json n'est pas autorisé. Il doit s'agir de text/plain ou application/x-www-form-urlencoded.
L'en-tête Authorization n'est pas un en-tête de requête autorisé par CORS.
Les autres en-têtes ne sont pas non plus autorisés.

Le déclencheur appelable gère automatiquement ces requêtes OPTIONS.

Corps de la requête

Le corps de la requête HTTP doit être un objet JSON avec l'un des champs suivants :

Obligatoire : data : argument transmis à la fonction. Il peut s'agir de n'importe quelle valeur JSON valide. Il est automatiquement décodé en types JavaScript natifs en fonction du format de sérialisation décrit ci-dessous.

Si d'autres champs sont présents dans la requête, le backend considère que la requête est mal formée et la rejette.

Format de la réponse : codes d'état

Plusieurs cas peuvent entraîner différents codes d'état HTTP et codes d'état de chaîne pour erreurs dans la réponse.

En cas d'erreur HTTP avant l'appel du déclencheur client, la réponse n'est pas gérée comme une fonction client. Par exemple, si un client tente d'appeler une fonction inexistante, il reçoit une réponse 404 Not Found.
Si le déclencheur client est appelé, mais que la requête est au mauvais format (par exemple, si elle n'est pas au format JSON, si elle comporte des champs non valides ou si le champ data est manquant), la requête est rejetée avec 400 Bad Request et un code d'erreur INVALID_ARGUMENT.
Si le jeton d'authentification fourni dans la requête n'est pas valide, la requête est rejetée avec 401 Unauthorized et un code d'erreur UNAUTHENTICATED.
Si le jeton d'enregistrement FCM fourni dans la requête n'est pas valide, le comportement n'est pas défini. Le jeton n'est pas vérifié pour chaque requête, sauf lorsqu'il est utilisé pour envoyer une notification push avec FCM.
Si le déclencheur appelable est appelé, mais échoue avec une exception non gérée ou renvoie une promesse ayant échoué, la requête est rejetée avec 500 Internal Server Error et un code d'erreur INTERNAL. Cela empêche les erreurs de codage d'être accidentellement exposées aux utilisateurs finaux.
Si l'appelable est appelé et renvoie une condition d'erreur explicite à l'aide de l'API fournie pour les fonctions appelables, la requête échoue. Le code d'état HTTP renvoyé est basé sur le mappage officiel de l'état d'erreur à l'état HTTP, tel que défini dans code.proto. Le code d'erreur, le message et les détails spécifiques renvoyés sont encodés dans le corps de la réponse, comme décrit ci-dessous. Cela signifie que si la fonction renvoie une erreur explicite avec l'état OK, la réponse a l'état 200 OK, mais le champ error est défini dans la réponse.
Si le déclencheur client réussit, l'état de la réponse est 200 OK.

Format de la réponse : en-têtes

La réponse comporte les en-têtes suivants :

Content-Type: application/json
Un ; charset=utf-8 facultatif est autorisé.

Corps de la réponse

La réponse d'un point de terminaison client est toujours un objet JSON. Elle contient au minimum result ou error, ainsi que tous les champs facultatifs. Si la réponse n'est pas un objet JSON ou ne contient pas data ou error, le SDK client doit traiter la requête comme ayant échoué avec le code d'erreur Google INTERNAL (13).

error : si ce champ est présent, la requête est considérée comme ayant échoué, quel que soit le code d'état HTTP ou la présence de data. La valeur de ce champ doit être un objet JSON au format de mappage HTTP Google Cloud standard pour les erreurs, avec des champs pour status, message et (facultativement) details. Le champ code ne doit pas être inclus. Si le champ status n'est pas défini ou s'il s'agit d'une valeur non valide, le client doit traiter l'état comme INTERNAL, conformément à code.proto. Si details est présent, il est inclus dans toutes les informations utilisateur associées à l'erreur dans le SDK client, le cas échéant.
Remarque : Le champ details est une valeur fournie par l'utilisateur. Il ne s'agit pas nécessairement d'une liste de valeurs indexées par type proto comme dans le format Status de Google.
result : valeur renvoyée par la fonction. Il peut s'agir de n'importe quelle valeur JSON valide. Le SDK firebase-functions encode automatiquement la valeur renvoyée par l'utilisateur dans ce format JSON. Les SDK clients décodent automatiquement ces paramètres en types natifs en fonction du format de sérialisation décrit ci-dessous.

Si d'autres champs sont présents, ils doivent être ignorés.

Sérialisation

Le format de sérialisation des charges utiles de données arbitraires est le même pour la requête et la réponse.

Pour assurer la cohérence de la plate-forme, elles sont encodées au format JSON comme s'il s'agissait de la valeur d'un champ Any dans un tampon de protocole proto3, à l'aide du mappage JSON standard. Les valeurs de types simples tels que null, int, double ou string sont encodées directement et n'incluent pas leur type explicite. Ainsi, un float et un double sont encodés de la même manière, et vous ne savez peut-être pas lequel est reçu à l'autre bout de l'appel. Pour les types qui ne sont pas natifs de JSON, l'encodage proto3 typé de la valeur est utilisé. Pour en savoir plus, consultez la documentation sur l'encodage JSON Any.

Les types suivants sont autorisés :

null : null
int (signé ou non signé, jusqu'à 32 bits) : par exemple, 3 ou -30.
float : par exemple, 3.14
double : par exemple, 3.14
boolean : true ou false
chaîne - par exemple, "hello world"
map<string, any=""> : par exemple, {"x": 3}</string,>
list : par exemple, [1, 2, 3]
long (signé ou non signé, jusqu'à 64 bits) : [voir ci-dessous pour plus de détails]

Les valeurs NaN et Infinity pour float et double ne sont pas compatibles.

Notez que long est un type spécial qui n'est normalement pas autorisé dans JSON, mais qui est couvert par la spécification proto3. Par exemple, ils sont encodés comme suit :

long

{
    '@type': 'type.googleapis.com/google.protobuf.Int64Value',
    'value': '-123456789123456'
}

unsigned long

{
    '@type': 'type.googleapis.com/google.protobuf.UInt64Value',
    'value': '123456789123456'
}

En général, la clé @type doit être considérée comme réservée et ne doit pas être utilisée pour les cartes transmises.

Étant donné que le type n'est pas spécifié pour les types simples, certaines valeurs changent de type après avoir été transmises. Un float transmis devient un double. Un short devient un int, et ainsi de suite. Sous Android, List et JSONArray sont compatibles avec les valeurs de liste. Dans ce cas, la transmission d'un JSONArray génère une List.

Si une carte avec un champ @type inconnu est désérialisée, elle est laissée telle quelle. Cela permet aux développeurs d'ajouter des champs avec de nouveaux types à leurs valeurs renvoyées sans casser les anciens clients.

Exemples de code

Les exemples de cette section illustrent comment encoder les éléments suivants :

Exemple de callable.call en Swift
Réponse de réussite pour l'appel
Réponse d'échec pour l'appel

Exemple de callable.call en Swift à encoder

callable.call([
    "aString": "some string",
    "anInt": 57,
    "aFloat": 1.23,
    "aLong": -123456789123456 as Int64
])

En-tête de requête :

Method: POST
Content-Type: application/json; charset=utf-8
Authorization: Bearer some-auth-token
Firebase-Instance-ID-Token: some-iid-token

Corps de la requête :

{
    "data": {
        "aString": "some string",
        "anInt": 57,
        "aFloat": 1.23,
        "aLong": {
            "@type": "type.googleapis.com/google.protobuf.Int64Value",
            "value": "-123456789123456"
        }
    }
}

Réponse à encoder

return {
    "aString": "some string",
    "anInt": 57,
    "aFloat": 1.23
};

En-tête de réponse réussie :

200 OK
Content-Type: application/json; charset=utf-8

Corps de la réponse réussie :

{
    "response": {
        "aString": "some string",
        "anInt": 57,
        "aFloat": 1.23
    }
}

Réponse d'échec à encoder

throw new HttpsError("unauthenticated", "Request had invalid credentials.", {
  "some-key": "some-value"
});

En-tête de réponse ayant échoué :

401 UNAUTHENTICATED
Content-Type: application/json; charset=utf-8

Corps de la réponse ayant échoué :

{
    "error": {
        "message": "Request had invalid credentials.",
        "status": "UNAUTHENTICATED",
        "details": {
            "some-key": "some-value"
        }
    }
}