Управляйте конфигурациями проекта с помощью манифеста расширений.

Манифест расширений — это список экземпляров расширений и их конфигураций. С помощью манифеста вы можете:

  • Поделитесь конфигурацией своих расширений с другими
  • Копируйте конфигурацию расширений между различными проектами (например, из промежуточного проекта в производственный проект)
  • Разверните все ваши расширения одновременно
  • Проверьте, как ваши расширения работают с вашим приложением, используя Firebase Local Emulator Suite
  • Зафиксируйте конфигурацию расширений в системе управления исходным кодом
  • Включите расширения в свой конвейер CI/CD

Манифест расширений состоит из двух частей:

  • Раздел extensions файла firebase.json , представляющий собой сопоставление идентификатора экземпляра с версией расширения. Например:

    {
 "extensions": {
   "my-bigquery-extension": "firebase/firestore-bigquery-export@^0.1.18",
   "my-image-resizer": "firebase/storage-resize-images@^0.1.22",
 }
}

  • Файлы .env , содержащие конфигурацию для каждого экземпляра расширения, находятся в подкаталоге extensions/ каталога проекта Firebase. Например, экземпляр storage-resize-images может иметь файл .env следующего вида:

    IMAGE_TYPE=jpeg
LOCATION=us-central1
IMG_BUCKET=${param:PROJECT_ID}.firebasestorage.app
IMG_SIZES=100x100
DELETE_ORIGINAL_FILE=false

Создать манифест расширений

Существует три способа создания манифеста расширений:

  • Управляйте манифестом расширений с помощью Firebase CLI
  • Экспорт конфигурации расширений проекта
  • Редактируйте файлы манифеста вручную

Первые два метода описаны ниже.

Управляйте манифестом расширений с помощью Firebase CLI

Вы можете запустить большинство команд Firebase CLI ext: с опцией --local для обновления манифеста расширений без фактического изменения текущей конфигурации проекта.

Например:

firebase ext:install --local firebase/firestore-bigquery-export

Выполнение указанной выше команды предложит вам настроить последнюю версию расширения firebase/firestore-bigquery-export и сохранить конфигурацию в манифесте, но она не будет развернута в вашем проекте.

Вот еще несколько примеров команд, изменяющих манифест расширений:

# ext:configure changes the params for an extension instance in your extensions manifest
$ firebase ext:configure my-bigquery-extension --local

# ext:update --local updates an instance in your extensions manifest
# to the latest version of that extension
$ firebase ext:update my-bigquery-extension --local

# You can also specify a version if you don't want to update to the latest version
$ firebase ext:update my-bigquery-extension firebase/firestore-bigquery-export@0.1.10 --local 

# ext:uninstall --local removes an instance from your extensions manifest
$ firebase ext:uninstall my-bigquery-extension --local

Экспорт конфигурации расширений проекта

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

  1. Если вы еще этого не сделали, настройте Firebase CLI.
  2. В командной строке оболочки перейдите в каталог проекта. (Каталог вашего проекта содержит файл firebase.json ).
  3. Выполните команду ext:export : 
    firebase ext:export

Команда ext:export добавит раздел extensions в файл firebase.json . Кроме того, команда ext:export создаёт каталог extensions , содержащий файл .env для каждого установленного экземпляра расширения. Эти файлы содержат параметры конфигурации для каждого экземпляра.

Протестируйте конфигурацию расширений с помощью Firebase Local Emulator Suite

После добавления нескольких экземпляров расширений в манифест расширений вы можете протестировать их с помощью Local Emulator Suite .

  1. Установите и настройте Local Emulator Suite .

  2. Запустите Local Emulator Suite :

    • Чтобы запустить Emulator Suite в интерактивном режиме, выполните: firebase emulators:start
    • Чтобы запустить Emulator Suite и выполнить тестовый скрипт, выполните: firebase emulators:exec my-test.sh

Теперь, если в манифесте указаны экземпляры расширений, Local Emulator Suite загрузит исходный код этих расширений в ~/.cache/firebase/extensions . После загрузки Local Emulator Suite запустится, и вы сможете запустить любые фоновые функции расширений и подключить своё приложение к Emulator Suite для проверки их интеграции с вашим приложением.

Развертывание конфигурации расширений в проекте

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

Чтобы развернуть манифест расширений:

  1. В командной строке оболочки перейдите в каталог, содержащий сохранённую конфигурацию расширений. (Это каталог, содержащий firebase.json . Если вы только что выполнили ext:export , вы уже находитесь в нужном каталоге.)
  2. Выполните команду deploy . Если вы хотите развернуть расширения в проекте, отличном от текущего, укажите также --project= : 
    firebase deploy --only extensions –-project=YOUR_PROJECT_ID

Команда deploy проверит конфигурацию каждого экземпляра, спросит, хотите ли вы удалить какие-либо экземпляры расширения из вашего целевого проекта, которые не перечислены в firebase.json , а затем развернет все ваши экземпляры расширения.

Конфигурации расширения для конкретного проекта

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

  • Поместите значения параметров, которые различаются между проектами, в extensions/ EXTENSION_INSTANCE_ID .env. YOUR_PROJECT_ID
  • Поместите значения общих параметров в extensions/ EXTENSION_INSTANCE_ID .env .

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

  • Поместите несекретные параметры, которые вы хотите использовать во время эмуляции, в extensions/ EXTENSION_INSTANCE_ID .env.local
  • Поместите значения секретных параметров в extensions/ EXTENSION_INSTANCE_ID .secret.local