Llama a funciones desde tu app

Los SDK de cliente de Cloud Functions para Firebase te permiten llamar a funciones directamente desde una app de Firebase. Para hacerlo, escribe e implementa una función HTTPS que admita llamadas en Cloud Functions y, luego, agrega lógica de cliente para llamar a la función desde tu app.

Es importante tener en cuenta que las funciones HTTPS que admiten llamadas son similares, pero no idénticas a las funciones de HTTP. Para usar funciones HTTPS que admiten llamadas, debes utilizar el SDK cliente de tu plataforma junto con la API de backend de functions.https (o implementar el protocolo). Las funciones que admiten llamadas tienen esta diferencia clave en comparación con las funciones de HTTP:

  • Con las funciones que admiten llamadas, los tokens de Firebase Authentication y FCM se incluyen en las solicitudes automáticamente cuando están disponibles.
  • El activador functions.https.onCall deserializa automáticamente el cuerpo de la solicitud y valida los tokens de autenticación.

El SDK de Firebase para Cloud Functions v0.9.1 (y versiones posteriores) funciona en conjunto con estas versiones mínimas del SDK cliente de Firebase para ser compatible con las funciones HTTPS que admiten llamadas:

  • SDK de Firebase para iOS 6.13.0
  • SDK de Firebase para Android 19.0.1
  • SDK de Firebase JavaScript 7.4.0

Si quieres agregar una función similar a una app compilada en una plataforma no compatible, consulta la especificación del protocolo de https.onCall. En el resto de esta guía, se proporcionan instrucciones para escribir, implementar y llamar a una función HTTPS que admite llamadas para iOS, Android, la Web, C++ y Unity.

Escribe y también implementa la función que admite llamadas

Usa functions.https.onCall para crear una función HTTPS que admite llamadas. Este método recibe dos parámetros: data y context(opcional):

// Saves a message to the Firebase Realtime Database but sanitizes the text by removing swearwords.
exports.addMessage = functions.https.onCall((data, context) => {
  // ...
});

En el caso de una función que admite llamadas y guarda un mensaje de texto en Realtime Database, por ejemplo, data podría contener el texto del mensaje, mientras que los parámetros de context representan la información de autenticación del usuario:

// Message text passed from the client.
const text = data.text;// Authentication / user information is automatically added to the request.
const uid = context.auth.uid;
const name = context.auth.token.name || null;
const picture = context.auth.token.picture || null;
const email = context.auth.token.email || null;

La distancia entre la ubicación de la función que admite llamadas y la ubicación del cliente que emite la llamada puede crear una latencia de red importante. Para optimizar el rendimiento, especifica la ubicación de la función cuando corresponda. Además, asegúrate de alinear la ubicación de la función que admite llamadas con la ubicación establecida cuando inicialices el SDK en el cliente.

Cómo devolver los resultados

Para devolver los datos al cliente, muestra los datos que pueden tener codificación JSON. Por ejemplo, para mostrar el resultado de una operación de suma:

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: '+',
  operationResult: firstNumber + secondNumber,
};

Para mostrar los datos después de una operación asíncrona, muestra una promesa. Los datos que muestra la promesa se devuelven al cliente. Por ejemplo, podrías mostrar el texto depurado que la función que admite llamadas escribió en Realtime Database:

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

Maneja errores

Para garantizar que el cliente obtenga información útil sobre los errores, muestra los errores desde una función que acepte llamadas. Para ello, arroja una instancia defunctions.https.HttpsError (o muestra una promesa rechazada con ese error). El error tiene un atributo code que puede ser uno de los valores que se muestran en functions.https.HttpsError. Los errores también tienen una string message, que está vacía en su configuración predeterminada. También pueden tener un campo details opcional con un valor arbitrario. Si se arroja un error distinto de HttpsError desde tus funciones, el cliente recibirá un error con el mensaje INTERNAL y el código internal.

Por ejemplo, una función podría arrojar errores de autenticación y validación de datos con mensajes de error que se devuelven al cliente que emite la llamada:

// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('invalid-argument', 'The function must be called with ' +
      'one arguments "text" containing the message text to add.');
}
// Checking that the user is authenticated.
if (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

Implementa la función que admite llamadas

Cuando completas una función que admite llamadas y la guardas en index.js, esta se implementa junto con todas las otras funciones cuando ejecutas firebase deploy. A fin de implementar solo la función que admite llamadas, usa el argumento --only para ejecutar implementaciones parciales, como se muestra a continuación:

$ firebase deploy --only functions:addMessage

Configura el entorno de desarrollo de tu cliente

Asegúrate de cumplir todos los requisitos y de agregar las dependencias y las bibliotecas cliente necesarias a tu app.

iOS

  1. Sigue las instrucciones a fin de agregar Firebase a tu app para iOS.
  2. Agrega el pod de Cloud Functions a tu Podfile:
    pod 'Firebase/Functions'
  3. Luego de guardar el archivo, ejecuta este comando:
    pod install

Web

  1. Sigue las instrucciones para agregar Firebase a tu app web.
  2. Agrega la biblioteca cliente de Firebase Core y de Cloud Functions a tu app:
    <script src="https://www.gstatic.com/firebasejs/7.4.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/7.4.0/firebase-functions.js"></script>
    

El SDK de Cloud Functions también está disponible como paquete npm.

  1. Ejecuta el siguiente comando desde tu terminal:
    npm install firebase@7.4.0 --save
    
  2. Solicita manualmente Firebase Core y Cloud Functions:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Java

  1. Sigue las instrucciones a fin de agregar Firebase a tu app para Android.
  2. En tu archivo build.gradle de nivel de proyecto, asegúrate de incluir el repositorio Maven de Google en las secciones buildscript y allprojects.
  3. Agrega la dependencia para la biblioteca de Android de Cloud Functions al archivo Gradle (generalmente app/build.gradle) de tu módulo (nivel de app):
    implementation 'com.google.firebase:firebase-functions:19.0.1'
    

Kotlin

  1. Sigue las instrucciones a fin de agregar Firebase a tu app para Android.
  2. En tu archivo build.gradle de nivel de proyecto, asegúrate de incluir el repositorio Maven de Google en las secciones buildscript y allprojects.
  3. Agrega la dependencia para la biblioteca de Android de Cloud Functions al archivo Gradle (generalmente app/build.gradle) de tu módulo (nivel de app):
    implementation 'com.google.firebase:firebase-functions:19.0.1'
    

C++

Para C++ con Android:

  1. Sigue las instrucciones para agregar Firebase a tu proyecto de C++.
  2. En tu archivo build.gradle de nivel de proyecto, asegúrate de incluir el repositorio Maven de Google en las secciones buildscript y allprojects.
  3. Agrega la biblioteca firebase_functions a tu archivo CMakeLists.txt.

Para C++ con iOS:

  1. Sigue las instrucciones para agregar Firebase a tu proyecto de C++.
  2. Agrega el pod de Cloud Functions a tu Podfile:
    pod 'Firebase/Functions'
  3. Luego de guardar el archivo, ejecuta este comando:
    pod install
  4. Agrega los marcos de trabajo de Firebase Core y de Cloud Functions desde el SDK de Firebase C++ a tu proyecto de Xcode.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Sigue las instrucciones para agregar Firebase a tu proyecto de Unity.
  2. Agrega el FirebaseFunctions.unitypackage del SDK de Firebase Unity a tu proyecto de Unity.

Inicializa el SDK cliente

Inicializa una instancia de Cloud Functions:

Swift

lazy var functions = Functions.functions()

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;// ...
self.functions = [FIRFunctions functions];

Web

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

Java

private FirebaseFunctions mFunctions;// ...
mFunctions = FirebaseFunctions.getInstance();

Kotlin

private lateinit var functions: FirebaseFunctions// ...
functions = FirebaseFunctions.getInstance()

C++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

Unity

functions = Firebase.Functions.DefaultInstance;

Llama a la función

Swift

functions.httpsCallable("addMessage").call(["text": inputField.text]) { (result, error) in
  if let error = error as NSError? {
    if error.domain == FunctionsErrorDomain {
      let code = FunctionsErrorCode(rawValue: error.code)
      let message = error.localizedDescription
      let details = error.userInfo[FunctionsErrorDetailsKey]
    }
    // ...
  }
  if let text = (result?.data as? [String: Any])?["text"] as? String {
    self.resultField.text = text
  }
}

Objective-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if (error.domain == FIRFunctionsErrorDomain) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({text: messageText}).then(function(result) {
  // Read result of the Cloud Function.
  var sanitizedMessage = result.data.text;
  // ...
});

Java

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}

Kotlin

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true
    )

    return functions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith { task ->
                // This continuation runs on either success or failure, but if the task
                // has failed then result will throw an Exception which will be
                // propagated down.
                val result = task.result?.data as String
                result
            }
}

C++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Unity

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

Maneja errores en el cliente

El cliente recibe un error si el servidor arroja un error o si se rechaza la promesa resultante.

Si el error que muestra la función es del tipo function.https.HttpsError, el cliente recibe el code, el message y los details del error del servidor. En caso contrario, el error contiene el mensaje INTERNAL y el código INTERNAL. Consulta la guía sobre cómo solucionar errores en tu función que admite llamadas.

Swift

if let error = error as NSError? {
  if error.domain == FunctionsErrorDomain {
    let code = FunctionsErrorCode(rawValue: error.code)
    let message = error.localizedDescription
    let details = error.userInfo[FunctionsErrorDetailsKey]
  }
  // ...
}

Objective-C

if (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({text: messageText}).then(function(result) {
  // Read result of the Cloud Function.
  var sanitizedMessage = result.data.text;}).catch(function(error) {
  // Getting the Error details.
  var code = error.code;
  var message = error.message;
  var details = error.details;
  // ...
});

Java

addMessage(inputMessage)
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (!task.isSuccessful()) {
                    Exception e = task.getException();
                    if (e instanceof FirebaseFunctionsException) {
                        FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
                        FirebaseFunctionsException.Code code = ffe.getCode();
                        Object details = ffe.getDetails();
                    }

                    // ...
                }

                // ...
            }
        });

Kotlin

addMessage(inputMessage)
        .addOnCompleteListener(OnCompleteListener { task ->
            if (!task.isSuccessful) {
                val e = task.exception
                if (e is FirebaseFunctionsException) {
                    val code = e.code
                    val details = e.details
                }

                // ...
            }

            // ...
        })

C++

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult *result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
// ...

Unity

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});