استقرار برنامه‌تان را به‌صورت محلی آزمایش کنید

می‌توانید قبل‌از استقرار App Hosting، بااستفاده از شبیه‌ساز App Hosting که بخشی از Firebase Local Emulator Suite است، آزمایش‌های محلی برنامه‌تان را انجام دهید.

قبل‌از استفاده از شبیه‌ساز App Hosting، مطمئن شوید که گردش کار کلی Firebase Local Emulator Suite را درک کرده‌اید و Local Emulator Suite را نصب و پیکربندی کرده‌اید و فرمان‌های CLI آن را مرور کرده‌اید.

این موضوع فرض می‌کند که شما ازقبل با App Hosting آشنا هستید. درصورت نیاز، مقدمه App Hosting و سایر مطالب را مرور کنید تا به شما کمک کند نحوه عملکرد App Hosting را درک کنید.

با شبیه‌ساز App Hosting چه کارهایی می‌توانم انجام دهم؟

شبیه‌ساز App Hosting به شما امکان می‌دهد برنامه‌های وب خود را به‌صورت محلی آزمایش و اصلاح کنید. این کار می‌تواند فرایند توسعه شما را ساده‌تر کند و کیفیت برنامه‌های وب ساخته‌شده با Firebase و مستقرشده در App Hosting را بهبود بخشد.

شبیه‌ساز App Hosting:

  1. به شما امکان می‌دهد برنامه وب خود را به‌صورت محلی اجرا کنید، با متغیرهای محیطی و اسرار تعریف‌شده در فایل‌های پیکربندی apphosting.yaml.
  2. می‌تواند متغیرهای محیطی و اطلاعات محرمانه را برای استفاده در شبیه‌ساز با فایل apphosting.emulator.yaml لغو کند.
  3. می‌تواند در کنار شبیه‌سازهای دیگر Firebase استفاده شود. اگر از Firestore،‏ Auth، یا هر شبیه‌ساز دیگری استفاده می‌کنید، Local Emulator Suite تضمین می‌کند که این شبیه‌سازها قبل‌از شبیه‌ساز App Hosting راه‌اندازی شوند.

پیکربندی شبیه‌ساز

برای شروع، Local Emulator Suite را همان‌طور که در نصب، پیکربندی، و ادغام Local Emulator Suite شرح داده شده است نصب و مقداردهی اولیه کنید. علاوه‌بر هر شبیه‌ساز Firebase دیگری که می‌خواهید راه‌اندازی کنید، حتماً App Hosting Emulator را انتخاب کنید. رابط خط فرمان از شما می‌خواهد برخی‌از مقادیر شبیه‌ساز App Hosting را وارد کنید، ازجمله:

  • دایرکتوری ریشه برنامه‌تان نسبت‌به پروژه؛ این مورد زمانی مهم است که از تک‌مخزن با App Hosting استفاده می‌کنید.
  • آیا می‌خواهید مقادیر را برای توسعه محلی لغو کنید.
  • آیا می‌خواهید به هم‌تیمی‌ها اجازه دسترسی به اطلاعات محرمانه برای توسعه محلی بدهید.
firebase init emulators
=== Emulators Setup
? Which Firebase emulators do you want to set up? Press Space to select emulators, then Enter to confirm your choices. (Press
<space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◯ App Hosting Emulator
 ◯ Firestore Emulator
 ◯ Database Emulator
 ◯ Hosting Emulator
 ◯ Pub/Sub Emulator
 ◯ Storage Emulator
 ◯ Eventarc Emulator
(Move up and down to reveal more choices)

? Specify your app's root directory relative to your project (./)

? The App Hosting emulator uses a file called apphosting.emulator.yaml to
override values in apphosting.yaml for local testing. This codebase does not
have one, would you like to create it? (Y/n)

? Which environment variables would you like to override? (Press <space> to
select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◯ MEMCACHE_ADDR
 ◯ API_KEY

? What new value would you like for plaintext MEMCACHE_ADDR?

? What would you like to name the secret reference for API_KEY? (test-api-key)

? What new value would you like for secret TESTKEY [input is hidden]? [input is hidden]

? Your config has secret values. Please provide a comma-separated list of users
or groups who should have access to secrets for local development:

✔  Successfully set IAM bindings on secret test-api-key.

هر مقداری که در این جریان راه‌اندازی ارائه دهید برای به‌روزرسانی پیکربندی شبیه‌ساز App Hosting در firebase.json استفاده می‌شود. همچنین می‌توانید شبیه‌ساز «میزبانی برنامه» را با به‌روزرسانی مستقیم firebase.json پیکربندی کنید. طرح‌واره شبیه‌ساز App Hosting عبارت است از:

{
  ...
  "emulators": {
    "apphosting": {
      "startCommand": <command> [optional],
      "rootDirectory": <path> [optional]
    }
  }
}
  • startCommand به‌طور خودکار تولید و تنظیم می‌شود وقتی شبیه‌ساز مقداردهی اولیه می‌شود. اگر ارائه نشود، شبیه‌ساز فرمان توسعه مدیر بسته شما را شناسایی و اجرا خواهد کرد.
  • ‫rootDirectory برای پشتیبانی از راه‌اندازی پروژه تک‌مخزن استفاده می‌شود. اگر برنامه وب شما در زیرفهرست راهنما است، باید مسیر آن فهرست راهنما را نسبت‌به ریشه (مکان firebase.json) ارائه دهید.

مدیریت شبیه‌سازی

مقداردهی اولیه شبیه‌ساز یک فایل apphosting.emulator.yaml در دایرکتوری ریشه برنامه‌تان ایجاد می‌کند. این فایل پیکربندی همان طرح‌واره فایل apphosting.yaml را دارد که در تولید استفاده می‌شود، اما درعوض صرفاً برای توسعه محلی درنظر گرفته شده است. به‌طور پیش‌فرض، شبیه‌ساز پیکربندی را از فایل apphosting.yaml شما می‌خواند، اما اگر فایل apphosting.emulator.yaml وجود داشته باشد، پیکربندی‌های آن فایل در اولویت قرار می‌گیرند و تقدم دارند.

فایل apphosting.emulator.yaml طوری طراحی شده است که برای ارسال و هم‌رسانی با همکاران ایمن باشد. برای کمک به اطمینان از اینکه به‌طور تصادفی داده‌های حساس را به مخازن منبع ارسال نمی‌کنید، هر متغیر محیطی که در apphosting.yaml محرمانه است باید در apphosting.emulator.yaml نیز محرمانه باشد. اگر نیازی به تغییر رمز بین تولید و توسعه محلی نیست (برای مثال، کلید Gemini API)، نیازی به افزودن آن به apphosting.emulator.yaml نیست؛ درعوض به تیمتان اجازه دسترسی به رمز را بدهید.

اگر برنامه شما از اطلاعات محرمانه زیادی استفاده می‌کند (برای مثال، کلیدهای میانای API برای سه سرویس مختلف، با مقادیر متفاوت برای هریک از توسعه‌های محلی، مرحله‌ای، و تولیدی)، ممکن است از سطح رایگان Cloud Secret Manager فراتر بروید و ماهانه ۰٫۰۶ دلار برای هر اطلاعات محرمانه اضافی پرداخت کنید. اگر ترجیح می‌دهید پیکربندی محلی را خارج از کنترل منبع مدیریت کنید تا از این هزینه اجتناب کنید، می‌توانید از فایل قدیمی apphosting.local.yaml استفاده کنید. برخلاف apphosting.emulator.yaml، این فایل مجاز است مقادیر متن ساده را برای متغیرهای محیطی که مقادیر مخفی در apphosting.yaml هستند ارائه دهد.

اعطای دسترسی به اطلاعات محرمانه به کاربران یا گروه‌ها

اطلاعات محرمانه ذخیره‌شده در apphosting.emulator.yaml هنگام راه‌اندازی شبیه‌ساز خوانده می‌شود. این یعنی تیم توسعه شما به این کلید خصوصی نیاز دارد. می‌توانید از فرمان apphosting:secrets:grantaccess برای اعطای دسترسی به یک رمز به کاربر یا گروه ازطریق ایمیل استفاده کنید.

firebase apphosting:secrets:grantaccess test-api-key --emails my-team@my-company.com

درصورت لزوم، از کلیدهای فقط آزمایشی در apphosting.emulator.yaml استفاده کنید که به داده‌های تولید دسترسی ندارند، نمی‌توانند عوارض جانبی جهانی داشته باشند (ارسال ایمیل، شارژ کارت‌های اعتباری)، یا سهمیه‌های کمتری دارند. این کار کمک می‌کند مطمئن شویم کد بازبینی‌نشده پیامدهای کمتری در دنیای واقعی دارد.

به‌جای اعطای دسترسی به کاربران به‌صورت فردی، از «گروه‌های Google» برای مدیریت دسترسی به اطلاعات محرمانه استفاده کنید. این کار آماده‌سازی اعضای جدید تیم توسعه‌دهنده را ساده‌تر می‌کند، زیرا با افزودن آن‌ها به گروه، به همه اطلاعات محرمانه موردنیازشان دسترسی پیدا می‌کنند. ممکن است ازقبل گروه مناسبی داشته باشید که توسعه‌دهندگان در آن با یکدیگر ارتباط برقرار می‌کنند. کنترل دسترسی توسط «گروه‌های Google» همچنین کمک می‌کند مطمئن شوید توسعه‌دهندگانی که تیم شما را ترک می‌کنند، وقتی از گروه ایمیل برداشته می‌شوند، دسترسی به همه اطلاعات محرمانه را ازدست می‌دهند. اگر کلید محرمانه به داده‌های تولید یا عوارض جانبی دنیای واقعی دسترسی دارد، شاید بهتر باشد کلیدتان را بچرخانید و بااستفاده از firebase apphosting:secrets:set مقدار جدیدی به آن بدهید.

اجرای شبیه‌ساز

firebase emulators:start

با این کار، همه شبیه‌سازهای تعریف‌شده در فایل firebase.json، ازجمله شبیه‌ساز App Hosting، راه‌اندازی می‌شوند.

پیکربندی فرمان start برای برنامه‌های Angular

اگر مهلت زمانی فرمان شبیه‌ساز start به‌پایان برسد، احتمالاً سرور توسعه Angular برنامه شما را در درگاهی متفاوت با درگاه موردانتظار شبیه‌ساز App Hosting ارائه می‌کند. می‌توانید با افزودن پیکربندی اضافی در firebase.json، این مشکل را برطرف کنید:

  • emulators.apphosting.startCommand را روی ng serve تنظیم کرد.
  • برای استفاده از درگاه غیرپیش‌فرض، آن را با emulators.apphosting.port تنظیم کنید (به‌جای افزودن پرچم --port به ng serve در emulators.apphosting.startCommand).

برای مثال:

"emulators": {
    "apphosting": {
      "port": 5002,
      "rootDirectory": "./test-app",
      "startCommand": "ng serve"
    },
    "ui": {
      "enabled": true
    },
    ...
  }