Quản lý cấu hình dự án bằng tệp kê khai Tiện ích mở rộng

Tệp kê khai tiện ích mở rộng là danh sách các phiên bản tiện ích mở rộng và cấu hình của chúng. Với tệp kê khai, bạn có thể:

  • Chia sẻ cấu hình tiện ích mở rộng của bạn với những người khác
  • Sao chép cấu hình tiện ích mở rộng của bạn giữa các dự án khác nhau (chẳng hạn như từ dự án giai đoạn sang dự án sản xuất của bạn)
  • Triển khai tất cả các tiện ích mở rộng của bạn cùng một lúc
  • Kiểm tra cách tiện ích mở rộng hoạt động với ứng dụng của bạn bằng Bộ mô phỏng cục bộ Firebase
  • Cam kết cấu hình tiện ích mở rộng của bạn với kiểm soát nguồn
  • Bao gồm các tiện ích mở rộng trong đường dẫn CI / CD của bạn

Tệp kê khai tiện ích mở rộng có hai phần:

  • Phần extensions của firebase.json , là bản đồ của ID phiên bản đến tham chiếu phiên bản tiện ích mở rộng. Ví dụ:

    {
     "extensions": {
       "my-bigquery-extension": "firebase/firestore-bigquery-export@^0.1.18",
       "my-image-resizer": "firebase/storage-resize-images@^0.1.22",
     }
    }
    
  • các tệp .env chứa cấu hình cho từng trường hợp tiện ích mở rộng của bạn, trong các extensions/ thư mục con của thư mục dự án Firebase của bạn. Ví dụ: một phiên bản của storage-resize-images có thể có tệp .env như sau:

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

Tạo tệp kê khai tiện ích mở rộng

Có ba cách để tạo tệp kê khai tiện ích mở rộng:

  • Quản lý tệp kê khai tiện ích của bạn bằng Firebase CLI
  • Xuất cấu hình tiện ích mở rộng của dự án
  • Chỉnh sửa tệp kê khai theo cách thủ công

Hai phương pháp đầu tiên được giải thích dưới đây.

Quản lý tệp kê khai tiện ích của bạn bằng Firebase CLI

Bạn có thể chạy hầu hết các lệnh ext: của Firebase CLI với tùy chọn --local để cập nhật tệp kê khai tiện ích mở rộng mà không thực sự thay đổi cấu hình hiện tại của dự án.

Ví dụ:

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

Chạy lệnh trên sẽ nhắc bạn định cấu hình phiên bản mới nhất của tiện ích mở rộng firebase/firestore-bigquery-export và lưu cấu hình vào tệp kê khai, nhưng nó sẽ không triển khai cấu hình cho dự án của bạn.

Dưới đây là một số ví dụ khác về các lệnh sửa đổi tệp kê khai tiện ích mở rộng:

# 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

Xuất cấu hình tiện ích mở rộng của dự án

Để lưu cấu hình tiện ích mở rộng hiện tại của dự án vào tệp kê khai, hãy làm như sau:

  1. Nếu bạn chưa làm như vậy, hãy thiết lập Firebase CLI
  2. Từ một lời nhắc trình bao, hãy thay đổi sang thư mục dự án. (Thư mục dự án của bạn chứa tệp firebase.json ).
  3. Chạy lệnh ext:export :
    firebase ext:export

Lệnh ext:export sẽ thêm một extensions vào tệp firebase.json . Ngoài ra, lệnh ext:export tạo một thư mục extensions có chứa tệp .env cho mỗi phiên bản tiện ích mở rộng mà bạn đã cài đặt. Các tệp này chứa các tham số cấu hình cho mỗi phiên bản.

Kiểm tra cấu hình tiện ích mở rộng với Bộ trình mô phỏng cục bộ Firebase

Khi bạn đã thêm một số phiên bản tiện ích mở rộng vào tệp kê khai tiện ích mở rộng của mình, bạn có thể kiểm tra chúng bằng cách sử dụng Local Emulator Suite.

  1. Cài đặt và cấu hình Local Emulator Suite .

  2. Khởi động Bộ mô phỏng cục bộ :

    • Để chạy Bộ phần mềm giả lập một cách tương tác, hãy chạy: firebase emulators:start
    • Để chạy Bộ phần mềm giả lập và thực thi một tập lệnh thử nghiệm, hãy chạy: firebase emulators:exec my-test.sh

Bây giờ, nếu bạn có các phiên bản tiện ích mở rộng được liệt kê trong tệp kê khai của mình, Local Emulator Suite sẽ tải mã nguồn của các tiện ích mở rộng đó xuống ~/.cache/firebase/extensions . Khi chúng đã được tải xuống, Local Emulator Suite sẽ bắt đầu và bạn sẽ có thể kích hoạt bất kỳ chức năng nào được kích hoạt trong nền của tiện ích mở rộng và kết nối ứng dụng của bạn với bộ Trình mô phỏng để kiểm tra khả năng tích hợp của chúng với ứng dụng của bạn.

Triển khai cấu hình tiện ích mở rộng cho một dự án

Khi bạn đã thêm một số phiên bản tiện ích vào tệp kê khai tiện ích của mình, bạn có thể triển khai nó cho một dự án bằng cách sử dụng Firebase CLI. Khi bạn triển khai với tệp kê khai tiện ích mở rộng, bạn cài đặt, cập nhật và định cấu hình tất cả các phiên bản tiện ích mở rộng trong tệp kê khai thành một dự án cùng một lúc.

Để triển khai tệp kê khai tiện ích mở rộng:

  1. Từ lời nhắc trình bao, hãy chuyển sang thư mục chứa cấu hình tiện ích mở rộng đã lưu. (Đây là thư mục chứa firebase.json . Nếu bạn vừa chạy ext:export , bạn đã ở đúng thư mục.)
  2. Chạy lệnh deploy . Nếu bạn muốn triển khai các tiện ích mở rộng cho một dự án khác với dự án hiện tại, hãy chỉ định --project= :
    firebase deploy --only extensions –-project=YOUR_PROJECT_ID

Lệnh deploy sẽ xác thực từng cấu hình phiên bản, hỏi xem bạn có muốn xóa bất kỳ phiên bản tiện ích mở rộng nào khỏi dự án đích không được liệt kê trong firebase.json hay không, rồi triển khai tất cả các phiên bản tiện ích mở rộng của bạn.

Cấu hình phần mở rộng dành riêng cho dự án

Các cấu hình phần mở rộng đã lưu có thể được sử dụng để triển khai cho nhiều dự án khác nhau: ví dụ: một dự án dàn dựng và một dự án sản xuất. Khi thực hiện việc này, một số giá trị tham số có thể cần khác nhau đối với từng dự án. .env dành riêng cho dự án làm cho điều này trở nên khả thi:

  • Đặt các giá trị tham số khác nhau giữa các dự án trong extensions/ EXTENSION_INSTANCE_ID .env. YOUR_PROJECT_ID
  • Đặt các giá trị thông số được chia sẻ trong extensions/ EXTENSION_INSTANCE_ID .env .

Đôi khi, bạn có thể muốn sử dụng một giá trị thông số khác khi mô phỏng tiện ích mở rộng của mình: ví dụ: bạn có thể muốn cung cấp khóa API thử nghiệm thay vì khóa sản xuất. Đặt các tham số này vào tệp .local :

  • Đặt các thông số không bí mật mà bạn muốn sử dụng trong quá trình mô phỏng trong extensions/ EXTENSION_INSTANCE_ID .env.local
  • Đặt các giá trị thông số bí mật trong các extensions/ EXTENSION_INSTANCE_ID .secret.local