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

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

  • Поделитесь конфигурацией своих расширений с другими
  • Копируйте конфигурацию расширений между разными проектами (например, из промежуточного проекта в производственный проект)
  • Разверните все ваши расширения одновременно
  • Проверьте, как ваши расширения работают с вашим приложением, используя 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