Управление функциями

Вы можете развертывать, удалять и изменять функции с помощью команд командной строки Firebase или задавая параметры времени выполнения в исходном коде функций.

Развернуть функции

Чтобы развернуть функции, запустите эту команду Firebase CLI:

firebase deploy --only functions

По умолчанию интерфейс командной строки Firebase развертывает все функции внутри index.js одновременно. Если ваш проект содержит более 5 функций, мы рекомендуем вам использовать флаг --only с конкретными именами функций, чтобы развернуть только те функции, которые вы отредактировали. Развертывание определенных функций таким образом ускоряет процесс развертывания и помогает избежать превышения квот на развертывание. Например:

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

При развертывании большого количества функций вы можете превысить стандартную квоту и получить сообщения об ошибках HTTP 429 или 500. Чтобы решить эту проблему, разверните функции группами по 10 или меньше.

Полный список доступных команд см. в справке Firebase CLI .

По умолчанию интерфейс командной строки Firebase ищет исходный код в папке functions/ . При желании вы можете организовать функции в кодовых базах или нескольких наборах файлов.

Удалить функции

Вы можете удалить ранее развернутые функции следующими способами:

  • явно в интерфейсе командной строки Firebase с functions:delete
  • явно в Google Cloud Console .
  • неявно , удалив функцию из index.js перед развертыванием.

Все операции удаления требуют подтверждения перед удалением функции из производства.

Явное удаление функции в интерфейсе командной строки Firebase поддерживает несколько аргументов, а также группы функций и позволяет указать функцию, работающую в определенном регионе. Кроме того, вы можете переопределить запрос подтверждения.

# 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

При неявном удалении функций firebase firebase deploy анализирует index.js и удаляет из производства все функции, которые были удалены из файла.

Изменить имя, область или триггер функции

Если вы переименовываете или изменяете регионы или триггеры для функций, обрабатывающих рабочий трафик, выполните действия, описанные в этом разделе, чтобы избежать потери событий во время модификации. Прежде чем выполнять эти шаги, сначала убедитесь, что ваша функция является идемпотентной , поскольку и новая, и старая версии вашей функции будут выполняться одновременно во время изменения.

Переименовать функцию

Чтобы переименовать функцию, создайте новую переименованную версию функции в index.js а затем выполните две отдельные команды развертывания. Первая команда развертывает функцию с новым именем, а вторая команда удаляет развернутую ранее версию. Например, если у вас есть функция с именем webhook , которую вы хотите изменить на webhookNew , измените код следующим образом:

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

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

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

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

Затем выполните следующие команды, чтобы развернуть новую функцию:

# 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

Изменение региона или регионов функции

Если вы меняете указанные регионы для функции, обрабатывающей рабочий трафик, вы можете предотвратить потерю событий, выполнив следующие действия по порядку:

  1. Переименуйте функцию и измените ее регион или регионы по желанию.
  2. Разверните переименованную функцию, что приведет к временному запуску одного и того же кода в обоих наборах регионов.
  3. Удалить предыдущую функцию.

Например, если у вас есть функция с именем webhook , которая в настоящее время находится в регионе функций по умолчанию us-central1 , и вы хотите перенести ее в asia-northeast1 , вам нужно сначала изменить исходный код, чтобы переименовать функцию и пересмотреть регион. .

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

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

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

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

Затем разверните, запустив:

firebase deploy --only functions:webhookAsia

Теперь запущены две одинаковые функции: webhook работает в us-central1 , а webhookAsia — в asia-northeast1 .

Затем удалите webhook :

firebase functions:delete webhook

Сейчас есть только одна функция — webhookAsia , которая работает в asia-northeast1 .

Изменить тип триггера функции

По мере разработки облачных функций для развертывания Firebase вам может потребоваться изменить тип триггера функции по разным причинам. Например, вы можете:

Невозможно изменить тип события функции, просто изменив исходный код и запустив firebase deploy . Чтобы избежать ошибок, измените тип триггера функции с помощью этой процедуры:

  1. Измените исходный код, чтобы включить новую функцию с желаемым типом триггера.
  2. Разверните функцию, что приведет к временному запуску как старой, так и новой функций.
  3. Явным образом удалите старую функцию из рабочей среды с помощью интерфейса командной строки Firebase.

Например, если у вас есть функция objectChanged с устаревшим типом события onChange , и вы хотите изменить ее на onFinalize , сначала переименуйте функцию и отредактируйте ее, указав тип события onFinalize .

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

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

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

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

Затем выполните следующие команды, чтобы сначала создать новую функцию, прежде чем удалять старую:

# 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

Установить параметры времени выполнения

Облачные функции для Firebase позволяют выбирать параметры среды выполнения, такие как версия среды выполнения Node.js и тайм-аут для каждой функции, выделение памяти и минимальное/максимальное количество экземпляров функции.

Установить версию Node.js

Firebase SDK для Cloud Functions 2.0.0 и более поздних версий позволяет выбирать среду выполнения Node.js. Вы можете запустить все функции в проекте исключительно в среде выполнения, соответствующей одной из следующих поддерживаемых версий Node.js:

  • Node.js 16
  • Node.js 14
  • Node.js 12
  • Node.js 10
  • Node.js 8 (устарело 8 июня 2020 г.) Развертывание функций в среде выполнения Node.js 8 было отключено в интерфейсе командной строки Firebase 15 декабря 2020 г. Выполнение уже развернутых функций будет остановлено в какой-то момент в будущем; если вы развернули функции в среде выполнения Node.js 8, мы рекомендуем вам выполнить обновление до среды выполнения Node.js 16 .

Чтобы установить версию Node.js:

Установите версию в поле engines в файле package.json , который был создан в вашем каталоге functions/ во время инициализации. Например, чтобы использовать только версию 16, отредактируйте эту строку в package.json :

  "engines": {"node": "16"}

Поле engines обязательно; в нем должна быть указана одна из поддерживаемых версий Node.js, чтобы вы могли развертывать и запускать функции. В настоящее время firebase init functions устанавливают для этого поля значение 16 .

Обновите среду выполнения Node.js

Чтобы обновить среду выполнения Node.js:

  1. Убедитесь, что ваш проект включен в тарифный план Blaze .
  2. Убедитесь, что вы используете Firebase CLI v9.17.0 или более позднюю версию.
  3. Измените значение engines в файле package.json , который был создан в вашем каталоге functions/ во время инициализации. Например, если вы обновляете версию 10 до версии 16, запись должна выглядеть так: "engines": {"node": "16"}
  4. При желании протестируйте свои изменения с помощью Firebase Local Emulator Suite .
  5. Повторное развертывание функций с помощью интерфейса командной строки Firebase версии 9.17.0 или более поздней версии.

Управление масштабированием

По умолчанию облачные функции для Firebase масштабируют количество запущенных экземпляров в зависимости от количества входящих запросов, потенциально уменьшая количество экземпляров до нуля в периоды снижения трафика. Однако если вашему приложению требуется меньшая задержка и вы хотите ограничить количество холодных запусков, вы можете изменить это поведение по умолчанию, указав минимальное количество экземпляров контейнера, которые должны поддерживаться в горячем состоянии и быть готовыми к обслуживанию запросов.

Точно так же вы можете установить максимальное количество, чтобы ограничить масштабирование экземпляров в ответ на входящие запросы. Используйте этот параметр для контроля затрат или для ограничения количества подключений к резервной службе, например к базе данных.

Уменьшить количество холодных пусков

Чтобы установить минимальное количество экземпляров функции в исходном коде, используйте параметр runWith . Этот параметр среды выполнения принимает объект JSON, соответствующий интерфейсу RuntimeOptions , который определяет значение для minInstances . Например, эта функция устанавливает минимум 5 экземпляров для сохранения тепла:

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

Вот некоторые вещи, которые следует учитывать при установке значения для minInstances :

  • Если облачные функции для Firebase масштабируют ваше приложение выше параметра minInstances , вы будете испытывать холодный запуск для каждого экземпляра выше этого порога.
  • Холодный запуск сильнее всего влияет на приложения с резким трафиком. Если ваше приложение имеет пиковый трафик и вы установили значение minInstances достаточно высоким, чтобы холодные запуски уменьшались при каждом увеличении трафика, вы увидите значительное снижение задержки. Для приложений с постоянным трафиком холодный запуск вряд ли сильно повлияет на производительность.

  • Установка минимального количества экземпляров может иметь смысл для производственных сред, но обычно ее следует избегать в тестовых средах. Чтобы масштабировать до нуля в вашем тестовом проекте, но при этом сократить количество холодных запусков в рабочем проекте, вы можете установить minInstances на основе переменной среды 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

Ограничить максимальное количество экземпляров функции

Чтобы установить максимальное количество экземпляров в исходном коде функции, используйте параметр runWith . Этот параметр среды выполнения принимает объект JSON, соответствующий интерфейсу RuntimeOptions , который определяет значения для maxInstances . Например, эта функция устанавливает ограничение в 100 экземпляров, чтобы не перегружать гипотетическую устаревшую базу данных:

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

Если функция HTTP масштабируется до предела maxInstances , новые запросы помещаются в очередь на 30 секунд, а затем отклоняются с кодом ответа 429 Too Many Requests , если к тому времени ни один экземпляр не будет доступен.

Чтобы узнать больше о рекомендациях по использованию параметров максимального количества экземпляров, ознакомьтесь с этими рекомендациями по использованию maxInstances .

Установите время ожидания и выделение памяти

В некоторых случаях у ваших функций могут быть особые требования к длительному тайм-ауту или большому выделению памяти. Вы можете установить эти значения либо в Google Cloud Console, либо в исходном коде функции (только для Firebase).

Чтобы задать выделение памяти и время ожидания в исходном коде функций, используйте параметр runWith , представленный в Firebase SDK для Cloud Functions 2.0.0. Этот параметр среды выполнения принимает объект JSON, соответствующий интерфейсу RuntimeOptions , который определяет значения для timeoutSeconds и memory . Например, эта функция хранения использует 1 ГБ памяти и время ожидания истекает через 300 секунд:

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

Максимальное значение timeoutSeconds — 540 или 9 минут. Объем памяти, предоставленный функции, соответствует ЦП, выделенному для функции, как указано в этом списке допустимых значений для memory :

  • 128MB — 200 МГц
  • 256MB — 400 МГц
  • 512MB — 800 МГц
  • 1GB — 1,4 ГГц
  • 2GB — 2,4 ГГц
  • 4GB — 4,8 ГГц
  • 8GB — 4,8 ГГц

Чтобы установить выделение памяти и время ожидания в Google Cloud Console:

  1. В консоли Google Google Cloud выберите « Облачные функции» в меню слева.
  2. Выберите функцию, щелкнув ее имя в списке функций.
  3. Щелкните значок « Изменить » в верхнем меню.
  4. Выберите выделение памяти в раскрывающемся меню с надписью Выделенная память .
  5. Нажмите « Дополнительно », чтобы отобразить дополнительные параметры, и введите количество секунд в текстовом поле « Время ожидания ».
  6. Щелкните Сохранить , чтобы обновить функцию.