הגדר והשתמש בפרמטרים בתוסף שלך

פרמטרים הם המנגנון שדרכו משתמש מתאים אישית כל מופע מותקן של הרחבה. פרמטרים הם כמו משתני הסביבה עבור הרחבה. הערכים של פרמטרים יכולים להיות מאוכלסים אוטומטית (מסופק על ידי Firebase לאחר ההתקנה) או מוגדרים על ידי המשתמש (הצוין על ידי המשתמש במהלך ההתקנה).

פרמטרים אלו זמינים עבורך להתייחסות בקוד המקור של הפונקציות של התוסף שלך, בקובץ extension.yaml ובקובץ POSTINSTALL.md שלך. להלן התחביר כיצד להתייחס לפרמטר בשם PARAMETER_NAME :

• בתוך קוד המקור של הפונקציות שלך, השתמש במודול params (לדוגמה, params.defineInt(" PARAMETER_NAME ") ) או process.env. PARAMETER_NAME .

• בתוך extension.yaml ו- POSTINSTALL.md , השתמש ב ${param: PARAMETER_NAME } .

  לאחר ההתקנה, מסוף Firebase מציג את התוכן של הקובץ POSTINSTALL.md וממלא את כל הפניות לפרמטרים עם הערכים בפועל עבור המופע המותקן.

פרמטרים מאוכלסים אוטומטית

לכל מופע מותקן של תוסף יש גישה אוטומטית למספר פרמטרים המאוכלסים אוטומטית המוגדרים כברירת מחדל שסופקו על ידי Firebase (עיין בטבלה למטה). ערכי הפרמטרים האלה הם ערכי ברירת המחדל של פרויקט Firebase (כמו דלי האחסון המוגדר כברירת מחדל) או שהם ספציפיים לתוסף (כמו מזהה המופע של התוסף).

כל ערכי הפרמטרים המאוכלסים אוטומטית אינם ניתנים לשינוי. הם נקבעים בזמן יצירת הפרויקט או התקנת ההרחבה.

למרות ש-Firebase מאכלסת אוטומטית את ערכי הפרמטרים האלה עבור התוסף, Firebase לא מספקת אוטומטית את המוצרים המשויכים למשתמש במהלך ההתקנה . המשתמש שמתקין את התוסף חייב להפעיל את המוצר/ים המשויכים והישימים בפרויקט שלו לפני ההתקנה. לדוגמה, אם התוסף שלך כולל את Cloud Firestore, המשתמש חייב להגדיר את Cloud Firestore בפרויקט שלו. אנו ממליצים ליידע את המשתמשים שלך על דרישות אלה בקובץ PREINSTALL.md .

פרמטרים בהגדרת משתמש

כדי לאפשר למשתמש להתאים אישית כל מופע מותקן של הרחבה, אתה יכול לבקש מהמשתמש לציין ערכי פרמטרים במהלך ההתקנה. כדי לבקש ערכים אלה, אתה מגדיר את ההנחיות בקטע params של קובץ extension.yaml שלך.

להלן סעיף params לדוגמה, ואחריו טבלה המתארת ​​את כל שדות הפרמטרים הזמינים.

# 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

במקטע params של קובץ extension.yaml שלך, השתמש בשדות הבאים כדי להגדיר פרמטר מוגדר על ידי משתמש:

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

אימות והודעות שגיאה עבור ערכים המוגדרים על ידי משתמש

כאשר אתה מגדיר פרמטר עם type string , עליך להגדיר אימות רגולרי מתאים באמצעות שדה validationRegex של הפרמטר.

כמו כן, עבור הרחבות רבות, ערך פרמטר מבוקש נפוץ הוא נתיב מסד נתונים או דלי של Cloud Storage. שים לב שבמהלך התקנה, הגדרה מחדש או עדכון, שירות ההרחבות אינו מאמת את הדברים הבאים בזמן הזנת ערך הפרמטר:

• האם מסד הנתונים או Cloud Storage שצוין מוגדרים בתוך פרויקט Firebase של המשתמש
• האם נתיב מסד הנתונים שצוין קיים במסד הנתונים של המשתמש

עם זאת, כאשר התוסף למעשה פורס את המשאבים שלו, קונסולת Firebase או Firebase CLI יציגו הודעת שגיאה אם ​​מסד הנתונים או דלי ה-Cloud Storage לא הוגדר עדיין בפרויקט.

אנו ממליצים בחום להודיע ​​למשתמשים בקובץ ה- PREINSTALL על הדרישות הללו, כך שכאשר הם מתקינים את התוסף שלך, הוא יותקן בהצלחה ויעבוד כצפוי.

פרמטרי מערכת

פרמטרי מערכת שולטים בתצורה הבסיסית של משאבי הרחבה. מכיוון שהם נועדו לשלוט על תצורת המשאבים, הם אינם נגישים כמשתני סביבה מתוך קוד הפונקציה שלך.

בדרך כלל אינך צריך להצהיר שום דבר עבור הפרמטרים הללו ב- extension.yaml . הם מוגדרים אוטומטית עבור כל מופע של תוסף, ולמשתמשים יש הזדמנות להגדיר ערכים מותאמים אישית כשהם מתקינים את התוסף שלך.

עם זאת, אם לתוסף שלך יש דרישות משאבים מיוחדות, תוכל להגדיר ערכים ספציפיים ברמת משאב ב- extension.yaml . הגדרות תצורה אלה לכל משאב יעקפו את הגדרות המופע של הרחבה של המשתמש. לדוגמה:

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

פרמטרי המערכת הזמינים הם: