Манифест расширений — это список экземпляров расширений и их конфигураций. С помощью манифеста вы можете:
- Поделитесь конфигурацией расширений с другими
- Скопируйте конфигурацию расширений между разными проектами (например, из промежуточного проекта в производственный проект).
- Разверните все свои расширения одновременно
- Проверьте, как ваши расширения работают с вашим приложением, используя 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}.appspot.com IMG_SIZES=100x100 DELETE_ORIGINAL_FILE=false
Создайте манифест расширений
Существует три способа создания манифеста расширений:
- Управляйте манифестом расширений с помощью Firebase CLI
- Экспорт конфигурации расширений проекта
- Редактируйте файлы манифеста вручную
Первые два метода описаны ниже.
Управляйте манифестом расширений с помощью Firebase CLI
Вы можете запустить большинство команд ext:
Firebase CLI с опцией --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
Экспорт конфигурации расширений проекта
Чтобы сохранить текущую конфигурацию расширений проекта в манифесте, выполните следующие действия:
- Если вы еще этого не сделали, настройте Firebase CLI.
- В командной строке перейдите в каталог проекта. (Каталог вашего проекта содержит файл
firebase.json
). - Запустите команду
ext:export
:firebase ext:export
Команда ext:export
добавит раздел extensions
в файл firebase.json
. Кроме того, команда ext:export
создает каталог extensions
, содержащий файл .env
для каждого установленного вами экземпляра расширения. Эти файлы содержат параметры конфигурации для каждого экземпляра.
Проверьте конфигурацию расширений с помощью Firebase Local Emulator Suite
Добавив несколько экземпляров расширений в манифест расширений, вы можете протестировать их с помощью Local Emulator Suite .
Запустите Local Emulator Suite :
- Чтобы запустить Emulator Suite в интерактивном режиме, запустите:
firebase emulators:start
- Чтобы запустить набор эмуляторов и выполнить тестовый сценарий, запустите:
firebase emulators:exec my-test.sh
- Чтобы запустить Emulator Suite в интерактивном режиме, запустите:
Теперь, если в вашем манифесте указаны экземпляры расширений, Local Emulator Suite загрузит исходный код этих расширений в ~/.cache/firebase/extensions
. После их загрузки запустится Local Emulator Suite , и вы сможете активировать любые фоновые функции расширений и подключить свое приложение к пакету эмуляторов, чтобы проверить их интеграцию с вашим приложением.
Развертывание конфигурации расширений в проекте
Добавив несколько экземпляров расширения в манифест расширения, вы можете развернуть его в проекте с помощью интерфейса командной строки Firebase. При развертывании с помощью манифеста расширений вы одновременно устанавливаете, обновляете и настраиваете все экземпляры расширений в манифесте в проекте.
Чтобы развернуть манифест расширений:
- В командной строке перейдите в каталог, содержащий сохраненную конфигурацию расширений. (Это каталог, содержащий
firebase.json
. Если вы только что запустилиext:export
, вы уже находитесь в правильном каталоге.) - Запустите команду
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