ضبط البيئة


ستحتاج في أغلب الأحيان إلى إعدادات إضافية لوظائفك، مثل مفاتيح واجهة برمجة التطبيقات التابعة لجهات خارجية أو الإعدادات القابلة للضبط. توفّر حزمة Firebase SDK لنظام التشغيل Cloud Functions إعدادات بيئة مدمجة لتسهيل تخزين هذا النوع من البيانات واستردادها لمشروعك.

يمكنك الاختيار بين الخيارَين التاليَين:

  • الإعدادات المُعرَّفة بالمَعلمات (يُنصح بها في معظم السيناريوهات) يقدّم ذلك إعدادات بيئة بأنواع محدّدة باستخدام مَعلمات يتم التحقّق منها في وقت النشر، ما يؤدي بدوره إلى منع حدوث أخطاء وتبسيط عملية تصحيح الأخطاء.
  • الضبط المستنِد إلى الملفات لمتغيّرات البيئة باستخدام هذا النهج، يمكنك إنشاء ملف dotenv يدويًا لتحميل متغيّرات البيئة.

في معظم حالات الاستخدام، يُنصح باستخدام الإعدادات المُستندة إلى المَعلمات. يتيح هذا النهج توفّر قيم الإعدادات في وقت التشغيل ووقت النشر، ويؤدي إلى حظر النشر ما لم تكن جميع المَعلمات تحتوي على قيمة صالحة. في المقابل، لا تتوفّر الإعدادات باستخدام متغيّرات البيئة في وقت النشر.

الإعدادات المُعلَمة

يوفّر Cloud Functions for Firebase واجهة لتحديد مَعلمات الإعدادات بشكل صريح داخل قاعدة بياناتك البرمجية. تتوفّر قيمة هذه المَعلمات أثناء نشر الدالة، وعند ضبط خيارات التنفيذ والنشر ، وأثناء التنفيذ. وهذا يعني أنّ وحدة تحكّم سطر الأوامر ستحظر عملية النشر ما لم تكن جميع المَعلمات ذات قيمة صالحة.

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!')

عند نشر دالة تتضمّن متغيّرات إعدادات مستندة إلى مَعلمات، يحاول ملف IDE لـ 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> الذي تم إنشاؤه إلى أداة التحكّم في الإصدارات.

استخدام المَعلمات في النطاق العام

أثناء عملية النشر، يتم تحميل رمز الدوالّ وفحصه قبل أن تحصل paramter على قيم فعلية. وهذا يعني أنّ جلب قيم المَعلمات أثناء النطاق الشامل يؤدي إلى تعذُّر النشر. في الحالات التي تريد فيها استخدام مَعلمة لإعداد قيمة عالمية، استخدِم دالة الاستدعاء لإعداد القيمة 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() غير صحيح قبل استخدامه.

ضبط سلوك واجهة سطر الأوامر

يمكن ضبط المَعلمات باستخدام كائن Options يتحكّم في كيفية طلب CLI للقيم. يحدِّد المثال التالي خيارات للتحقّق من تنسيق رقم الهاتف، وتوفير خيار اختيار بسيط، و preenchimento خيار اختيار تلقائيًا من مشروع 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",
)

أنواع المَعلمات

توفّر الإعدادات المُعرَّفة بالمَعلمات كتابة قوية لقيم المَعلمات، ويسمح باستخدام الأسرار من "أداة إدارة الأسرار في السحابة الإلكترونية". الأنواع المتوافقة هي:

  • سري
  • سلسلة
  • منطقي
  • العدد الصحيح
  • عائم
  • List (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!')

المَعلمات المضمّنة

توفّر حزمة تطوير البرامج (SDK) لوظائف Cloud ثلاث مَعلمات محدّدة مسبقًا، وهي متاحة من الحزمة الفرعية firebase-functions/params:

Node.js

  • projectID: مشروع Cloud الذي يتم تشغيل الدالة فيه
  • databaseURL: عنوان URL لمثيل "قاعدة بيانات فورية الاستجابة" المرتبط بالدالة (إذا كان مفعّلاً في مشروع Firebase)
  • storageBucket: حزمة Cloud Storage المرتبطة بالدالة (إذا كانت مفعّلة في مشروع Firebase)

Python

  • PROJECT_ID: مشروع Cloud الذي يتم تشغيل الدالة فيه
  • DATABASE_URL: عنوان URL لمثيل "قاعدة بيانات فورية الاستجابة" المرتبط بالدالة (إذا كان مفعّلاً في مشروع Firebase)
  • STORAGE_BUCKET: حزمة Cloud Storage المرتبطة بالدالة (إذا كانت مفعّلة في مشروع Firebase)

تعمل هذه الدوالّ مثل مَعلمات سلاسل ملفوظة تحدّدها أنت من جميع النواحي، باستثناء أنّه لن يُطلب منك أبدًا إدخال قيمها عند النشر ولن يتم حفظها في ملفات .env لأنّ قيمها معروفة دائمًا لأداة Firebase CLI.

المَعلمات السرية

تمثّل المَعلمات من النوع Secret، التي يتم تحديدها باستخدام defineSecret()، مَعلمات سلاسل تحتوي على قيمة مخزّنة في أداة "إدارة الأسرار في السحابة الإلكترونية". بدلاً من التحقّق من ملف .env محلي وكتابة قيمة جديدة في الملف في حال عدم توفّره، تتحقّق مَعلمات المفتاح السري من توفّره في أداة "إدارة مفاتيح المرور في السحابة الإلكترونية"، وتطلب بشكل تفاعلي قيمة مفتاح سري جديد أثناء عملية النشر.

يجب ربط المَعلمات السرية المحدَّدة بهذه الطريقة بوظائف فردية يجب أن يكون بإمكانها الوصول إليها:

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 في مشروعك، وأضِف المتغيّرات المطلوبة، ثمّ فعِّل الملف:

  1. أنشئ ملف .env في دليل functions/:

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

  2. افتح ملف .env لتعديله وأضِف المفاتيح المطلوبة. على سبيل المثال:

    PLANET=Earth
AUDIENCE=Humans

  3. يمكنك نشر الدوال والتأكّد من تحميل متغيّرات البيئة:

    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 (مثل مرحلة الإعداد مقابل مرحلة الإنتاج)، أنشئ ملفًا بعنوان .env.<project or alias> واكتب فيه متغيّرات البيئة الخاصة بالمشروع. سيتم تضمين متغيّرات البيئة منملفَي .env و.env الخاصَين بالمشروع (في حال توفّرهما) في جميع الدوالّ المنشورة.

على سبيل المثال، يمكن أن يتضمّن المشروع الملفات الثلاثة التالية التي تحتوي على قيم مختلفة قليلاً للتطوير والإصدار:

.env .env.dev .env.prod
PLANET=Earth

AUDIENCE=Humans

AUDIENCE=Dev Humans AUDIENCE=Prod Humans

استنادًا إلى القيم الواردة في هذه الملفات المنفصلة، ستختلف مجموعة متغيّرات البيئة التي يتم نشرها مع وظائفك حسب المشروع المستهدَف:

$ 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
  • GOOGLE_CLOUD_PROJECT
  • FUNCTION_TRIGGER_TYPE
  • FUNCTION_NAME
  • FUNCTION_MEMORY_MB
  • FUNCTION_TIMEOUT_SEC
  • FUNCTION_IDENTITY
  • FUNCTION_REGION
  • FUNCTION_TARGET
  • FUNCTION_SIGNATURE_TYPE
  • K_SERVICE
  • K_REVISION
  • PORT
  • K_CONFIGURATION

تخزين معلومات الضبط الحسّاسة والوصول إليها

يمكن استخدام متغيّرات البيئة المخزّنة في ملفات .env لضبط وظائف، ولكن يجب عدم اعتبارها طريقة آمنة لتخزين المعلومات الحسّاسة، مثل بيانات اعتماد قاعدة البيانات أو مفاتيح واجهة برمجة التطبيقات. ويُعدّ ذلك مهمًا بشكل خاص إذا كنت تُراجع ملفات .env في أداة التحكّم في المصدر.

لمساعدتك في تخزين معلومات الضبط الحسّاسة، Cloud Functions for Firebase يتم دمج Google Cloud Secret Manager. تخزِّن هذه الخدمة المشفَّرة قيم الضبط بأمان، مع السماح بالوصول إليها بسهولة من وظائفك عند الحاجة.

إنشاء سر واستخدامه

لإنشاء سر، استخدِم واجهة برمجة التطبيقات Firebase.

لإنشاء سرّ واستخدامه:

  1. من جذر دليل المشروع على الجهاز، نفِّذ الأمر التالي: 

    firebase functions:secrets:set SECRET_NAME

  2. أدخِل قيمة في حقل SECRET_NAME.

    يعرض سطر الأوامر رسالة نجاح ويحذّرك من أنّه عليك نشر الدوالّ لكي يسري التغيير.

  3. قبل نشر التطبيق، تأكَّد من أنّ رمز الدوال يسمح للدالة بالوصول إلى القيمة السرية باستخدام المَعلمة 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
    ...

  4. نشر 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 على وجه التحديد هي التي يمكنها الوصول إلى هذا السرّ كمتغيّر بيئة. يساعدك ذلك في التأكّد من أنّ قيم الأسرار لا تتوفّر إلا عند الحاجة إليها، ما يقلل من خطر تسرُّب سرّ عن طريق الخطأ.

إدارة الأسرار

استخدِم واجهة برمجة التطبيقات Firebase لإدارة أسرارك. أثناء إدارة الأسرار بهذه الطريقة، تذكَّر أنّ بعض التغييرات في سطر الأوامر تتطلّب تعديل و/أو إعادة نشر الوظائف المرتبطة. على وجه التحديد:

  • عند ضبط قيمة جديدة لمفتاح سري، يجب إعادة نشر كل الدوال التي تشير إلى ذلك المفتاح السري لكي تحصل على أحدث قيمة.
  • إذا حذفت سرًا، تأكَّد من أنّ أيًا من وظائفك المنشورة لا تشير إلى هذا السر. ستتعطّل الدوال التي تستخدِم قيمة سرية تم حذفها بدون إشعار.

في ما يلي ملخّص لأوامر Firebase CLI لإدارة الأسرار:

# 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 مع الأمر لاطلاع على مساعدة سطر الأوامر.

كيفية تحصيل رسوم مفاتيح المرور

تسمح Secret Manager بـ 6 إصدارات فعالة من الأسرار بدون أي تكلفة. وهذا يعني أنّه يمكنك الحصول على 6 أسرار شهريًا في مشروع Firebase بدون أي تكلفة.

تحاول أداة Firebase CLI تلقائيًا إتلاف إصدارات السر غير المستخدَمة عند الاقتضاء، مثل عند نشر الدوالّ باستخدام إصدار جديد من السر. يمكنك أيضًا تنظيف الأسرار غير المستخدَمة بشكل نشط باستخدام 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.local الأولوية على ملف.env وملف.env الخاص بالمشروع.

على سبيل المثال، يمكن أن يتضمّن المشروع الملفات الثلاثة التالية التي تحتوي على قيم مختلفة قليلاً للتطوير والاختبار على الجهاز:

.env .env.dev .env.local
PLANET=Earth

AUDIENCE=Humans

AUDIENCE=Dev Humans AUDIENCE=Local Humans

عند تشغيل المحاكي في السياق المحلي، يحمِّل المحاكي متغيّرات الشدَّة البيئية كما هو موضّح:

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

الأسرار وبيانات الاعتماد في محاكي Cloud Functions

يتيح محاكي Cloud Functions استخدام الأسرار لتخزين معلومات الضبط الحسّاسة والوصول إليها. سيحاول المحاكي الوصول إلى أسرار الإصدار العلني تلقائيًا باستخدام بيانات اعتماد التطبيق التلقائية. في بعض الحالات، مثل بيئات التطوير المتكامل (CI)، قد يتعذّر على المحاكي الوصول إلى القيم السرية بسبب قيود الأذونات.

على غرار توافق محاكي Cloud Functions مع متغيّرات البيئة، يمكنك تجاوز قيم الأسرار من خلال إعداد ملف .secret.local. يسهّل عليك ذلك اختبار الدوالّ على الجهاز، خاصةً إذا لم يكن لديك إذن بالوصول إلى القيمة السرية.

نقل البيانات من إعدادات البيئة

إذا كنت تستخدم إعدادات البيئة مع functions.config، يمكنك نقل إعداداتك الحالية كمتغيّرات بيئة (بتنسيق dotenv). توفّر واجهة Firebase CLI أمر تصدير يعرض إعدادات كل عنوان بديل أو مشروع مُدرَج في ملف .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 بدلاً من ذلك، كما هو موضّح في متغيّرات البيئة.