Thiết lập và sử dụng các tham số trong tiện ích mở rộng của bạn

Tham số là cơ chế mà qua đó người dùng tùy chỉnh từng phiên bản được cài đặt của tiện ích mở rộng. Các tham số giống như các biến môi trường cho một tiện ích mở rộng. Các giá trị cho tham số có thể được tự động điền (do Firebase cung cấp sau khi cài đặt) hoặc do người dùng định cấu hình (do người dùng chỉ định trong khi cài đặt).

Các tham số này có sẵn để bạn tham khảo trong mã nguồn chức năng của tiện ích mở rộng, tệp tiện ích extension.yaml và tệp POSTINSTALL.md của bạn. Đây là cú pháp về cách tham chiếu một tham số có tên PARAMETER_NAME :

• Trong mã nguồn hàm của bạn, hãy sử dụng mô-đun params (ví dụ: params.defineInt(" PARAMETER_NAME ") ) hoặc process.env. PARAMETER_NAME .

• Trong extension.yaml và POSTINSTALL.md , hãy sử dụng ${param: PARAMETER_NAME } .

  Sau khi cài đặt, bảng điều khiển Firebase hiển thị nội dung của tệp POSTINSTALL.md và điền bất kỳ tham chiếu tham số nào có giá trị thực cho phiên bản đã cài đặt.

Thông số tự động điền

Mỗi phiên bản tiện ích mở rộng đã cài đặt sẽ tự động có quyền truy cập vào một số thông số được điền tự động mặc định do Firebase cung cấp (tham khảo bảng bên dưới). Các giá trị tham số này là giá trị mặc định cho dự án Firebase (như nhóm Bộ nhớ mặc định ) hoặc chúng dành riêng cho tiện ích mở rộng (như ID phiên bản của tiện ích mở rộng).

Tất cả các giá trị tham số được điền tự động đều không thể thay đổi. Chúng được đặt tại thời điểm tạo dự án hoặc cài đặt tiện ích mở rộng.

Mặc dù Firebase tự động điền các giá trị thông số này cho tiện ích mở rộng nhưng Firebase không tự động cung cấp các sản phẩm được liên kết cho người dùng trong quá trình cài đặt . Người dùng cài đặt tiện ích mở rộng phải kích hoạt (các) sản phẩm được liên kết và áp dụng trong dự án của họ trước khi cài đặt. Ví dụ: nếu tiện ích mở rộng của bạn liên quan đến Cloud Firestore, người dùng phải thiết lập Cloud Firestore trong dự án của họ. Chúng tôi khuyên bạn nên thông báo cho người dùng của mình về những yêu cầu này trong tệp PREINSTALL.md .

Thông số do người dùng định cấu hình

Để cho phép người dùng tùy chỉnh từng phiên bản đã cài đặt của tiện ích mở rộng, bạn có thể yêu cầu người dùng chỉ định các giá trị tham số trong khi cài đặt. Để yêu cầu những giá trị này, bạn thiết lập lời nhắc trong phần params của tệp extension.yaml .

Sau đây là phần params ví dụ, theo sau là bảng mô tả tất cả các trường thông số có sẵn.

# extension.yaml
...

# Parameters (environment variables) for which the user specifies values during installation
params:
  - param: DB_PATH
    label: Realtime Database path
    description: >-
      What is the Realtime Database path where you will write new text
      for sentiment analysis?
    type: string
    validationRegex: ^\S+$
    validationErrorMessage: Realtime Database path cannot contain spaces.
    example: path/to/posts
    required: true

  - param: TEXT_KEY
    label: Key for text
    description: What is the name of the key that will contain text to be analyzed?
    type: string
    default: textToAnalyze
    required: true

Trong phần params của tệp extension.yaml , hãy sử dụng các trường sau để xác định tham số do người dùng định cấu hình:

options:
  - label:
    value:
  - label:
    value:
  - label:
    value:

Xác thực và thông báo lỗi cho các giá trị do người dùng định cấu hình

Khi thiết lập một tham số có type string , bạn cần xác định xác thực biểu thức chính quy phù hợp thông qua trường validationRegex của tham số.

Ngoài ra, đối với nhiều tiện ích mở rộng, giá trị tham số thường được yêu cầu là đường dẫn cơ sở dữ liệu hoặc nhóm Cloud Storage. Xin lưu ý rằng trong quá trình cài đặt, định cấu hình lại hoặc cập nhật, dịch vụ Tiện ích mở rộng không xác thực các thông tin sau tại thời điểm nhập giá trị tham số :

• Liệu cơ sở dữ liệu đã chỉ định hoặc nhóm Cloud Storage có được thiết lập trong dự án Firebase của người dùng hay không
• Liệu đường dẫn cơ sở dữ liệu đã chỉ định có tồn tại trong cơ sở dữ liệu của người dùng hay không

Tuy nhiên, khi tiện ích mở rộng thực sự triển khai tài nguyên của nó, bảng điều khiển Firebase hoặc Firebase CLI sẽ hiển thị thông báo lỗi nếu cơ sở dữ liệu được tham chiếu hoặc nhóm Cloud Storage chưa được thiết lập trong dự án.

Chúng tôi thực sự khuyên bạn nên thông báo cho người dùng trong tệp PREINSTALL về các yêu cầu này để khi họ cài đặt tiện ích mở rộng của bạn, tiện ích sẽ cài đặt thành công và hoạt động như mong đợi.

Hệ thống tham số toán học

Các tham số hệ thống kiểm soát cấu hình cơ bản của tài nguyên tiện ích mở rộng. Vì chúng nhằm mục đích kiểm soát cấu hình tài nguyên nên chúng không thể truy cập được dưới dạng biến môi trường từ bên trong mã hàm của bạn.

Thông thường, bạn không cần khai báo bất kỳ điều gì cho các tham số này trong extension.yaml . Chúng được xác định tự động cho mọi phiên bản tiện ích mở rộng và người dùng có cơ hội đặt giá trị tùy chỉnh khi họ cài đặt tiện ích mở rộng của bạn.

Tuy nhiên, nếu tiện ích mở rộng của bạn có yêu cầu tài nguyên đặc biệt, bạn có thể đặt các giá trị cụ thể ở cấp độ mỗi tài nguyên trong extension.yaml . Các cài đặt cấu hình cho mỗi tài nguyên này sẽ ghi đè cài đặt trên toàn phiên bản tiện ích mở rộng của người dùng. Ví dụ:

resources:
- name: high_memory_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function needs at least 1GB of memory!
  properties:
    httpsTrigger: {}
    runtime: nodejs18
    availableMemoryMb: 1024
- name: normal_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function has no special memory requirements. It will use the
    default value, or the value of `firebaseextension.v1beta.function/memory`
  properties:
    httpsTrigger: {}
    runtime: nodejs18

Các thông số hệ thống có sẵn là: