דף זה תורגם על ידי Cloud Translation API.

הגדרת הסביבה

לעיתים קרובות יהיה צורך בהגדרות נוספות עבור הפונקציות, כמו למפתחות API של צד שלישי או להגדרות שניתנות לכוונון. ‏SDK של Firebase ל-Cloud Functions כולל הגדרת סביבה מובנית, שמאפשרת לאחסן ולשלוף בקלות את סוג הנתונים הזה בפרויקט.

אפשר לבחור מבין האפשרויות הבאות:

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

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

הגדרות אישיות

Cloud Functions for Firebase מספק ממשק להגדרת תצורה פרמטרים הצהרתיים בתוך ה-codebase שלכם. הערך של הפרמטרים האלה זמינות גם במהלך פריסת הפונקציה, בזמן הגדרת הפריסה וזמן הריצה ובמהלך הביצוע. כלומר, ה-CLI ייחסום את הפריסה אלא אם לכל הפרמטרים יהיה ערך תקין.

Node.js

const { onRequest } = require('firebase-functions/v2/https');
const { defineInt, defineString } = require('firebase-functions/params');

// Define some parameters
const minInstancesConfig = defineInt('HELLO_WORLD_MININSTANCES');
const welcomeMessage = defineString('WELCOME_MESSAGE');

// To use configured parameters inside the config for a function, provide them
// directly. To use them at runtime, call .value() on them.
export const helloWorld = onRequest(
  { minInstances: minInstancesConfig },
(req, res) => {
    res.send(`${welcomeMessage.value()}! I am a function.`);
  }
);

Python

from firebase_functions import https_fn
from firebase_functions.params import IntParam, StringParam

MIN_INSTANCES = IntParam("HELLO_WORLD_MIN_INSTANCES")
WELCOME_MESSAGE = StringParam("WELCOME_MESSAGE")

# To use configured parameters inside the config for a function, provide them
# directly. To use them at runtime, call .value() on them.
@https_fn.on_request(min_instances=MIN_INSTANCES)
def hello_world(req):
    return https_fn.Response(f'{WELCOME_MESSAGE.value()}! I am a function!')

כשפורסים פונקציה עם משתני תצורה עם פרמטרים, בשלב הראשון ב-CLI של Firebase המערכת מנסה לטעון את הערכים מקובצי .env מקומיים. אם הם לא נמצאים בקובצים האלה ולא מוגדר default, ה-CLI יציג בקשה להזנת הערכים במהלך הפריסה, ולאחר מכן ישמור את הערכים באופן אוטומטי בקובץ .env בשם .env.<project_ID> בתיקייה functions/:

$ firebase deploy
i  functions: preparing codebase default for deployment
? Enter a string value for ENVIRONMENT: prod
i  functions: Writing new parameter values to disk: .env.projectId
…
$ firebase deploy
i  functions: Loaded environment variables from .env.projectId

בהתאם לתהליך העבודה שלכם בפיתוח, יכול להיות שיהיה כדאי להוסיף את קובץ ה-.env.<project_ID> שנוצר למערכת בקרת הגרסאות.

שימוש בפרמטרים ברמת ה-global

במהלך הפריסה, קוד הפונקציות נטען ונבדק לפני שהפרמטרים מקבלים ערכים בפועל. כלומר, אחזור של ערכי פרמטרים ברמת ההיקף הגלובלי גורם לכישלון הפריסה. במקרים שבהם רוצים להשתמש בפרמטר כדי לאתחל ערך גלובלי, משתמשים ב-callback לאתחול onInit(). הקריאה החוזרת הזו פועלת לפני שהפונקציות פועלות בסביבת הייצור, אבל היא לא נקראת במהלך הפריסה, כך שזו נקודה בטוחה לגשת לערכים של פרמטרים.

Node.js

const { GoogleGenerativeAI } = require('@google/generative-ai');
const { defineSecret } = require('firebase-functions/params');
const { onInit } = require('firebase-functions/v2/core');

const apiKey = defineSecret('GOOGLE_API_KEY');

let genAI;
onInit(() => {
  genAI = new GoogleGenerativeAI(apiKey.value());
})

Python

from firebase_functions.core import init
from firebase_functions.params import StringParam, PROJECT_ID
import firebase_admin
import vertexai

location = StringParam("LOCATION")

x = "hello"

@init
def initialize():
  # Note: to write back to a global, you'll need to use the "global" keyword
  # to avoid creating a new local with the same name.
  global x
  x = "world"
  firebase_admin.initialize_app()
  vertexai.init(PROJECT_ID.value, location.value)

אם משתמשים בפרמטרים מהסוג Secret, חשוב לזכור שהם זמינים רק בתהליך של הפונקציות שקישרו את הסוד. אם נוצר קשר סוד רק בפונקציות מסוימות, צריך לבדוק אם secret.value() שגוי לפני שמשתמשים בו.

הגדרת ההתנהגות של ה-CLI

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

Node.js

const { defineString } = require('firebase-functions/params');

const welcomeMessage = defineString('WELCOME_MESSAGE', {default: 'Hello World',
description: 'The greeting that is returned to the caller of this function'});

const onlyPhoneNumbers = defineString('PHONE_NUMBER', {
  input: {
    text: {
      validationRegex: /\d{3}-\d{3}-\d{4}/,
      validationErrorMessage: "Please enter
a phone number in the format XXX-YYY-ZZZZ"
    },
  },
});

const selectedOption = defineString('PARITY', {input: params.select(["odd", "even"])});

const memory = defineInt("MEMORY", {
  description: "How much memory do you need?",
  input: params.select({ "micro": 256, "chonky": 2048 }),
});

const extensions = defineList("EXTENSIONS", {
  description: "Which file types should be processed?",
  input: params.multiSelect(["jpg", "tiff", "png", "webp"]),
});

const storageBucket = defineString('BUCKET', {
  description: "This will automatically
populate the selector field with the deploying Cloud Project’s
storage buckets",
  input: params.PICK_STORAGE_BUCKET,
});

Python

from firebase_functions.params import (
    StringParam,
    ListParam,
    TextInput,
    SelectInput,
    SelectOptions,
    ResourceInput,
    ResourceType,
)

MIN_INSTANCES = IntParam("HELLO_WORLD_MIN_INSTANCES")

WELCOME_MESSAGE = StringParam(
    "WELCOME_MESSAGE",
    default="Hello World",
    description="The greeting that is returned to the caller of this function",
)

ONLY_PHONE_NUMBERS = StringParam(
    "PHONE_NUMBER",
    input=TextInput(
        validation_regex="\d{3}-\d{3}-\d{4}",
        validation_error_message="Please enter a phone number in the format XXX-YYY-XXX",
    ),
)

SELECT_OPTION = StringParam(
    "PARITY",
    input=SelectInput([SelectOptions(value="odd"), SelectOptions(value="even")]),
)

STORAGE_BUCKET = StringParam(
    "BUCKET",
    input=ResourceInput(type=ResourceType.STORAGE_BUCKET),
    description="This will automatically populate the selector field with the deploying Cloud Project's storage buckets",
)

סוגי פרמטרים

תצורה עם פרמטרים מאפשרת הקלדה חזקה של ערכי פרמטרים, תומכים גם בסודות מ-Cloud Secret Manager. הסוגים הנתמכים הם:

סודי
String
בוליאני
מספר שלם
Float
רשימה (Node.js)

ערכים וביטויים של פרמטרים

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

כדי להעביר פרמטר לפונקציה כאפשרות בסביבת זמן ריצה, צריך להעביר אותו ישירות:

Node.js

const { onRequest } = require('firebase-functions/v2/https');
const { defineInt } = require('firebase-functions/params');
const minInstancesConfig = defineInt('HELLO\_WORLD\_MININSTANCES');

export const helloWorld = onRequest(
  { minInstances: minInstancesConfig },
  (req, res) => {
    //…

Python

from firebase_functions import https_fn
from firebase_functions.params import IntParam

MIN_INSTANCES = IntParam("HELLO_WORLD_MIN_INSTANCES")

@https_fn.on_request(min_instances=MIN_INSTANCES)
def hello_world(req):
    ...

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

Node.js

const { onRequest } = require('firebase-functions/v2/https');
const environment = params.defineString(‘ENVIRONMENT’, {default: 'dev'});

// use built-in comparators
const minInstancesConfig = environment.equals('PRODUCTION').thenElse(10, 1);
export const helloWorld = onRequest(
  { minInstances: minInstancesConfig },
  (req, res) => {
    //…

Python

from firebase_functions import https_fn
from firebase_functions.params import IntParam, StringParam

ENVIRONMENT = StringParam("ENVIRONMENT", default="dev")
MIN_INSTANCES = ENVIRONMENT.equals("PRODUCTION").then(10, 0)

@https_fn.on_request(min_instances=MIN_INSTANCES)
def hello_world(req):
    ...

אפשר לגשת לפרמטר ולביטוי הפרמטר שמשמשים רק במהלך זמן הריצה באמצעות הפונקציה value:

Node.js

const { onRequest } = require('firebase-functions/v2/https');
const { defineString } = require('firebase-functions/params');
const welcomeMessage = defineString('WELCOME_MESSAGE');

// To use configured parameters inside the config for a function, provide them
// directly. To use them at runtime, call .value() on them.
export const helloWorld = onRequest(
(req, res) => {
    res.send(`${welcomeMessage.value()}! I am a function.`);
  }
);

Python

from firebase_functions import https_fn
from firebase_functions.params import StringParam

WELCOME_MESSAGE = StringParam("WELCOME_MESSAGE")

@https_fn.on_request()
def hello_world(req):
    return https_fn.Response(f'{WELCOME_MESSAGE.value()}! I am a function!')

פרמטרים מובְנים

ה-Cloud Functions SDK כולל שלושה פרמטרים מוגדרים מראש, שזמינים חבילת המשנה firebase-functions/params:

Node.js

projectID – הפרויקט ב-Cloud שבו הפונקציה פועלת.
databaseURL – כתובת ה-URL של המופע של מסד הנתונים בזמן אמת המשויך עם הפונקציה (אם היא מופעלת בפרויקט Firebase).
storageBucket – הקטגוריה של Cloud Storage שמשויכת לפונקציה (אם הוא מופעל בפרויקט Firebase).

Python

PROJECT_ID – הפרויקט ב-Cloud שבו הפונקציה פועלת.
DATABASE_URL – כתובת ה-URL של המכונה של Realtime Database שמשויכת לפונקציה (אם היא מופעלת בפרויקט Firebase).
STORAGE_BUCKET – הקטגוריה ב-Cloud Storage שמשויכת לפונקציה (אם היא מופעלת בפרויקט Firebase).

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

פרמטרים סודיים

פרמטרים מסוג Secret, שהוגדרו באמצעות defineSecret(), מייצגים מחרוזת פרמטרים שמכילים ערך שמאוחסן ב-Cloud Secret Manager. במקום בדיקת מול קובץ .env מקומי וכתיבת ערך חדש לקובץ אם חסרים, פרמטרים סודיים בודקים אם קיימים ב-Cloud Secret Manager להציג באופן אינטראקטיבי את הערך של סוד חדש במהלך הפריסה.

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

Node.js

const { onRequest } = require('firebase-functions/v2/https');
const { defineSecret } = require('firebase-functions/params');
const discordApiKey = defineSecret('DISCORD_API_KEY');

export const postToDiscord = onRequest(
  { secrets: [discordApiKey] },
  (req, res) => {
  const apiKey = discordApiKey.value();
    //…

Python

from firebase_functions import https_fn
from firebase_functions.params import SecretParam

DISCORD_API_KEY = SecretParam('DISCORD_API_KEY')

@https_fn.on_request(secrets=[DISCORD_API_KEY])
def post_to_discord(req):
    api_key = DISCORD_API_KEY.value

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

משתני סביבה

Cloud Functions for Firebase תומך ב dotenv פורמט קובץ לטעינת משתני הסביבה שצוינו בקובץ .env זמן ריצה של אפליקציה. אחרי הפריסה, אפשר לקרוא את משתני הסביבה דרך process.env בממשק (בפרויקטים המבוססים על Node.js) או os.environ (אינץ') פרויקטים שמבוססים על Python).

כדי להגדיר את הסביבה בדרך הזו, צריך ליצור קובץ .env בפרויקט, מוסיפים את המשתנים הרצויים ופורסים:

יוצרים קובץ .env בספרייה functions/:

# Directory layout:
#   my-project/
#     firebase.json
#     functions/
#       .env
#       package.json
#       index.js

פותחים את הקובץ .env לעריכה ומוסיפים את המפתחות הרצויים. לדוגמה:
```
PLANET=Earth
AUDIENCE=Humans
```

פריסת פונקציות ואימות שמשתני הסביבה נטענו:

firebase deploy --only functions
# ...
# i functions: Loaded environment variables from .env.
# ...

אחרי הפריסה של משתני הסביבה המותאמים אישית, קוד הפונקציה יכול לגשת אליהם:

Node.js

// Responds with "Hello Earth and Humans"
exports.hello = onRequest((request, response) => {
  response.send(`Hello ${process.env.PLANET} and ${process.env.AUDIENCE}`);
});

Python

import os

@https_fn.on_request()
def hello(req):
    return https_fn.Response(
        f"Hello {os.environ.get('PLANET')} and {os.environ.get('AUDIENCE')}"
    )

פריסה של מספר קבוצות של משתני סביבה

אם אתם צריכים קבוצה חלופית של משתני סביבה ל-Firebase לפרויקטים (כמו Staging לעומת ייצור), ליצור קובץ אחד (.env.<project or alias>) וכתיבה של משתני סביבה ספציפיים לפרויקט. משתני הסביבה מקובץ .env ומקבצים .env ספציפיים לפרויקט (אם הם קיימים) ייכללו בכל הפונקציות שנפרסות.

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

`.env`	`.env.dev`	`.env.prod`
PLANET=Earth AUDIENCE=בני אדם	AUDIENCE=Dev Humans	AUDIENCE=בני אדם פרועים

בהתאם לערכים בקובצי ה-env הנפרדים, קבוצת משתני הסביבה שנפרסים עם הפונקציות תשתנה בהתאם לפרויקט היעד:

$ firebase use dev
$ firebase deploy --only functions
i functions: Loaded environment variables from .env, .env.dev.
# Deploys functions with following user-defined environment variables:
#   PLANET=Earth
#   AUDIENCE=Dev Humans

$ firebase use prod
$ firebase deploy --only functions
i functions: Loaded environment variables from .env, .env.prod.
# Deploys functions with following user-defined environment variables:
#   PLANET=Earth
#   AUDIENCE=Prod Humans

משתני סביבה שמורים

חלק ממפתחות משתני הסביבה שמורים לשימוש פנימי. אין להשתמש באף אחד מהמפתחות האלה בקבצים .env:

כל המפתחות מתחילים ב-X_GOOGLE_
כל המפתחות החל מ-EXT_
כל המפתחות שמתחילים ב-FIREBASE_
כל מקש מהרשימה הבאה:
CLOUD_RUNTIME_CONFIG
ENTRY_POINT
GCP_PROJECT
GCLOUD_PROJECT (פרויקט GCLOUD_PROJECT)
פרויקט_GOOGLE_CLOUD_PROJECT
FUNCTION_TRIGGER_TYPE
FUNCTION_NAME
FUNCTION_MEMORY_MB
FUNCTION_TIMEOUT_SEC
FUNCTION_IDENTITY
פונקציית FUNCTION_REGION
FUNCTION_TARGET (פונקציית FUNCTION_TARGET)
FUNCTION_SIGNATURE_TYPE
K_SERVICE
K_REVISION
PORT
K_CONFIGURATION

אחסון מידע רגיש בתצורה וגישה אליו

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

כדי לעזור לך לאחסן מידע רגיש של הגדרות, Cloud Functions for Firebase משתלב עם Google Cloud Secret Manager. השירות המוצפן הזה מאחסן את ערכי ההגדרות באופן מאובטח, עדיין מאפשרת גישה קלה מהפונקציות במקרה הצורך.

יצירת סוד ושימוש בו

כדי ליצור סוד, משתמשים ב-CLI של Firebase.

כדי ליצור סוד ולהשתמש בו:

ברמה הבסיסית (root) של ספריית הפרויקט המקומית, מריצים את הפקודה הבאה:
```
firebase functions:secrets:set SECRET_NAME
```
מזינים ערך בשדה SECRET_NAME.

ה-CLI משדר הודעת הצלחה ומזהיר אתכם שצריך לפרוס פונקציות כדי שהשינוי ייכנס לתוקף.

לפני הפריסה, חשוב לוודא שקוד הפונקציות מאפשר לפונקציה לגשת לסוד באמצעות הפרמטר runWith:

Node.js

const { onRequest } = require('firebase-functions/v2/https');

exports.processPayment = onRequest(
  { secrets: ["SECRET_NAME"] },
  (req, res) => {
    const myBillingService = initializeBillingService(
      // reference the secret value
      process.env.SECRET_NAME
    );
    // Process the payment
  }
);

Python

import os
from firebase_functions import https_fn

@https_fn.on_request(secrets=["SECRET_NAME"])
def process_payment(req):
    myBillingService = initialize_billing(key=os.environ.get('SECRET_NAME'))
    # Process the payment
    ...

פריסה של Cloud Functions:

firebase deploy --only functions

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

Node.js

exports.anotherEndpoint = onRequest((request, response) => {
  response.send(`The secret API key is ${process.env.SECRET_NAME}`);
  // responds with "The secret API key is undefined" because the `runWith` parameter is missing
});

Python

@https_fn.on_request()
def another_endpoint(req):
    return https_fn.Response(f"The secret API key is {os.environ.get("SECRET_NAME")}")
    # Responds with "The secret API key is None" because the `secrets` parameter is missing.

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

ניהול סודות

צריך להשתמש ב-CLI של Firebase כדי לנהל את הסודות. אבל אם מנהלים סודות בדרך הזו, חשוב לזכור שחלק מהשינויים ב-CLI מחייבים שינוי ו/או פריסה מחדש בפונקציות שקשורות אליו. ספציפית:

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

ריכזנו כאן את הפקודות של CLI ב-Firebase לניהול סודות:

# Change the value of an existing secret
firebase functions:secrets:set SECRET_NAME

# View the value of a secret
functions:secrets:access SECRET_NAME

# Destroy a secret
functions:secrets:destroy SECRET_NAME

# View all secret versions and their state
functions:secrets:get SECRET_NAME

# Automatically clean up all secrets that aren't referenced by any of your functions
functions:secrets:prune

בפקודות access ו-destroy, אפשר לציין את הפרמטר האופציונלי version כדי לנהל גרסה מסוימת. לדוגמה:

functions:secrets:access SECRET_NAME[@VERSION]

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

איך מתבצע החיוב על סודות

ב-Secret Manager אפשר ליצור 6 גרסאות סודיות פעילות ללא עלות. כלומר, יכולים להיות לכם 6 סודות בחודש ב-Firebase בפרויקט ללא עלות.

כברירת מחדל, ה-CLI של Firebase מנסה להשמיד באופן אוטומטי גרסאות של סודות שלא בשימוש במקרים הרלוונטיים, למשל כשפורסים פונקציות עם גרסה חדשה של הסוד. אפשר גם לנקות סודות שלא נמצאים בשימוש באמצעות functions:secrets:destroy וגם functions:secrets:prune

Secret Manager מאפשר 10,000 פעולות גישה חודשיות ללא חיוב בסוד. בכל פעם שמופעל הפעלה מחדש של פונקציה, המכונות שלה קוראות רק את הסודות שצוינו בפרמטר runWith. אם יש לכם הרבה מכונות של פונקציות שקוראות הרבה סודות, יכול להיות שהפרויקט שלכם יחרוג מההרשאה הזו. במקרה כזה, תחויבו ב-0.03$ לכל 10,000 פעולות גישה.

מידע נוסף זמין במאמר הבא: Secret Manager תמחור.

תמיכה באמולטור

הגדרת הסביבה באמצעות dotenv נועדה לפעול באופן הדדי עם אמולטור Cloud Functions מקומי.

כשמשתמשים באמולטור Cloud Functions מקומי, אפשר לשנות את הסביבה של הפרויקט שלכם על ידי הגדרת קובץ .env.local. תוכן של הפרמטר .env.local מקבל עדיפות על פני .env והקובץ .env הספציפי לפרויקט.

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

`.env`	`.env.dev`	`.env.local`
PLANET=Earth AUDIENCE=בני אדם	AUDIENCE=Dev בני אדם	AUDIENCE=בני אדם מקומיים

כשהמכונה הווירטואלית מופעלת בהקשר המקומי, היא טוענת את משתני הסביבה באופן הבא:

  $ firebase emulators:start
  i  emulators: Starting emulators: functions
  # Starts emulator with following environment variables:
  #  PLANET=Earth
  #  AUDIENCE=Local Humans

סודות ופרטי כניסה במהנתח Cloud Functions

במהדורת ה-emulator של Cloud Functions אפשר להשתמש בסודות כדי לאחסן מידע רגיש על הגדרות ולגשת אליו. כברירת מחדל, האמולטור ינסה לגשת לסודות של הייצור באמצעות Application Default Credentials במצבים מסוימים, כמו סביבות CI, יכול להיות שהאמולטור לא יקבל גישה ערכים סודיים עקב הגבלות הרשאות.

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

מעבר מהגדרת הסביבה

אם השתמשתם בהגדרות סביבה עם functions.config, תוכלו להעביר את ההגדרות הקיימות כמשתני סביבה (בפורמט dotenv). ב-CLI של Firebase יש פקודה לייצוא שמפיקה את ההגדרות של כל כינוי או פרויקט שמפורטים בקובץ .firebaserc בספרייה (בדוגמה הבאה, local,‏ dev ו-prod) כקובצי .env.

כדי להעביר את ההגדרות, מייצאים את הגדרות הסביבה הקיימות באמצעות הפקודה firebase functions:config:export:

firebase functions:config:export
i  Importing configs from projects: [project-0, project-1]
⚠  The following configs keys could not be exported as environment variables:

⚠  project-0 (dev):
    1foo.a => 1FOO\_A (Key 1FOO\_A must start with an uppercase ASCII letter or underscore, and then consist of uppercase ASCII letters, digits, and underscores.)

Enter a PREFIX to rename invalid environment variable keys: CONFIG\_
✔  Wrote functions/.env.prod
✔  Wrote functions/.env.dev
✔  Wrote functions/.env.local
✔  Wrote functions/.env

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

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

בנוסף, תצטרכו לעדכן את קוד הפונקציות. פונקציות שמשתמשות בהן עכשיו צריך להשתמש ב-functions.config במקום זאת ב-process.env, כפי שמוצג ב: משתני סביבה.