ทดสอบการติดตั้งใช้งานแอปในเครื่อง

คุณสามารถทำการทดสอบแอปในเครื่องก่อนการติดตั้งใช้งาน App Hosting โดยใช้โปรแกรมจำลอง App Hosting ซึ่งเป็นส่วนหนึ่งของชุดโปรแกรมจำลองภายในของ Firebase

ก่อนใช้โปรแกรมจำลอง App Hosting โปรดตรวจสอบว่าคุณเข้าใจเวิร์กโฟลว์โดยรวมของ Firebase Local Emulator Suite และติดตั้งและกำหนดค่า Local Emulator Suite รวมถึงตรวจสอบคำสั่ง CLI ของ Firebase แล้ว

หัวข้อนี้ถือว่าคุณคุ้นเคยกับ 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 ด้วย CLI จะแจ้งให้คุณระบุค่าบางอย่างของโปรแกรมจำลอง App Hosting ซึ่งรวมถึงค่าต่อไปนี้

  • ไดเรกทอรีรากของแอปที่เกี่ยวข้องกับโปรเจ็กต์ ซึ่งสำคัญหากคุณใช้ Monorepo กับ 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 นอกจากนี้ คุณยังกำหนดค่าโปรแกรมจำลอง App Hosting ได้โดยอัปเดต firebase.json โดยตรง สคีมาสำหรับโปรแกรมจำลอง App Hosting มีดังนี้

{
  ...
  "emulators": {
    "apphosting": {
      "startCommand": <command> [optional],
      "rootDirectory": <path> [optional]
    }
  }
}
  • ระบบจะสร้างและตั้งค่า startCommand โดยอัตโนมัติเมื่อเริ่มต้นโปรแกรมจำลอง หากไม่ได้ระบุไว้ โปรแกรมจำลองจะตรวจหาและเรียกใช้คำสั่ง dev ของเครื่องมือจัดการแพ็กเกจ
  • rootDirectory ใช้เพื่อรองรับการตั้งค่าโปรเจ็กต์ Monorepo หากเว็บแอปอยู่ในไดเรกทอรีย่อย คุณต้องระบุเส้นทางของไดเรกทอรีนั้นที่สัมพันธ์กับรูท (ตำแหน่งของ 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 สำหรับบริการที่แตกต่างกัน 3 รายการ โดยมีค่าที่แตกต่างกันสำหรับแต่ละเวอร์ชันที่ใช้งานจริง เวอร์ชันทดลอง และเวอร์ชันที่พัฒนาในเครื่อง) คุณอาจใช้เกินโควต้ารุ่นฟรีของ Cloud Secret Manager และต้องจ่าย $0.06 ต่อข้อมูลลับเพิ่มเติมต่อเดือน หากต้องการจัดการการกำหนดค่าในเครื่องนอกการควบคุมแหล่งที่มาเพื่อหลีกเลี่ยงค่าธรรมเนียมนี้ คุณสามารถใช้ไฟล์ 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 Groups เพื่อจัดการสิทธิ์เข้าถึงข้อมูลลับแทนการให้สิทธิ์เข้าถึงแก่ผู้ใช้แต่ละราย วิธีนี้จะช่วยให้การเตรียมความพร้อมผู้ใช้งานใหม่ในทีมนักพัฒนาซอฟต์แวร์ง่ายขึ้น เนื่องจากเมื่อเพิ่มสมาชิกใหม่ลงในกลุ่มแล้ว สมาชิกจะได้รับสิทธิ์เข้าถึงข้อมูลลับทั้งหมดที่ต้องการ คุณอาจมีกลุ่มที่เหมาะสมซึ่งนักพัฒนาแอปใช้สื่อสารกันอยู่แล้ว การควบคุมการเข้าถึงโดย Google Groups ยังช่วยให้มั่นใจได้ว่านักพัฒนาซอฟต์แวร์ที่ออกจากทีมจะเสียสิทธิ์เข้าถึงข้อมูลลับทั้งหมดเมื่อถูกนำออกจากกลุ่มอีเมล หากข้อมูลลับมีสิทธิ์เข้าถึงข้อมูลเวอร์ชันที่ใช้งานจริงหรือผลข้างเคียงในชีวิตจริง คุณก็ยังควรหมุนเวียนคีย์และกำหนดค่าใหม่ด้วย 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
    },
    ...
  }