Administra funciones

2ª gen. 1ª gen.

Usa los comandos de Firebase CLI o configura opciones de entorno de ejecución en el código fuente para implementar, borrar y modificar funciones.

Implementa funciones

Para implementar funciones, ejecuta el siguiente comando de Firebase CLI:

firebase deploy --only functions

De forma predeterminada, Firebase CLI implementa todas las funciones dentro de la fuente al mismo tiempo. Si tu proyecto contiene más de 5 funciones, te recomendamos que uses la marca --only con nombres de funciones específicas para implementar solo las funciones que editaste. Si implementas funciones específicas de esta forma, acelerarás el proceso de implementación y evitarás alcanzar los límites de las cuotas de implementación. Por ejemplo:

firebase deploy --only functions:addMessage,functions:makeUppercase

Cuando implementas una gran cantidad de funciones, es posible que excedas la cuota estándar y recibas mensajes de error HTTP 429 o 500. Para solucionar este problema, implementa funciones en grupos de 10 o menos.

Para ver una lista completa de los comandos disponibles, consulta la Referencia de Firebase.

Según la configuración predeterminada, Firebase CLI busca el código fuente en la carpeta functions/. Si lo prefieres, puedes organizar funciones en bases de código o varios conjuntos de archivos.

Borra funciones

Puedes borrar las funciones implementadas previamente de estas maneras:

• De forma explícita en Firebase CLI con functions:delete
• De forma explícita en la consola de Google Cloud.
• De forma implícita si quitas la función de la fuente antes de la implementación.

Para realizar cualquiera de estas operaciones, deberás confirmar que quieres quitar la función de producción.

La función de eliminación explícita en Firebase CLI admite varios argumentos y grupos de funciones, y te permite especificar que una función se ejecute en una región en particular. Además, puedes anular la solicitud de confirmación.

# Delete all functions that match the specified name in all regions.
firebase functions:delete myFunction

# Delete a specified function running in a specific region.
firebase functions:delete myFunction --region us-east-1

# Delete more than one function
firebase functions:delete myFunction myOtherFunction

# Delete a specified functions group.
firebase functions:delete groupA

# Bypass the confirmation prompt.
firebase functions:delete myFunction --force

En la función de eliminación implícita, firebase deploy analiza la fuente y quita de producción las funciones eliminadas del archivo.

Modifica el nombre, la región o el activador de una función

Si quieres cambiar el nombre, las regiones o el activador de una función que maneja tráfico de producción, sigue los pasos de esta sección para no perder eventos durante la modificación. Antes de hacerlo, asegúrate de que tu función sea idempotente, ya que se ejecutarán al mismo tiempo la versión nueva y la antigua de la función durante el cambio.

Cambia el nombre de una función

Para cambiar el nombre de una función, crea una versión nueva de la función con otro nombre en la fuente y, luego, ejecuta dos comandos de implementación separados. El primer comando implementa la función nueva con otro nombre y el segundo comando quita la versión implementada anteriormente. Por ejemplo, si tienes una función de Node.js llamada webhook que te gustaría cambiar a webhookNew, modifica el código de la siguiente manera:

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions/v1');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

A continuación, ejecuta los siguientes comandos para implementar la función nueva:

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

Cambia las regiones de una función

Si cambias las regiones determinadas de una función que maneja tráfico de producción, puedes perder eventos. Para evitarlo, realiza los siguientes pasos en el mismo orden:

1. Cambia el nombre de la función y sus regiones como desees.
2. Implementa la función con el nombre nuevo. Esto ejecutará temporalmente el mismo código en ambos conjuntos de regiones.
3. Borra la función anterior.

Por ejemplo, si tienes una función llamada webhook que se encuentra actualmente en la región de funciones predeterminada de us-central1 y deseas migrarla a asia-northeast1, primero debes modificar tu código fuente para cambiarle el nombre a la función y revisar la región.

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions/v1');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

A continuación, impleméntala con el comando:

firebase deploy --only functions:webhookAsia

Ahora, tienes dos funciones idénticas en ejecución: webhook se ejecuta en us-central1 y webhookAsia se ejecuta en asia-northeast1.

Luego, borra webhook:

firebase functions:delete webhook

Solamente queda una función, webhookAsia, que se ejecuta en asia-northeast1.

Cambia el tipo de activador de una función

A medida que desarrollas tu implementación de Cloud Functions for Firebase, es posible que debas cambiar el tipo de activador de una función por diversas razones. Por ejemplo, es posible que quieras cambiar de un tipo de evento Firebase Realtime Database o Cloud Firestore a otro.

No es posible cambiar el tipo de evento de una función solo con cambiar el código fuente y ejecutar firebase deploy. Para evitar errores, usa el siguiente procedimiento a fin de cambiar el tipo de activador de una función:

1. Modifica el código fuente para que incluya una función nueva con el tipo de activador que desees.
2. Implementa la función, lo que tendrá como resultado la ejecución temporal de la función antigua y de la nueva.
3. Borra de producción la función antigua de forma explícita con Firebase CLI.

Por ejemplo, si tienes una función de Node.js llamada objectChanged con un tipo de evento heredado onChange y deseas cambiarlo a onFinalize, primero debes cambiar el nombre de la función y modificarla para que tenga el tipo de evento onFinalize.

// before
const functions = require('firebase-functions/v1');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions/v1');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

A continuación, y antes de borrar la función antigua, ejecuta los siguientes comandos para crear primero la función nueva:

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

Configura las opciones del entorno de ejecución

Cloud Functions for Firebase te permite seleccionar opciones de ejecución, como la versión del entorno de ejecución de Node.js, el tiempo de espera por función, la asignación de memoria y la cantidad mínima o máxima de instancias de función.

Como práctica recomendada, estas opciones (excepto la versión de Node.js) deben establecerse en un objeto de configuración dentro del código de la función. Este objeto RuntimeOptions es la fuente de información para las opciones del entorno de ejecución de tu función y anulará las opciones establecidas mediante cualquier otro método (como la consola de Google Cloud o la CLI de gcloud).

Si tu flujo de trabajo de desarrollo implica configurar manualmente las opciones del entorno de ejecución a través de la consola de Google Cloud o la CLI de gcloud, y no quieres que se anulen estos valores en cada implementación, configura la opción preserveExternalChanges como true. Cuando esta opción se configura como true, Firebase combina las opciones del entorno de ejecución configuradas en el código con la configuración de la versión implementada actualmente de la función y la siguiente prioridad:

1. Si la opción está establecida en el código de las funciones, se anulan los cambios externos.
2. Si la opción está establecida en RESET_VALUE en el código de las funciones, se anulan los cambios externos con el valor predeterminado.
3. Si la opción no está configurada en el código de las funciones, pero sí en la función implementada actualmente, se usa la opción especificada en la función implementada.

No se recomienda usar la opción preserveExternalChanges: true en la mayoría de los casos porque el código ya no será la fuente de confianza completa de las opciones del entorno de ejecución para las funciones. Si la usas, consulta la consola de Google Cloud o usa la CLI de gcloud para ver la configuración completa de una función.

Configura la versión de Node.js

El SDK de Firebase para Cloud Functions permite seleccionar el entorno de ejecución de Node.js. Puedes ejecutar todas las funciones de un proyecto de manera exclusiva en el entorno correspondiente a una de estas versiones compatibles de Node.js:

• Node.js 20 (vista previa)
• Node.js 18
• Node.js 16
• Node.js 14

Sigue estos pasos para configurar la versión de Node.js:

Puedes configurar la versión en el campo engines del archivo package.json que se creó en el directorio functions/ durante la inicialización. Por ejemplo, edita la línea que está a continuación en package.json si quieres usar solo la versión 18:

  "engines": {"node": "18"}

Si usas el administrador de paquetes Yarn o tienes otros requisitos específicos para el campo engines, puedes configurar el entorno de ejecución del SDK de Firebase para Cloud Functions en firebase.json en su lugar:

  {
    "functions": {
      "runtime": "nodejs18" // or nodejs14, nodejs16 or nodejs20
    }
  }

La CLI usa el valor establecido en firebase.json antes que cualquier valor o rango que configures por separado en package.json.

Actualiza el entorno de ejecución de Node.js

Sigue estos pasos para actualizar el entorno de ejecución de Node.js:

1. Asegúrate de que tu proyecto tenga el plan de precios Blaze.
2. Asegúrate de usar la versión 11.18.0 o posterior de Firebase.
3. Cambia el valor de engines en el archivo package.json que se creó en el directorio functions/ durante la inicialización. Por ejemplo, si actualizas de la versión 16 a la 18, la entrada debería tener este aspecto: "engines": {"node": "18"}.
4. De manera opcional, también puedes probar los cambios con Firebase Local Emulator Suite.
5. Vuelve a implementar todas las funciones.

Controla el comportamiento del escalamiento

Según la configuración predeterminada, Cloud Functions for Firebase escala la cantidad de instancias en ejecución según la cantidad de solicitudes entrantes y podría reducir la escala verticalmente a cero en los momentos con menos tráfico. Sin embargo, si tu app requiere una latencia reducida y deseas limitar la cantidad de inicios en frío, puedes cambiar este comportamiento predeterminado si especificas una cantidad mínima de instancias de contenedor que se deben mantener en espera y listas para entregar solicitudes.

De manera similar, puedes establecer una cantidad máxima para limitar el escalamiento de las instancias en respuesta a las solicitudes entrantes. Usa este parámetro de configuración como una forma de controlar tus costos o limitar la cantidad de conexiones a un servicio de respaldo, como una base de datos.

Reduce la cantidad de inicios en frío

Si quieres establecer una cantidad mínima de instancias para una función en el código fuente, usa el método runWith. Este método acepta un objeto JSON de acuerdo con la interfaz RuntimeOptions, que define el valor de minInstances. Por ejemplo, esta función establece un mínimo de 5 instancias para mantenerse en espera:

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });
index.js

Nota: Una cantidad mínima de instancias que se mantienen en ejecución genera costos de facturación a tarifas de inactividad. Por lo general, mantener una instancia de función inactiva en espera cuesta menos de $6.00 por mes. Firebase CLI proporciona una estimación de los costos en el momento de la implementación para las funciones con instancias mínimas reservadas. Consulta Precios de Cloud Functions para calcular los costos.

A continuación, se mencionan algunos puntos que deberás tener en cuenta cuando configures un valor para minInstances:

• Si Cloud Functions for Firebase escala tu app por sobre el parámetro de configuración de minInstances, experimentarás un inicio en frío en cada instancia que supere ese umbral.
• Los inicios en frío afectan de forma más grave a las apps con aumento de tráfico. Si tu app tiene un aumento de tráfico y estableces un valor de minInstances lo suficientemente alto como para que los inicios en frío se reduzcan en cada aumento de tráfico, verás una disminución significativa de la latencia. En el caso de las apps con tráfico constante, es poco probable que los inicios en frío afecten gravemente al rendimiento.

• Configurar instancias mínimas puede ser útil para los entornos de producción, pero, por lo general, se debe evitar en entornos de pruebas. Para reducir la escala a cero en tu proyecto de prueba y seguir disminuyendo los inicios en frío en el proyecto de producción, puedes configurar minInstances según la variable de entorno FIREBASE_CONFIG:

  // Get Firebase project id from `FIREBASE_CONFIG` environment variable
  const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;
  
  exports.renderProfilePage = functions
      .runWith({
        // Keep 5 instances warm for this latency-critical function
        // in production only. Default to 0 for test projects.
        minInstances: envProjectId === "my-production-project" ? 5 : 0,
      })
      .https.onRequest((req, res) => {
        // render some html
      });
  index.js
  

Limita la cantidad máxima de instancias para una función

Para establecer una cantidad máxima de instancias en el código fuente de la función, usa el método runWith. Este método acepta un objeto JSON de acuerdo con la interfaz RuntimeOptions, que define valores para maxInstances. Por ejemplo, esta función establece un límite de 100 instancias para no sobrecargar una base de datos heredada hipotética, de la siguiente manera:

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });
index.js

Si una función de HTTP se escala verticalmente hasta el límite de maxInstances, las solicitudes nuevas se ponen en cola durante 30 segundos y, luego, se rechazan con un código de respuesta de 429 Too Many Requests si no hay una instancia disponible para ese momento.

A fin de obtener más información sobre las prácticas recomendadas para usar la configuración de instancias máximas, consulta estas prácticas recomendadas sobre el uso de maxInstances.

Configura el tiempo de espera y la asignación de memoria

En algunos casos, es posible que tus funciones necesiten requisitos especiales para tener un valor de tiempo de espera largo o una mayor asignación de memoria. Puedes establecer estos valores en la consola de Google Cloud o en el código fuente de la función (solamente en Firebase).

Usa el parámetro runWith en el SDK de Firebase para Cloud Functions 2.0.0. para establecer la asignación de memoria y el tiempo de espera en el código fuente de la función. Esta opción de tiempo de ejecución acepta un objeto JSON de acuerdo con la interfaz RuntimeOptions que permite definir los valores para timeoutSeconds y memory. Por ejemplo, esta función de almacenamiento usa 1 GB de memoria, y su tiempo de espera se agota en 300 segundos:

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });
index.js

El valor máximo para timeoutSeconds es de 540 o 9 minutos. La cantidad de memoria otorgada a una función corresponde a la CPU asignada para la función, como se detalla en esta lista de valores válidos para memory:

• 128MB: 200 MHz
• 256MB: 400 MHz
• 512MB: 800 MHz
• 1GB: 1.4 GHz
• 2GB: 2.4 GHz
• 4GB: 4.8 GHz
• 8GB: 4.8 GHz

Para configurar el tiempo de espera y la asignación de memoria en la consola de Google Cloud, sigue estos pasos:

1. En la consola de Google Cloud de Google, selecciona Cloud Functions en el menú de la izquierda.
2. Haz clic en el nombre de una función para elegirla en la lista de funciones.
3. Haz clic en el ícono Editar en el menú de la parte superior.
4. Selecciona una asignación de memoria del menú desplegable Memoria asignada.
5. Haz clic en Más para ver las opciones avanzadas y, a continuación, ingresa la cantidad de segundos en el cuadro de texto Tiempo de espera.
6. Haz clic en Guardar para actualizar la función.