Skonfiguruj i użyj parametrów w swoim rozszerzeniu

Parametry to mechanizm, za pomocą którego użytkownik dostosowuje każdą zainstalowaną instancję rozszerzenia. Parametry działają jak zmienne środowiskowe rozszerzenia. Wartości parametrów mogą być wypełniane automatycznie (dostarczane przez Firebase po instalacji) lub konfigurowane przez użytkownika (określane przez użytkownika podczas instalacji).

Do tych parametrów można się odwoływać w kodzie źródłowym funkcji rozszerzenia, w plikach extension.yaml i POSTINSTALL.md . Oto składnia odwoływania się do parametru o nazwie PARAMETER_NAME :

• W kodzie źródłowym funkcji użyj modułu params (na przykład params.defineInt(" PARAMETER_NAME ") ) lub process.env. PARAMETER_NAME .

• W extension.yaml i POSTINSTALL.md użyj ${param: PARAMETER_NAME } .

  Po instalacji konsola Firebase wyświetla zawartość pliku POSTINSTALL.md i wypełnia wszelkie odniesienia do parametrów rzeczywistymi wartościami zainstalowanej instancji.

Parametry wypełniane automatycznie

Każda zainstalowana instancja rozszerzenia automatycznie ma dostęp do kilku domyślnych, automatycznie wypełnianych parametrów dostarczonych przez Firebase (patrz tabela poniżej). Te wartości parametrów są albo wartościami domyślnymi dla projektu Firebase (np. domyślny zasobnik pamięci), albo są specyficzne dla rozszerzenia (np. identyfikator instancji rozszerzenia).

Wszystkie automatycznie wypełniane wartości parametrów są niezmienne. Są one ustawiane w momencie tworzenia projektu lub instalacji rozszerzenia.

Mimo że Firebase automatycznie wypełnia te wartości parametrów rozszerzenia, Firebase nie udostępnia użytkownikowi automatycznie powiązanych produktów podczas instalacji . Użytkownik instalujący rozszerzenie musi przed instalacją włączyć w swoim projekcie powiązane i odpowiednie produkty. Na przykład, jeśli Twoje rozszerzenie obejmuje Cloud Firestore, użytkownik musi skonfigurować Cloud Firestore w swoim projekcie. Zalecamy powiadomienie użytkowników o tych wymaganiach w pliku PREINSTALL.md .

Parametry konfigurowane przez użytkownika

Aby umożliwić użytkownikowi dostosowanie każdej zainstalowanej instancji rozszerzenia, możesz poprosić go o określenie wartości parametrów podczas instalacji. Aby zażądać tych wartości, skonfiguruj monity w sekcji params pliku extension.yaml .

Oto przykładowa sekcja params , po której następuje tabela opisująca wszystkie dostępne pola parametrów.

# 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

W sekcji params pliku extension.yaml użyj następujących pól, aby zdefiniować parametr konfigurowany przez użytkownika:

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

Walidacja i przesyłanie komunikatów o błędach dla wartości skonfigurowanych przez użytkownika

Kiedy ustawiasz parametr type string , musisz zdefiniować odpowiednią walidację wyrażenia regularnego za pomocą pola validationRegex parametru.

Ponadto w przypadku wielu rozszerzeń często wymaganą wartością parametru jest ścieżka do bazy danych lub zasobnik Cloud Storage. Należy pamiętać, że podczas instalacji, rekonfiguracji lub aktualizacji usługa rozszerzeń nie sprawdza następujących elementów w momencie wprowadzania wartości parametrów:

• Określa, czy określona baza danych lub zasobnik Cloud Storage jest skonfigurowany w projekcie Firebase użytkownika
• Określa, czy określona ścieżka bazy danych istnieje w bazie danych użytkownika

Jeśli jednak rozszerzenie faktycznie wdraża swoje zasoby, konsola Firebase lub interfejs CLI Firebase wyświetli komunikat o błędzie, jeśli przywoływana baza danych lub zasobnik Cloud Storage nie jest jeszcze skonfigurowany w projekcie.

Zdecydowanie zalecamy powiadomienie użytkowników w pliku PREINSTALL o tych wymaganiach, aby po zainstalowaniu rozszerzenia zostało ono pomyślnie zainstalowane i działało zgodnie z oczekiwaniami.

Parametry systemu

Parametry systemowe kontrolują podstawową konfigurację zasobów rozszerzenia. Ponieważ mają one na celu kontrolowanie konfiguracji zasobów, nie są dostępne jako zmienne środowiskowe z poziomu kodu funkcji.

Zwykle nie musisz deklarować niczego dla tych parametrów w extension.yaml . Są one automatycznie definiowane dla każdej instancji rozszerzenia, a użytkownicy mają możliwość ustawienia niestandardowych wartości podczas instalowania rozszerzenia.

Jeśli jednak Twoje rozszerzenie ma specjalne wymagania dotyczące zasobów, możesz ustawić określone wartości na poziomie poszczególnych zasobów w extension.yaml . Te ustawienia konfiguracji dla poszczególnych zasobów zastąpią ustawienia dotyczące całej instancji rozszerzenia użytkownika. Na przykład:

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

Dostępne parametry systemu to: