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


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

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

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

firebase deploy --only functions

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

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

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

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

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

Очистка артефактов развертывания

В рамках развертывания функций образы контейнеров генерируются и сохраняются в Artifact Registry . Эти образы не требуются для запуска развернутых функций; Cloud Functions извлекает и сохраняет копию образа при первоначальном развертывании, но сохранённые артефакты не требуются для работы функции во время выполнения.

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

Для управления расходами на хранение Firebase CLI 14.0.0 и выше позволяет настраивать политику очистки Artifact Registry для репозиториев, в которых хранятся артефакты развертывания после каждого развертывания функции.

Вы можете вручную настроить или отредактировать политику очистки с помощью functions:artifacts:setpolicy :

firebase functions:artifacts:setpolicy

По умолчанию эта команда настраивает Artifact Registry на автоматическое удаление образов контейнеров старше 1 дня. Это обеспечивает разумный баланс между минимизацией затрат на хранение и возможностью проверки последних сборок.

Вы можете настроить период хранения с помощью параметра --days :

firebase functions:artifacts:setpolicy --days 7  # Delete images older than 7 days

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

$ firebase functions:artifacts:setpolicy --location europe-west1

Отказаться от очистки артефактов

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

$ firebase functions:artifacts:setpolicy --none

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

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

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

  • явно в Firebase CLI с помощью functions:delete
  • явно в консоли Google Cloud .
  • неявно, путем удаления функции из источника перед развертыванием.

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

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

# 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 deploy анализирует ваш исходный код и удаляет из производства все функции, которые были удалены из файла.

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

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

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

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

// 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");
});

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

# 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/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");
    });

Затем выполните развертывание, выполнив: 

firebase deploy --only functions:webhookAsia

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

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

firebase functions:delete webhook

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

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

По мере развития развертывания Cloud Functions for Firebase вам может потребоваться изменить тип триггера функции по разным причинам. Например, вам может потребоваться перейти с одного типа событий Firebase Realtime Database или Cloud Firestore на другой.

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

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

Например, если у вас есть функция Node.js с именем objectChanged , имеющая устаревший тип события onChange , и вы хотите изменить ее на onFinalize , сначала переименуйте функцию и отредактируйте ее так, чтобы она имела тип события 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);
});

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

# 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

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

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

Рекомендуется задавать эти параметры (за исключением версии Node.js) в объекте конфигурации внутри кода функции. Этот объект RuntimeOptions является источником истинных параметров выполнения вашей функции и переопределяет параметры, заданные любым другим способом (например, через консоль Google Cloud или интерфейс командной строки gcloud).

Если ваш рабочий процесс разработки предполагает ручную настройку параметров среды выполнения через консоль Google Cloud или интерфейс командной строки gcloud, и вы не хотите, чтобы эти значения переопределялись при каждом развертывании, установите для параметра preserveExternalChanges значение true . Если этот параметр установлен в true , Firebase объединяет параметры среды выполнения, заданные в вашем коде, с настройками текущей развернутой версии вашей функции со следующим приоритетом:

  1. В коде функций установлена опция: переопределить внешние изменения.
  2. В коде функций параметру присвоено значение RESET_VALUE : переопределять внешние изменения значением по умолчанию.
  3. Параметр не задан в коде функции, но задан в текущей развернутой функции: используйте параметр, указанный в развернутой функции.

Использование параметра preserveExternalChanges: true не рекомендуется в большинстве случаев, поскольку ваш код больше не будет единственным источником информации о параметрах времени выполнения ваших функций. Если вы всё же используете его, проверьте консоль Google Cloud или используйте интерфейс командной строки gcloud для просмотра полной конфигурации функции.

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

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

  • Node.js 20
  • Node.js 18 (устарело)

Ознакомьтесь с графиком поддержки для получения важной информации о дальнейшей поддержке этих версий Node.js.

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

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

  "engines": {"node": "20"}

Если вы используете менеджер пакетов Yarn или у вас есть другие особые требования к области engines , вы можете вместо этого установить среду выполнения для Firebase SDK для Cloud Functions в firebase.json : 

  {
    "functions": {
      "runtime": "nodejs20"
    }
  }

CLI использует значение, заданное в firebase.json , в качестве приоритета перед любым значением или диапазоном, заданным отдельно в package.json .

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

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

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

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

По умолчанию Cloud Functions for 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 :

  • Если Cloud Functions for 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 :

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