จัดการการกำหนดค่าโปรเจ็กต์ด้วยไฟล์ Manifest ของส่วนขยาย

ไฟล์ Manifest ของส่วนขยายคือรายการอินสแตนซ์ของส่วนขยายและการกำหนดค่าของอินสแตนซ์เหล่านั้น โดยไฟล์ Manifest ช่วยให้คุณทำสิ่งต่อไปนี้ได้

  • แชร์การกำหนดค่าส่วนขยายกับผู้อื่น
  • คัดลอกการกำหนดค่าส่วนขยายระหว่างโปรเจ็กต์ต่างๆ (เช่น จากโปรเจ็กต์การจัดเตรียมไปยังโปรเจ็กต์การผลิต)
  • ติดตั้งใช้งานส่วนขยายทั้งหมดพร้อมกัน
  • ทดสอบว่าส่วนขยายทำงานร่วมกับแอปอย่างไรโดยใช้ Firebase Local Emulator Suite
  • ส่งการกำหนดค่าส่วนขยายไปยังการควบคุมแหล่งที่มา
  • รวมส่วนขยายไว้ในไปป์ไลน์ CI/CD

ไฟล์ Manifest ของส่วนขยายมี 2 ส่วน ดังนี้

  • ส่วน extensions ของ firebase.json ซึ่งเป็นแผนที่ของรหัสอินสแตนซ์ ไปยังการอ้างอิงเวอร์ชันส่วนขยาย เช่น

    {
 "extensions": {
   "my-bigquery-extension": "firebase/firestore-bigquery-export@^0.1.18",
   "my-image-resizer": "firebase/storage-resize-images@^0.1.22",
 }
}

  • .env ที่มีข้อมูลการกำหนดค่าสำหรับอินสแตนซ์ส่วนขยายแต่ละรายการในไดเรกทอรีย่อย extensions/ ของไดเรกทอรีโปรเจ็กต์ Firebase เช่น อินสแตนซ์ของ storage-resize-images อาจมีไฟล์ .env ดังต่อไปนี้

    IMAGE_TYPE=jpeg
LOCATION=us-central1
IMG_BUCKET=${param:PROJECT_ID}.firebasestorage.app
IMG_SIZES=100x100
DELETE_ORIGINAL_FILE=false

สร้างไฟล์ Manifest ของส่วนขยาย

การสร้างไฟล์ Manifest ของส่วนขยายทำได้ 3 วิธี ดังนี้

  • จัดการไฟล์ Manifest ของส่วนขยายด้วย Firebase CLI
  • ส่งออกการกำหนดค่าส่วนขยายของโปรเจ็กต์
  • แก้ไขไฟล์ Manifest ด้วยตนเอง

โดยจะอธิบาย 2 วิธีแรกด้านล่าง

จัดการไฟล์ Manifest ของส่วนขยายด้วย Firebase CLI

คุณเรียกใช้ext:คำสั่งส่วนใหญ่ของ Firebase CLI ด้วยตัวเลือก --local ได้ เพื่ออัปเดตไฟล์ Manifest ของส่วนขยายโดยไม่ต้องเปลี่ยนการกำหนดค่าปัจจุบันของโปรเจ็กต์จริงๆ

เช่น

firebase ext:install --local firebase/firestore-bigquery-export

การเรียกใช้คำสั่งข้างต้นจะแจ้งให้คุณกำหนดค่าส่วนขยายเวอร์ชันล่าสุดของ firebase/firestore-bigquery-export และบันทึกการกำหนดค่าลงใน ไฟล์ Manifest แต่จะไม่ทำให้การกำหนดค่าใช้งานในโปรเจ็กต์

ต่อไปนี้คือตัวอย่างคำสั่งเพิ่มเติมที่แก้ไขไฟล์ Manifest ของส่วนขยาย

# ext:configure changes the params for an extension instance in your extensions manifest
$ firebase ext:configure my-bigquery-extension --local

# ext:update --local updates an instance in your extensions manifest
# to the latest version of that extension
$ firebase ext:update my-bigquery-extension --local

# You can also specify a version if you don't want to update to the latest version
$ firebase ext:update my-bigquery-extension firebase/firestore-bigquery-export@0.1.10 --local 

# ext:uninstall --local removes an instance from your extensions manifest
$ firebase ext:uninstall my-bigquery-extension --local

ส่งออกการกำหนดค่าส่วนขยายของโปรเจ็กต์

หากต้องการบันทึกการกำหนดค่าส่วนขยายปัจจุบันของโปรเจ็กต์ลงในไฟล์ Manifest ให้ทำดังนี้

  1. หากยังไม่ได้ดำเนินการ ให้ตั้งค่า Firebase CLI
  2. เปลี่ยนไปที่ไดเรกทอรีโปรเจ็กต์จากพรอมต์เชลล์ (ไดเรกทอรีโปรเจ็กต์มีไฟล์ firebase.json)
  3. เรียกใช้คำสั่ง ext:export 
    firebase ext:export

คำสั่ง ext:export จะเพิ่มextensionsลงในfirebase.json ไฟล์ นอกจากนี้ คำสั่ง ext:export ยังสร้างextensionsไดเรกทอรี ที่มีไฟล์ .env สำหรับอินสแตนซ์ส่วนขยายแต่ละรายการที่คุณติดตั้งไว้ ไฟล์เหล่านี้มีพารามิเตอร์การกำหนดค่าสำหรับแต่ละอินสแตนซ์

ทดสอบการกำหนดค่าส่วนขยายด้วย Firebase Local Emulator Suite

เมื่อเพิ่มอินสแตนซ์ส่วนขยายบางรายการลงในไฟล์ Manifest ของส่วนขยายแล้ว คุณจะทดสอบอินสแตนซ์เหล่านั้นได้โดยใช้ Local Emulator Suite

  1. ติดตั้งและกำหนดค่า Local Emulator Suite

  2. เริ่มLocal Emulator Suiteโดยทำดังนี้

    • หากต้องการเรียกใช้ชุดโปรแกรมจำลองแบบอินเทอร์แอกทีฟ ให้เรียกใช้คำสั่งต่อไปนี้ firebase emulators:start
    • หากต้องการเรียกใช้ชุดโปรแกรมจำลองและเรียกใช้สคริปต์ทดสอบ ให้เรียกใช้คำสั่งต่อไปนี้ firebase emulators:exec my-test.sh

ตอนนี้หากคุณมีอินสแตนซ์ส่วนขยายที่แสดงในไฟล์ Manifest Local Emulator Suite จะดาวน์โหลดซอร์สโค้ดของส่วนขยายเหล่านั้นไปยัง ~/.cache/firebase/extensions เมื่อดาวน์โหลดแล้ว Local Emulator Suite จะเริ่มทำงาน และคุณจะเรียกใช้ฟังก์ชันที่ทริกเกอร์ในเบื้องหลังของส่วนขยาย ใดก็ได้ รวมถึงเชื่อมต่อแอปกับชุดโปรแกรมจำลอง เพื่อทดสอบการผสานรวมกับแอปได้

กำหนดค่าการกำหนดค่าส่วนขยายไปยังโปรเจ็กต์

เมื่อเพิ่มอินสแตนซ์ของส่วนขยายลงในไฟล์ Manifest ของส่วนขยายแล้ว คุณจะ ติดตั้งใช้งานในโปรเจ็กต์ได้โดยใช้ Firebase CLI เมื่อติดตั้งใช้งานด้วยไฟล์ Manifest ของส่วนขยาย คุณจะติดตั้ง อัปเดต และกำหนดค่าอินสแตนซ์ส่วนขยายทั้งหมดในไฟล์ Manifest ลงในโปรเจ็กต์ได้พร้อมกัน

วิธีติดตั้งใช้งานไฟล์ Manifest ของส่วนขยาย

  1. จากพรอมต์เชลล์ ให้เปลี่ยนไปที่ไดเรกทอรีที่มีการกำหนดค่าส่วนขยายที่บันทึกไว้ (นี่คือไดเรกทอรีที่มี firebase.json หากเพิ่งเรียกใช้ ext:export แสดงว่าคุณอยู่ในไดเรกทอรีที่ถูกต้องแล้ว )
  2. เรียกใช้คำสั่ง deploy หากต้องการติดตั้งใช้งานส่วนขยายในโปรเจ็กต์อื่นที่ไม่ใช่โปรเจ็กต์ปัจจุบัน ให้ระบุ--project=ด้วย 
    firebase deploy --only extensions –-project=YOUR_PROJECT_ID

คำสั่ง deploy จะตรวจสอบการกำหนดค่าแต่ละอินสแตนซ์ ถามว่าคุณต้องการลบอินสแตนซ์ส่วนขยายออกจากโปรเจ็กต์ปลายทางที่ไม่ได้อยู่ในรายการ firebase.json หรือไม่ จากนั้นจะติดตั้งใช้งานอินสแตนซ์ส่วนขยายทั้งหมด

การกำหนดค่าส่วนขยายเฉพาะโปรเจ็กต์

คุณสามารถใช้การกำหนดค่าส่วนขยายที่บันทึกไว้เพื่อทำให้ใช้งานได้ในโปรเจ็กต์ต่างๆ หลายโปรเจ็กต์ เช่น โปรเจ็กต์ทดสอบและโปรเจ็กต์ที่ใช้งานจริง เมื่อทำเช่นนี้ ค่าพารามิเตอร์บางค่าอาจต้องแตกต่างกันสำหรับแต่ละโปรเจ็กต์ .envไฟล์เฉพาะโปรเจ็กต์ช่วยให้ทำสิ่งนี้ได้

  • ใส่ค่าพารามิเตอร์ที่แตกต่างกันระหว่างโปรเจ็กต์ใน extensions/EXTENSION_INSTANCE_ID.env.YOUR_PROJECT_ID
  • ใส่ค่าพารามิเตอร์ที่ใช้ร่วมกันใน extensions/EXTENSION_INSTANCE_ID.env

บางครั้งคุณอาจต้องการใช้ค่าพารามิเตอร์อื่นเมื่อจำลองส่วนขยาย เช่น คุณอาจต้องการระบุคีย์ API สำหรับทดสอบแทนคีย์ API สำหรับเวอร์ชันที่ใช้งานจริง ใส่พารามิเตอร์ต่อไปนี้ในไฟล์ .local

  • ใส่พารามิเตอร์ที่ไม่ใช่ความลับที่คุณต้องการใช้ระหว่างการจำลองใน extensions/EXTENSION_INSTANCE_ID.env.local
  • ใส่ค่าพารามิเตอร์ลับใน extensions/EXTENSION_INSTANCE_ID.secret.local