Menyiapkan dan menggunakan parameter di ekstensi Anda

Parameter adalah mekanisme yang digunakan pengguna untuk menyesuaikan setiap instance ekstensi yang diinstal. Parameter mirip seperti variabel lingkungan untuk ekstensi. Nilai untuk parameter dapat terisi otomatis (disediakan oleh Firebase setelah penginstalan) atau dikonfigurasi pengguna (ditentukan oleh pengguna selama penginstalan).

Parameter ini tersedia untuk Anda referensikan dalam kode sumber fungsi ekstensi, file extension.yaml, dan file POSTINSTALL.md Anda. Berikut adalah sintaksis cara mereferensikan parameter bernama PARAMETER_NAME:

• Dalam kode sumber fungsi Anda, gunakan modul params (misalnya, params.defineInt("PARAMETER_NAME")) atau process.env.PARAMETER_NAME.

• Dalam extension.yaml dan POSTINSTALL.md, gunakan ${param:PARAMETER_NAME}.

  Setelah penginstalan, Firebase console akan menampilkan isi file POSTINSTALL.md dan mengisi referensi parameter dengan nilai sebenarnya untuk instance yang diinstal.

Parameter yang terisi otomatis

Setiap instance ekstensi yang diinstal akan otomatis memiliki akses ke sejumlah parameter default dan terisi otomatis yang disediakan oleh Firebase (lihat tabel di bawah). Parameter value ini dapat berupa nilai default untuk project Firebase (seperti bucket Storage default) atau parameter value khusus ekstensi (seperti ID instance ekstensi).

Semua parameter value yang terisi otomatis tidak dapat diubah. Parameter tersebut ditetapkan selama pembuatan project atau penginstalan ekstensi.

Meskipun otomatis mengisi parameter value ini untuk ekstensi, Firebase tidak otomatis menyediakan produk terkait untuk pengguna selama penginstalan. Pengguna yang menginstal ekstensi harus mengaktifkan produk yang terkait dan berlaku dalam project-nya sebelum penginstalan. Misalnya, jika ekstensi Anda menggunakan Cloud Firestore, pengguna harus menyiapkan Cloud Firestore dalam project-nya. Sebaiknya beri tahukan persyaratan ini kepada pengguna dalam file PREINSTALL.md.

Parameter yang dikonfigurasi oleh pengguna

Agar pengguna dapat menyesuaikan setiap instance ekstensi yang diinstal, Anda dapat meminta mereka menentukan parameter value selama penginstalan. Untuk meminta nilai ini, siapkan perintah di bagian params file extension.yaml.

Berikut adalah contoh bagian params, diikuti dengan tabel yang mendeskripsikan semua kolom parameter yang tersedia.

# 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

Di bagian params file extension.yaml, gunakan kolom berikut untuk menentukan parameter yang dikonfigurasi pengguna:

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

Validasi dan pesan error untuk nilai yang dikonfigurasi pengguna

Saat menyiapkan parameter dengan type dari string, Anda harus menentukan validasi ekspresi reguler yang sesuai melalui kolom validationRegex parameter.

Selain itu, bagi banyak ekstensi, parameter value yang biasanya diminta adalah jalur database atau bucket Cloud Storage. Perlu diketahui bahwa selama penginstalan, pengonfigurasian ulang, atau update, layanan Extensions tidak memvalidasi hal berikut pada saat entri parameter value:

• Apakah database atau bucket Cloud Storage yang ditentukan disiapkan dalam project Firebase pengguna
• Apakah jalur database yang ditentukan ada dalam database pengguna

Namun, jika ekstensi benar-benar men-deploy resource-nya, Firebase console atau Firebase CLI akan menampilkan pesan error jika database atau bucket Cloud Storage yang direferensikan belum disiapkan dalam project tersebut.

Sebaiknya beri tahukan persyaratan ini kepada pengguna melalui file PREINSTALL, agar saat mereka menginstal ekstensi Anda, ekstensi tersebut berhasil diinstal dan berfungsi seperti yang diharapkan.

Parameter sistem

Parameter sistem mengontrol konfigurasi dasar dari suatu resource ekstensi. Karena ditujukan untuk mengontrol konfigurasi resource, parameter sistem tidak dapat diakses sebagai variabel lingkungan dari dalam kode fungsi Anda.

Biasanya, Anda tidak perlu mendeklarasikan apa pun untuk parameter ini di extension.yaml. Parameter sistem secara otomatis ditentukan untuk setiap instance ekstensi, dan pengguna dapat menetapkan nilai kustom saat menginstal ekstensi Anda.

Namun, jika ekstensi memiliki persyaratan resource khusus, Anda dapat menetapkan nilai tertentu pada tingkat per-resource di extension.yaml. Setelan konfigurasi per-resource ini akan menggantikan setelan seluruh instance ekstensi pengguna. Contoh:

resources:
- name: high_memory_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function needs at least 1GB of memory!
  properties:
    httpsTrigger: {}
    runtime: nodejs18
    memory: 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

Parameter sistem yang tersedia adalah: